Skip to content

Commit 6e7d1fc

Browse files
jacobjthompsonjacobjthompson
authored
Merge branch 'master' into Bybit-Readme
2 parents 2df2571 + 2bac560 commit 6e7d1fc

File tree

17 files changed

+1561
-180
lines changed

17 files changed

+1561
-180
lines changed

‎README.md

Lines changed: 57 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,13 @@
33
[![Build Status](https://dev.azure.com/DigitalRuby/DigitalRuby/_apis/build/status/jjxtra_ExchangeSharp?branchName=master)](https://dev.azure.com/DigitalRuby/DigitalRuby/_build/latest?definitionId=5&branchName=master) [![NuGet](https://img.shields.io/nuget/dt/DigitalRuby.ExchangeSharp.svg)][nuget]
44

55
## Overview
6+
67
ExchangeSharp is a C# **framework/lib** and [console app](#Installing-the-CLI) for trading and communicating with [various](#Exchanges) exchange API end points for cryptocurrency assets. Many exchanges are supported, along with [web sockets](#Websockets), withdraws and more!
78

89
Feel free to visit the discord channel at https://discord.gg/sHCUHH3 and chat with other developers.
910

1011
### Features
12+
1113
- Many exchanges supported with public, private and web socket API
1214
- Easy to use and well documented code and API
1315
- Optional global market symbol normalization, since each exchange has their own way of doing market symbols
@@ -16,56 +18,62 @@ Feel free to visit the discord channel at https://discord.gg/sHCUHH3 and chat wi
1618
- Has a great [CLI](#Installing-the-CLI) that enables you to use all features from all exchanges right from your command line.
1719

1820
### Exchanges
21+
1922
The following cryptocurrency exchanges are supported:
2023
(Web socket key: T = tickers, R = trades, B = order book, O = private orders)
2124

22-
|Exchange Name |Public REST|Private REST |Web Socket | Notes
23-
| ---------------- | --------- | ----------- | --------- | ---------
24-
| Binance | x | x | T R B |
25-
| Binance Jersey | x | x | T R B |
26-
| Binance.US | x | x | T R B |
27-
| Binance DEX | | | R |
28-
| Bitbank | x | x | |
29-
| Bitfinex | x | x | T R O |
30-
| Bithumb | x | | |
31-
| BitMEX | x | x | R O |
32-
| Bitstamp | x | x | R |
33-
| Bittrex | x | x | T R |
34-
| BL3P | x | x | R B | Trades stream does not send trade's ids.
35-
| Bleutrade | x | x | |
36-
| BTSE | x | x | |
37-
| Bybit | x | x | R | Has public method for Websocket Positions
38-
| Coinbase | x | x | T R |
39-
| Digifinex | x | x | R B |
40-
| Gemini | x | x | R |
41-
| HitBTC | x | x | R |
42-
| Huobi | x | x | R B |
43-
| Kraken | x | x | R | Dark order symbols not supported
44-
| KuCoin | x | x | T R |
45-
| LBank | x | x | |
46-
| Livecoin | x | x | |
47-
| NDAX | x | x | T R |
48-
| OKCoin | x | x | R B |
49-
| OKEx | x | x | R B |
50-
| Poloniex | x | x | T R B |
51-
| YoBit | x | x | |
52-
| ZB.com | wip | | R |
25+
| Exchange Name | Public REST | Private REST | Web Socket | Notes |
26+
| -------------- | ----------- | ------------ | ---------- | ---------------------------------------- |
27+
| Aquanow | wip | x | |
28+
| Binance | x | x | T R B |
29+
| Binance Jersey | x | x | T R B |
30+
| Binance.US | x | x | T R B |
31+
| Binance DEX | | | R |
32+
| Bitbank | x | x | |
33+
| Bitfinex | x | x | T R O |
34+
| Bithumb | x | | |
35+
| BitMEX | x | x | R O |
36+
| Bitstamp | x | x | R |
37+
| Bittrex | x | x | T R |
38+
| BL3P | x | x | R B | Trades stream does not send trade's ids. |
39+
| Bleutrade | x | x | |
40+
| BTSE | x | x | |
41+
| Bybit | x | x | R | Has public method for Websocket Positions
42+
| Coinbase | x | x | T R |
43+
| Digifinex | x | x | R B |
44+
| Gemini | x | x | R |
45+
| HitBTC | x | x | R |
46+
| Huobi | x | x | R B |
47+
| Kraken | x | x | R | Dark order symbols not supported |
48+
| KuCoin | x | x | T R |
49+
| LBank | x | x | |
50+
| Livecoin | x | x | |
51+
| NDAX | x | x | T R |
52+
| OKCoin | x | x | R B |
53+
| OKEx | x | x | R B |
54+
| Poloniex | x | x | T R B |
55+
| YoBit | x | x | |
56+
| ZB.com | wip | | R |
5357

5458
The following cryptocurrency services are supported:
59+
5560
- Cryptowatch (partial)
5661

5762
### Installing the CLI
5863

59-
On *nix systems:
60-
- Run this command `curl https://github.com/jjxtra/ExchangeSharp/raw/master/install-console.sh | sh`
64+
On \*nix systems:
65+
66+
- Run this command `curl https://github.com/jjxtra/ExchangeSharp/raw/master/install-console.sh | sh`
6167

6268
On Windows (or manually):
63-
- Download the [latest binaries](https://github.com/jjxtra/ExchangeSharp/releases/latest) for your OS.
64-
- Unzip it into a folder that is in your environment variable `PATH` (`ctrl` + `shift` + `pause|break` -> Environment Variables)
65-
- Use it from the your preferred command-line emulator (e.g. Powershell, cmd, etc.)
66-
- `exchange-sharp --help` shows all available commands
69+
70+
- Download the [latest binaries](https://github.com/jjxtra/ExchangeSharp/releases/latest) for your OS.
71+
- Unzip it into a folder that is in your environment variable `PATH` (`ctrl` + `shift` + `pause|break` -> Environment Variables)
72+
- Use it from the your preferred command-line emulator (e.g. Powershell, cmd, etc.)
73+
- `exchange-sharp --help` shows all available commands
6774

6875
### Notes
76+
6977
ExchangeSharp uses **`marketSymbol`** to refer to markets, or pairs of currencies.
7078

7179
Please send pull requests if you have made a change that you feel is worthwhile, want a bug fixed or want a new feature. You can also donate to get new features.
@@ -87,10 +95,12 @@ See [`WebSocket4NetClientWebSocket.cs`][websocket4net] for implementation detail
8795
### Nuget
8896

8997
#### dotnet CLI
90-
[`dotnet add package DigitalRuby.ExchangeSharp --version 0.7.1`][nuget]
98+
99+
[`dotnet add package DigitalRuby.ExchangeSharp --version 0.7.3`][nuget]
91100

92101
#### Package Manager on VS
93-
[`PM> Install-Package DigitalRuby.ExchangeSharp -Version 0.7.1`][nuget]
102+
103+
[`PM> Install-Package DigitalRuby.ExchangeSharp -Version 0.7.3`][nuget]
94104

95105
### Examples
96106

@@ -119,6 +129,7 @@ public static async Task Main(string[] args)
119129
```
120130

121131
### Logging
132+
122133
ExchangeSharp uses NLog internally _currently_. To log, use `ExchangeSharp.Logger`.
123134

124135
Do **not** use `Console.WriteLine` to log messages in the lib project.
@@ -132,12 +143,15 @@ The `ExchageAPI` class provides a method caching mechanism. Use `MethodCachePoli
132143
You can also set request cache policy if you want to tweak how the http caching behaves.
133144

134145
### How to contribute
146+
135147
Please read the [contributing guideline](CONTRIBUTING.md) **before** submitting a **pull request**.
136148

137149
### Consulting
150+
138151
I'm happy to make customizations to the software for you and keep in private repo, email [email protected].
139152

140153
### Donations Gratefully Accepted
154+
141155
Believe it or not, donations are quite rare. I've posted publicly the total donation amounts below. If ExchangeSharp has helped you in anyway, please consider donating.
142156

143157
[![Donate with Bitcoin](https://en.cryptobadges.io/badge/small/1GBz8ithHvTqeRZxkmpHx5kQ9wBXuSH8AG)](https://en.cryptobadges.io/donate/1GBz8ithHvTqeRZxkmpHx5kQ9wBXuSH8AG)
@@ -149,13 +163,13 @@ Believe it or not, donations are quite rare. I've posted publicly the total dona
149163
[![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=L67Q4KQN5DHLY)
150164

151165
Donation totals:
152-
0.02350084 BTC, 10.25 LTC
166+
0.039 BTC, 10.25 LTC
153167

154168
Thanks for visiting!
155169

156170
Jeff Johnson
157171
[email protected]
158-
http://www.digitalruby.com
172+
http://www.digitalruby.com
159173

160-
[nuget]: https://www.nuget.org/packages/DigitalRuby.ExchangeSharp/
161-
[websocket4net]: https://github.com/kerryjiang/WebSocket4Net
174+
[nuget]: https://www.nuget.org/packages/DigitalRuby.ExchangeSharp/
175+
[websocket4net]: https://github.com/kerryjiang/WebSocket4Net

0 commit comments

Comments
 (0)