search

JKorf / Kucoin.Net

A C# .netstandard client library for the Kucoin REST and Websocket Spot and Futures API focusing on clear usage and models
https://jkorf.github.io/Kucoin.Net/
MIT License
113 stars 62 forks source link
crypto cryptocurrencies cryptocurrency cryptoexchange-net exchange kucoin kucoin-api kucoin-exchange kucoin-futures kucoin-net kucoinnet market-data tradeapi

readme

.Kucoin.Net Kucoin.Net

.NET License

Kucoin.Net is a strongly typed client library for accessing the Kucoin REST and Websocket API.

Features

Supported Frameworks

The library is targeting both .NET Standard 2.0 and .NET Standard 2.1 for optimal compatibility

.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

REST Endpoints 

// 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;

Websocket streams 

// 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 information on the clients, dependency injection, response processing and more see the Kucoin.Net documentation, CryptoExchange.Net documentation, or have a look at the examples here or here.

CryptoExchange.Net

Kraken.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.

Exchange Repository Nuget
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
Bybit JKorf/Bybit.Net Nuget version
Coinbase JKorf/Coinbase.Net Nuget version
CoinEx JKorf/CoinEx.Net Nuget version
CoinGecko JKorf/CoinGecko.Net Nuget version
Crypto.com JKorf/CryptoCom.Net Nuget version
Gate.io JKorf/GateIo.Net Nuget version
HTX JKorf/HTX.Net Nuget version
Kraken JKorf/Kraken.Net Nuget version
Mexc JKorf/Mexc.Net Nuget version
OKX JKorf/OKX.Net Nuget version
WhiteBit JKorf/WhiteBit.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

I develop and maintain this package on my own for free in my spare time, any support is greatly appreciated.

Donate

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

Sponsor

Alternatively, sponsor me on Github using Github Sponsors.

Release notes