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

• Response data is mapped to descriptive models
• Input parameters and response values are mapped to discriptive enum values where possible
• High performance
• Automatic websocket (re)connection management
• Client side rate limiting
• Client side order book implementation
• Support for managing different accounts
• Extensive logging
• Support for different environments
• Easy integration with other exchange client based on the CryptoExchange.Net base library
• Native AOT support

Performance is a core focus. For a benchmark comparing OKX.Net performance to CCXT and OKX.Api, see docs/okx-net-benchmark.md.

The library is targeting both .NET Standard 2.0 and .NET Standard 2.1 for optimal compatibility, as well as the latest dotnet versions to use the latest framework features.

dotnet add package JK.OKX.Net

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.

The NuGet package files are added along side the source with the latest GitHub release which can found here.

Basic request:

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

Place order:

var restClient = new OKXRestClient(opts => {
	opts.ApiCredentials = new OKXCredentials("APIKEY", "APISECRET", "PASS");
});

// Place Limit order to buy 10 long contracts of ETH/USD at 2000
var orderResult = await restClient.UnifiedApi.Trading.PlaceOrderAsync(
    "ETH-USD-SWAP",
    OrderSide.Buy,
    OrderType.Limit,
    quantity: 10m,
    price: 2000,
    positionSide: PositionSide.Long,
    tradeMode: TradeMode.Cross
    );

WebSocket subscription:

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

Note that for European clients the environment should be updated to Europe like so:

// With DI
services.AddOKX(options =>
{
    options.Environment = OKXEnvironment.Europe;
});

// Or when constructing client
var client = new OKXRestClient(options => 
{
    options.Environment = OKXEnvironment.Europe;
});

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

OKX.Net includes AI-oriented documentation and examples for code generation tools:

See cryptoexchange-skills-hub for installable skills.

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
Aster	JKorf/Aster.Net
Binance	JKorf/Binance.Net
BingX	JKorf/BingX.Net
Bitfinex	JKorf/Bitfinex.Net
Bitget	JKorf/Bitget.Net
BitMart	JKorf/BitMart.Net
BitMEX	JKorf/BitMEX.Net
Bitstamp	JKorf/Bitstamp.Net
BloFin	JKorf/BloFin.Net
Bybit	JKorf/Bybit.Net
Coinbase	JKorf/Coinbase.Net
CoinEx	JKorf/CoinEx.Net
CoinGecko	JKorf/CoinGecko.Net
CoinW	JKorf/CoinW.Net
Crypto.com	JKorf/CryptoCom.Net
DeepCoin	JKorf/DeepCoin.Net
Gate.io	JKorf/GateIo.Net
HTX	JKorf/HTX.Net
HyperLiquid	JKorf/HyperLiquid.Net
Kraken	JKorf/Kraken.Net
Kucoin	JKorf/Kucoin.Net
Lighter	JKorf/Lighter.Net
Mexc	JKorf/Mexc.Net
Pionex	JKorf/Pionex.Net
Polymarket	JKorf/Polymarket.Net
Toobit	JKorf/Toobit.Net
Upbit	JKorf/Upbit.Net
Weex	JKorf/Weex.Net
WhiteBit	JKorf/WhiteBit.Net
XT	JKorf/XT.Net

A Discord server is available here. Feel free to join for discussion and/or questions around the CryptoExchange.Net and implementation libraries.

Any support is greatly appreciated.

If you do not yet have an account please consider using this referal link to sign up:
Link

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 5.2.0 - 21 Jul 2026

  • Updated CryptoExchange.Net to v12.2.0
  • Added SpotSymbolCatalog to Shared ISpotSymbolRestClient interface
  • Added FuturesSymbolCatalog to Shared IFuturesSymbolRestClient interface
  • Added BaseAssetType, BaseAssetSubType, QuoteAssetType and QuoteAssetSubType to GetSymbolsRequest model
  • Added DisplayName to SharedSpotSymbol and SharedFuturesSymbol models
  • Added BaseAssetType, BaseAssetSubType, QuoteAssetType and QuoteAssetSubType to SharedSpotSymbol and SharedFuturesSymbol models
  • Added DebuggerDisplay attributes to Shared models
  • Updated websocket event handlers to handle all items in array instead of first
  • Fixed Shared websocket order updates labeling filled quantity as base asset instead of contracts

• Version 5.1.0 - 09 Jul 2026

  • Updated CryptoExchange.Net to v12.1.0
  • Added Us environment
  • Added EuropeDemo environment
  • Added CollateralRestricted to OKXDiscountInfo model
  • Added PreviousFundingTime to OKXFundingRate model
  • Added BuyApr, SellApr and Discount to OKXOptionSummary
  • Added PriceLimitPercentage, InitialPriceLimitPercentage, MaxPlatformOpenInterestLimit, MaxPriceLimitCap and UpcomingChanges to OKXInstrument model
  • Added custodyType parameter to restClient.UnifiedApi.Account.GetFundingBillHistoryAsync endpoint
  • Updated FundingBillType enum values
  • Fixed OKXDeliveryExerciseHistory Symbol deserialization
  • Removed NextFundingRate from OKXFundingRate model

• Version 5.0.2 - 30 Jun 2026

  • Fixed symbol name mapping for XPerps in Europe environment

• Version 5.0.1 - 30 Jun 2026

  • Fixed Shared GetFuturesSymbolsAsync failing if underlying type is not set

• Version 5.0.0 - 29 Jun 2026

  • Result types:
    • (Web)CallResult types are replaced by HttpResult, WebSocketResult and QueryResult with the same logic
    • WebSocketResult and QueryResult now return additional info for websocket operations
    • Updated result types to record type
    • Removed implicit result type conversion to bool, if (result) no longer works, instead use if (result.Success)
    • Fixed result object nullability hinting, for example Data might be null if Success isn't checked for true
  • Clients:
    • Added ToString overrides on base API types
    • Added Exchange property on BaseApiClient
    • Added ApiCredentials property on Api clients
    • Updated ILogger source from client name to topic specific client name
    • Removed logging from client creation
    • Fixed issue in SocketApiClient.GetSocketConnection causing requests to always wait the full max 10 seconds when there was a reconnecting socket
  • Shared APIs:
    • Added missing dedicated option types
    • Added Discover method on ISharedClient interface, returning info on supported capabilities and operations
    • Added ResetStaticExchangeParameters method on ExchangeParameters
    • Added Status property to SharedWithdrawal model
    • Added TradingModes property to SharedBalance model
    • Added support for Europe environment XPerps when using Shared APIs by setting SharedApiEuropeUseXPerps in the client options
    • Updated Shared ExchangeParameters parameter names to be case insensitive
    • Updated code comments
    • Replaced ExchangeResult with ExchangeCallResult type
    • Removed TradingMode from the response model, only maintained on models where it makes sense
    • Fixed futures symbols cache overwriting when using different trading modes
  • Added async streaming on UserDataTracker items with StreamUpdatesAsync
  • Added cancellation token support to UserDataTracker starting
  • Added SupportedEnvironments property to PlatformInfo
  • Added Clear() method on UserClientProvider to clear all cached clients
  • Added setter to OKXExchange.RateLimiter to allow custom rate limit settings
  • Various small performance improvements
  • Fixed websocket connection attempts counting towards rate limit even when server could not be reached