Home

Awesome

<img src='logo.png' width='600' alt="Project's logo" />

Github Sponsorship

NuGet

Overview

ExchangeSharp is a C# framework/lib and console app for trading and communicating with various exchange API end points for cryptocurrency assets. Many exchanges are supported, along with web sockets, withdraws and more!

Feel free to visit the discord channel at https://discord.gg/58ktxXuTVK and chat with other developers.

Features

Exchanges

The following cryptocurrency exchanges are supported:
(Web socket key: T = tickers, R = trades, B = orderbook / delta orderbook, O = private orders, U = user data)

Exchange NamePublic RESTPrivate RESTWeb SocketNotes
ApolloXxxT R B O U
Aquanowwipx
BinancexxT R B O U
Binance JerseyxxT R B O UCeased operations
Binance.USxxT R B O U
Binance DEXR
Bitbankxx
BitfinexxxT R O
BitflyerR
BithumbxR
BitMEXxxR O
BitstampxxR
BittrexxxT R
BL3PxxR BTrades stream does not send trade's ids.
Bleutradexx
BtcTurkR
BTSExx
BybitxxR BHas public method for Websocket Positions
Coinbase (Advanced)xxT R O U
CoincheckR
Coinmatexx
Crypto.comR
DigifinexxxR B
DydxR
FTXxxT R
FTX.usxxT R
gate.ioxxR
GeminixxT R B
HitBTCxxR
HuobixxR B
KrakenxxRDark order symbols not supported
KuCoinxxT R B
LBankxxR
Livecoinxx
MEXCxx
NDAXxxT R
OKCoinxxR B
OKExxxT R B O
PoloniexxxT R B
UPbitR
YoBitxx
ZB.comwipR

The following cryptocurrency services are supported:

Exchange constructors are private, to get access to an exchange in code use:

ExchangeAPI.GetExchangeAPIAsync<>().

Installing the CLI

On *nix systems:

On Windows (or manually):

Notes

ExchangeSharp uses marketSymbol to refer to markets, or pairs of currencies.

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.

Building/Compiling

Websockets

If you must use an older Windows (older than win8.1), you'll need to use the Websocket4Net nuget package, and override the web socket implementation by calling

ExchangeSharp.ClientWebSocket.RegisterWebSocketCreator(
    () => new ExchangeSharpConsole.WebSocket4NetClientWebSocket()
);

See WebSocket4NetClientWebSocket.cs for implementation details.

Nuget

dotnet CLI

dotnet add package DigitalRuby.ExchangeSharp --version 1.2.0

Package Manager on VS

PM> Install-Package DigitalRuby.ExchangeSharp -Version 1.2.0

Examples

Creating an order

There's a lot of examples on how to use the API in our console application.
e.g. ExampleOption.cs

Getting ticker info via Web Sockets

public static async Task Main(string[] args)
{
    // create a web socket connection to Binance. Note you can Dispose the socket anytime to shut it down.
    using var api = await ExchangeAPI.GetExchangeAPIAsync<ExchangeBinanceAPI>();
    // the web socket will handle disconnects and attempt to re-connect automatically.
    using var socket = await api.GetTickersWebSocket(tickers =>
    {
        Console.WriteLine("{0} tickers, first: {1}", tickers.Count, tickers.First());
    });

    Console.WriteLine("Press ENTER to shutdown.");
    Console.ReadLine(true);
}

Authentication

Private api calls like placing orders require you to call LoadApiKeys first. You can generate an api keys file by running the bundled console application and choosing the generate key file option.

Logging

ExchangeSharp uses NLog internally currently. To log, use ExchangeSharp.Logger.

Do not use Console.WriteLine to log messages in the lib project.

Provide your own nlog.config or app.config nlog configuration if you want to change logging settings or turn logging off.

Caching

The ExchageAPI class provides a method caching mechanism. Use MethodCachePolicy to put caching behind public methods, or clear to remove caching. Some methods are cached by default. You can set ExchangeAPI.UseDefaultMethodCachePolicy to false to stop all caching as well.

You can also set request cache policy if you want to tweak how the http caching behaves.

How to contribute

Please read the contributing guideline before submitting a pull request.

Consulting

I'm happy to make customizations to the software for you and keep in private repo, email exchangesharp@digitalruby.com.

Donations Gratefully Accepted

Believe it or not, donations are quite rare. I've posted publicly the total donation amounts below. If ExchangeSharp has helped you in any way, please consider donating.

Donate with Bitcoin

Donate with Litecoin

Donate with Ethereum

Donate

Donation totals: 0.039 BTC, 10.25 LTC

Thanks for visiting!

Jeff Johnson
jeff@digitalruby.com
http://www.digitalruby.com