JK.OKX.Net 1.11.0

dotnet add package JK.OKX.Net --version 1.11.0
NuGet\Install-Package JK.OKX.Net -Version 1.11.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="JK.OKX.Net" Version="1.11.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add JK.OKX.Net --version 1.11.0
#r "nuget: JK.OKX.Net, 1.11.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install JK.OKX.Net as a Cake Addin
#addin nuget:?package=JK.OKX.Net&version=1.11.0

// Install JK.OKX.Net as a Cake Tool
#tool nuget:?package=JK.OKX.Net&version=1.11.0

Icon! OKX.Net

.NET License

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.

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

Get the library

Nuget version Nuget downloads

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

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
Bybit JKorf/Bybit.Net Nuget version
CoinEx JKorf/CoinEx.Net Nuget version
CoinGecko JKorf/CoinGecko.Net Nuget version
Gate.io JKorf/GateIo.Net Nuget version
Huobi/HTX JKorf/Huobi.Net Nuget version
Kraken JKorf/Kraken.Net Nuget version
Kucoin JKorf/Kucoin.Net Nuget version
Mexc JKorf/Mexc.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

Unified API

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

Broker API

API Supported Location
Trading Account Rest X

Support the project

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.

Release notes

  • Version 1.11.0 - 23 Jun 2024

    • Updated CryptoExchange.Net to version 7.7.0, see https://github.com/JKorf/CryptoExchange.Net/releases/tag/7.7.0
    • Added CancellationToken optional parameter to websocket requests
    • Added dedicated connection configuration; a websocket connection can now be established before making the first request by calling okxSocketClient.UnifiedApi.PrepareConnectionsAsync();
  • Version 1.10.1 - 17 Jun 2024

    • Fixed deserialization issue in market sell websocket order updates
  • Version 1.10.0 - 11 Jun 2024

  • Version 1.9.0 - 02 Jun 2024

    • Added UnifiedApi.Account.GetAssetValuationAsync endpoint
    • Renamed BestAskSize to BestAskQuantity in OKXTicker model
    • Fixed OKXSocketOptions not using OKXApiCredentials
  • 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

    • Added support for multiple symbol tickers subscriptions in single call
    • Fixed quantity being required in UnifiedApi.Trading.PlaceAlgoOrderAsync
  • Version 1.7.1 - 24 Mar 2024

  • Version 1.7.0 - 16 Mar 2024

  • 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
Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 is compatible. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on JK.OKX.Net:

Package Downloads
CryptoClients.Net

CryptoClients.Net offers API clients for multiple cryptocurrency exchanges. The clients allow for accessing market data as well as managing accounts and trading cryptocurrencies.

GitHub repositories (1)

Showing the top 1 popular GitHub repositories that depend on JK.OKX.Net:

Repository Stars
JKorf/CryptoExchange.Net
Base for exchanges
Version Downloads Last updated
1.11.0 0 6/23/2024
1.10.1 158 6/17/2024
1.10.0 227 6/11/2024
1.9.0 262 6/2/2024
1.8.4 871 5/7/2024
1.8.3 200 5/1/2024
1.8.2 177 4/28/2024
1.8.1 176 4/23/2024
1.8.0 240 4/18/2024
1.7.2 376 3/28/2024
1.7.1 521 3/24/2024
1.7.0 291 3/16/2024
1.6.2 200 3/13/2024
1.6.1 306 2/26/2024
1.6.0 651 2/25/2024
1.6.0-beta3 171 2/18/2024
1.6.0-beta2 194 2/10/2024
1.6.0-beta1 217 2/6/2024
1.5.0 1,303 1/4/2024
1.4.5 396 12/26/2023
1.4.4 662 12/3/2023
1.4.3 412 11/28/2023
1.4.2 849 10/24/2023
1.4.1 507 10/9/2023
1.4.0 457 9/30/2023
1.3.2 485 9/20/2023
1.3.1 455 9/17/2023
1.3.0 417 9/17/2023
1.2.0 670 8/26/2023
1.1.1 461 8/25/2023
1.1.0 596 8/13/2023
1.0.0 505 8/12/2023
0.0.2 482 8/6/2023
0.0.1 450 8/4/2023