JKorf.BitMEX.Net 3.9.3

BitMEX.Net

BitMEX.Net is a client library for accessing the BitMEX 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 JKorf.BitMEX.Net

GitHub packages

BitMEX.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 BitMEXRestClient();
var tickerResult = await restClient.ExchangeApi.ExchangeData.GetSymbolsAsync("ETHUSDT");
var lastPrice = tickerResult.Data.Single().LastPrice;

Place order:

var restClient = new BitMEXRestClient(opts => {
	opts.ApiCredentials = new BitMEXCredentials("APIKEY", "APISECRET");
});

// Place Limit order to go long for 10 contracts ETH/USD at 2000
var orderResult = await restClient.ExchangeApi.Trading.PlaceOrderAsync(
    "ETH_USD",
    OrderSide.Buy,
    OrderType.Limit,
    10,    
    2000);

WebSocket subscription:

// Subscribe to ETH/USDT ticker updates via the websocket API
var socketClient = new BitMEXSocketClient();
var tickerSubscriptionResult = socketClient.ExchangeApi.SubscribeToSymbolUpdatesAsync("ETHUSDT", (update) =>
{
	// If update.Data.LastPrice == null the price hasn't changed since last update
	if (update.Data.LastPrice != null)
	{ 
		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 or here.

BitMEX Quantities

BitMEX handles quantities a bit differently than most exchange API's. Asset quantities like account balances are denoted in a base value.
For example 9846 XBt instead of 0.00009846 BTC. The same logic is also applied to trading quantities, if you want to place a spot order for 0.1 BTC you'd need to specify a quantity of 10000000 XBt. Note that futures trading works with contracts.
How many decimal places are used for each asset and symbol can be requested using the restClient.ExchangeApi.ExchangeData.GetAssetsAsync and restClient.ExchangeApi.ExchangeData.GetActiveSymbolsAsync endpoints.

The library offers an easy way of converting between these quantities with the ToSharedAssetQuantity, ToSharedSymbolQuantity, ToBitMEXAssetQuantity and ToBitMEXSymbolQuantity extension methods. For example:
Getting balance info

// Make sure to call this at least once at the start of the program to retrieve the conversion data
await BitMEXUtils.UpdateSymbolInfoAsync();

var balances = await bitMEXRestClient.ExchangeApi.Account.GetBalancesAsync();
foreach (var balance in balances.Data)
{
    var bitMEXQuantity = balance.Quantity; // The quantity as used in the BitMEX API, for example 1000000
    var bitMEXAssetName = balance.Currency; // The currency name as used in the BitMEX API, for example `gwei`
    var assetQuantity = balance.Quantity.ToSharedAssetQuantity(balance.Currency); // The quantity in the actual assset, for example 0.01
    var assetName = BitMEXUtils.GetAssetFromCurrency(balance.Currency); // The asset name, for example `ETH`
}

Placing spot order

// Make sure to call this at least once at the start of the program to retrieve the conversion data
await BitMEXUtils.UpdateSymbolInfoAsync();

var symbols = await bitMEXRestClient.ExchangeApi.ExchangeData.GetActiveSymbolsAsync();
var ethUsdtSpotSymbol = symbols.Data.SingleOrDefault(x => x.BaseAsset == "ETH" && x.QuoteAsset == "USDT" && x.SymbolType == SymbolType.Spot);
var minQuantityInBaseUnit = ethUsdtSpotSymbol.LotSize; // For example 1000
var minQuantityInETH = ethUsdtSpotSymbol.LotSize.ToSharedSymbolQuantity(ethUsdtSpotSymbol.Symbol); // For example 0.001

var quantityToPlace = 0.1m;
var quantityBitMEX = quantityToPlace.ToBitMEXSymbolQuantity(ethUsdtSpotSymbol.Symbol); // For example 1000000
var result = await bitMEXRestClient.ExchangeApi.Trading.PlaceOrderAsync(ethUsdtSpotSymbol.Symbol, OrderSide.Buy, OrderType.Market, quantityBitMEX);

CryptoExchange.Net

BitMEX.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
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
Gate.io	JKorf/GateIo.Net
Kraken	JKorf/Kraken.Net
Kucoin	JKorf/Kucoin.Net
Mexc	JKorf/Mexc.Net
OKX	JKorf/OKX.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

When using multiple of these API's the CryptoClients.Net package can be used which combines this and the other packages and allows easy access to all exchange API's.

Discord

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

Supported functionality

Rest API

WebSocket API

Support the project

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: bc1q277a5n54s2l2mzlu778ef7lpkwhjhyvghuv8qf
Eth: 0xcb1b63aCF9fef2755eBf4a0506250074496Ad5b7
USDT (TRX) TKigKeJPXZYyMVDgMyXxMf17MWYia92Rjd

Sponsor

Alternatively, sponsor me on Github using Github Sponsors.

Release notes

• Version 3.9.3 - 13 Apr 2026

  • Fixed potential exceptions when new symbols or assets are added when using BitMEXUtils helper methods

• Version 3.9.2 - 09 Apr 2026

  • Updated CryptoExchange.Net to version 11.1.0, see https://github.com/JKorf/CryptoExchange.Net/releases/ for full release notes
  • Added some missing properties on response models

• Version 3.9.1 - 24 Mar 2026

  • Fix issue in credentials copying

• Version 3.9.0 - 24 Mar 2026

  • Updated CryptoExchange.Net to version 11.0.1, see https://github.com/JKorf/CryptoExchange.Net/releases/ for full release notes

  • Updated class for supplying API credentials from ApiCredentials to BitMEXCredentials

  • Updated Shared order status parsing to default to Unknown value if not parsable

  • Notes for updating:

    • Update ApiCredentials to BitMEXCredentials for authentication, i.e. ApiCredentials = new ApiCredentials(..) ⇒ ApiCredentials = new BitMEXCredentials(..)

• Version 3.8.0 - 06 Mar 2026

  • Updated CryptoExchange.Net to version 10.8.0, see https://github.com/JKorf/CryptoExchange.Net/releases/ for full release notes
  • Improved method XML comments

• Version 3.7.1 - 03 Mar 2026

  • Updated CryptoExchange.Net to version 10.7.2, see https://github.com/JKorf/CryptoExchange.Net/releases/ for full release notes
  • Fixed asset parameter serialization on restCient.ExchangeApi.Account.GetMarginStatusAsync
  • Fixed response parsing when asset filter is used on restCient.ExchangeApi.Account.GetMarginStatusAsync and restCient.ExchangeApi.Account.GetBalancesAsync

• Version 3.7.0 - 24 Feb 2026

  • Updated CryptoExchange.Net to version 10.7.0
  • Added additional Http settings to client options
  • Updated Shared REST interfaces pagination logic
  • Updated HttpClient registration, fixing issue of DNS changes not getting processed
  • Fixed UserClientProvider using unconfigured HttpClient
  • Fixed restClient.ExchangeApi.Account.GetBalanceHistoryAsync parameters serialization
  • Fixed various endpoints reverse parameter serialization
  • Fixed TransactionTime property deserialization on BitMEXTransaction model

• Version 3.6.0 - 16 Feb 2026

  • Updated CryptoExchange.Net to version 10.6.0, see https://github.com/JKorf/CryptoExchange.Net/releases/ for full release notes
  • Fixed SymbolOrderBook websocket subscription not getting closed if when waiting for initial data times out

• Version 3.5.0 - 10 Feb 2026

  • Updated CryptoExchange.Net to version 10.5.1, see https://github.com/JKorf/CryptoExchange.Net/releases/ for full release notes
  • Fixed websocket symbol update mapping
  • Updated UserClientProvider internal client cache to non-static to prevent cleanup issues

• Version 3.4.0 - 06 Feb 2026

  • Updated CryptoExchange.Net to version 10.4.0, see https://github.com/JKorf/CryptoExchange.Net/releases/ for full release notes
  • Added BitMEXUserSpotDataTracker and BitMEXUserFuturesDataTracker
  • Added additional methods for requesting supported symbols to Shared ISpotSymbolRestClient/IFuturesSymbolRestClient interfaces
  • Added PositionMode mapping on SharedPosition models
  • Added Status mapping for SharedDeposit models
  • Fixed disposed clients getting returned from UserClientProvider
  • Fixed deserialization issues BitMEXPosition

• Version 3.3.0 - 22 Jan 2026

  • Updated CryptoExchange.Net to version 10.3.0, see https://github.com/JKorf/CryptoExchange.Net/releases/ for full release notes
  • Removed legacy websocket message handling and the corresponding UseUpdatedDeserialization client option
  • Added Metadata to BitMEXExchange

• Version 3.2.1 - 14 Jan 2026

  • Updated CryptoExchange.Net to version 10.2.3, see https://github.com/JKorf/CryptoExchange.Net/releases/ for full release notes

• Version 3.2.0 - 13 Jan 2026

  • Updated CryptoExchange.Net to version 10.2.0, see https://github.com/JKorf/CryptoExchange.Net/releases/ for full release notes

• Version 3.1.0 - 07 Jan 2026

  • Updated CryptoExchange.Net version to 10.1.0, see https://github.com/JKorf/CryptoExchange.Net/releases/ for full release notes
  • Added DataTimeLocal and DataAge properties to DataEvent object
  • Added UpdateServerTime, UpdateLocalTime and DataAge properties to (I)SymbolOrderBook
  • Fixed deserialization error on websocket messages with filter

• Version 3.0.1 - 17 Dec 2025

  • Fixed websocket unsubscribe response handling

• Version 3.0.0 - 16 Dec 2025

  • Added Net10.0 target framework
  • Updated CryptoExchange.Net version to 10.0.0, see https://github.com/JKorf/CryptoExchange.Net/releases/ for full release notes
  • Improved performance across the board, biggest gains in websocket message processing
  • Updated REST message response handling
  • Updated WebSocket message handling
  • Added UseUpdatedDeserialization socket client options to toggle by new and old message handling
  • Added SocketIndividualSubscriptionCombineTarget socket client option
  • Added MRSXXX Enum value to SymbolType enum
  • Updated Shared API's subscription update types from ExchangeEvent to DataEvent

• Version 2.11.0 - 11 Nov 2025

  • Updated CryptoExchange.Net version to 9.13.0, see https://github.com/JKorf/CryptoExchange.Net/releases/

• Version 2.10.0 - 03 Nov 2025

  • Updated CryptoExchange.Net to version 9.12.0
  • Added support for using SharedSymbol.UsdOrStable in Shared APIs
  • Fixed deserialization issue in restClient.ExchangeApi.ExchangeData.GetIndicesAsync
  • Fixed exception when initial trade snapshot has no items in TradeTracker
  • Removed some unhelpful verbose logs

• Version 2.9.0 - 16 Oct 2025

  • Updated CryptoExchange.Net version to 9.10.0, see https://github.com/JKorf/CryptoExchange.Net/releases/
  • Added ClientOrderId mapping on SharedUserTrade models
  • Fixed occasional deserialization error restClient.ExchangeApi.ExchangeData.GetIndicesAsync

• Version 2.8.0 - 30 Sep 2025

  • Updated CryptoExchange.Net version to 9.8.0, see https://github.com/JKorf/CryptoExchange.Net/releases/
  • Added ITrackerFactory to TrackerFactory implementation
  • Added ContractAddress mapping in Shared IAssetClient implementation
  • Added InvalidQuantity error mapping

• Version 2.7.0 - 01 Sep 2025

  • Updated CryptoExchange.Net version to 9.7.0, see https://github.com/JKorf/CryptoExchange.Net/releases/
  • HTTP REST requests will now use HTTP version 2.0 by default

• Version 2.6.0 - 25 Aug 2025

  • Updated CryptoExchange.Net version to 9.6.0, see https://github.com/JKorf/CryptoExchange.Net/releases/
  • Added ClearUserClients method to user client provider

• Version 2.5.1 - 21 Aug 2025

  • Added Invalid API key error parsing
  • Added unknown symbol websocket error mapping

• Version 2.5.0 - 20 Aug 2025

  • Updated CryptoExchange.Net to version 9.5.0, see https://github.com/JKorf/CryptoExchange.Net/releases/
  • Added improved error parsing
  • Added additional success check on restClient.ExchangeApi.Trading.CancelOrderAsync endpoint
  • Updated rest request sending too prevent duplicate parameter serialization

• Version 2.4.0 - 04 Aug 2025

  • Updated CryptoExchange.Net to version 9.4.0, see https://github.com/JKorf/CryptoExchange.Net/releases/
  • Added support for multi-symbol Shared socket subscriptions

• Version 2.3.0 - 23 Jul 2025

  • Updated CryptoExchange.Net to version 9.3.0, see https://github.com/JKorf/CryptoExchange.Net/releases/
  • Updated websocket message matching

• Version 2.2.1 - 16 Jul 2025

  • Updated CryptoExchange.Net to version 9.2.1, see https://github.com/JKorf/CryptoExchange.Net/releases/
  • Fixed issue with websocket ping response parsing

• Version 2.2.0 - 15 Jul 2025

  • Updated CryptoExchange.Net to version 9.2.0, see https://github.com/JKorf/CryptoExchange.Net/releases/
  • Removed some fields from restClient.ExchangeApi.Account.GetAccountInfoAsync response model no longer returned by API

• Version 2.1.0 - 02 Jun 2025

  • Updated CryptoExchange.Net to version 9.1.0, see https://github.com/JKorf/CryptoExchange.Net/releases/
  • Added (I)BitMEXUserClientProvider allowing for easy client management when handling multiple users

• Version 2.0.0 - 13 May 2025

  • Updated CryptoExchange.Net to version 9.0.0, see https://github.com/JKorf/CryptoExchange.Net/releases/
  • Added support for Native AOT compilation
  • Added RateLimitUpdated event
  • Added SharedSymbol response property to all Shared interfaces response models returning a symbol name
  • Added GenerateClientOrderId method to ExchangeApi Shared clients
  • Added OptionalExchangeParameters and Supported properties to EndpointOptions
  • Added IBookTickerRestClient implementation to ExchangeApi Shared client
  • Added ISpotOrderClientIdClient implementation to ExchangeApi Shared client
  • Added IFuturesOrderClientIdClient implementation to ExchangeApi Shared client
  • Added ISpotTriggerOrderRestClient implementation to ExchangeApi Shared client
  • Added IFuturesTpSlClient implementation to ExchangeApi Shared client
  • Added TriggerPrice, IsTriggerOrder and IsCloseOrder to SharedFuturesOrder model
  • Added TriggerPrice and IsTriggerOrder properties to SharedSpotOrder response model
  • Added QuoteVolume property mapping to SharedSpotTicker response model
  • Added All property to retrieve all available environment on BitMEXEnvironment
  • Added automatic mapping between XBT and BTC asset and symbol names when using the Shared implementations
  • Added missing Enum value ExecutionType enum
  • Refactored Shared clients quantity parameters and responses to use SharedQuantity
  • Updated all IEnumerable response and model types to array response types
  • Updated ExecutionInstruction property on BitMEXOrder model to array
  • Renamed BitMEXExchangeSymbolOrderBook to BitMEXSymbolOrderBook
  • Removed Newtonsoft.Json dependency
  • Removed legacy AddBitMEX(restOptions, socketOptions) DI overload
  • Fixed incorrect DataTradeMode on certain Shared interface responses
  • Fixed InvalidOperationException on empty socket user snapshot updates
  • Fixed some typos
  • Fixed error using Shared GetAssetsAsync endpoint

• Version 2.0.0-beta3 - 01 May 2025

  • Updated CryptoExchange.Net version to 9.0.0-beta5
  • Added property to retrieve all available API environments

• Version 2.0.0-beta2 - 23 Apr 2025

  • Updated CryptoExchange.Net to version 9.0.0-beta2
  • Added Shared spot ticker QuoteVolume mapping
  • Fixed incorrect DataTradeMode on responses
  • Fixed deserialization error in symbol subscription

• Version 2.0.0-beta1 - 22 Apr 2025

  • Updated CryptoExchange.Net to version 9.0.0-beta1, see https://github.com/JKorf/CryptoExchange.Net/releases/
  • Added support for Native AOT compilation
  • Added RateLimitUpdated event
  • Added SharedSymbol response property to all Shared interfaces response models returning a symbol name
  • Added GenerateClientOrderId method to ExchangeApi Shared clients
  • Added OptionalExchangeParameters and Supported properties to EndpointOptions
  • Added IBookTickerRestClient implementation to ExchangeApi Shared client
  • Added ISpotOrderClientIdClient implementation to ExchangeApi Shared client
  • Added IFuturesOrderClientIdClient implementation to ExchangeApi Shared client
  • Added ISpotTriggerOrderRestClient implementation to ExchangeApi Shared client
  • Added IFuturesTpSlClient implementation to ExchangeApi Shared client
  • Added TriggerPrice, IsTriggerOrder and IsCloseOrder to SharedFuturesOrder model
  • Added TriggerPrice and IsTriggerOrder properties to SharedSpotOrder response model
  • Refactored Shared clients quantity parameters and responses to use SharedQuantity
  • Updated all IEnumerable response and model types to array response types
  • Updated ExecutionInstruction property on BitMEXOrder model to array
  • Renamed BitMEXExchangeSymbolOrderBook to BitMEXSymbolOrderBook
  • Removed Newtonsoft.Json dependency
  • Removed legacy AddBitMEX(restOptions, socketOptions) DI overload
  • Fixed some typos
  • Fixed error using Shared GetAssetsAsync endpoint

• Version 1.1.0 - 11 Feb 2025

  • Updated CryptoExchange.Net to version 8.8.0, see https://github.com/JKorf/CryptoExchange.Net/releases/
  • Added setting of DataTime value on websocket DataEvent updates
  • Added DisplayName and ImageUrl to BitMEXExchange class
  • Fixed supported SharedKlineInterval not being specified correctly in the options
  • Fix Mono runtime exception on rest client construction using DI

• Version 1.0.0 - 07 Feb 2025

  • Initial release