Skip to content

Repository files navigation

.Kucoin.Net Kucoin.Net

.NET License Since

Docs

Kucoin.Net is a strongly typed client library for accessing the Kucoin 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 (production, testnet)
  • Easy integration with other exchange client based on the CryptoExchange.Net base library
  • Native AOT support

Documentation

The Kucoin.Net documentation is the main resource for installing, configuring, and using the library.

Resource Description
Client guide Installation, REST and WebSocket clients, authentication, dependency injection, error handling, and advanced features
Examples Common REST and WebSocket operations
API reference Client interfaces, methods, and properties
Shared API guide Common interfaces and models for working with multiple exchanges

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 implementation Version Support
.NET Core 2.0 and higher
.NET Framework 4.6.1 and higher
Mono 5.4 and higher
Xamarin.iOS 10.14 and higher
Xamarin.Android 8.0 and higher
UWP 10.0.16299 and higher
Unity 2018.1 and higher

Install the library

NuGet

NuGet version Nuget downloads

dotnet add package Kucoin.Net

GitHub packages

Kucoin.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 KucoinRestClient();
var tickerResult = await restClient.SpotApi.ExchangeData.GetTickerAsync("ETH-USDT");
var lastPrice = tickerResult.Data.LastPrice;

Place order:

var restClient = new KucoinRestClient(opts => {
	opts.ApiCredentials = new KucoinCredentials("APIKEY", "APISECRET");
});

// Place Limit order to go long for 0.1 ETH at 2000
var orderResult = await restClient.FuturesApi.Trading.PlaceOrderAsync(
    "ETHUSDTM",
    OrderSide.Buy,
    NewOrderType.Limit,
    quantity: 10,
    price: 2000,
    positionSide: PositionSide.Long
    );

WebSocket subscription:

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

For more examples and explanations, continue with the Kucoin.Net documentation or browse the compilable repository examples.

AI / LLM documentation

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

File Purpose
AGENTS.md Assistant skill with core Kucoin.Net patterns, pitfalls, and examples
llms.txt Short LLM index with links to docs, examples, and critical usage rules
llms-full.txt Detailed LLM context with endpoint routing, code patterns, and anti-hallucination checks
docs/ai-api-map.md Table-style intent-to-method map for Spot, Futures, Unified, WebSocket, and SharedApis
Examples/ai-friendly Compilable single-file examples for common REST, WebSocket, shared API, and error handling workflows

See cryptoexchange-skills-hub for installable skills.

Shared / unified API

The CryptoExchange.Net Shared API V2 provides exchange-agnostic interfaces and models for common operations such as retrieving tickers, order books and balances, placing orders, and subscribing to market updates.

V2 uses a strict interface per capability. The SharedApi property on each Kucoin API surface therefore exposes only the operations or subscriptions that surface actually supports. IKucoinSharedApiClient groups the SpotRest, FuturesRest, SpotSocket, and FuturesSocket surfaces for dependency injection and runtime capability lookup.

Access a strict capability

using CryptoExchange.Net.SharedApis;
using Kucoin.Net.Clients;

using var restClient = new KucoinRestClient();
IGetTickerRest tickerClient = restClient.SpotApi.SharedApi;

var symbol = new SharedSymbol(TradingMode.Spot, "ETH", "USDT");
var result = await tickerClient.GetTickerAsync(
    new GetTickerRequest(symbol));

if (!result.Success)
{
    Console.WriteLine(result.Error);
    return;
}

Console.WriteLine(result.Data.LastPrice);

The request and response models belong to CryptoExchange.Net.SharedApis, so the same operation can accept another exchange's IGetTickerRest implementation. When using dependency injection, inject IKucoinSharedApiClient to access all Kucoin Shared API surfaces or inject a capability such as IGetTickerRest directly. Use GetCapability on the aggregate when the operation, transport, or trading mode is selected at runtime.

CryptoExchange.Net

Kucoin.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 provides shared access to different exchange APIs.

Exchange Repository Nuget
Aster JKorf/Aster.Net Nuget version
Binance JKorf/Binance.Net Nuget version
BingX JKorf/BingX.Net Nuget version
Bitfinex JKorf/Bitfinex.Net Nuget version
Bitget JKorf/Bitget.Net Nuget version
BitMart JKorf/BitMart.Net Nuget version
BitMEX JKorf/BitMEX.Net Nuget version
Bitstamp JKorf/Bitstamp.Net Nuget version
BloFin JKorf/BloFin.Net Nuget version
Bybit JKorf/Bybit.Net Nuget version
Coinbase JKorf/Coinbase.Net Nuget version
CoinEx JKorf/CoinEx.Net Nuget version
CoinGecko JKorf/CoinGecko.Net Nuget version
CoinW JKorf/CoinW.Net Nuget version
Crypto.com JKorf/CryptoCom.Net Nuget version
DeepCoin JKorf/DeepCoin.Net Nuget version
Gate.io JKorf/GateIo.Net Nuget version
HTX JKorf/HTX.Net Nuget version
HyperLiquid JKorf/HyperLiquid.Net Nuget version
Kraken JKorf/Kraken.Net Nuget version
LBank JKorf/LBank.Net Nuget version
Lighter JKorf/Lighter.Net Nuget version
Mexc JKorf/Mexc.Net Nuget version
OKX JKorf/OKX.Net Nuget version
Pionex JKorf/Pionex.Net Nuget version
Polymarket JKorf/Polymarket.Net Nuget version
Tapbit JKorf/Tapbit.Net Nuget version
Toobit JKorf/Toobit.Net Nuget version
Upbit JKorf/Upbit.Net Nuget version
Weex JKorf/Weex.Net Nuget version
WhiteBit JKorf/WhiteBit.Net Nuget version
XT JKorf/XT.Net Nuget version

Discord

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

Supported functionality

Rest Api

API Supported Location
Account Basic Info ✓ restClient.SpotApi.Account / restClient.FuturesApi.Account
Account Sub-Account ✓ restClient.SpotApi.SubAccount
Funding Overview ✓ restClient.SpotApi.Account
Funding Deposit ✓ restClient.SpotApi.Account
Funding Withdrawal ✓ restClient.SpotApi.Account
Funding Transfer ✓ restClient.SpotApi.Account
Funding Trade Fee ✓ restClient.SpotApi.Account
Spot Trading Market Data ✓ restClient.SpotApi.ExchangeData
Spot Trading HF Trade ✓ restClient.SpotApi.ProAccount
Spot Trading Orders ✓ restClient.SpotApi.Trading
Spot Trading Fills ✓ restClient.SpotApi.Trading
Spot Trading Stop Order ✓ restClient.SpotApi.Trading
Margin Trading Margin HF Trade X
Margin Trading Margin Orders ✓ restClient.SpotApi.Trading
Margin Trading Margin Info ✓ restClient.SpotApi.ExchangeData
Margin Trading Isolated Margin ✓ restClient.SpotApi.ExchangeData / restClient.SpotApi.Account
Margin Trading Margin Trading(V3) ✓ restClient.SpotApi.Margin
Margin Trading Lending Market(V3) ✓ restClient.SpotApi.Margin
Futures Trading Market Data ✓ restClient.FuturesApi.ExchangeData
Futures Trading Orders ✓ restClient.FuturesApi.Trading
Futures Trading Fills ✓ restClient.FuturesApi.Trading
Futures Trading Positions ✓ restClient.FuturesApi.Acount / restClient.FuturesApi.Trading
Futures Trading Risk Limit ✓ restClient.FuturesApi.Acount
Futures Trading Funding Fees ✓ restClient.FuturesApi.ExchangeData

Websocket Api

API Supported Location
Spot Public ✓ socketClient.SpotApi
Spot Private ✓ socketClient.SpotApi
Margin Public ✓ socketClient.SpotApi
Margin Private ✓ socketClient.SpotApi
Futures Public ✓ socketClient.FuturesApi
Futures Private ✓ socketClient.FuturesApi

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

Donate

Make a one time donation in a crypto currency of your choice. If you prefer to donate in a different currency or network send me a message.

USDT (TRX) TKigKeJPXZYyMVDgMyXxMf17MWYia92Rjd

Sponsor

Alternatively, sponsor me on Github using Github Sponsors.

Release notes

  • Version 9.6.0 - 24 Sep 2026

    • Updated CryptoExchange.Net to v13.0.0
    • Shared APIs
    • Rate limiting
      • Added rate limit admission callback to client options to allow rate limit admission ruling on request definition
      • Added WithRateLimitAdmissionAsync to client to allow rate limit admission ruling on a specific request
      • Update rate limit safety margin logic
      • Fixed some rate limit calculation issues
    • Request coalescing
      • Sending identical public GET requests on the same client at the same time will only send a single request to the server and use the same response
      • Coalescing is enabled by default and can be disabled with the RequestCoalescingEnabled client option
    • Fixed proxy setting not being used for internal REST requests
  • Version 9.5.0 - 21 Aug 2026

    • Updated to CryptoExchange.Net v12.5.0
    • Added LastFundingRate to KucoinContract model
    • Added MakerFeePercentage, TakerFeePercentage, MaxLongLeverage, TakerFeePercentage, MaxLongLeverage, MaxShortLeverage, UpperFundingCap, LowerFundingCap, LowerPriceLimitPercentage, UpperPriceLimitPercentage to SharedFuturesSymbol mapping
  • Version 9.4.0 - 14 Aug 2026

    • Added restClient.UnifiedApi.ExchangeData.GetCallAuctionInfoAsync GetInterestRateIndexAsync and GetPlatformStatsAsync
    • Added socketClient.UnifiedApi.SubscribeToCallAuctionInfoUpdatesAsync subscription
    • Added MemoRegex and AddressRegex to KucoinAssetNetwork model
    • Added BizType EarnRedeem and updated EarnLock mapping values
    • Added UpdateTime to KucoinUaPosition model
    • Updated LiquidityRole on KucoinUaUserTrade to nullable
  • Version 9.3.0 - 29 Jul 2026

    • Updated CryptoExchange.Net to version 12.4.0
    • Added calculation of AveragePrice on Shared order models if data is available and AveragePrice is not set
    • Added DebuggerDisplay attributes to Result models
    • Added AveragePrice property to SharedQuantity model
    • Updated SharedFuturesTicker, SharedSpotTicker, SharedTrade and SharedKline to use SharedOrderQuantity for volumes/quantities
  • Version 9.2.0 - 21 Jul 2026

    • Updated CryptoExchange.Net to v12.2.0
    • Added SpotSymbolCatalog to Shared ISpotSymbolRestClient interface
    • Added FuturesSymbolCatalog to Shared IFuturesSymbolRestClient interface
    • Added BaseAssetType, BaseAssetSubType, QuoteAssetType and QuoteAssetSubType to GetSymbolsRequest model
    • Added DisplayName to SharedSpotSymbol and SharedFuturesSymbol models
    • Added BaseAssetType, BaseAssetSubType, QuoteAssetType and QuoteAssetSubType to SharedSpotSymbol and SharedFuturesSymbol models
    • Added DebuggerDisplay attributes to Shared models
    • Updated GetTickersAsync request weight from 15 to 5
  • Version 9.1.0 - 09 Jul 2026

    • Updated CryptoExchange.Net to v12.1.0
    • Added OpenPrice, LastQuantity to KucoinAllTick model
    • Added TradeId to KucoinTrade model
    • Added ContractId to KucoinFuturesTrade model
    • Added DailyInterestRate to KucoinFundingRate model
    • Added FeeTaxRate to KucoinTradeFee model
    • Added OptionSubQuantity, MaxOptionSubQuantity to KucoinUserInfo model, updated quantity properties to int type
    • Added FailureReason, FailureReasonMessage, SubStatus properties to KucoinWithdrawal model
    • Added RiskRatio, PositionMargin to KucoinUaPosition and KucoinUaPositionUpdate models
    • Added restClient.UnifiedApi.Account.SetMarginModeAsync endpoint
    • Added restClient.UnifiedApi.Account.SetIsolatedMarginAsync endpoint
    • Added closeOrder parameter to restClient.UnifiedApi.Trading.PlaceOrderAsync
    • Added restClient.UnifiedApi.ExchangeData.GetFiatPricesAsync endpoint
    • Added type parameter to restClient.UnifiedApi.ExchangeData.GetKlinesAsync endpoint
    • Added PriceChange, PriceChangePercent, IndexPrice and MarkPrice to KucoinUaTicker model
    • Added CollateralStatus to KucoinUaBalanceAsset and KucoinUaBalanceUpdate models
    • Added SubscribeToFundingFeeUpdatesAsync and SubscribeToMarkPriceUpdatesAsync subscriptions to UnifiedApi websocket client
    • Updated KucoinContract with various missing properties
    • Updated KucoinDeposit with missing properties
    • Updated DepositStatus enum values
    • Removed Incremental value for OrderBookDepth enum, added Incremental10Ms value
  • Version 9.0.1 - 04 Jul 2026

    • Fixed subscribing to user streams not triggering socket authentication if a public socket was already connected
  • Version 9.0.0 - 29 Jun 2026

    • Result types:
      • (Web)CallResult types are replaced by HttpResult, WebSocketResult and QueryResult with the same logic
      • WebSocketResult and QueryResult now return additional info for websocket operations
      • Updated result types to record type
      • Removed implicit result type conversion to bool, if (result) no longer works, instead use if (result.Success)
      • Fixed result object nullability hinting, for example Data might be null if Success isn't checked for true
    • Clients:
      • Added ToString overrides on base API types
      • Added Exchange property on BaseApiClient
      • Added ApiCredentials property on Api clients
      • Updated ILogger source from client name to topic specific client name
      • Removed logging from client creation
      • Fixed issue in SocketApiClient.GetSocketConnection causing requests to always wait the full max 10 seconds when there was a reconnecting socket
    • Shared APIs:
      • Added missing dedicated option types
      • Added Discover method on ISharedClient interface, returning info on supported capabilities and operations
      • Added ResetStaticExchangeParameters method on ExchangeParameters
      • Added Status property to SharedWithdrawal model
      • Added TradingModes property to SharedBalance model
      • Updated Shared ExchangeParameters parameter names to be case insensitive
      • Updated code comments
      • Replaced ExchangeResult with ExchangeCallResult type
      • Removed TradingMode from the response model, only maintained on models where it makes sense
    • Added async streaming on UserDataTracker items with StreamUpdatesAsync
    • Added cancellation token support to UserDataTracker starting
    • Added SupportedEnvironments property to PlatformInfo
    • Added Clear() method on UserClientProvider to clear all cached clients
    • Added setter to KucoinExchange.RateLimiter to allow custom rate limit settings
    • Added BizType EarnLock value
    • Various small performance improvements
    • Fixed websocket connection attempts counting towards rate limit even when server could not be reached
    • Fixed RiskLimitLevel type on KucoinPositionRiskAdjustResultUpdate model

About

C#/.NET client library for the Kucoin.com cryptocurrency exchange REST and WebSocket APIs, supporting Spot and Futures trading and market data with strongly typed models.

Topics

Resources

Stars

119 stars

Watchers

9 watching

Forks

Releases

Sponsor this project

Packages

Used by

Contributors

Languages