JK.OKX.Net 1.7.0

OKX.Net

OKX.Net is client library for accessing the OKX REST and Websocket API. All data is mapped to readable models and enum values. Additional features include an implementation for maintaining a client side order book, easy integration with other exchange client libraries and more.

Supported Frameworks

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

Get the library

dotnet add package JK.OKX.Net

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 documentation, or have a look at the examples here.

CryptoExchange.Net

Mexc.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
Bitfinex	JKorf/Bitfinex.Net
Bitget	JKorf/Bitget.Net
Bybit	JKorf/Bybit.Net
CoinEx	JKorf/CoinEx.Net
CoinGecko	JKorf/CoinGecko.Net
Huobi/HTX	JKorf/Huobi.Net
Kraken	JKorf/Kraken.Net
Kucoin	JKorf/Kucoin.Net
Mexc	JKorf/Mexc.Net

Discord

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

Broker API

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: bc1qz0jv0my7fc60rxeupr23e75x95qmlq6489n8gh
Eth: 0xcb1b63aCF9fef2755eBf4a0506250074496Ad5b7

Sponsor

Alternatively, sponsor me on Github using Github Sponsors.

Release notes

• Version 1.7.0 - 16 Mar 2024

  • Updated CryptoExchange.Net to 7.1.0, see https://github.com/JKorf/CryptoExchange.Net?tab=readme-ov-file#release-notes for release notes
  • Updated unit test package dependencies and updated tests accordingly

• Version 1.6.2 - 13 Mar 2024

  • Added UnifiedApi.Account..GetAffiliateInviteeDetailsAsync endpoint
  • Fixed websocket AlgoOrder update subscriptions url
  • Fixed Symbol property not set on websocket kline updates

• Version 1.6.1 - 26 Feb 2024

  • Update OKXPosition model
  • Fixed PlaceMultipleOrdersAsync and AmendMultipleOrdersAsync quantity and price parameter serialization
  • Fixed deserialization OKXFundingRate model

• Version 1.6.0 - 25 Feb 2024

  • Updated the position model to include stop order info
  • Updated CryptoExchange.Net and implemented reworked websocket message handling. For release notes for the CryptoExchange.Net base library see: https://github.com/JKorf/CryptoExchange.Net?tab=readme-ov-file#release-notes
  • Fixed websocket message handling with empty data array
  • Added UnifiedApi.Account.SetAccountModeAsync
  • Fixed issue in DI registration causing http client to not be correctly injected
  • Added DataEvent wrapper to socket client subscription callbacks
  • Updated subscriptions to return lists where multiple updates are pushed in a single websocket message
  • Updated socket client PlaceOrderAsync endpoint to correctly respect client order id
  • Removed redundant OkxRestClient constructor overload
  • Updated some namespaces

• Version 1.5.0 - 04 Jan 2024

  • Added UnifiedApi.Trading.GetAlgoOrderAsync endpoint
  • Added UnifiedApi.Trading.AmendAlgoOrderAsync endpoint
  • Added UnifiedApi.Account.SetIsolatedMarginModeAsync endpoint
  • Added UnifiedApi.Account.GetTransferAsync endpoint
  • Updated savings endpoints to new url

• Version 1.4.5 - 26 Dec 2023

  • Added Account.DusConvertAsync endpoint

• Version 1.4.4 - 03 Dec 2023

  • Updated CryptoExchange.Net

• Version 1.4.3 - 28 Nov 2023

  • Updated BrokerId logic so clientOrderId isn't influenced
  • Fixed order update deserialization issue

• Version 1.4.2 - 24 Oct 2023

  • Updated CryptoExchange.Net

• Version 1.4.1 - 09 Oct 2023

  • Updated CryptoExchange.Net version
  • Fix incorrect OKXSocketClient injection
  • Added missing ISocketClient interface on IOKXSocketClient

• Version 1.4.0 - 30 Sep 2023

  • Added support for settings custom broker id
  • Added missing fields for klines/candles
  • Fix for Symbol deserialization
  • Fix for Ticker deserialization
  • Fixed algoId defined as long instead of string

• Version 1.3.2 - 20 Sep 2023

  • Added ISpotClient/CommonSpotClient implementation
  • Added missing ConfigureAwait(false) statements

• Version 1.3.1 - 17 Sep 2023

  • Added demo environment support

• Version 1.3.0 - 17 Sep 2023

  • Fixed start/end time filtering
  • Mapped BalanceAndPositionUpdates stream to new model
  • Added missing properties to position model

• Version 1.2.0 - 26 Aug 2023

  • Split socket client into different topics
  • Added websocket order management support
  • Added LiquidationWarning update stream
  • Added Withdrawal update stream
  • Added Deposit update stream

• Version 1.1.1 - 25 Aug 2023

  • Updated CryptoExchange.Net

• Version 1.1.0 - 13 Aug 2023

  • Updated parameters for endpoints to the latest version of the documentation

• Version 1.0.0 - 12 Aug 2023

  • Updated models to latest documentation
  • Added unit tests

• Version 0.0.2 - 06 Aug 2023

  • Fixed Unified socket API stream addresses
  • Renamed Unified socket API underlying parameters to intrumentFamily

• Version 0.0.1 - 04 Aug 2023

  • Initial version