OKX.Net is strongly typed 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.
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 |
dotnet add package JK.OKX.Net
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.
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.
Exchange | Repository | Nuget |
---|---|---|
Binance | JKorf/Binance.Net | |
BingX | JKorf/BingX.Net | |
Bitfinex | JKorf/Bitfinex.Net | |
Bitget | JKorf/Bitget.Net | |
Bybit | JKorf/Bybit.Net | |
CoinEx | JKorf/CoinEx.Net | |
CoinGecko | JKorf/CoinGecko.Net | |
Gate.io | JKorf/GateIo.Net | |
Huobi/HTX | JKorf/Huobi.Net | |
Kraken | JKorf/Kraken.Net | |
Kucoin | JKorf/Kucoin.Net | |
Mexc | JKorf/Mexc.Net |
A Discord server is available here. Feel free to join for discussion and/or questions around the CryptoExchange.Net and implementation libraries.
API | Supported | Location |
---|---|---|
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 Rest | x | |
Order Book Grid Trading Websocket | x | |
Order Book Signal Trading Rest | x | |
Order Book Recurring Buy Rest | x | |
Order Book Recurring Buy Websocket | x | |
Order Book Copy Trading Rest | x | |
Order Book Copy Trading Websocket | x | |
Order Book Market Data Rest | ✓ | restClient.UnifiedApi.ExchangeData |
Order Book Market Data Websocket | ✓ | socketClient.UnifiedApi.ExchangeData |
Block Trading | X | |
Spread Trading | X | |
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 Product | X | |
Affiliate | X | |
Status Rest | ✓ | restClient.UnifiedApi.ExchangeData |
Status Websocket | ✓ | socketClient.UnifiedApi.ExchangeData |
API | Supported | Location |
---|---|---|
Trading Account Rest | X |
I develop and maintain this package on my own for free in my spare time, any support is greatly appreciated.
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.
Version 2.0.0 - 02 Jul 2024
Version 1.11.1 - 25 Jun 2024
Version 1.11.0 - 23 Jun 2024
okxSocketClient.UnifiedApi.PrepareConnectionsAsync();
Version 1.10.1 - 17 Jun 2024
Version 1.10.0 - 11 Jun 2024
Version 1.9.0 - 02 Jun 2024
Version 1.8.4 - 07 May 2024
Version 1.8.3 - 01 May 2024
Version 1.8.2 - 28 Apr 2024
Version 1.8.1 - 23 Apr 2024
Version 1.8.0 - 18 Apr 2024
Version 1.7.2 - 28 Mar 2024
Version 1.7.1 - 24 Mar 2024
Version 1.7.0 - 16 Mar 2024
Version 1.6.2 - 13 Mar 2024
Version 1.6.1 - 26 Feb 2024
Version 1.6.0 - 25 Feb 2024
Version 1.5.0 - 04 Jan 2024
Version 1.4.5 - 26 Dec 2023
Version 1.4.4 - 03 Dec 2023
Version 1.4.3 - 28 Nov 2023
Version 1.4.2 - 24 Oct 2023
Version 1.4.1 - 09 Oct 2023
Version 1.4.0 - 30 Sep 2023
Version 1.3.2 - 20 Sep 2023
Version 1.3.1 - 17 Sep 2023
Version 1.3.0 - 17 Sep 2023
Version 1.2.0 - 26 Aug 2023
Version 1.1.1 - 25 Aug 2023
Version 1.1.0 - 13 Aug 2023
Version 1.0.0 - 12 Aug 2023
Version 0.0.2 - 06 Aug 2023
Version 0.0.1 - 04 Aug 2023