Movatterモバイル変換

Request Parameter

Request

curl https://api-cloud.bitmart.com/system/time

None

Response Data

Response

{"code":1000,"trace":"886fb6ae-456b-4654-b4e0-d681ac05cea1","message":"OK","data":{"server_time":1527777538000}}

Field	Type	Description
server_time	Long	Current system time (timestamp, accuracy in milliseconds)

Get System Service Status

Get system service status

Request URL

GET https://api-cloud.bitmart.com/system/service

Request Limit

Request Parameter

Request

curl https://api-cloud.bitmart.com/system/service

None

Response Data

Response

{"code":1000,"trace":"886fb6ae-456b-4654-b4e0-d681ac05cea1","message":"OK","data":{"service":[{"title":"Spot API Stop","service_type":"spot","status":"2","start_time":1527777538000,"end_time":1527777538000},{"title":"Contract API Stop","service_type":"contract","status":"2","start_time":1527777538000,"end_time":1527777538000}]}}

Field	Type	Description
title	String	System maintenance instructions title
status	Long	System maintenance status -`0`=Waiting -`1`=Working -`2`=Completed
service_type	String	Service type -`spot`=Spot API service -`contract`=Contract API service -`account`=Account API service
start_time	Long	System maintenance start time, UTC-0, timestamp accuracy in milliseconds
end_time	Long	System maintenance end time, UTC-0, timestamp accuracy in milliseconds

Public Market Data

Get Currency List (V1)

Get a list of all cryptocurrencies on the platform

Request URL

GET https://api-cloud.bitmart.com/spot/v1/currencies

Request Limit

If the currency you need is not included in the returned response, the currency may have been delisted.

Request Parameter

Request

curl https://api-cloud.bitmart.com/spot/v1/currencies

None

Response Data

Response

{"code":1000,"trace":"886fb6ae-456b-4654-b4e0-d681ac05cea1","message":"OK","data":{"currencies":[{"id":"BTC","name":"Bitcoin","withdraw_enabled":true,"deposit_enabled":true},{"id":"ETH","name":"Ethereum","withdraw_enabled":true,"deposit_enabled":true}]}}

Field	Type	Description
id	String	Currency abbreviation, such as BTC
name	String	Currency full name, such as Bitcoin
withdraw_enabled	Boolean	Whether this currency can be withdrawn on the platform -`true`=can -`false`=no
deposit_enabled	Boolean	Whether this currency can be deposited on the platform -`true`=can -`false`=no

Get Trading Pairs List (V1)

Get a list of all trading pairs on the platform

Request URL

GET https://api-cloud.bitmart.com/spot/v1/symbols

Request Limit

Request Parameter

Request

curl https://api-cloud.bitmart.com/spot/v1/symbols

None

Response Data

Response

{"code":1000,"trace":"886fb6ae-456b-4654-b4e0-d681ac05cea1","message":"OK","data":{"symbols":["BMX_ETH","XLM_ETH","MOBI_ETH"]}}

Field	Type	Description
symbols	List	Array of trading pairs

Note

Returns an array of trading pairs
"BMX_ETH" it means that the base currency of this trading pair is BMX, and the quote currency is ETH

Get Trading Pair Details (V1)

Get a detailed list of all trading pairs on the platform

Request URL

GET https://api-cloud.bitmart.com/spot/v1/symbols/details

Request Limit

Request Parameter

Request

curl https://api-cloud.bitmart.com/spot/v1/symbols/details

None

Response Data

Response

{"code":1000,"trace":"886fb6ae-456b-4654-b4e0-d681ac05cea1","message":"OK","data":{"symbols":[{"symbol":"GXC_BTC","symbol_id":1024,"base_currency":"GXC","quote_currency":"BTC","quote_increment":"1.00000000","base_min_size":"1.00000000","price_min_precision":6,"price_max_precision":8,"expiration":"NA","min_buy_amount":"0.00010000","min_sell_amount":"0.00010000","trade_status":"trading"}]}}

Field	Type	Description
symbols	List	Array of trading pair details
symbol	String	Trading pair name
symbol_id	Int	Trading pair id
base_currency	String	Base currency
quote_currency	String	Quote currency
quote_increment	String	The minimum order quantity is also the minimum order quantity increment
base_min_size	String	Minimum order quantity
price_min_precision	Number	Minimum price accuracy (decimal places), used to query k-line and depth
price_max_precision	Number	Maximum price accuracy (decimal places), used to query k-line and depth
expiration	String	Expiration time of trading pair
min_buy_amount	String	Minimum order amount
min_sell_amount	String	Minimum sell amount
trade_status	String	Trade Status -`trading`=is trading -`pre-trade`=pre-open

Get Ticker of All Pairs (V3)

Get all trading pairs with a volume greater than 0 within 24 hours.Market data includes: latest transaction price, best bid price, best ask price and 24-hour transaction volume snapshot information.Note that the interface is not real-time data, if you need real-time data, please use websocket to subscribe Ticker channel

Request URL

GET https://api-cloud.bitmart.com/spot/quotation/v3/tickers

Request Limit

Request Parameter

Request

curl https://api-cloud.bitmart.com/spot/quotation/v3/tickers`

None

Response Data

Response

{"code":1000,"trace":"886fb6ae-456b-4654-b4e0-1231","message":"success","data":[["BTC_USDT",//symbol"30000.00",//last"582.08066",//v_24h"4793098.48",//qv_24h"28596.30",//open_24h"31012.44",//high_24h"12.44",//low_24h"0.04909",//fluctuation"30000",//bid_px"1",//bid_sz"31012.44",//ask_px"69994.75267",//ask_sz"1691671091933"//ts],["ETH_USDT","1840.00","2.00000","3680.00","1842.18","1842.18","1840.00","-0.00118","1812.35","4.61989","1859.34","4.07793","1691671094213"]]}

Field	Type	Description
symbol	String	Trading pair
last	String	Latest price
v_24h	String	24-hour trade volume in base currency
qv_24h	String	24-hour trade volume in quote currency
open_24h	String	24-hour open price
high_24h	String	24-hour highest price
low_24h	String	24-hour lowest price
fluctuation	String	24-hour price change
bid_px	String	top buy price
bid_sz	String	Size of top buy order
ask_px	String	top sell price
ask_sz	String	Size of top sell order
ts	String	Time of generation(in milliseconds)

Get Ticker of a Trading Pair (V3)

Applicable to query the aggregated market price of a certain trading pair, and return the latest ticker information. Note that the interface is not real-time data, if you need real-time data, please use websocket to subscribe Ticker channel

Request URL

GET https://api-cloud.bitmart.com/spot/quotation/v3/ticker

Request Limit

1.If no corresponding trading pair is found, this trading pair has been delisted.
2.For frequent query needs, we recommend using this endpoint to obtain aggregated ticker for a single trading pair.

Request Parameter

Request

curl https://api-cloud.bitmart.com/spot/quotation/v3/ticker?symbol=BTC_USDT

Field	Type	Required?	Description
symbol	String	Yes	Trading pair (e.g. BMX_USDT)

Response Data

Response

{"code":1000,"trace":"886fb6ae-456b-4654-b4e0-1231","message":"success","data":{"symbol":"BTC_USDT","last":"30000.00","v_24h":"582.08066","qv_24h":"4793098.48","open_24h":"28596.30","high_24h":"31012.44","low_24h":"12.44","fluctuation":"0.04909","bid_px":"30000","bid_sz":"1","ask_px":"31012.44","ask_sz":"69994.75267","ts":"1691671061919"}}

Field	Type	Description
symbol	String	Trading pair
last	String	Latest price
v_24h	String	24-hour trade volume in base currency
qv_24h	String	24-hour trade volume in quote currency
open_24h	String	24-hour open price
high_24h	String	24-hour highest price
low_24h	String	24-hour lowest price
fluctuation	String	24-hour price change
bid_px	String	top buy price
bid_sz	String	Size of top buy order
ask_px	String	top sell price
ask_sz	String	Size of top sell order
ts	String	Time of generation(in milliseconds)

Get Latest K-Line (V3)

Query the latest K-line and return a maximum of 1000 data. Note that the latest K-line of the interface is not real-time data. If you want real-time data, please use websocket to subscribe to K-line channel

Request URL

GET https://api-cloud.bitmart.com/spot/quotation/v3/lite-klines

Request Limit

A total of four query modes are supported:
1. If only before is passed, check forward according to the time
2. If only after is passed, check backward according to the time
3. Both before and after need to verify whether the time interval is legal, and if it is legal, check the interval
4. If neither before nor after is passed, the latest K-line will be returned in reverse order

Request Parameter

Request

curl https://api-cloud.bitmart.com/spot/quotation/v3/lite-klines?symbol=BMX_ETH&step=15&limit=10

Field	Type	Required?	Description
symbol	String	Yes	Trading pair (e.g.`BMX_USDT`)
before	Long	No	Query timestamp (unit: second, e.g. 1525760116), query the data before this time
after	Long	No	Query timestamp (unit: second, e.g. 1525769116), query the data after this time
step	Int	No	k-line step, value`[1, 5, 15, 30, 60,` `120, 240, 1440, 10080, 43200]` unit: minute, default 1
limit	Int	No	Return number, the maximum value is 200, default is 100

Response Data

Response

{"code":1000,"trace":"886fb6ae-456b-4654-b4e0-1231","message":"success","data":[["1689736680",//t"3.721",//o"3.743",//h"3.677",//l"3.708",//c"22698348.04828491",//v"12698348.04828491"//qv],["1689736620","3.731","3.799","3.494","3.72","67632347.24399722","37632347.24399722"]]}

Field	Type	Description
t	String	Create timestamp (in seconds), It can be used as the unique identification of K line
o	String	Open price
h	String	Highest price
l	String	Lowest price
c	String	Close price
v	String	Trading volume, with a unit of currency (If in BTC_USDT, The unit is BTC)
qv	String	Trading volume, the value is the quantity in quote currency (If in BTC_USDT, The unit is USDT)

Get History K-Line (V3)

Get k-line data within a specified time range of a specified trading pair.Note that the interface is not real-time data, if you need real-time data, please use websocket to subscribe KLine channel

Request URL

GET https://api-cloud.bitmart.com/spot/quotation/v3/klines

Request Limit

Request Parameter

Request

curl https://api-cloud.bitmart.com/spot/quotation/v3/klines?symbol=BMX_ETH&step=15&limit=10

Field	Type	Required?	Description
symbol	String	Yes	Trading pair (e.g.`BMX_USDT`)
before	Long	No	Query timestamp (unit: second, e.g. 1525760116), query the data before this time
after	Long	No	Query timestamp (unit: second, e.g. 1525769116), query the data after this time
step	Int	No	k-line step, value`[1, 5, 15, 30, 60,` `120, 240, 1440, 10080, 43200]` unit: minute, default 1
limit	Int	No	Return number, the maximum value is 200, default is 100

Response Data

Response

{"code":1000,"trace":"886fb6ae-456b-4654-b4e0-1231","message":"success","data":[["1689736680",//t"3.721",//o"3.743",//h"3.677",//l"3.708",//c"22698348.04828491",//v"12698348.04828491"//qv],["1689736620","3.731","3.799","3.494","3.72","67632347.24399722","37632347.24399722"]]}

Field	Type	Description
t	String	Create timestamp (in seconds), It can be used as the unique identification of K line
o	String	Open price
h	String	Highest price
l	String	Lowest price
c	String	Close price
v	String	Trading volume, with a unit of currency (If in BTC_USDT, The unit is BTC)
qv	String	Trading volume, the value is the quantity in quote currency (If in BTC_USDT, The unit is USDT)

Get Depth (V3)

Get full depth of trading pairs.Note that the interface is not real-time data, if you need real-time data, please use websocket to subscribe Depth channel

Request URL

GET https://api-cloud.bitmart.com/spot/quotation/v3/books

Request Limit

Request Parameter

Request

curl https://api-cloud.bitmart.com/spot/quotation/v3/books?symbol=BTC_USDT&limit=1

Field	Type	Required?	Description
symbol	String	Yes	Trading pair (e.g.`BMX_USDT`)
limit	Int	No	Order book depth per side. Maximum 50, e.g. 50 bids + 50 asks. Default returns to 35 depth data, e.g. 35 bids + 35 asks.

Response Data

Response

{"code":1000,"trace":"886fb6ae-456b-4654-b4e0-1231","message":"success","data":{"ts":"1691672864874","symbol":"BTC_USDT","asks":[["31012.44",//price"69994.75267"//amount]],"bids":[["30000.00",//price"1.00000"//amount]]}}

Field	Type	Description
ts	String	Create time(Timestamp in milliseconds)
symbol	String	Trading pair
asks	List[]	Order book on sell side
bids	List[]	Order book on buy side
amount	String	Total number of current price depth
price	String	The price at current depth

Get Recent Trades (V3)

Get the latest trade records of the specified trading pair.Note that the interface is not real-time data, if you need real-time data, please use websocket to subscribe Trade channel

Request URL

GET https://api-cloud.bitmart.com/spot/quotation/v3/trades

Request Limit

Request Parameter

Request

curl https://api-cloud.bitmart.com/spot/quotation/v3/trades?symbol=BMX_ETH&limit=10

Field	Type	Required?	Description
symbol	String	Yes	Trading pair (e.g.`BMX_USDT`)
limit	Int	No	Number of returned items, maximum is 50, default 50

Response Data

Response

{"code":1000,"trace":"886fb6ae-456b-4654-b4e0-1231","message":"success","data":[["BMX_ETH",//symbol"1691743270994",//ts"1.00000000",//price"1.0",//size"sell"//side]]}

Field	Type	Description
symbol	String	Trading pair
ts	String	Trade time (in milliseconds)
price	String	Trade price
size	String	Trade number
side	String	Order Side -`buy` -`sell`

Funding Account

Get Account Balance (KEYED)

Gets Account Balance

Request URL

GET https://api-cloud.bitmart.com/account/v1/wallet

Request Limit

Only assets with a balance greater than 0 will be returned.

Request Parameter

Request

curl-H'X-BM-KEY:{{AccessKey}}'https://api-cloud.bitmart.com/account/v1/wallet?currency=USDT&needUsdValuation=true

Field	Type	Required?	Description
currency	String	No	Currency
needUsdValuation	Bool	No	Whether to return the USD valuation, default is`false`

Response Data

Response

{"message":"OK","code":1000,"trace":"ef834248-51d3-4223-9481-f862aa9dd39f","data":{"wallet":[{"currency":"USDT","name":"Tether USD","available":"1000.00000000","available_usd_valuation":"1002.00000000","frozen":"0.00000000","unAvailable":"0.00000000"}]}}

Field	Type	Description
currency	String	Token symbol, e.g., 'BTC'
name	String	Token name, e.g., 'Bitcoin'
available	String	Available Balance
available_usd_valuation	String	Available Balance USD valuation
frozen	String	Trading frozen Balance
unAvailable	String	Trading frozen Balance + Other frozen Balance

Get Currencies

Gets the currency of the asset for withdrawal

Request URL

GET https://api-cloud.bitmart.com/account/v1/currencies

Request Limit

1. If the returned response does not contain the currency you need, the currency may have been removed.
2. There are multiple USDT currencies. Note that:
`currency` = `USDT` default is OMNI network
`currency` = `USDT-TRC20` , is TRC20 network
`currency` = `USDT-ERC20`, is ERC20 network

Request Parameter

Request

curl https://api-cloud.bitmart.com/account/v1/currencies?currencies=BTC,ETH,BMX

Field	Type	Required?	Description
currencies	String	No	Single query, such as`BTC`; multiple queries, such as`BTC,ETH,BMX`, can have a maximum of 20.

Response Data

Response

{"code":1000,"trace":"886fb6ae-456b-4654-b4e0-d681ac05cea1","message":"OK","data":{"currencies":[{"currency":"USDT","name":"Tether USD","contract_address":null,"network":"OMNI","withdraw_enabled":false,"deposit_enabled":false,"withdraw_minsize":null,"withdraw_minfee":null,"withdraw_fee":"10","withdraw_fee_estimate":"10.3"},{"currency":"USDT-TRC20","name":"USDT-TRC20","contract_address":"TR7NHqjeKQxGTCi8q8ZY4pL8otSzgjLj6t","network":"TRC20","withdraw_enabled":true,"deposit_enabled":true,"withdraw_minsize":"10","withdraw_minfee":null,"withdraw_fee":"10","withdraw_fee_estimate":"10.3"},{"currency":"USDT-ERC20","name":"USDT-ERC20","contract_address":"0xdac17f958d2ee523a2206206994597c13d831ec7","network":"ERC20","withdraw_enabled":true,"deposit_enabled":true,"withdraw_minsize":"26","withdraw_minfee":null,"withdraw_fee":"26","withdraw_fee_estimate":"26.3"}]}}

Field	Type	Description
currency	String	Token symbol, e.g., 'BTC'
name	String	Token name, e.g., 'Bitcoin'
contract_address	String	Contract address
network	String	network, e.g., 'ERC20'
withdraw_enabled	Boolean	Availability to withdraw -`true`=available -`false`=not available
deposit_enabled	Boolean	Availability to deposit -`true`=available -`false`=not available
withdraw_minsize	String	Minimum withdrawal amount
withdraw_minfee	String	Minimum withdrawal fee (After 2025-05-18, the field will be removed)
withdraw_fee	String	Withdrawal fee. The unit corresponds to the currency
withdraw_fee_estimate	String	Withdrawal fee estimate. The unit is USD.

Get Spot Wallet Balance (KEYED)

Get the user's wallet balance for all currencies

Request URL

GET https://api-cloud.bitmart.com/spot/v1/wallet

Request Limit

Request Parameter

Request

curl-H'X-BM-KEY:{{AccessKey}}' https://api-cloud.bitmart.com/spot/v1/wallet

None

Response Data

Response

{"code":1000,"trace":"886fb6ae-456b-4654-b4e0-d681ac05cea1","message":"OK","data":{"wallet":[{"id":"BTC","available":"10.000000","name":"Bitcoin","frozen":"10.000000",},...]}}

Field	Type	Description
id	String	Cryptocurrency abbreviation
name	String	Full name
available	String	Available balance
frozen	String	Frozen balance

Deposit Address (KEYED)

Gets Deposit Address

Request URL

GET https://api-cloud.bitmart.com/account/v1/deposit/address

Request Limit

USDT has multiple recharge addresses, please select them correctly. For example:
`currency` = `USDT` default is OMNI;
`currency` = `USDT-TRC20` is TRC20;
`currency` = `USDT-ERC20` is ERC20;

Request Parameter

Request

curl-H'X-BM-KEY:{{AccessKey}}'https://api-cloud.bitmart.com/account/v1/deposit/address?currency=USDT-TRC20

Field	Type	Required?	Description
currency	String	Yes	Token symbol, e.g., 'BTC'

Instruction

PNG

Response Data

Response

{"message":"OK","code":1000,"trace":"0e6edd79-f77f-4251-abe5-83ba75d06c1a","data":{"currency":"USDT-TRC20","chain":"USDT-TRC20","address":"TGR3ghy2b5VLbyAYrmiE15jasR6aPHTvC5","address_memo":""}}

Field	Type	Description
currency	String	Token symbol, e.g., 'BTC'
chain	String	Token chain
address	String	Deposit address
address_memo	String	Tag (tag/payment_id/memo); If some currencies need to withdraw currency, it will return data. If not, it will return empty string

This interface is not available for sub-account The tag names required by each currency are different, such as (tag/payment_id/memo). For convenience, BitMart is uniformly defined as address_Memo. This means that regardless of the currency in which tag/payment_id/memo is required, the service returns the address_Memo field uniformly. Please pay attention to the distinction.
Tag are required for some tokens. Please include them while making deposits to ensure the your funds will be properly credited.
IOTA and HLX COINS are temporarily not supported for deposit.

Forgot to write Memo/Wrote a wrong Memo?

Withdraw Quota (KEYED)

Query withdraw quota for currencies

Request URL

GET https://api-cloud.bitmart.com/account/v1/withdraw/charge

Request Limit

This interface is not available for sub-account 1. When `withdraw_precision`=5, then the decimal point of the withdrawal amount cannot exceed 5 digits.
2. When `withdraw_Precision_GeTen`=10, then the withdrawal amount must be an integral multiple of 10.

Request Parameter

Request

curl-H'X-BM-KEY:{{AccessKey}}' https://api-cloud.bitmart.com/account/v1/withdraw/charge?currency=BTC

Field	Type	Required?	Description
currency	String	Yes	Token symbol, e.g., 'BTC'

Response Data

Response

{"message":"OK","code":1000,"trace":"62a80bde-0cb4-4bf1-b8e5-5ad2c71463e7","data":{"today_available_withdraw_BTC":"100.0000","min_withdraw":"0.00000000","withdraw_precision":8,"withdraw_fee":"0.00000000","withdraw_Precision_GeTen":10}}

Field	Type	Description
today_available_withdraw_BTC	String	Amount available for withdrawal today, unit: BTC
min_withdraw	String	Minimum withdrawal amount
withdraw_precision	Int	Withdrawal amount must be accurate to several decimal places.
withdraw_fee	String	Withdrawal fee
withdraw_Precision_GeTen	Long	Withdrawal amount must be an integral multiple of this value. If it is null, it means there is no such requirement.

Withdraw (SIGNED)

Creates a withdraw request from spot account to an external address

The API can only make withdrawal to verified addresses, and verified addresses can be set by WEB/APP.

Request URL

POST https://api-cloud.bitmart.com/account/v1/withdraw/apply

Request Limit

This interface is not available for sub-account

Request Parameter

Field	Type	Required?	Description
currency	String	Yes	Token symbol, e.g., 'BTC'
amount	String	Yes	The amount of currency to withdraw

Parameters for Withdraw to the blockchain

1.Request: Withdraw to the blockchain

curl-H'X-BM-KEY:{{AccessKey}}'-H'X-BM-TIMESTAMP:{{currentTime}}'-H'X-BM-SIGN:{{SIGN}}'-X POST-d'{{    "currency": "USDT-TRC20",    "amount": "100.000",    "destination": "To Digital Address",    "address": "0x1EE6FA5A3803608fc22a1f3F76********",    "address_memo": ""}'https://api-cloud.bitmart.com/account/v1/withdraw/apply

Field	Type	Required?	Description
address	String	Yes	Withdraw address (only the address added on the official website is supported)
address_memo	String	No	Address tag(tag Or payment_id Or memo)
destination	String	No	Remark

Parameters for Withdraw to BitMart account

2.Request: Withdraw to BitMart account

curl-H'X-BM-KEY:{{AccessKey}}'-H'X-BM-TIMESTAMP:{{currentTime}}'-H'X-BM-SIGN:{{SIGN}}'-X POST-d'{{    "currency": "USDT-TRC20",    "amount": "100.000",    "type": 1,    "value": "876940329",    "areaCode": ""}'https://api-cloud.bitmart.com/account/v1/withdraw/apply

Field	Type	Required?	Description
type	Int	Yes	Account type `1`=CID `2`=Email `3`=Phone
value	String	Yes	Account
areaCode	String	Yes	Phone area code, required when account type is phone, e.g.: 61

Important notes on request parameters

1. If the currency has multiple blockchains, please pay attention to passing parameters: such as USDT
`currency`=`USDT-TRX` network is TRX
`currency`=`USDT-ETH` network is ETH
`currency`=`USDT-BSC_BNB` network is BSC_BNB
`currency`=`USDT-SOL` network is SOL
`currency`=`USDT-ALGO` network is ALGO
find more currencies network
2. Withdraw only supports addresses in the list of commonly used addresses of users. IOTA, HLX one-time currency withdrawal address cannot be set as the common address, so IOTA, HLX withdrawal address is not supported.
3. Without the withdrawal tag, `address_memo` does not pass or pass an empty string.
4. If the parameters for `Withdraw to the blockchain` and the parameters for `Withdraw to BitMart account` are transmitted at the same time, the parameters for `Withdraw to the blockchain` will take precedence.

Response Data

Response

{"code":1000,"trace":"886fb6ae-456b-4654-b4e0-d681ac05cea1","message":"OK","data":{"withdraw_id":"121212"}}

Field	Type	Description
withdraw_id	String	Withdrawa ID

Note

1. When withdraw_id is returned, it means that the withdrawal request has been sent successfully.

2. You can check the tx_id of this withdrawal by using the interface ofGet A Deposit Or Withdraw Detail, and use it to query the withdrawal progress on the blockchain.

3. If you get an error message， message=This address is not verified. Please add and verify this address on the client
You need to add the address to the whitelist address according to the following 3 steps.

Step 1: After logging in to the account on the Web or APP, enter the withdrawal page.

Step 2: Click【Add withdrawal address】

PNG

Step 3: On the address management page, save the withdrawal address as [Verified Address], which supports API withdrawal.

PNG PNG

4. Address Types:

1. Standard Address: Can be withdrawn to a specified currency and network address.
2. Universal Address: Can be withdrawn to all currencies on the specified network.
3. EVM Address: Can be withdrawn to currencies on EVM type networks.

5. Verified Addresses:

1. When saving an address, it can be pre-verified to skip the verification during withdrawal (Verified addresses will not need to be verified again during the withdrawal process).
2. API withdrawal must use verified addresses; un-verified addresses cannot be used for withdrawal via API.

Withdraw Address (KEYED)

Gets Withdraw Address List

Request URL

GET https://api-cloud.bitmart.com/account/v1/withdraw/address/list

Request Limit

Request Parameter

Request

curl-H'X-BM-KEY:{{AccessKey}}'https://api-cloud.bitmart.com/account/v1/withdraw/address/list

None

Response Data

Response

{"message":"OK","code":1000,"trace":"0e6edd79-f77f-4251-abe5-83ba75d06c1a","data":{"list":[{"currency":"ETH","network":"ETH","address":"0x1121","memo":"12","remark":"12","addressType":0,"verifyStatus":0}]}}

Field	Type	Description
address	String	Withdraw Address
memo	String	Memo
remark	String	Remark
verifyStatus	Int	Address verify status -`0`=Unverified -`1`=Verified
addressType	Int	Address Type -`0`=Standard Address -`1`=Universal Address -`2`=EVM Address
network	String	Network. The value is present only when the address type is a Standard address or Universal Address
currency	String	The value is present only when the address type is a Standard address

Get Deposit And Withdraw History (KEYED)

The original /account/v1/deposit-withdraw/history interface, the old interface is no longer supported, please switch to the new interface as soon as possible

Search for all existed withdraws and deposits and return their latest status.

Request URL

GET https://api-cloud.bitmart.com/account/v2/deposit-withdraw/history

Request Limit

1. The deposit id has a value when `operation_type` = 'deposit'. The withdraw id has a value when `operation_type` = 'withdraw'.
2. Tx_id is an empty string before it is chained.
3. Please notice the default startTime and endTime to make sure that time interval is within 0-90 days.
4. If both startTime and endTime are sent, time between startTime and endTime must be less than 90 days.
This endpoint is not available for sub-account

Request Parameter

Request

curl-H'X-BM-KEY:{{AccessKey}}'https://api-cloud.bitmart.com/account/v2/deposit-withdraw/history?N=100&operation_type=withdraw&startTime=1739499865000

Field	Type	Required?	Description
currency	String	No	Token symbol, e.g., 'BTC'
operation_type	String	Yes	type -`deposit`=deposit -`withdraw`=withdraw
startTime	Long	No	Default: 90 days from current timestamp (milliseconds)
endTime	Long	No	Default: present timestamp (milliseconds)
N	Int	Yes	Recent N records (value range 1-1000)

Response Data

Response

{"message":"OK","code":1000,"trace":"142bf92a-fc50-4689-92b6-590886f90b97","data":{"records":[{"withdraw_id":"1679952","deposit_id":"","operation_type":"withdraw","currency":"BMX","apply_time":1588867374000,"arrival_amount":"59.000000000000","fee":"1.000000000000","status":0,"address":"0xe57b69a8776b37860407965B73cdFFBDFe668Bb5","address_memo":"","tx_id":""}]}}

Field	Type	Description
withdraw_id	String	withdraw id
deposit_id	String	deposit id
operation_type	String	type -`deposit`=deposit -`withdraw`=withdraw
currency	String	Token symbol, e.g., 'BTC'
apply_time	Long	The request timestamp is accurate to milliseconds(UTC-0)
arrival_amount	String	Actual amount received
fee	String	fee
status	Int	status -`0`=Create -`1`=Submitted, waiting for withdrawal -`2`=Processing -`3`=Done -`4`=Cancel -`5`=Fail
address	String	Address
address_memo	String	Address tag
tx_id	String	Hash record

Get A Deposit Or Withdraw Detail (KEYED)

Query a single charge record

Request URL

GET https://api-cloud.bitmart.com/account/v1/deposit-withdraw/detail

Request Limit

1. The deposit id has a value when `operation_type` = 'deposit'. The withdraw id has a value when `operation_type` = 'withdraw'.
2. Tx_id is an empty string before it is chained.This interface is not available for sub-account

Request Parameter

Request

curl-H'X-BM-KEY:{{AccessKey}}'https://api-cloud.bitmart.com/account/v1/deposit-withdraw/detail?id=1679952

Field	Type	Required?	Description
id	String	Yes	`withdraw_id` or`deposit_id`

Response Data

Response

{"message":"OK","code":1000,"trace":"f7f74924-14da-42a6-b7f2-d3799dd9a612","data":{"record":{"withdraw_id":"1679952","deposit_id":"","operation_type":"withdraw","currency":"BMX","apply_time":1588867374000,"arrival_amount":"59.000000000000","fee":"1.000000000000","status":0,"address":"0xe57b69a8776b37860407965B73cdFFBDFe668Bb5","address_memo":"","tx_id":""}}}

Field	Type	Description
withdraw_id	String	withdraw id
deposit_id	String	deposit id
operation_type	String	type -`deposit`=deposit -`withdraw`=withdraw
currency	String	Token symbol, e.g., 'BTC'
apply_time	Long	The request timestamp is accurate to milliseconds(UTC-0)
arrival_amount	String	Actual amount received
fee	String	fee
status	Int	status -`0`=Create -`1`=Submitted, waiting for withdrawal -`2`=Processing -`3`=Done -`4`=Cancel -`5`=Fail
address	String	address
address_memo	String	address tag
tx_id	String	Hash record

Get Margin Account Details(Isolated) (KEYED)

Applicable for isolated margin account inquiries

Request URL

GET https://api-cloud.bitmart.com/spot/v1/margin/isolated/account

Request Limit

Request Parameter

Request

curl-H'X-BM-KEY:{{AccessKey}}' https://api-cloud.bitmart.com/spot/v1/margin/isolated/account?symbol=BTC_USDT

Field	Type	Required?	Description
symbol	String	No	Trading pair (e.g. BMX_USDT), no symbol is passed, and all isolated margin assets are returned

Response Data

Response

{"message":"OK","code":1000,"trace":"f7f74924-14da-42a6-b7f2-d3799dd9a612","data":{"symbols":[{"symbol":"BTC_USDT","risk_rate":"18.77","risk_level":"1","buy_enabled":true,"sell_enabled":true,"liquidate_price":"-0.09408905","liquidate_rate":"1.1","base":{"currency":"BTC","borrow_enabled":false,"borrowed":"2.00000000","borrow_unpaid":"0.84478234","interest_unpaid":"0.01385763","available":"112.89603334","frozen":"0.00000000","net_asset":"110.89603334","net_assetBTC":"0.00000000","total_asset":"112.89603334"},"quote":{"currency":"USDT","borrow_enabled":true,"borrowed":"0.00000000","borrow_unpaid":"0.84478234","interest_unpaid":"0.01385763","available":"10.00000000","frozen":"0.00000000","net_asset":"10.00000000","net_assetBTC":"0.00000000","total_asset":"10.00000000"}},...]}}

Field	Type	Description
symbol	String	Trading pair
risk_rate	String	Current risk rate
risk_level	String	Risk level
buy_enabled	Boolean	Whether open to buy
sell_enabled	Boolean	Whether open to sell
liquidate_price	String	Liquidation price (precision: 8 decimal places)
liquidate_rate	String	Liquidation rate
currency	String	Currency
borrow_enabled	Boolean	Whether open to borrow
borrowed	String	Borrowed assets (precision: 8 decimal places)
borrow_unpaid	String	Outstanding principal amount (precision: 8 decimal places)
interest_unpaid	String	Interest outstanding (precision: 8 decimal places)
available	String	Available assets (precision: 8 decimal places)
frozen	String	Trading frozen assets (precision: 8 decimal places)
net_asset	String	Net assets (precision: 8 decimal places)
net_assetBTC	String	Converted BTC net assets (precision: 8 decimal places)
total_asset	String	Total assets (precision: 8 decimal places)

Margin Asset Transfer (SIGNED)

For fund transfers between a margin account and spot account

Request URL

POST https://api-cloud.bitmart.com/spot/v1/margin/isolated/transfer

Request Limit

Request Parameter

Request

curl-H'X-BM-KEY:{{AccessKey}}'-H'X-BM-TIMESTAMP:{{currentTime}}'-H'X-BM-SIGN:{{SIGN}}'-X POST-d'{    "symbol":"BTC_USDT",    "currency":"BTC",    "amount":"1",    "side":"in"}'https://api-cloud.bitmart.com/spot/v1/margin/isolated/transfer

Field	Type	Required?	Description
symbol	String	Yes	Trading pair (e.g. BMX_USDT)
currency	String	Yes	Currency
amount	String	Yes	Amount of transfers (precision: 8 decimal places)
side	String	Yes	Transfer direction -`in`=Transfer in -`out`=Transfer out

Response Data

Response

{"message":"OK","code":1000,"trace":"f7f74924-14da-42a6-b7f2-d3799dd9a612","data":{"transfer_id":"124532"}}

Field	Type	Description
transfer_id	String	Transfer order id, only successful transfers will be returned

Get Basic Fee Rate (KEYED)

For querying the base rate of the current user

Request URL

GET https://api-cloud.bitmart.com/spot/v1/user_fee

Request Limit

Request Parameter

Request

curl-H'X-BM-KEY:{{AccessKey}}' https://api-cloud.bitmart.com/spot/v1/user_fee

None

Response Data

Response

{"message":"OK","code":1000,"trace":"0187ba0c876e4236ac191d9848a0f719.94.16778301620100121","data":{"user_rate_type":0,"level":"LV1","taker_fee_rate_A":"0.001","maker_fee_rate_A":"0.001","taker_fee_rate_B":"0.0025","maker_fee_rate_B":"0.0025","taker_fee_rate_C":"0.004","maker_fee_rate_C":"0.004","taker_fee_rate_D":"0.006","maker_fee_rate_D":"0.006"}}

Field	Type	Description
user_rate_type	Long	Rate type： -`0`=Normal Users -`1`=VIP Users -`2`=Special VIP Users
level	String	User Level
taker_fee_rate_A	String	Taker fee rate for Class-A pairs
maker_fee_rate_A	String	Maker fee rate for Class-A pairs
taker_fee_rate_B	String	Taker fee rate for Class-B pairs
maker_fee_rate_B	String	Maker fee rate for Class-B pairs
taker_fee_rate_C	String	Taker fee rate for Class-C pairs
maker_fee_rate_C	String	Maker fee rate for Class-C pairs
taker_fee_rate_D	String	Taker fee rate for Class-D pairs
maker_fee_rate_D	String	Maker fee rate for Class-D pairs

Get Actual Trade Fee Rate (KEYED)

For the actual fee rate of the trading pairs

Request URL

GET https://api-cloud.bitmart.com/spot/v1/trade_fee

Request Limit

Request Parameter

Request

curl-H'X-BM-KEY:{{AccessKey}}'https://api-cloud.bitmart.com/spot/v1/trade_fee?symbol=BTC_USDT

Field	Type	Required?	Description
symbol	String	Yes	Trading pair (e.g. BMX_USDT)

Response Data

Response

{"message":"OK","code":1000,"trace":"87614aa8-5327-4fe2-aafc-02e2ddca7210","data":{"symbol":"BTC_USDT","buy_taker_fee_rate":"0.0008","sell_taker_fee_rate":"0.0008","buy_maker_fee_rate":"0.0006","sell_maker_fee_rate":"0.0006"}}

Field	Type	Description
symbol	String	Trading pair
buy_taker_fee_rate	String	Taker fee rate (Buy)
sell_taker_fee_rate	String	Taker fee rate (Sell)
buy_maker_fee_rate	String	Maker fee rate (Buy)
sell_maker_fee_rate	String	Maker fee rate (Sell)

Spot / Margin Trading

New Order(v2) (SIGNED)

Send in a new order.

Request URL

POST https://api-cloud.bitmart.com/spot/v2/submit_order

Request Limit

The request is successful only when order_id is returned.

Request Parameter

Request

curl-H'X-BM-KEY:{{AccessKey}}'-H'X-BM-TIMESTAMP:{{currentTime}}'-H'X-BM-SIGN:{{SIGN}}'-X POST-d'{    "symbol":"BTC_USDT",    "side":"buy",    "type":"limit",    "size":"10",    "price":"7000"    "stpMode":"none"}'https://api-cloud.bitmart.com/spot/v2/submit_order

Field	Type	Required?	Description
symbol	String	Yes	Trading pair (e.g. BTC_USDT)
side	String	Yes	Side -`buy`=Buy order -`sell`=Sell order
type	String	Yes	Order type -`limit`=Limit order -`market`=Market order -`limit_maker`=PostOnly order -`ioc`=IOC order
client_order_id	String	No	Client-defined OrderId(A combination of case-sensitive alphanumerics, all numbers, or all letters of up to 32 characters)
stpMode	String	No	Self transaction protection type(default:none) -`none` -`cancel_maker` -`cancel_taker` -`cancel_both`

Special Parameters for Limit Orders/PostOnly Orders/IOC Orders (`type`=limit/limit_maker/ioc)

Field	Type	Required?	Description
size	String	Yes	Order size
price	String	Yes	Price

Special Parameters for Market Buy Orders (`type`=market,`side`=buy)

Field	Type	Required?	Description
notional	String	Yes	Required for placing orders by amount

Special Parameters for Market Sell Orders (`type`=market,`side`=sell)

Field	Type	Required?	Description
size	String	Yes	Required for placing orders by quantity

Instruction

Buy-limit-maker

When "order price">="market lowest selling price", the order will be canceled by the system
When the "order price" <"the lowest selling price in the market", the order will be accepted by the system after the submission is successful
When "order price"*"order size"<minimum deal amount in the market, the order will be canceled by the system

Sell-limit-maker

When "order price" <= "market highest bid price", after the order is submitted, the order will be canceled by the system
When "order price"> "market highest bid price", the order will be accepted by the system after the submission is successful
When "order price"*"order size"<minimum deal amount in the market, the order will be canceled by the system

Buy-ioc,Sell-ioc

After the order is placed, all orders that cannot be filled immediately are cancelled immediately

Self trade prevention (STP)

The trading platform imposes self trade prevention at account level. The default STP mode is none. Users can also utilize the stpMode request parameter of the placing order endpoint to determine the stpMode of a certain order.Self trade prevention will not lead to latency.

Orders placed via OpenAPI: If both sides of the matched trade are orders submitted through OpenAPI, the system will execute based on the stpMode configuration of the Taker order.
Mixed orders: If one side of the matched trade is an OpenAPI order and the other is a Web/App order, the handling will be determined by the stpMode setting of the OpenAPI order.

There are three STP modes.

Cancel Maker: Which cancels the maker order to prevent self-trading. Then, the taker order continues to match with the next order based on the order book priority.
Cancel Taker: The taker order is canceled to prevent self-trading. If the user's own maker order is lower in the order book priority, the taker order is partially filled and then canceled. FOK orders are always honored and canceled if they would result in self-trading.
Cancel Both: Both taker and maker orders are canceled to prevent self-trading. If the user's own maker order is lower in the order book priority, the taker order is partially filled. Then, the remaining quantity of the taker order and the first maker order are canceled. FOK orders are not supported in this mode.

Response Data

Response

{"code":1000,"trace":"886fb6ae-456b-4654-b4e0-d681ac05cea1","message":"OK","data":{"order_id":"1223181"}}

Field	Type	Description
order_id	String	Order ID

Cancel Order(v3) (SIGNED)

Applicable to the cancellation of a specified unfinished order

Request URL

POST https://api-cloud.bitmart.com/spot/v3/cancel_order

Request Limit

In each request, you must select one of the parameters order_id and client_order_id to submit

Request Parameter

Request

curl-H'X-BM-KEY:{{AccessKey}}'-H'X-BM-TIMESTAMP:{{currentTime}}'-H'X-BM-SIGN:{{SIGN}}'-X POST-d'{    "symbol": "BTC_USDT",    "order_id": "112121212"}'https://api-cloud.bitmart.com/spot/v3/cancel_order

Field	Type	Required?	Description
symbol	String	Yes	Trading pair (e.g. BMX_USDT)
order_id	String	order_id, client_order_id, one of them is required	Order ID
client_order_id	String	order_id, client_order_id, one of them is required	Client-defined Order ID

Response Data

Response

{"code":1000,"trace":"886fb6ae-456b-4654-b4e0-d681ac05cea1","message":"OK","data":{"result":true}}

Field	Type	Description
result	Boolean	Cancel result -`true`=Cancel successfully -`false`=Cancel failed

`result` = 'true' indicates successful cancel; `result` = 'false' indicates that the cancel failed because the order was matched or cancelled.

New Batch Order(v4) (SIGNED)

Batch order

Request URL

POST https://api-cloud.bitmart.com/spot/v4/batch_orders

Request Limit

The request is successful only when orderIds is returned.

Request Parameter

Request

curl-H'X-BM-KEY:{{AccessKey}}'-H'X-BM-TIMESTAMP:{{currentTime}}'-H'X-BM-SIGN:{{SIGN}}'-X POST-d'{    "symbol":"BTC_USDT",    "orderParams":[{          "clientOrderId":"123456789",          "size":"0.1",          "price":"8800",          "side":"buy",          "type":"limit"          "stpMode":"none"    }],    "recvWindow":5000}'https://api-cloud.bitmart.com/spot/v4/batch_orders

Field	Type	Required?	Description
symbol	String	Yes	Trading pair (e.g. BTC_USDT)
orderParams	List	Yes	Order parameters, the number of transactions cannot exceed 10
recvWindow	Long	No	Trade time limit, allowed range (0,60000], default: 5000 milliseconds

orderParams

Field	Type	Required?	Description
side	String	Yes	Side -`buy`=Buy order -`sell`=Sell order
type	String	Yes	Order type -`limit`=Limit order -`market`=Market order -`limit_maker`=PostOnly order -`ioc`=IOC order
clientOrderId	String	No	Client-defined OrderId(A combination of case-sensitive alphanumerics, all numbers, or all letters of up to 32 characters)
stpMode	String	No	Self transaction protection type(default:none) -`none` -`cancel_maker` -`cancel_taker` -`cancel_both`

Special Parameters for Limit Orders/PostOnly Orders/IOC Orders (`type`=limit/limit_maker/ioc)

Field	Type	Required?	Description
size	String	Yes	Order size
price	String	Yes	Price

Special Parameters for Market Buy Orders (`type`=market,`side`=buy)

Field	Type	Required?	Description
notional	String	Yes	Required for placing orders by amount

Special Parameters for Market Sell Orders (`type`=market,`side`=sell)

Field	Type	Required?	Description
size	String	Yes	Required for placing orders by quantity

Instruction

Buy-limit-maker

When "order price">="market lowest selling price", the order will be canceled by the system
When the "order price" <"the lowest selling price in the market", the order will be accepted by the system after the submission is successful
When "order price"*"order size"<minimum deal amount in the market, the order will be canceled by the system

Sell-limit-maker

When "order price" <= "market highest bid price", the order will be canceled by the system
When "order price"> "market highest bid price", the order will be accepted by the system after the submission is successful
When "order price"*"order size"<minimum deal amount in the market, the order will be canceled by the system

Buy-ioc,Sell-ioc

After the order is placed, all orders that cannot be filled immediately are cancelled immediately

Self trade prevention (STP)

Orders placed via OpenAPI: If both sides of the matched trade are orders submitted through OpenAPI, the system will execute based on the stpMode configuration of the Taker order.
Mixed orders: If one side of the matched trade is an OpenAPI order and the other is a Web/App order, the handling will be determined by the stpMode setting of the OpenAPI order.

There are three STP modes.

Cancel Maker: Which cancels the maker order to prevent self-trading. Then, the taker order continues to match with the next order based on the order book priority.
Cancel Taker: The taker order is canceled to prevent self-trading. If the user's own maker order is lower in the order book priority, the taker order is partially filled and then canceled. FOK orders are always honored and canceled if they would result in self-trading.
Cancel Both: Both taker and maker orders are canceled to prevent self-trading. If the user's own maker order is lower in the order book priority, the taker order is partially filled. Then, the remaining quantity of the taker order and the first maker order are canceled. FOK orders are not supported in this mode.

Response Data

Response

{"message":"OK","code":1000,"trace":"5fc697fb817a4b5396284786a9b2609a.263.17022620476480263","data":{"code":0,"msg":"success","data":{"orderIds":["212751308355553320"]}}}

Field	Type	Description
orderIds	List	Order ID

Cancel Batch Order(v4) (SIGNED)

Cancel all outstanding orders in the specified direction for the specified trading pair or cancel based on the order ID

Request URL

POST https://api-cloud.bitmart.com/spot/v4/cancel_orders

Request Limit

In each request, you must select one of the parameters orderIds and clientOrderIds to submit

Request Parameter

Request

curl-H'X-BM-KEY:{{AccessKey}}'-H'X-BM-TIMESTAMP:{{currentTime}}'-H'X-BM-SIGN:{{SIGN}}'-X POST-d'{  "symbol":"BTC_USDT",  "orderIds":[    "5e925f3981"  ],  "recvWindow":5000}'https://api-cloud.bitmart.com/spot/v4/cancel_orders

Field	Type	Required?	Description
symbol	String	Yes	Trading pair (e.g. BTC_USDT)
orderIds	List	orderIds, clientOrderIds, one of them is required	Order Id List (Limited to 10 ids)
clientOrderIds	List	orderIds, clientOrderIds, one of them is required	Client-defined OrderId List (Limited to 10 ids)
recvWindow	Long	No	Trade time limit, allowed range (0,60000], default: 5000 milliseconds

Response Data

Response

{"message":"OK","code":1000,"trace":"c4edbce860164203954f7c3c81d60fc6.309.17022669632770001","data":{"successIds":["213055379155243012"],"failIds":[],"totalCount":1,"successCount":1,"failedCount":0}}

Field	Type	Description
successIds	List	Successfully canceled order IDs
failIds	List	Order IDs that failed to cancel
totalCount	Int	Number of submissions
successCount	Int	Number of successes
failedCount	Int	Number of failures

Cancel All Order(v4) (SIGNED)

Cancel all orders

Request URL

POST https://api-cloud.bitmart.com/spot/v4/cancel_all

Request Limit

Request Parameter

Request

curl-H'X-BM-KEY:{{AccessKey}}'-H'X-BM-TIMESTAMP:{{currentTime}}'-H'X-BM-SIGN:{{SIGN}}'-X POST-d'{  "symbol":"BTC_USDT",  "side":"buy"}'https://api-cloud.bitmart.com/spot/v4/cancel_all

Field	Type	Required?	Description
symbol	String	No	Trading pair (e.g. BTC_USDT)
side	String	No	Order side -`buy` -`sell`

Response Data

Response

{"code":1000,"trace":"886fb6ae-456b-4654-b4e0-d681ac05cea1","message":"OK","data":{}}

If code is equal to 1000, it means the cancellation is successful.

New Margin Order(v1) (SIGNED)

Applicable for margin order placement

Request URL

POST https://api-cloud.bitmart.com/spot/v1/margin/submit_order

Request Limit

The request is successful only when order_id is returned.

Request Parameter

Request

curl-H'X-BM-KEY:{{AccessKey}}'-H'X-BM-TIMESTAMP:{{currentTime}}'-H'X-BM-SIGN:{{SIGN}}'-X POST-d'{    "symbol":"BTC_USDT",    "side":"buy",    "type":"limit",    "size":"10",    "price":"7000"}'https://api-cloud.bitmart.com/spot/v1/margin/submit_order

Field	Type	Required?	Description
symbol	String	Yes	Trading pair (e.g. BTC_USDT)
side	String	Yes	Side -`buy`=Buy order -`sell`=Sell order
type	String	Yes	Order type -`limit`=Limit order -`market`=Market order -`limit_maker`=PostOnly order -`ioc`=IOC order
clientOrderId	String	No	Client-defined OrderId(A combination of case-sensitive alphanumerics, all numbers, or all letters of up to 32 characters)

Special Parameters for Limit Orders/PostOnly Orders/IOC Orders (`type`=limit/limit_maker/ioc)

Field	Type	Required?	Description
size	String	Yes	Order size
price	String	Yes	Price

Special Parameters for Market Buy Orders (`type`=market,`side`=buy)

Field	Type	Required?	Description
notional	String	Yes	Required for placing orders by amount

Special Parameters for Market Sell Orders (`type`=market,`side`=sell)

Field	Type	Required?	Description
size	String	Yes	Required for placing orders by quantity

Instruction

Buy-limit-maker

When "order price">="market lowest selling price", the system will refuse to accept the order after the order is submitted
When the "order price" <"the lowest selling price in the market", the order will be canceled by the system

Sell-limit-maker

When "order price" <= "market highest bid price", after the order is submitted, the system will refuse to accept the order
When "order price"> "market highest bid price", the order will be canceled by the system

Buy-ioc,Sell-ioc

After the order is placed, all orders that cannot be filled immediately are cancelled immediately

Response Data

Response

{"message":"OK","code":1000,"trace":"f7f74924-14da-42a6-b7f2-d3799dd9a612","data":{"order_id":1223181}}

Field	Type	Description
order_id	Long	Order ID

Query Order By Id (v4) (SIGNED)

Query a single order by orderId

Request URL

POST https://api-cloud.bitmart.com/spot/v4/query/order

Request Limit

Refer to Rate Limitation Details

Request Parameter

Request

curl-H'X-BM-KEY:{{AccessKey}}'-H'X-BM-TIMESTAMP:{{currentTime}}'-H'X-BM-SIGN:{{SIGN}}'-X POST-d'{  "orderId":"118100034543076010",  "queryState":"open",  "recvWindow":5000}'https://api-cloud.bitmart.com/spot/v4/query/order

Field	Type	Required?	Description
orderId	String	Yes	Order id
queryState	String	No	Query Type -`open`=Query order state [new, partially_filled] -`history`=QUery order state [filled, canceled, partially_canceled])
recvWindow	Long	No	Trade time limit, allowed range (0,60000], default: 5000 milliseconds

Note

IfqueryState is not filled in, all types of orders will be queried. If you know the order status, it is recommended to fill in, so that the query speed will be faster.
API transaction is not completed and the order is cancelled, the query time is within 20 minutes.

Response Details

Response

{"code":1000,"message":"success","data":{"orderId":"118100034543076010","clientOrderId":"118100034543076010","symbol":"BTC_USDT","side":"buy","orderMode":"spot","type":"limit","state":"filled","cancelSource":"","stpMode":"cancel_maker","price":"48800.00","priceAvg":"39999.00","size":"0.10000","filledSize":"0.10000","notional":"4880.00000","filledNotional":"3999.90000","createTime":1681701557927,"updateTime":1681701559408},"trace":"8aab576e50024648ae45e3cfaf90f9cf.60.16817015721880197"}

Field	Type	Description
orderId	String	Order ID
clientOrderId	String	User-defined ID
symbol	String	Trading pair (e.g. BTC_USDT)
side	String	Order side -`buy`=buy -`sell`=sell
orderMode	String	Order mode -`spot`=spot -`iso_margin`=isolated margin
type	String	Order type -`limit`=limit order -`market`=market order -`limit_maker`=PostOnly order -`ioc`=IOC order
state	String	Order status -`new`=The order has been accepted by the engine. -`partially_filled`=A part of the order has been filled. -`filled`=The order has been completed. -`canceled`=The order has been canceled. -`partially_canceled`=A part of the order has been filled , and the order has been canceled.
cancelSource	String	Order cancellation reason(Return value only if the order state iscanceled orpartially_canceled, otherwise it will return an empty string) -`user`=User manually canceled. -`system`=System automatically canceled. -`stp`=Stp Cancelled.
stpMode	String	Self transaction protection type -`none`=none -`cancel_maker`=cancel_maker -`cancel_taker`=cancel_taker -`cancel_both`=cancel_both
price	String	Order price
priceAvg	String	Average execution price of the order
size	String	Order quantity
filledSize	String	Actual execution quantity
notional	String	Order amount
filledNotional	String	Actual execution amount
createTime	Long	Order creation time in milliseconds, e.g. 1681701557927
updateTime	Long	Last update time in milliseconds, e.g. 1681701557927

Query Order By clientOrderId(v4) (SIGNED)

Query a single order by clientOrderId.

Request URL

POST https://api-cloud.bitmart.com/spot/v4/query/client-order

Request Limit

Request Parameter

Request

curl-H'X-BM-KEY:{{AccessKey}}'-H'X-BM-TIMESTAMP:{{currentTime}}'-H'X-BM-SIGN:{{SIGN}}'-X POST-d'{  "clientOrderId":"118100034543076010",  "queryState":"open",  "recvWindow":5000}'https://api-cloud.bitmart.com/spot/v4/query/client-order

Field	Type	Required?	Description
clientOrderId	String	Yes	User-defined order id
queryState	String	No	Query Type -`open`=Query order state [new, partially_filled] -`history`=Query order state [filled, canceled, partially_canceled])
recvWindow	Long	No	Trade time limit, allowed range (0,60000], default: 5000 milliseconds

Note

IfqueryState is not filled in, all types of orders will be queried. If you know the order status, it is recommended to fill in, so that the query speed will be faster.
API transaction is not completed and the order is cancelled, the query time is within 20 minutes.

Response Details

Response

{"code":1000,"message":"success","data":{"orderId":"118100034543076010","clientOrderId":"118100034543076010","symbol":"BTC_USDT","side":"buy","orderMode":"spot","type":"limit","state":"filled","cancelSource":"","stpMode":"cancel_maker","price":"48800.00","priceAvg":"39999.00","size":"0.10000","filledSize":"0.10000","notional":"4880.00000","filledNotional":"3999.90000","createTime":1681701557927,"updateTime":1681701559408},"trace":"8aab576e50024648ae45e3cfaf90f9cf.60.16817015721880197"}

Field	Type	Description
orderId	String	Order ID
clientOrderId	String	User-defined ID
symbol	String	Trading pair (e.g. BTC_USDT)
side	String	Order side -`buy`=buy -`sell`=sell
orderMode	String	Order mode -`spot`=spot -`iso_margin`=isolated margin
type	String	Order type -`limit`=limit order -`market`=market order -`limit_maker`=PostOnly order -`ioc`=IOC order
state	String	Order status -`new`=The order has been accepted by the engine. -`partially_filled`=A part of the order has been filled. -`filled`=The order has been completed. -`canceled`=The order has been canceled. -`partially_canceled`=A part of the order has been filled , and the order has been canceled.
cancelSource	String	Order cancellation reason(Return value only if the order state iscanceled orpartially_canceled, otherwise it will return an empty string) -`user`=User manually canceled. -`system`=System automatically canceled. -`stp`=Stp Cancelled.
stpMode	String	Self transaction protection type -`none`=none -`cancel_maker`=cancel_maker -`cancel_taker`=cancel_taker -`cancel_both`=cancel_both
price	String	Order price
priceAvg	String	Average execution price of the order
size	String	Order quantity
filledSize	String	Actual execution quantity
notional	String	Order amount
filledNotional	String	Actual execution amount
createTime	Long	Order creation time in milliseconds, e.g. 1681701557927
updateTime	Long	Last update time in milliseconds, e.g. 1681701557927

Current Open Orders(v4) (SIGNED)

Query the current opening order list of the account, only including state=[new, partially_filled] orders

Request URL

POST https://api-cloud.bitmart.com/spot/v4/query/open-orders

Request Limit

Request Parameter

Request

curl-H'X-BM-KEY:{{AccessKey}}'-H'X-BM-TIMESTAMP:{{currentTime}}'-H'X-BM-SIGN:{{SIGN}}'-X POST-d'{  "symbol":"BTC_USDT",  "orderMode":"spot",  "startTime":1682239652931,  "endTime":1682239657931,  "limit":10,  "recvWindow":5000}'https://api-cloud.bitmart.com/spot/v4/query/open-orders

Field	Type	Required?	Description
symbol	String	No	Trading pair (e.g. BTC_USDT)
orderMode	String	No	Order mode -`spot`=spot trade -`iso_margin`=isolated margin trade
startTime	Long	No	Start time in milliseconds, (e.g. 1681701557927)
endTime	Long	No	End time in milliseconds, (e.g. 1681701557927)
limit	Int	No	Number of queries, allowed range [1,200], default 200
recvWindow	Long	No	Trade time limit, allowed range (0,60000], default: 5000 milliseconds

Note

For high-volume trades, it is strongly recommended that users maintain their own current order list and use websocket to update the order status. You should pull the current order list once before each transaction.
symbol is not filled in, all trading pairs will be searched by default
orderMode is not filled in, and all order modes are searched by default
limit is not filled, the default is 200, if it is filled, it cannot exceed 200
If the time rangestartTime andendTime are not filled in, the data of the last 7 days will be displayed by default.
When filling in the time range,endTime must be greater than the value ofstartTime.
If onlystartTime is filled in, query the historical records starting from this timestamp.
If onlyendTime is filled in, query the historical records starting from this timestamp.

Response Details

Response

{"code":1000,"message":"success","data":[{"orderId":"125213058731346056","clientOrderId":"125213058731346056","symbol":"BTC_USDT","side":"buy","orderMode":"spot","type":"limit","state":"new","cancelSource":"","stpMode":"cancel_maker","price":"800.00","priceAvg":"0.00","size":"0.10000","filledSize":"0.00000","notional":"80.00000000","filledNotional":"0.00000000","createTime":1681892198608,"updateTime":1681892198946}],"trace":"5e1c9f98d761443ea559c7af71ca57fa.60.16818922069220005"}

Field	Type	Description
orderId	String	Order ID
clientOrderId	String	User-defined ID
symbol	String	Trading pair (e.g. BTC_USDT)
side	String	Order side -`buy`=buy -`sell`=sell
orderMode	String	Order mode -`spot`=spot -`iso_margin`=isolated margin
type	String	Order type -`limit`=limit order -`market`=market order -`limit_maker`=PostOnly order -`ioc`=IOC order
state	String	Order status -`new`=The order has been accepted by the engine. -`partially_filled`=a part of the order has been filled.
cancelSource	String	Order cancellation reason(Return value only if the order state iscanceled orpartially_canceled, otherwise it will return an empty string) -`user`=User manually canceled. -`system`=System automatically canceled.
stpMode	String	自成交保护类型 -`none`=不使用 -`cancel_maker`=撤销maker -`cancel_taker`=撤销taker -`cancel_both`=全部撤销
price	String	Order price
priceAvg	String	Average execution price of the order
size	String	Order quantity
filledSize	String	Actual execution quantity
notional	String	Order amount
filledNotional	String	Actual execution amount
createTime	Long	Order creation time in milliseconds, e.g. 1681701557927
updateTime	Long	Last update time in milliseconds, e.g. 1681701557927

Account Orders(v4) (SIGNED)

Query the account history order list, only including state=[filled, canceled, partially_canceled] orders

Request URL

POST https://api-cloud.bitmart.com/spot/v4/query/history-orders

Request Limit

Request Parameter

Request

curl-H'X-BM-KEY:{{AccessKey}}'-H'X-BM-TIMESTAMP:{{currentTime}}'-H'X-BM-SIGN:{{SIGN}}'-X POST-d'{  "symbol":"BTC_USDT",  "orderMode":"spot",  "startTime":1682239502394,  "endTime":1682239507394,  "limit":10,  "recvWindow":5000}'https://api-cloud.bitmart.com/spot/v4/query/history-orders

Field	Type	Required?	Description
symbol	String	No	Trading pair (e.g. BTC_USDT)
orderMode	String	No	Order mode -`spot`=spot trade -`iso_margin`=isolated margin trade
startTime	Long	No	Start time in milliseconds, (e.g. 1681701557927)
endTime	Long	No	End time in milliseconds, (e.g. 1681701557927)
limit	Int	No	Number of queries, allowed range [1,200], default 200
recvWindow	Long	No	Trade time limit, allowed range (0,60000], default: 5000 milliseconds

Note

symbol is not filled in, all trading pairs will be searched by default
orderMode is not filled in, and all order modes are searched by default
limit is not filled, the default is 200, if it is filled, it cannot exceed 200
If the time rangestartTime andendTime are not filled in, the data of the last 7 days will be displayed by default.
When filling in the time range,endTime must be greater than the value ofstartTime.
If onlystartTime is filled in, query the historical records starting from this timestamp.
If onlyendTime is filled in, query the historical records starting from this timestamp.

Response Details

Response

{"code":1000,"message":"success","data":[{"orderId":"118100034543076010","clientOrderId":"118100034543076010","symbol":"BTC_USDT","side":"buy","orderMode":"spot","type":"limit","state":"filled","cancelSource":"","stpMode":"cancel_maker","price":"48800.00","priceAvg":"39999.00","size":"0.10000","filledSize":"0.10000","notional":"4880.00000000","filledNotional":"3999.90000000","createTime":1681701557927,"updateTime":1681701559408}],"trace":"acc282ba9e434cc1a90bf6326de9e119.64.16818913787390001"}

Field	Type	Description
orderId	String	Order ID
clientOrderId	String	User-defined ID
symbol	String	Trading pair (e.g. BTC_USDT)
side	String	Order side -`buy`=buy -`sell`=sell
orderMode	String	Order mode -`spot`=spot -`iso_margin`=isolated margin
type	String	Order type -`limit`=limit order -`market`=market order -`limit_maker`=PostOnly order -`ioc`=IOC order
state	String	Order status -`filled`=The order has been completed. -`canceled`=The order has been canceled. -`partially_canceled`=A part of the order has been filled , and the order has been canceled.
cancelSource	String	Order cancellation reason(Return value only if the order state iscanceled orpartially_canceled, otherwise it will return an empty string) -`user`=User manually canceled. -`system`=System automatically canceled. -`stp`=Stp Cancelled.
stpMode	String	Self transaction protection type -`none`=none -`cancel_maker`=cancel_maker -`cancel_taker`=cancel_taker -`cancel_both`=cancel_both
price	String	Order price
priceAvg	String	Average execution price of the order
size	String	Order quantity
filledSize	String	Actual execution quantity
notional	String	Order amount
filledNotional	String	Actual execution amount
createTime	Long	Order creation time in milliseconds, e.g. 1681701557927
updateTime	Long	Last update time in milliseconds, e.g. 1681701557927

Account Trade List(v4) (SIGNED)

Query all transaction records of the account

Request URL

POST https://api-cloud.bitmart.com/spot/v4/query/trades

Request Limit

Request Parameter

Request

 curl-H'X-BM-KEY:{{AccessKey}}'-H'X-BM-TIMESTAMP:{{currentTime}}'-H'X-BM-SIGN:{{SIGN}}'-X POST-d'{  "symbol":"BTC_USDT",  "orderMode":"spot",  "startTime":1682239845952,  "endTime":1682239850952,  "limit":10,  "recvWindow":5000}'https://api-cloud.bitmart.com/spot/v4/query/trades

Field	Type	Required?	Description
symbol	String	No	Trading pair (e.g. BTC_USDT)
orderMode	String	No	Order mode -`spot`=spot trade -`iso_margin`=isolated margin trade
startTime	Long	No	Start time in milliseconds, (e.g. 1681701557927)
endTime	Long	No	End time in milliseconds, (e.g. 1681701557927)
limit	Int	No	Number of queries, allowed range [1,200], default 200
recvWindow	Long	No	Trade time limit, allowed range (0,60000], default: 5000 milliseconds

Note

symbol is not filled in, all trading pairs will be searched by default
orderMode is not filled in, and all order modes are searched by default
limit is not filled, the default is 200, if it is filled, it cannot exceed 200
If the time rangestartTime andendTime are not filled in, the data of the last 7 days will be displayed by default.
When filling in the time range,endTime must be greater than the value ofstartTime.
If onlystartTime is filled in, query the historical records starting from this timestamp.
If onlyendTime is filled in, query the historical records starting from this timestamp.

Response Details

Response

{"code":1000,"message":"success","data":[{"tradeId":"125277182593091639","orderId":"125213058731346053","clientOrderId":"125213058731346053","symbol":"BTC_USDT","side":"buy","orderMode":"spot","type":"limit","stpMode":"cancel_maker","price":"39999.00","size":"0.10000","notional":"3999.90000000","fee":"9.99975000","feeCoinName":"USDT","tradeRole":"taker","createTime":1681891896569,"updateTime":1681891896569}],"trace":"5e1c9f98d761443ea559c7af71ca57fa.61.16819603026240455"}

Field	Type	Description
tradeId	String	Trade id
orderId	String	Order ID
clientOrderId	String	User-defined ID
symbol	String	Trading pair (e.g. BTC_USDT)
side	String	Order side -`buy`=buy -`sell`=sell
orderMode	String	Order mode -`spot`=spot -`iso_margin`=isolated margin
type	String	Order type -`limit`=limit order -`market`=market order -`limit_maker`=PostOnly order -`ioc`=IOC order
stpMode	String	Self transaction protection type -`none`=none -`cancel_maker`=cancel_maker -`cancel_taker`=cancel_taker -`cancel_both`=cancel_both
price	String	Transaction price
size	String	Transaction quantity
notional	String	Transaction amount
fee	String	Fee amount
feeCoinName	String	Fee coin name
tradeRole	String	Trade role -`taker`=Take orders, take the initiative to deal -`maker`=Pending order, passive transaction
createTime	Long	Order creation time in milliseconds, e.g. 1681701557927
updateTime	Long	Last update time in milliseconds, e.g. 1681701557927

Order Trade List(v4) (SIGNED)

Query all transaction records of a single order

Request URL

POST https://api-cloud.bitmart.com/spot/v4/query/order-trades

Request Limit

Request Parameter

Request

 curl-H'X-BM-KEY:{{AccessKey}}'-H'X-BM-TIMESTAMP:{{currentTime}}'-H'X-BM-SIGN:{{SIGN}}'-X POST-d'{  "orderId":"118100034543076010",  "recvWindow":5000}'https://api-cloud.bitmart.com/spot/v4/query/order-trades

Field	Type	Required?	Description
orderId	String	Yes	Order id
recvWindow	Long	No	Trade time limit, allowed range (0,60000], default: 5000 milliseconds

Note

orderId OrderID is required and cannot be empty

Response Details

Response

{"code":1000,"message":"success","data":[{"tradeId":"122177405911172002","orderId":"118100034543076010","clientOrderId":"118100034543076010","symbol":"BTC_USDT","side":"buy","orderMode":"spot","type":"limit","stpMode":"cancel_maker","price":"39999.00","size":"0.10000","notional":"3999.90000000","fee":"9.99975000","feeCoinName":"USDT","tradeRole":"taker","createTime":1681701559210,"updateTime":1681701559210}],"trace":"5e1c9f98d761443ea559c7af71ca57fa.62.16818934219090007"}

Field	Type	Description
tradeId	String	Trade id
orderId	String	Order ID
clientOrderId	String	User-defined ID
symbol	String	Trading pair (e.g. BTC_USDT)
side	String	Order side -`buy`=buy -`sell`=sell
orderMode	String	Order mode -`spot`=spot -`iso_margin`=isolated margin
type	String	Order type -`limit`=limit order -`market`=market order -`limit_maker`=PostOnly order -`ioc`=IOC order
stpMode	String	Self transaction protection type -`none`=none -`cancel_maker`=cancel_maker -`cancel_taker`=cancel_taker -`cancel_both`=cancel_both
price	String	Transaction price
size	String	Transaction quantity
notional	String	Transaction amount
fee	String	Fee amount
feeCoinName	String	Fee coin name
tradeRole	String	Trade role -`taker`=Take orders, take the initiative to deal -`maker`=Pending order, passive transaction
createTime	Long	Order creation time in milliseconds, e.g. 1681701557927
updateTime	Long	Last update time in milliseconds, e.g. 1681701557927

Margin Loan

Margin Borrow (Isolated) (SIGNED)

Applicable to isolated margin account borrowing operations

Request URL

POST https://api-cloud.bitmart.com/spot/v1/margin/isolated/borrow

Request Limit

Request Parameter

Request

curl-H'X-BM-KEY:{{AccessKey}}'-H'X-BM-TIMESTAMP:{{currentTime}}'-H'X-BM-SIGN:{{SIGN}}'-X POST-d'{    "symbol":"BTC_USDT",    "currency":"BTC",    "amount":"1"}'https://api-cloud.bitmart.com/spot/v1/margin/isolated/borrow

Field	Type	Required?	Description
symbol	String	Yes	Trading pair (e.g. BMX_USDT)
currency	String	Yes	Borrowing currency, selected according to the borrowing trading pair(like BTC or USDT)
amount	String	Yes	Amount of borrowing (precision: 8 decimal places)

Response Data

Response

{"message":"OK","code":1000,"trace":"f7f74924-14da-42a6-b7f2-d3799dd9a612","data":{"borrow_id":"113896"}}

Field	Type	Description
borrow_id	String	Borrowing order ID, only successful borrowing will be returned

Margin Repay (Isolated) (SIGNED)

Applicable to isolated margin account repayment operations

Request URL

POST https://api-cloud.bitmart.com/spot/v1/margin/isolated/repay

Request Limit

Request Parameter

Request

curl-H'X-BM-KEY:{{AccessKey}}'-H'X-BM-TIMESTAMP:{{currentTime}}'-H'X-BM-SIGN:{{SIGN}}'-X POST-d'{    "symbol":"BTC_USDT",    "currency":"BTC",    "amount":"1"}'https://api-cloud.bitmart.com/spot/v1/margin/isolated/repay

Field	Type	Required?	Description
symbol	String	Yes	Trading pair (e.g. BMX_USDT)
currency	String	Yes	Repayment currency, selected according to the borrowing trading pair(like BTC or USDT)
amount	String	Yes	Amount of repayments (precision: 8 decimal places)

Response Data

Response

{"message":"OK","code":1000,"trace":"f7f74924-14da-42a6-b7f2-d3799dd9a612","data":{"repay_id":"123165"}}

Field	Type	Description
repay_id	String	Repayment order ID, only successful repayment will be returned

Get Borrow Record(Isolated) (KEYED)

Applicable to the inquiry of borrowing records of an isolated margin account

Request URL

GET https://api-cloud.bitmart.com/spot/v1/margin/isolated/borrow_record

Request Limit

Request Parameter

Request

curl-H'X-BM-KEY:{{AccessKey}}' https://api-cloud.bitmart.com/spot/v1/margin/isolated/borrow_record?symbol=BTC_USDT

Field	Type	Required?	Description
symbol	String	Yes	Trading pair (e.g. BMX_USDT)
borrow_id	String	No	Borrow order id
start_time	Long	No	Query start time: Timestamp
end_time	Long	No	Query end time: Timestamp
N	Int	No	Query record size, allowed range[1-100]. Default is 50

Response Data

Response

{"message":"OK","code":1000,"trace":"f7f74924-14da-42a6-b7f2-d3799dd9a612","data":{"records":[{"borrow_id":"133425","symbol":"BTC_USDT","currency":"BTC","borrow_amount":"1.23854339","daily_interest":"0.05","hourly_interest":"0.00208334","interest_amount":"0.02398474","create_time":1655345808},...]}}

Field	Type	Description
borrow_id	String	Borrow order id
symbol	String	Trading pair
currency	String	Currency
borrow_amount	String	The total principal amount borrowed (precision: 8 decimal places)
daily_interest	String	Daily interest
hourly_interest	String	Hourly interest
interest_amount	String	Total interest (precision: 8 decimal places)
create_time	Long	Order creation time

Get Repayment Record(Isolated) (KEYED)

Applicable to the inquiry of repayment records of isolated margin account

Request URL

GET https://api-cloud.bitmart.com/spot/v1/margin/isolated/repay_record

Request Limit

Request Parameter

Request

curl-H'X-BM-KEY:{{AccessKey}}'https://api-cloud.bitmart.com/spot/v1/margin/isolated/repay_record?symbol=BTC_USDT

Field	Type	Required?	Description
symbol	String	Yes	Trading pair (e.g. BMX_USDT)
repay_id	String	No	Repayment ID
currency	String	No	Currency
start_time	Long	No	Query start time: Timestamp
end_time	Long	No	Query end time: Timestamp
N	Int	No	Query record size, allowed range[1-100]. Default is 50

Response Data

Response

{"message":"OK","code":1000,"trace":"f7f74924-14da-42a6-b7f2-d3799dd9a612","data":{"records":[{"repay_id":"118723","repay_time":1655345808,"symbol":"BTC_USDT","currency":"BTC","repaid_amount":"1.1","repaid_principal":"1","repaid_interest":"0.1"},...]}}

Field	Type	Description
repay_id	String	Repayment ID
repay_time	Long	Repayment Timestamp
symbol	String	Repayment trading pairs(like BTC_USDT)
currency	String	Repayment currency
repaid_amount	String	Repayment amount
repaid_principal	String	The principal amount returned by this repayment
repaid_interest	String	Interest returned by this repayment

Get Trading Pair Borrowing Rate and Amount (KEYED)

Applicable for checking the borrowing rate and borrowing amount of trading pairs

Request URL

GET https://api-cloud.bitmart.com/spot/v1/margin/isolated/pairs

Request Limit

Sub-Account interface function is currently open to institutional users only, and will be opened gradually

Request Parameter

Request

curl-H'X-BM-KEY:{{AccessKey}}'https://api-cloud.bitmart.com/spot/v1/margin/isolated/pairs?symbol=BTC_USDT

Field	Type	Required?	Description
symbol	String	No	It can be multiple-choice; if not filled in, then return all, like BTC_USDT, ETH_USDT

Response Data

Response

{"message":"OK","code":1000,"trace":"f7f74924-14da-42a6-b7f2-d3799dd9a612","data":{"symbols":[{"symbol":"BTC_USDT","max_leverage":"10","symbol_enabled":true,"base":{"currency":"BTC","daily_interest":"0.05","hourly_interest":"0.00208334","max_borrow_amount":"1000.00000000","min_borrow_amount":"1.00000000","borrowable_amount":"955.90221219"},"quote":{"currency":"USDT","daily_interest":"0.05","hourly_interest":"0.00208334","max_borrow_amount":"12000.00000000","min_borrow_amount":"0.01000000","borrowable_amount":"12000.00000000"}},...]}}

Field	Type	Description
symbol	String	Trading pair
max_leverage	String	Leverage multiplier
symbol_enabled	Boolean	Whether the trading pair is enabled
currency	String	Currency
daily_interest	String	Daily interest
hourly_interest	String	Hourly interest
max_borrow_amount	String	The maximum amount of borrowing (precision: 8 decimal places)
min_borrow_amount	String	The minimum amount of borrowing (precision: 8 decimal places)
borrowable_amount	String	The current available amount of borrowing (precision: 8 decimal places)

Sub-Account

Sub-Account to Main-Account (For Main Account) (SIGNED)

Sub-account spot asset transfer to Main-account (For Main Account)

Request URL

POST https://api-cloud.bitmart.com/account/sub-account/main/v1/sub-to-main

Request Limit

Request Parameter

Request

curl-H'X-BM-KEY:{{AccessKey}}'-H'X-BM-TIMESTAMP:{{currentTime}}'-H'X-BM-SIGN:{{SIGN}}'-X POST-d'{    "requestNo":"4e2adcff-2122-1ce7-2557-4f65d2ce1ca2",    "amount":"1",    "currency":"BTC",    "subAccount":"[email protected]"}'https://api-cloud.bitmart.com/account/sub-account/main/v1/sub-to-main

Field	Type	Required?	Description
requestNo	String	Yes	UUID,unique identifier, max length 64
amount	String	Yes	Transfer amount
currency	String	Yes	Currency
subAccount	String	Yes	Sub-Account username

Response Data

Response

{"code":1000,"trace":"886fb6ae-456b-4654-b4e0-d681ac05cea1","message":"OK","data":{}}

If code value is 1000,it means the transfer is successful.

Sub-Account to Main-Account (For Sub-Account) (SIGNED)

Sub-Account spot asset transfer to Main-Account spot asset (For Sub-Account)

Request URL

POST https://api-cloud.bitmart.com/account/sub-account/sub/v1/sub-to-main

Request Limit

Request Parameter

Request

curl-H'X-BM-KEY:{{AccessKey}}'-H'X-BM-TIMESTAMP:{{currentTime}}'-H'X-BM-SIGN:{{SIGN}}'-X POST-d'{    "requestNo":"4e2adcff-2122-1ce7-2557-4f65d2ce1ca2",    "amount":"1",    "currency":"BTC"}'https://api-cloud.bitmart.com/account/sub-account/sub/v1/sub-to-main

Field	Type	Required?	Description
requestNo	String	Yes	UUID,unique identifier, max length 64
amount	String	Yes	Transfer amount
currency	String	Yes	Currency

Response Data

Response

{"code":1000,"trace":"886fb6ae-456b-4654-b4e0-d681ac05cea1","message":"OK","data":{}}

If code value is 1000,it means the transfer is successful.

Main-Account to Sub-Account (For Main Account) (SIGNED)

Main-account spot asset transfer to Sub-account spot asset (For Main Account)

Request URL

POST https://api-cloud.bitmart.com/account/sub-account/main/v1/main-to-sub

Request Limit

Request Parameter

Request

curl-H'X-BM-KEY:{{AccessKey}}'-H'X-BM-TIMESTAMP:{{currentTime}}'-H'X-BM-SIGN:{{SIGN}}'-X POST-d'{    "requestNo":"4e2adcff-2122-1ce7-2557-4f65d2ce1ca2",    "amount":"1",    "currency":"BTC",    "subAccount":"[email protected]"}'https://api-cloud.bitmart.com/account/sub-account/main/v1/main-to-sub

Field	Type	Required?	Description
requestNo	String	Yes	UUID,unique identifier, max length 64
amount	String	Yes	Transfer amount
currency	String	Yes	Currency
subAccount	String	Yes	Sub-Account username

Response Data

Response

{"code":1000,"trace":"886fb6ae-456b-4654-b4e0-d681ac05cea1","message":"OK","data":{}}

If code value is 1000,it means the transfer is successful.

Sub-Account to Sub-Account (For Main Account) (SIGNED)

Sub-Account spot asset transfer to Sub-Account spot asset (For Main Account)

Request URL

POST https://api-cloud.bitmart.com/account/sub-account/main/v1/sub-to-sub

Request Limit

Request Parameter

Request

curl-H'X-BM-KEY:{{AccessKey}}'-H'X-BM-TIMESTAMP:{{currentTime}}'-H'X-BM-SIGN:{{SIGN}}'-X POST-d'{    "requestNo":"4e2adcff-2122-1ce7-2557-4f65d2ce1ca2",    "amount":"1",    "currency":"BTC",    "fromAccount":"[email protected]",    "toAccount":"[email protected]"}'https://api-cloud.bitmart.com/account/sub-account/main/v1/sub-to-sub

Field	Type	Required?	Description
requestNo	String	Yes	UUID,unique identifier, max length 64
amount	String	Yes	Transfer amount
currency	String	Yes	Currency
fromAccount	String	Yes	Transfer out Sub-Account username
toAccount	String	Yes	Transfer to Sub-Account username

Response Data

Response

{"code":1000,"trace":"886fb6ae-456b-4654-b4e0-d681ac05cea1","message":"OK","data":{}}

If code value is 1000,it means the transfer is successful.

Get Sub-Account Transfer History (For Main Account) (KEYED)

Query Sub-Account Spot Asset Transfer History (For Main Account)

Request URL

GET https://api-cloud.bitmart.com/account/sub-account/main/v1/transfer-list

Request Limit

Note: Only the data for the last 3 months can be queried

Request Parameter

Request

curl-H'X-BM-KEY:{{AccessKey}}'https://api-cloud.bitmart.com/account/sub-account/main/v1/transfer-list?moveType=spot to spot

Field	Type	Required?	Description
moveType	String	Yes	type -`spot to spot`=Spot wallet transfer to spot wallet
accountName	String	No	Sub-Account username (default: all sub-accounts will be queried)
N	Int	Yes	Recent N records, allowed range[1,100]

Response Data

Response

{"message":"OK","code":1000,"trace":"282fd16e-73ee-464f-adb7-7241345929f6","data":{"total":2,"historyList":[{"fromAccount":"[email protected]","fromWalletType":"spot","toAccount":"[email protected]","toWalletType":"spot","currency":"BTC","amount":"1","submissionTime":1648471522},{"fromAccount":"[email protected]","fromWalletType":"spot","toAccount":"[email protected]","toWalletType":"spot","currency":"BTC","amount":"30","submissionTime":1648466178}]}}

Field	Type	Description
fromAccount	String	Transfer out Sub-Account username
fromWalletType	String	Transfer out wallet type -`spot`=spot wallet
toAccount	String	Transfer to Sub-Account username
toWalletType	String	Transfer to wallet type -`spot`=spot wallet
currency	String	currency
amount	String	Transfer amount
submissionTime	Long	The request timestamp is accurate to seconds(UTC-0)

Get Account Spot Asset Transfer History (For Main/Sub Account) (KEYED)

Get account spot asset transfer history (For Main/Sub Account)

Request URL

GET https://api-cloud.bitmart.com/account/sub-account/v1/transfer-history

Request Limit

Note: Only the data for the last 3 months can be queried

Request Parameter

Request

curl-H'X-BM-KEY:{{AccessKey}}'https://api-cloud.bitmart.com/account/sub-account/v1/transfer-history?moveType=spot to spot

Field	Type	Required?	Description
moveType	String	Yes	type -`spot to spot`=Spot wallet transfer to spot wallet
N	Int	Yes	Recent N records, allowed range[1,100]

Response Data

Response

{"message":"OK","code":1000,"trace":"282fd16e-73ee-464f-adb7-7241345929f6","data":{"total":2,"historyList":[{"fromAccount":"[email protected]","fromWalletType":"spot","toAccount":"[email protected]","toWalletType":"spot","currency":"BTC","amount":"1","submissionTime":1648471522},{"fromAccount":"[email protected]","fromWalletType":"spot","toAccount":"[email protected]","toWalletType":"spot","currency":"BTC","amount":"30","submissionTime":1648466178}]}}

Field	Type	Description
fromAccount	String	Transfer out Sub-Account username
fromWalletType	String	Transfer out wallet type -`spot`=spot wallet
toAccount	String	Transfer to Sub-Account username
toWalletType	String	Transfer to wallet type -`spot`=spot wallet
currency	String	currency
amount	String	Transfer amount
submissionTime	Long	The request timestamp is accurate to seconds(UTC-0)

Get Sub-Account Spot Wallet Balance (For Main Account) (KEYED)

Get Sub-Account spot wallet balance (For Main Account)

Request URL

GET https://api-cloud.bitmart.com/account/sub-account/main/v1/wallet

Request Limit

The return list contains only assets with a balance greater than 0.

Request Parameter

Request

curl-H'X-BM-KEY:{{AccessKey}}'https://api-cloud.bitmart.com/account/sub-account/main/v1/wallet?subAccount=[email protected]

Field	Type	Required?	Description
subAccount	String	Yes	Sub-Account username
currency	String	No	currency

Response Data

Response

{"message":"OK","code":1000,"trace":"ef834248-51d3-4223-9481-f862aa9dd39f","data":{"wallet":[{"currency":"USDT","name":"Tether USD","available":"1000.00000000","frozen":"0.00000000"},{"currency":"BTC","name":"Bitcoin","available":"10000.00000000","frozen":"10.00000000"}]}}

Field	Type	Description
currency	String	Token symbol, e.g., 'BTC'
name	String	Token name, e.g., 'Bitcoin'
available	String	Available Balance
frozen	String	Frozen Balance

Get Sub-Account List (For Main Account) (KEYED)

Get Sub-Account list (For Main Account)

Request URL

GET https://api-cloud.bitmart.com/account/sub-account/main/v1/subaccount-list

Request Limit