BitMart.Api
4.4.1026
See the version list below for details.
dotnet add package BitMart.Api --version 4.4.1026
NuGet\Install-Package BitMart.Api -Version 4.4.1026
<PackageReference Include="BitMart.Api" Version="4.4.1026" />
paket add BitMart.Api --version 4.4.1026
#r "nuget: BitMart.Api, 4.4.1026"
// Install BitMart.Api as a Cake Addin #addin nuget:?package=BitMart.Api&version=4.4.1026 // Install BitMart.Api as a Cake Tool #tool nuget:?package=BitMart.Api&version=4.4.1026
BitMart.Api
A .Net wrapper for the BitMart API as described on BitMart, including all features the API provides using clear and readable objects.
If you think something is broken, something is missing or have any questions, please open an Issue
Donations
Donations are greatly appreciated and a motivation to keep improving.
BTC: 33WbRKqt7wXARVdAJSu1G1x3QnbyPtZ2bH
ETH: 0x65b02db9b67b73f5f1e983ae10796f91ded57b64
USDT (TRC-20): TXwqoD7doMESgitfWa8B2gHL7HuweMmNBJ
Installation
Available on Nuget.
PM> Install-Package BitMart.Api
To get started with BitMart.Api first you will need to get the library itself. The easiest way to do this is to install the package into your project using NuGet. Using Visual Studio this can be done in two ways.
Using the package manager
In Visual Studio right click on your solution and select 'Manage NuGet Packages for solution...'. A screen will appear which initially shows the currently installed packages. In the top bit select 'Browse'. This will let you download net package from the NuGet server. In the search box type 'BitMart.Api' and hit enter. The BitMart.Api package should come up in the results. After selecting the package you can then on the right hand side select in which projects in your solution the package should install. After you've selected all project you wish to install and use BitMart.Api in hit 'Install' and the package will be downloaded and added to you projects.
Using the package manager console
In Visual Studio in the top menu select 'Tools' → 'NuGet Package Manager' → 'Package Manager Console'. This should open up a command line interface. On top of the interface there is a dropdown menu where you can select the Default Project. This is the project that BitMart.Api will be installed in. After selecting the correct project type Install-Package BitMart.Api
in the command line interface. This should install the latest version of the package in your project.
After doing either of above steps you should now be ready to actually start using BitMart.Api.
Getting started
After installing it's time to actually use it. To get started we have to add the BitMart.Api namespace: using BitMart.Api;
.
BitMart.Api provides two clients to interact with the BitMart.Api. The BitMartRestApiClient
provides all rest API calls. The BitMartWebSocketApiClient
provides functions to interact with the websocket provided by the BitMart.Api. Both clients are disposable and as such can be used in a using
statement.
Rest Api Examples
var api = new BitMartRestApiClient();
api.SetApiCredentials("XXXXXXXX-API-KEY-XXXXXXXX", "XXXXXXXX-API-SECRET-XXXXXXXX", "XXXXXXXX-MEMO-XXXXXXXX");
// Spot System Methods
var system_01 = await api.Spot.System.GetTimeAsync(/* optional parameters */);
var system_02 = await api.Spot.System.GetStatusAsync(/* optional parameters */);
// Spot Public Methods
var public_01 = await api.Spot.Public.GetCurrenciesAsync(/* optional parameters */);
var public_02 = await api.Spot.Public.GetSymbolsAsync(/* optional parameters */);
var public_03 = await api.Spot.Public.GetTickersAsync(/* optional parameters */);
var public_04 = await api.Spot.Public.GetTickerAsync("BTC_USDT" /* optional parameters */);
var public_05 = await api.Spot.Public.GetKlinesAsync("BTC_USDT", BitMartSpotKlineInterval.FourHours /* optional parameters */);
var public_06 = await api.Spot.Public.GetKlinesHistoryAsync("BTC_USDT", BitMartSpotKlineInterval.FourHours /* optional parameters */);
var public_07 = await api.Spot.Public.GetOrderBookAsync("BTC_USDT" /* optional parameters */);
var public_08 = await api.Spot.Public.GetTradesAsync("BTC_USDT" /* optional parameters */);
// Spot Funding Methods
var funding_01 = await api.Spot.Funding.GetAccountBalancesAsync(/* optional parameters */);
var funding_02 = await api.Spot.Funding.GetCurrenciesAsync(/* optional parameters */);
var funding_03 = await api.Spot.Funding.GetSpotBalancesAsync(/* optional parameters */);
var funding_04 = await api.Spot.Funding.GetDepositAddressAsync("USDT" /* optional parameters */);
var funding_05 = await api.Spot.Funding.GetDepositAddressAsync("USDT-TRC20" /* optional parameters */);
var funding_06 = await api.Spot.Funding.GetWithdrawQuotaAsync("USDT-TRC20" /* optional parameters */);
var funding_07 = await api.Spot.Funding.WithdrawToBlockchainAsync("USDT", 100.0m, "-----ADDRESS-----" /* optional parameters */);
var funding_08 = await api.Spot.Funding.WithdrawToBitMartAsync("USDT", 100.0m, BitMartSpotWithdrawalAccount.Email, "-----ADDRESS-----" /* optional parameters */);
var funding_09 = await api.Spot.Funding.GetTransactionsAsync("USDT", BitMartSpotTransactionType.Deposit /* optional parameters */);
var funding_10 = await api.Spot.Funding.GetTransactionAsync(1_000_0001L /* optional parameters */);
var funding_11 = await api.Spot.Funding.GetMarginBalanceAsync(/* optional parameters */);
var funding_12 = await api.Spot.Funding.MarginTransferAsync("SYMBOL", "CURRENCY", 100.0M, BitMartSpotMarginTransferSide.TransferIn /* optional parameters */);
var funding_13 = await api.Spot.Funding.GetBasicFeeRatesAsync(/* optional parameters */);
var funding_14 = await api.Spot.Funding.GetTradeFeeRatesAsync("BTC_USDT"/* optional parameters */);
// Spot Trading Methods
var trading_01 = await api.Spot.Trading.PlaceOrderAsync("BMX_USDT", BitMartSpotOrderSide.Buy, BitMartSpotOrderType.Market, quoteQuantity: 100.0m /* optional parameters */);
var trading_02 = await api.Spot.Trading.CancelOrderAsync("BMX_USDT", 1_000_0001L /* optional parameters */);
var trading_03 = await api.Spot.Trading.PlaceOrdersAsync("BMX_USDT", [] /* optional parameters */);
var trading_04 = await api.Spot.Trading.CancelOrdersAsync("BMX_USDT", [], [] /* optional parameters */);
var trading_05 = await api.Spot.Trading.CancelAllOrdersAsync(/* optional parameters */);
var trading_06 = await api.Spot.Trading.CancelAllOrdersAsync("BMX_USDT" /* optional parameters */);
var trading_07 = await api.Spot.Trading.PlaceMarginOrderAsync("BMX_USDT", BitMartSpotOrderSide.Buy, BitMartSpotOrderType.Market, quoteQuantity: 100.0m /* optional parameters */);
var trading_08 = await api.Spot.Trading.GetOrderAsync(1_000_0001L /* optional parameters */);
var trading_09 = await api.Spot.Trading.GetOpenOrdersAsync(/* optional parameters */);
var trading_10 = await api.Spot.Trading.GetOpenOrdersAsync("BMX_USDT"/* optional parameters */);
var trading_11 = await api.Spot.Trading.GetOrdersAsync(/* optional parameters */);
var trading_12 = await api.Spot.Trading.GetOrdersAsync("BMX_USDT" /* optional parameters */);
var trading_13 = await api.Spot.Trading.GetTradesAsync("BMX_USDT" /* optional parameters */);
var trading_14 = await api.Spot.Trading.GetTradesAsync(1_000_0001L /* optional parameters */);
// Spot Margin Methods
var margin_01 = await api.Spot.Margin.BorrowAsync("BMX_USDT", "USDT", 100.0M /* optional parameters */);
var margin_02 = await api.Spot.Margin.RepayAsync("BMX_USDT", "USDT", 100.0M /* optional parameters */);
var margin_03 = await api.Spot.Margin.GetBorrowsAsync("BMX_USDT" /* optional parameters */);
var margin_04 = await api.Spot.Margin.GetRepaysAsync("BMX_USDT" /* optional parameters */);
var margin_05 = await api.Spot.Margin.GetSymbolsAsync(/* optional parameters */);
// Spot Sub-Account Methods
var subaccount_01 = await api.Spot.SubAccount.SubAccountToMainAccountAsync("-----REQUEST-NUM-----", 100.0M, "CURRENCY" /* optional parameters */);
var subaccount_02 = await api.Spot.SubAccount.SubAccountToMainAccountAsync("-----REQUEST-NUM-----", 100.0M, "CURRENCY", "SUB-ACCOUNT" /* optional parameters */);
var subaccount_03 = await api.Spot.SubAccount.MainAccountToSubAccountAsync("-----REQUEST-NUM-----", 100.0M, "CURRENCY", "SUB-ACCOUNT" /* optional parameters */);
var subaccount_04 = await api.Spot.SubAccount.SubAccountToSubAccountAsync("-----REQUEST-NUM-----", 100.0M, "CURRENCY", "FROM-ACCOUNT", "TO-ACCOUNT" /* optional parameters */);
var subaccount_05 = await api.Spot.SubAccount.GetSubAccountTransfersAsync(/* optional parameters */);
var subaccount_06 = await api.Spot.SubAccount.GetAccountSpotAssetTransfersAsync(/* optional parameters */);
var subaccount_07 = await api.Spot.SubAccount.GetSubAccountTransfersAsync(/* optional parameters */);
var subaccount_08 = await api.Spot.SubAccount.GetSubAccountsAsync(/* optional parameters */);
// Futures Public Methods
var public_101 = await api.Futures.Public.GetContractsAsync(/* optional parameters */);
var public_102 = await api.Futures.Public.GetContractAsync("BTCUSDT" /* optional parameters */);
var public_103 = await api.Futures.Public.GetOrderBookAsync("BTCUSDT" /* optional parameters */);
var public_104 = await api.Futures.Public.GetOpenInterestAsync("BTCUSDT" /* optional parameters */);
var public_105 = await api.Futures.Public.GetFundingRateAsync("BTCUSDT" /* optional parameters */);
var public_106 = await api.Futures.Public.GetKlinesAsync("BTCUSDT", BitMartFuturesKlineInterval.FourHours, 1662518172, 1662518172 /* optional parameters */);
// Futures Public Methods
var account_101 = await api.Futures.Account.GetBalancesAsync(/* optional parameters */);
// Futures Trading Methods
var trading_101 = await api.Futures.Trading.GetTradeFeeRatesAsync("BTCUSDT" /* optional parameters */);
var trading_102 = await api.Futures.Trading.GetOrderAsync("BTCUSDT", 1_000_001L /* optional parameters */);
var trading_103 = await api.Futures.Trading.GetOrdersAsync("BTCUSDT" /* optional parameters */);
var trading_104 = await api.Futures.Trading.GetOpenOrdersAsync(/* optional parameters */);
var trading_105 = await api.Futures.Trading.GetOpenPlanOrdersAsync(/* optional parameters */);
var trading_106 = await api.Futures.Trading.GetPositionsAsync(/* optional parameters */);
var trading_107 = await api.Futures.Trading.GetPositionRisksAsync(/* optional parameters */);
var trading_108 = await api.Futures.Trading.GetTradesAsync(/* optional parameters */);
var trading_109 = await api.Futures.Trading.GetTransfersAsync(/* optional parameters */);
var trading_110 = await api.Futures.Trading.PlaceOrderAsync(new BitMartFuturesTradingOrderRequest() /* optional parameters */);
var trading_111 = await api.Futures.Trading.CancelOrderAsync("BTCUSDT" /* optional parameters */);
var trading_112 = await api.Futures.Trading.CancelOrdersAsync("BTCUSDT" /* optional parameters */);
var trading_113 = await api.Futures.Trading.PlacePlanOrderAsync(new BitMartFuturesTradingTriggerOrderRequest() /* optional parameters */);
var trading_114 = await api.Futures.Trading.CancelPlanOrderAsync("BTCUSDT", 1_000_001L /* optional parameters */);
var trading_115 = await api.Futures.Trading.TransferAsync("USDT", 100.0M, BitMartFuturesTransferType.SpotToContract /* optional parameters */);
var trading_116 = await api.Futures.Trading.SetLeverageAsync("BTCUSDT", 10, BitMartFuturesMarginType.IsolatedMargin /* optional parameters */);
var trading_117 = await api.Futures.Trading.PlaceTakeProfitStopLossAsync(new BitMartFuturesTradingTpSlOrderRequest() /* optional parameters */);
var trading_118 = await api.Futures.Trading.ModifyPlanOrderAsync(new BitMartFuturesTradingTriggerOrderModifyRequest() /* optional parameters */);
var trading_119 = await api.Futures.Trading.ModifyPresetPlanOrderAsync(new BitMartFuturesTradingTriggerOrderModifyPresetRequest() /* optional parameters */);
var trading_120 = await api.Futures.Trading.ModifyTakeProfitStopLossOrderAsync(new BitMartFuturesTradingTpSlOrderModifyRequest() /* optional parameters */);
// Futures Sub-Account Methods
var subaccount_101 = await api.Futures.SubAccount.SubAccountToMainAccountAsync("-----REQUEST-NUM-----", 100.0M, "CURRENCY" /* optional parameters */);
var subaccount_102 = await api.Futures.SubAccount.SubAccountToMainAccountAsync("-----REQUEST-NUM-----", 100.0M, "CURRENCY", "SUB-ACCOUNT" /* optional parameters */);
var subaccount_103 = await api.Futures.SubAccount.MainAccountToSubAccountAsync("-----REQUEST-NUM-----", 100.0M, "CURRENCY", "SUB-ACCOUNT" /* optional parameters */);
var subaccount_104 = await api.Futures.SubAccount.GetSubAccountBalancesAsync("SUB-ACCOUNT" /* optional parameters */);
var subaccount_105 = await api.Futures.SubAccount.GetSubAccountTransfersAsync("SUB-ACCOUNT" /* optional parameters */);
var subaccount_106 = await api.Futures.SubAccount.GetSubAccountAssetTransfersAsync(/* optional parameters */);
WebSocket Api Examples
The BitMart.Api socket client provides several socket endpoint to which can be subscribed.
var wss = new BitMartWebSocketApiClient();
wss.SetApiCredentials("XXXXXXXX-API-KEY-XXXXXXXX", "XXXXXXXX-API-SECRET-XXXXXXXX", "XXXXXXXX-MEMO-XXXXXXXX");
// WebSocket Spot Methods
var wss_01 = await wss.Spot.SubscribeToTickersAsync("BTC_USDT", data =>
{
// Your code here
});
var wss_02 = await wss.Spot.SubscribeToTickersAsync(["BTC_USDT", "ETH_USDT"], data =>
{
// Your code here
});
var wss_03 = await wss.Spot.SubscribeToKlinesAsync("BTC_USDT", BitMartSpotKlineInterval.OneDay, data =>
{
// Your code here
});
var wss_04 = await wss.Spot.SubscribeToKlinesAsync(["BTC_USDT", "ETH_USDT"], BitMartSpotKlineInterval.OneDay, data =>
{
// Your code here
});
var wss_05 = await wss.Spot.SubscribeToDepthAllAsync("BTC_USDT", 5, data =>
{
// Your code here
});
var wss_06 = await wss.Spot.SubscribeToDepthAllAsync(["BTC_USDT", "ETH_USDT"], 5, data =>
{
// Your code here
});
var wss_07 = await wss.Spot.SubscribeToDepthIncreaseAsync("BTC_USDT", data =>
{
// Your code here
});
var wss_08 = await wss.Spot.SubscribeToDepthIncreaseAsync(["BTC_USDT", "ETH_USDT"], data =>
{
// Your code here
});
var wss_09 = await wss.Spot.SubscribeToTradesAsync("BTC_USDT", data =>
{
// Your code here
});
var wss_10 = await wss.Spot.SubscribeToTradesAsync(["BTC_USDT", "ETH_USDT"], data =>
{
// Your code here
});
var wss_11 = await wss.Spot.SubscribeToOrdersAsync(data =>
{
// Your code here
});
var wss_12 = await wss.Spot.SubscribeToOrdersAsync("BTC_USDT", data =>
{
// Your code here
});
var wss_13 = await wss.Spot.SubscribeToOrdersAsync(["BTC_USDT", "ETH_USDT"], data =>
{
// Your code here
});
var wss_14 = await wss.Spot.SubscribeToBalancesAsync(data =>
{
// Your code here
});
// WebSocket Futures Methods
var wss_101 = await wss.Futures.SubscribeToTickersAsync(data =>
{
// Your code here
});
var wss_102 = await wss.Futures.SubscribeToDepthAsync("BTCUSDT", 5, data =>
{
// Your code here
});
var wss_103 = await wss.Futures.SubscribeToDepthAsync(["BTCUSDT", "ETHUSDT"], 5, data =>
{
// Your code here
});
var wss_104 = await wss.Futures.SubscribeToTradesAsync("BTCUSDT", data =>
{
// Your code here
});
var wss_105 = await wss.Futures.SubscribeToTradesAsync(["BTCUSDT", "ETHUSDT"], data =>
{
// Your code here
});
var wss_106 = await wss.Futures.SubscribeToKlinesAsync("BTC_USDT", BitMartFuturesKlineInterval.OneDay, data =>
{
// Your code here
});
var wss_107 = await wss.Futures.SubscribeToKlinesAsync(["BTC_USDT", "ETH_USDT"], BitMartFuturesKlineInterval.OneDay, data =>
{
// Your code here
});
var wss_108 = await wss.Futures.SubscribeToBalancesAsync("USDT", data =>
{
// Your code here
});
var wss_109 = await wss.Futures.SubscribeToBalancesAsync(["BTC", "ETH", "USDT"], data =>
{
// Your code here
});
var wss_110 = await wss.Futures.SubscribeToPositionsAsync(data =>
{
// Your code here
});
var wss_111 = await wss.Futures.SubscribeToOrdersAsync(data =>
{
// Your code here
});
// Unsubscribe
await wss.UnsubscribeAllAsync();
await wss.UnsubscribeAsync(wss_111.Data);
await wss.UnsubscribeAsync(wss_111.Data.Id);
Product | Versions 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. |
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
Please refer to changelog at Github https://github.com/burakoner/BitMart.Api/blob/main/CHANGELOG.md