Skip to content

Latest commit

 

History

History
224 lines (179 loc) · 12.8 KB

README.md

File metadata and controls

224 lines (179 loc) · 12.8 KB
Raw

.BitMart.Net BitMart.Net

.NET License

BitMart.Net is a client library for accessing the BitMart 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
  • Automatic websocket (re)connection management
  • Client side rate limiting
  • Client side order book implementation
  • Extensive logging
  • Support for different environments
  • Easy integration with other exchange client based on the CryptoExchange.Net base library

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

Install the library

NuGet

NuGet version Nuget downloads

dotnet add package BitMart.Net

GitHub packages

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

GitHub Release

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

How to use

  • REST Endpoints 
     // Get the ETH/USDT ticker via rest request
 var restClient = new BitMartRestClient();
 var tickerResult = await restClient.SpotApi.ExchangeData.GetTickerAsync("ETH_USDT");
 var lastPrice = tickerResult.Data.LastPrice;
  • Websocket streams 
     // Subscribe to ETH/USDT ticker updates via the websocket API
 var socketClient = new BitMartSocketClient();
 var tickerSubscriptionResult = socketClient.SpotApi.SubscribeToTickerUpdatesAsync("ETH_USDT", (update) => 
 {
   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.

CryptoExchange.Net

BitMart.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
Coinbase JKorf/Coinbase.Net Nuget version
CoinEx JKorf/CoinEx.Net Nuget version
CoinGecko JKorf/CoinGecko.Net Nuget version
Crypto.com JKorf/CryptoCom.Net Nuget version
Gate.io JKorf/GateIo.Net Nuget version
HTX JKorf/HTX.Net Nuget version
Gate.io JKorf/GateIo.Net Nuget version
Kraken JKorf/Kraken.Net Nuget version
Kucoin JKorf/Kucoin.Net Nuget version
Mexc JKorf/Mexc.Net Nuget version
OKX JKorf/OKX.Net Nuget version
WhiteBit JKorf/WhiteBit.Net Nuget version

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

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

Supported functionality

Spot Rest

API Supported Location
System Status ✓ restClient.SpotApi.ExchangeData
Public Market Data ✓ restClient.SpotApi.ExchangeData
Funding Account ✓ restClient.SpotApi.Account
Spot/Margin Trading ✓ restClient.SpotApi.Trading
Margin Loan ✓ restClient.SpotApi.Margin
Sub Account ✓ restClient.SpotApi.SubAccount

Spot Websocket

API Supported Location
Public ✓ socketClient.SpotApi
Private ✓ socketClient.SpotApi

Futures

API Supported Location
Futures Market Data ✓ restClient.FuturesApi.ExchangeData
Futures Account Data ✓ restClient.FuturesApi.Account
Futures Trading ✓ restClient.FuturesApi.Trading
Sub Account ✓ restClient.FuturesApi.SubAccount

Spot Websocket

API Supported Location
Public ✓ socketClient.FuturesApi
Private ✓ socketClient.FuturesApi

API Broker

API Supported Location
* X

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 1.8.0 - 19 Nov 2024

    • Updated CryptoExchange.Net to version 8.3.0, see https://github.com/JKorf/CryptoExchange.Net/releases/tag/8.3.0
    • Added support for loading client settings from IConfiguration
    • Added DI registration method for configuring Rest and Socket options at the same time
    • Added DisplayName and ImageUrl properties to BitMartExchange class
    • Updated client constructors to accept IOptions from DI
    • Removed redundant BitMartSocketClient constructor

  • Version 1.7.0 - 06 Nov 2024

  • Version 1.6.0 - 04 Nov 2024

    • Added socketClient.UsdFuturesApi.SubscribeToOrderBookSnapshotUpdatesAsync subscription
    • Added socketClient.UsdFuturesApi.SubscribeToOrderBookIncrementalUpdatesAsync subscription
    • Added IOrderBookSocketClient to UsdFuturesApi Shared socket implementations
    • Added MaxMarketOrderQuantity to BitMartContract response model

  • Version 1.5.0 - 28 Oct 2024

    • Updated CryptoExchange.Net to version 8.1.0, see https://github.com/JKorf/CryptoExchange.Net/releases/tag/8.1.0
    • Moved FormatSymbol to BitMartExchange class
    • Added support Side setting on SharedTrade model
    • Added BitMartTrackerFactory for creating trackers
    • Added overload to Create method on BitMartOrderBookFactory support SharedSymbol parameter

  • Version 1.4.0 - 21 Oct 2024

    • Added restClient.UsdFuturesApi.Account.GetSymbolTradeFeeAsync endpoint
    • Added TakerFeeRateD and MakerFeeRateD properties to restClient.SpotApi.Account.GetBaseTradeFeesAsync response model
    • Added FundingIntervalHours to restClient.UsdFuturesApi.ExchangeData.GetContractsAsync response model

  • Version 1.3.2 - 14 Oct 2024

  • Version 1.3.1 - 14 Oct 2024

    • Fixed symbol formatting order book factory
    • Fixed IBitMartOrderBookFactory DI lifetime

  • Version 1.3.0 - 08 Oct 2024

    • Added UsdFuturesApi.Trading.PlaceTpSlOrderAsync endpoint
    • Added UsdFuturesApi.Trading.EditTpSlOrderAsync endpoint
    • Added UsdFuturesApi.Trading.EditTriggerOrderAsync endpoint
    • Added UsdFuturesApi.Trading.EditPresetTriggerOrderAsync endpoint
    • Added clientOrderId parameter to CancelOrderAsync and CancelTriggerOrderAsync endpoints
    • Added planType parameter to GetTriggerOrdersAsync endpoint

  • Version 1.2.0 - 27 Sep 2024

    • Updated CryptoExchange.Net to version 8.0.0, see https://github.com/JKorf/CryptoExchange.Net/releases/tag/8.0.0
    • Added Shared client interfaces implementation for Spot and Usd Futures Rest and Socket clients
    • Added SpotApi.Account.GetDepositHistoryAsync endpoint
    • Added SpotApi.Account.GetwithdrawalHistoryAsync endpoint
    • Updated Sourcelink package version
    • Updated FuturesKlineInterval, FuturesStreamKlineInterval and KlineStreamInterval Enum values to match number of seconds
    • Updated TradeStatus property type from string to SymbolStatus? Enum on BitMartSymbol model
    • Fixed UsdFuturesApi.Trading.GetClosedOrdersAsync and GetUserTradesAsync startTime/endTime filter
    • Marked ISpotClient references as deprecated

  • Version 1.1.3 - 11 Sep 2024

    • Fixed SpotApi Websocket error response parsing

  • Version 1.1.2 - 25 Aug 2024

  • Version 1.1.1 - 09 Aug 2024

    • Fixed SpotApi.GetSymbolName not being implemented

  • Version 1.1.0 - 07 Aug 2024

  • Version 1.0.1 - 02 Aug 2024

    • Removed temporary workaround for UsdFuturesApi.Account.GetBalancesAsync as endpoint is fixed

  • Version 1.0.0 - 30 Jul 2024

    • Initial release