DeepCoin.Net

May 9, 2026 · View on GitHub

.NET License

DeepCoin.Net is a client library for accessing the DeepCoin REST and Websocket API.

Features

  • Response data is mapped to descriptive models
  • Input parameters and response values are mapped to discriptive enum values where possible
  • High performance
  • Automatic websocket (re)connection management
  • Client side rate limiting
  • Client side order book implementation
  • Support for managing different accounts
  • Extensive logging
  • Support for different environments
  • Easy integration with other exchange client based on the CryptoExchange.Net base library
  • Native AOT support

Supported Frameworks

The library is targeting both .NET Standard 2.0 and .NET Standard 2.1 for optimal compatibility, as well as the latest dotnet versions to use the latest framework features.

.NET implementationVersion Support
.NET Core2.0 and higher
.NET Framework4.6.1 and higher
Mono5.4 and higher
Xamarin.iOS10.14 and higher
Xamarin.Android8.0 and higher
UWP10.0.16299 and higher
Unity2018.1 and higher

Install the library

NuGet

NuGet version Nuget downloads

dotnet add package DeepCoin.Net

GitHub packages

DeepCoin.Net is available on GitHub packages. You'll need to add https://nuget.pkg.github.com/JKorf/index.json as a NuGet package source.

Download release

GitHub Release

The NuGet package files are added along side the source with the latest GitHub release which can found here.

How to use

Basic request:

// Get the ETH/USDT ticker via rest request
var restClient = new DeepCoinRestClient();
var tickerResult = await restClient.ExchangeApi.ExchangeData.GetTickersAsync(SymbolType.Spot);
var ticker = tickerResult.Data.Single(x => x.Symbol == "ETH-USDT");
var lastPrice = ticker.LastPrice;

Place order:

var restClient = new DeepCoinRestClient(opts => {
	opts.ApiCredentials = new DeepCoinCredentials("APIKEY", "APISECRET", "PASS");
});

// Place Limit order to go long for 0.1 ETH at 2000
var orderResult = await restClient.ExchangeApi.Trading.PlaceOrderAsync(
    "ETH-USDT-SWAP",
    OrderSide.Buy,
    OrderType.Limit,
    0.1m,
    price: 2000,
    tradeMode: TradeMode.Cross,
    positionSide: PositionSide.Long);

WebSocket subscription:

// Subscribe to ETH/USDT ticker updates via the websocket API
var socketClient = new DeepCoinSocketClient();
var tickerSubscriptionResult = socketClient.ExchangeApi.SubscribeToSymbolUpdatesAsync("ETH-USDT", (update) => 
{
  var lastPrice = update.Data.LastPrice;
});

For information on the clients, dependency injection, response processing and more see the documentation, or have a look at the examples here or here.

AI / LLM documentation

DeepCoin.Net includes AI-oriented documentation and examples for code generation tools:

FilePurpose
AGENTS.mdAssistant skill with core DeepCoin.Net patterns, pitfalls, and examples
llms.txtShort LLM index with links to docs, examples, and critical usage rules
llms-full.txtDetailed LLM context with endpoint routing, code patterns, and anti-hallucination checks
docs/ai-api-map.mdTable-style intent-to-method map for ExchangeApi REST, WebSocket, and SharedApis
Examples/ai-friendlyCompilable single-file examples for common REST, WebSocket, shared API, and error handling workflows

GitHub Copilot and Cursor instructions are also provided in .github/copilot-instructions.md and .cursor/rules/deepcoin-net.mdc; both point back to the root AI context files.

CryptoExchange.Net

DeepCoin.Net is based on the CryptoExchange.Net base library. Other exchange API implementations based on the CryptoExchange.Net base library are available and follow the same logic.

CryptoExchange.Net also allows for easy access to different exchange API's.

ExchangeRepositoryNuget
AsterJKorf/Aster.NetNuget version
BinanceJKorf/Binance.NetNuget version
BingXJKorf/BingX.NetNuget version
BitfinexJKorf/Bitfinex.NetNuget version
BitgetJKorf/Bitget.NetNuget version
BitMartJKorf/BitMart.NetNuget version
BitMEXJKorf/BitMEX.NetNuget version
BitstampJKorf/Bitstamp.NetNuget version
BloFinJKorf/BloFin.NetNuget version
BybitJKorf/Bybit.NetNuget version
CoinbaseJKorf/Coinbase.NetNuget version
CoinExJKorf/CoinEx.NetNuget version
CoinGeckoJKorf/CoinGecko.NetNuget version
CoinWJKorf/CoinW.NetNuget version
Crypto.comJKorf/CryptoCom.NetNuget version
Gate.ioJKorf/GateIo.NetNuget version
HTXJKorf/HTX.NetNuget version
HyperLiquidJKorf/HyperLiquid.NetNuget version
KrakenJKorf/Kraken.NetNuget version
KucoinJKorf/Kucoin.NetNuget version
MexcJKorf/Mexc.NetNuget version
OKXJKorf/OKX.NetNuget version
PolymarketJKorf/Polymarket.NetNuget version
ToobitJKorf/Toobit.NetNuget version
UpbitJKorf/Upbit.NetNuget version
WeexJKorf/Weex.NetNuget version
WhiteBitJKorf/WhiteBit.NetNuget version
XTJKorf/XT.NetNuget version

When using multiple of these API's the CryptoClients.Net package can be used which combines this and the other packages and allows easy access to all exchange API's.

Discord

Nuget version
A Discord server is available here. For discussion and/or questions around the CryptoExchange.Net and implementation libraries, feel free to join.

Supported functionality

REST

APISupportedLocation
DeepCoinAccount✓restClient.ExchangeApi.Account
DeepCoinMarket✓restClient.ExchangeApi.ExchangeData
DeepCoinTrade✓restClient.ExchangeApi.Trading
CopyTradeX
Internal TransferX(API not available)
RebateX
Assets✓restClient.ExchangeApi.Account

WebSocket

APISupportedLocation
Private websocket✓restClient.ExchangeApi.ExchangeData
Public websocket✓restClient.ExchangeApi.ExchangeData

Support the project

Any support is greatly appreciated.

Referal

If you do not yet have an account please consider using this referal link to sign up:
Link

Make a one time donation in a crypto currency of your choice. If you prefer to donate a currency not listed here please contact me.

Btc: bc1q277a5n54s2l2mzlu778ef7lpkwhjhyvghuv8qf
Eth: 0xcb1b63aCF9fef2755eBf4a0506250074496Ad5b7
USDT (TRX) TKigKeJPXZYyMVDgMyXxMf17MWYia92Rjd

Alternatively, sponsor me on Github using Github Sponsors.

Release notes

  • Version 3.9.2 - 09 Apr 2026

  • Version 3.9.1 - 24 Mar 2026

    • Fix issue in credentials copying

  • Version 3.9.0 - 24 Mar 2026

    • Updated CryptoExchange.Net to version 11.0.1, see https://github.com/JKorf/CryptoExchange.Net/releases/ for full release notes

    • Updated class for supplying API credentials from ApiCredentials to DeepCoinCredentials

    • Updated Shared order status parsing to default to Unknown value if not parsable

    • Notes for updating:

      • Update ApiCredentials to DeepCoinCredentials for authentication, i.e. ApiCredentials = new ApiCredentials(..) => ApiCredentials = new DeepCoinCredentials(..)

  • Version 3.8.0 - 06 Mar 2026

  • Version 3.7.0 - 24 Feb 2026

    • Updated CryptoExchange.Net to version 10.7.0
    • Added additional Http settings to client options
    • Updated Shared REST interfaces pagination logic
    • Updated HttpClient registration, fixing issue of DNS changes not getting processed
    • Fixed UserClientProvider using unconfigured HttpClient
    • Fixed restClient.ExchangeApi.Account.GetDepositHistoryAsync and GetWithdrawHistoryAsync startTime and endTime parameter serialization

  • Version 3.6.0 - 16 Feb 2026

  • Version 3.5.0 - 10 Feb 2026

  • Version 3.4.0 - 06 Feb 2026

    • Updated CryptoExchange.Net to version 10.4.0, see https://github.com/JKorf/CryptoExchange.Net/releases/ for full release notes
    • Added DeepCoinUserSpotDataTracker and DeepCoinUserFuturesDataTracker
    • Added additional methods for requesting supported symbols to Shared ISpotSymbolRestClient/IFuturesSymbolRestClient interfaces
    • Added PositionMode mapping on SharedPosition models
    • Added Status mapping for SharedDeposit models
    • Fixed disposed clients getting returned from UserClientProvider
    • Fixed SharedSymbol mapping for Shared model updates from websocket

  • Version 3.3.0 - 22 Jan 2026

    • Updated CryptoExchange.Net to version 10.3.0, see https://github.com/JKorf/CryptoExchange.Net/releases/ for full release notes
    • Removed legacy websocket message handling and the corresponding UseUpdatedDeserialization client option
    • Added Metadata to DeepCoinExchange

  • Version 3.2.1 - 14 Jan 2026

  • Version 3.2.0 - 13 Jan 2026

    • Updated CryptoExchange.Net to version 10.2.0, see https://github.com/JKorf/CryptoExchange.Net/releases/ for full release notes
    • Added SequenceNumber to order book websocket updates
    • Fixed SharedSymbol.UsdOrStable const not getting replaced for futures order book
    • Fixed futures order book symbol formatting

  • Version 3.1.0 - 07 Jan 2026

    • Updated CryptoExchange.Net version to 10.1.0, see https://github.com/JKorf/CryptoExchange.Net/releases/ for full release notes
    • Added DataTimeLocal and DataAge properties to DataEvent object
    • Added UpdateServerTime, UpdateLocalTime and DataAge properties to (I)SymbolOrderBook

  • Version 3.0.2 - 17 Dec 2025

    • Fix SharedSymbol.UsdOrStable mapping when using order book factory for spot asset

  • Version 3.0.1 - 16 Dec 2025

    • Fixed release

  • Version 3.0.0 - 16 Dec 2025

    • Added Net10.0 target framework
    • Updated CryptoExchange.Net version to 10.0.0, see https://github.com/JKorf/CryptoExchange.Net/releases/ for full release notes
    • Improved performance across the board, biggest gains in websocket message processing
    • Updated REST message response handling
    • Updated WebSocket message handling
    • Added UseUpdatedDeserialization socket client options to toggle by new and old message handling
    • Added SocketIndividualSubscriptionCombineTarget socket client option
    • Updated Shared API's subscription update types from ExchangeEvent to DataEvent

  • Version 2.11.0 - 11 Nov 2025

  • Version 2.10.0 - 03 Nov 2025

    • Updated CryptoExchange.Net to version 9.12.0
    • Added support for using SharedSymbol.UsdOrStable in Shared APIs
    • Fixed restClient.ExchageApi.Trading.CancelAllOrdersAsync parameter serialization
    • Fixed exception when initial trade snapshot has no items in TradeTracker
    • Removed some unhelpful verbose logs

  • Version 2.9.0 - 16 Oct 2025

  • Version 2.8.0 - 30 Sep 2025

  • Version 2.7.0 - 01 Sep 2025

  • Version 2.6.0 - 25 Aug 2025

  • Version 2.5.1 - 21 Aug 2025

    • Added error handling for non 200 status responses

  • Version 2.5.0 - 20 Aug 2025

    • Updated CryptoExchange.Net to version 9.5.0, see https://github.com/JKorf/CryptoExchange.Net/releases/
    • Added improved error parsing
    • Updated rest request sending too prevent duplicate parameter serialization
    • Fixed error responses not correctly getting logged as error

  • Version 2.4.0 - 04 Aug 2025

  • Version 2.3.0 - 23 Jul 2025

  • Version 2.2.1 - 16 Jul 2025

  • Version 2.2.0 - 15 Jul 2025

  • Version 2.1.0 - 02 Jun 2025

  • Version 2.0.0 - 13 May 2025

    • Updated CryptoExchange.Net to version 9.0.0, see https://github.com/JKorf/CryptoExchange.Net/releases/
    • Added support for Native AOT compilation
    • Added RateLimitUpdated event
    • Added SharedSymbol response property to all Shared interfaces response models returning a symbol name
    • Added GenerateClientOrderId method to ExchangeApi Shared clients
    • Added IBookTickerRestClient implementation to ExchangeApi Shared client
    • Added takeProfitPrice, stopLossPrice support to ExchangeApi Shared PlaceFuturesOrderAsync
    • Added TakeProfitPrice, StopLossPrice properties to SharedFuturesOrder model
    • Added MaxLongLeverage, MaxShortLeverage to SharedFuturesSymbol model
    • Added OptionalExchangeParameters and Supported properties to EndpointOptions
    • Added All property to retrieve all available environment on DeepCoinEnvironment
    • Refactored Shared clients quantity parameters and responses to use SharedQuantity
    • Replaced DeepCoinApiCredentials with ApiCredentials
    • Updated all IEnumerable response and model types to array response types
    • Removed Newtonsoft.Json dependency
    • Fixed incorrect Shared SpotSupportOrderQuantity configuration for limit orders
    • Fixed Shared spot PlaceOrder by quote asset quantity
    • Fixed DeepCoinExchange.ImageUrl link
    • Fixed incorrect DataTradeMode on certain Shared interface responses
    • Fixed parsing of order types
    • Fixed some typos

  • Version 2.0.0-beta3 - 01 May 2025

    • Updated CryptoExchange.Net version to 9.0.0-beta5
    • Added property to retrieve all available API environments
    • Disabled parsing of Shared spot ticker QuoteVolume as value is incorrect

  • Version 2.0.0-beta2 - 23 Apr 2025

    • Updated CryptoExchange.Net to version 9.0.0-beta2
    • Added Shared spot ticker QuoteVolume mapping
    • Fixed incorrect DataTradeMode on responses

  • Version 2.0.0-beta1 - 22 Apr 2025

    • Updated CryptoExchange.Net to version 9.0.0-beta1, see https://github.com/JKorf/CryptoExchange.Net/releases/
    • Added support for Native AOT compilation
    • Added RateLimitUpdated event
    • Added SharedSymbol response property to all Shared interfaces response models returning a symbol name
    • Added GenerateClientOrderId method to ExchangeApi Shared clients
    • Added IBookTickerRestClient implementation to ExchangeApi Shared client
    • Added takeProfitPrice, stopLossPrice support to ExchangeApi Shared PlaceFuturesOrderAsync
    • Added TakeProfitPrice, StopLossPrice properties to SharedFuturesOrder model
    • Added MaxLongLeverage, MaxShortLeverage to SharedFuturesSymbol model
    • Added OptionalExchangeParameters and Supported properties to EndpointOptions
    • Refactored Shared clients quantity parameters and responses to use SharedQuantity
    • Replaced DeepCoinApiCredentials with ApiCredentials
    • Updated all IEnumerable response and model types to array response types
    • Removed Newtonsoft.Json dependency
    • Fixed parsing of order types
    • Fixed some typos

  • Version 1.0.5 - 06 Mar 2025

    • Fixed restClient.ExchangeApi.Account.KeepAliveUserStreamAsync endpoint

  • Version 1.0.4 - 04 Mar 2025

    • Fix for handling websocket order book updates with the same sequence number split over 2 messages

  • Version 1.0.3 - 04 Mar 2025

    • Fixed Volume and QuoteVolume properties being inversed on DeepCoinTicker model
    • Fixed DeepCoinOrderBookFactory Create with SharedSymbol parameter not formatting correctly

  • Version 1.0.2 - 04 Mar 2025

    • Fix for spot websocket subscriptions not getting updates

  • Version 1.0.1 - 04 Mar 2025

    • Added Type property to DeepCoinExchange
    • Updated DeepCoinOptions to derive from LibraryOptions

  • Version 1.0.0 - 04 Mar 2025

    • Initial release