Home

Awesome

Icon! OKX.Net

.NET License

OKX.Net is strongly typed client library for accessing the OKX 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 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 JK.OKX.Net

GitHub packages

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

Websocket streams

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

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

CryptoExchange.Net

OKX.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
BinanceJKorf/Binance.NetNuget version
BingXJKorf/BingX.NetNuget version
BitfinexJKorf/Bitfinex.NetNuget version
BitgetJKorf/Bitget.NetNuget version
BitMartJKorf/BitMart.NetNuget version
BybitJKorf/Bybit.NetNuget version
CoinExJKorf/CoinEx.NetNuget version
CoinGeckoJKorf/CoinGecko.NetNuget version
Gate.ioJKorf/GateIo.NetNuget version
Huobi/HTXJKorf/Huobi.NetNuget version
KrakenJKorf/Kraken.NetNuget version
KucoinJKorf/Kucoin.NetNuget version
MexcJKorf/Mexc.NetNuget 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

Unified API

APISupportedLocation
Trading Account Rest✓restClient.UnifiedApi.Account
Trading Account Websocket✓socketClient.UnifiedApi.Account
Order Book Trade Rest✓restClient.UnifiedApi.Trading
Order Book Trade Websocket✓socketClient.UnifiedApi.Trading
Order Book Algo Trading Rest✓restClient.UnifiedApi.Trading
Order Book Algo Trading Websocket✓socketClient.UnifiedApi.Trading
Order Book Grid Trading Restx
Order Book Grid Trading Websocketx
Order Book Signal Trading Restx
Order Book Recurring Buy Restx
Order Book Recurring Buy Websocketx
Order Book Copy Trading Restx
Order Book Copy Trading Websocketx
Order Book Market Data Rest✓restClient.UnifiedApi.ExchangeData
Order Book Market Data Websocket✓socketClient.UnifiedApi.ExchangeData
Block TradingX
Spread TradingX
Public Data Rest✓restClient.UnifiedApi.ExchangeData
Public Data Websocket✓socketClient.UnifiedApi.ExchangeData
Trading Statistics✓restClient.UnifiedApi.ExchangeData
Funding Account Rest✓restClient.UnifiedApi.Account
Funding Account Websocket✓socketClient.UnifiedApi.Account
Sub-Account✓restClient.UnifiedApi.SubAccounts
Financial ProductX
AffiliateX
Status Rest✓restClient.UnifiedApi.ExchangeData
Status Websocket✓socketClient.UnifiedApi.ExchangeData

Broker API

APISupportedLocation
Trading Account RestX

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