OKX.Net

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

Features

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

Supported Frameworks

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.

Install the library

NuGet

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

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

How to use

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.

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| |--|--|--| |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|| |Mexc|JKorf/Mexc.Net|| |Polymarket|JKorf/Polymarket.Net|| |Toobit|JKorf/Toobit.Net|| |Upbit|JKorf/Upbit.Net|| |WhiteBit|JKorf/WhiteBit.Net|| |XT|JKorf/XT.Net||