Update Plan

• The KeepAlive mechanism of spot websocket now supports clients sending ping frames and ping text to maintain the connection. In the future we will only support ping text, not ping frames
• After 2024-06-30, BitMart will stop providing the following endpoints:

Change Log

2024-11-11

REST API

• [Update] /spot/v1/margin/submit_order New Margin Order(v1) (SIGNED)
  • The rate limit 1 times/1s based on API Key changes to 20 times/1s based on UID

2024-10-21

REST API

• [Update] /spot/v4/cancel_orders Cancel Batch Order(v4) (SIGNED)
  • The maximum number of orderIds in the request parameter is 10.
  • The maximum number of clientOrderIds in the request parameter is 10.

2024-10-09

REST API

• [Update] /spot/v1/user_fee Get Basic Fee Rate (KEYED)
  • Add new response field taker_fee_rate_D
  • Add new response field maker_fee_rate_D

2024-08-06

REST API

• [New] /spot/v4/cancel_all Cancel All Order(v4) (SIGNED)

2024-07-24

REST API

• [Delete] Public Market Data (History Version) document directory removed
• [Delete] Spot / Margin Trading (History Version) document directory remove

2024-06-30

WebSocket Steam: User private channels will implement the following frequency and flow limits::

• [Update] [Private] Balance Change channel
• [Update] [Private] Order Progress channel

The specific restriction rules are as follows:

• Each IP can maintain up to 10 connections with the private channel server.
• Once connected, allows clients to subscribe to up to 100 channels per connection.
• Send message rate limit:
  1. Initiate connection: Clients can initiate a maximum of 30 requests to connect to the BitMart server within 1 minute.
  2. Once connected: Clients can sending a maximum of 100 subscription messages within 10 seconds, message includes: PING frame, PONG frame, PING text, JSON format messages (subscription and unsubscription).
  3. Once connected: A maximum of 20 messages arrays can be sent by clients for a single subscription.
• If the user sends more messages than the limit, the connection will be disconnected. IPs that are repeatedly disconnected will be blocked by the server.

2024-05-28

Websocket Stream

• [Update] [Private] Order Progress channel
  • Feature：Supports one subscription request to subscribe to the order transaction progress of all trading pairs

2024-05-17

REST API

• [New] /spot/v4/batch_orders New Batch Order(v4) (SIGNED)
• [New] /spot/v4/cancel_orders Cancel Batch Order(v4) (SIGNED)

2024-04-23

Websocket Stream

• [Update] [Private] Balance Change channel
  • New type value for event_type field: BMX_DEDUCTION=BMX handling fee deduction

2024-04-03

REST API

• [Update] /account/v1/withdraw/charge Withdraw Quota (KEYED)
  • Add new response field withdraw_Precision_GeTen

2024-03-12

REST API

• [Update] /spot/v4/query/order Query Order By Id (v4) (SIGNED)
  • Response field state add new value failed

2024-03-07

REST API

• [Delete] /account/sub-account/sub/v1/sub-to-sub Sub-Account to Sub-Account (For Sub-Account) (SIGNED)

2024-02-29

Websocket Stream

• [Update] [Public] Ticker channel
  • Add a successful subscription message and return it to the client
  • Add new response field ms_t
  • Add new response field fluctuation
  • Add new response field bid_px
  • Add new response field bid_sz
  • Add new response field ask_px
  • Add new response field ask_sz
  • Add new response field quote_volume_24h
  • Bug fixed field base_volume_24h value
• [Update] [Public] KLine channel
  • Add a successful subscription message and return it to the client
  • Change the K-line generation time to the opening time of this K-line
• [Update] [Public] Depth-All channel
  • Add a successful subscription message and return it to the client
• [Update] [Public] Depth-Increase channel
  • Add a successful subscription message and return it to the client
• [Update] [Public] Trade channel
  • Add a successful subscription message and return it to the client
  • Add new response field ms_t
• [Update] [Private] Order Progress channel
  • Add a successful subscription message and return it to the client
  • Add new response field create_time
  • Add new response field update_time
  • Add new response field order_mode
  • Add new response field entrust_type
  • Add new response field order_state
• [Update] [Private] Balance Change channel
  • Add a successful subscription message and return it to the client

2024-02-19

REST API

• [Update] /account/v1/withdraw/apply Withdraw (SIGNED)
  • Feature: Withdrawal to accounts registered on the exchange

2023-10-27

Websocket Stream

• [New] spot/depth/increase100:<symbol> 【Private】Depth-Increase channel
  • Feature: Spot depth incremental push

2023-09-08

Websocket Stream

• [New] spot/user/balance:BALANCE_UPDATE 【Private】Balance Change
  • Feature: Spot balance changes push

2023-08-14

REST API

• [New] /spot/quotation/v3/tickers Get Ticker of All Pairs (V3)
• [New] /spot/quotation/v3/ticker Get Ticker of a Trading Pair(V3)
• [New] /spot/quotation/v3/lite-klines Get Latest K-Line (V3)
• [New] /spot/quotation/v3/klines Get History K-Line (V3)
• [New] /spot/quotation/v3/books Get Depth(V3)
• [New] /spot/quotation/v3/trades Get Recent Trades(V3)

2023-05-09

REST API

• [New] /spot/v4/query/order Query order by id (v4)
• [New] /spot/v4/query/client-order Query order by client order id (v4)
• [New] /spot/v4/query/open-orders Current open orders (v4)
• [New] /spot/v4/query/history-orders Account orders (v4)
• [New] /spot/v4/query/trades Account trade list (v4)
• [New] /spot/v4/query/order-trades Order trade list(v4)

2023-03-03

REST API

• [Update] /spot/v1/user_fee Get user fee rate
  • Add new response field taker_fee_rate_C
  • Add new response field maker_fee_rate_C

2022-12-22

• Update endpoints for Spot
  • WebSocket Subscription-【Private】Order Progress add new order status 12 = Partially filled and canceled

2022-11-03

• Update endpoints for Spot / Margin trading
  • /spot/v3/orders /spot/v2/tradesadd start_time and end_time field for flexible querying
  • add new order status 11 = Partially filled and canceled

2022-11-01

• Update endpoints for Account
  • /account/v1/currenciesAdd new field contract_address,withdraw_minsize and withdraw_minfee

2022-10-11

• The new version of market data-relateded endpoints
  • /spot/v2/ticker
  • /spot/v1/ticker_detail

2022-09-29

• New spot trading endpoints
  • /spot/v2/submit_order
  • /spot/v2/batch_orders
  • /spot/v3/cancel_order
  • /spot/v2/order_detail
  • /spot/v3/orders
  • /spot/v2/trades

2022-08-16

• New Endpoint for Trade Fee
  • /spot/v1/trade_fee
• New Endpoint for Basic Fee
  • /spot/v1/user_fee

2022-07-07

• New endpoints for the margin loan
  • /spot/v1/margin/isolated/borrow
  • /spot/v1/margin/isolated/repay
  • /spot/v1/margin/isolated/borrow_record
  • /spot/v1/margin/isolated/repay_record
  • /spot/v1/margin/isolated/pairs
• New endpoint for margin trading
  • /spot/v1/margin/submit_order
• New endpoints for margin accounts
  • /spot/v1/margin/isolated/account
  • /spot/v1/margin/isolated/transfer
• Update endpoints for Spot / Margin trading
  • A new "order_mode" field has been added to the following endpoints to distinguish whether the order originates from a spot or margin trade
  • /spot/v1/order_detail
  • /spot/v2/orders
  • /spot/v1/trades

2022-05-24

• Update endpoints for Spot
  • /spot/v2/ordersAdd new field clientOrderId
  • /spot/v1/tradesAdd new field clientOrderId
  • /spot/v1/order_detailAdd new field clientOrderId

2022-04-19

• New sub-account endpoints
  • /sub-account/main/v1/sub-to-main
  • /sub-account/sub/v1/sub-to-main
  • /sub-account/main/v1/main-to-sub
  • /sub-account/sub/v1/sub-to-sub
  • /sub-account/main/v1/sub-to-sub
  • /sub-account/main/v1/transfer-list
  • /sub-account/v1/transfer-history
  • /sub-account/main/v1/wallet
  • /sub-account/main/v1/subaccount-list
• Update WebSocket Order Progress channel
  • Add new field client_order_id
  • Add new field detail_id

2022-03-29

• WebSocket subscription, 【private】 order channel renamed to 【private】 order progress
• New parameter exec_type is added to 【Private】 order progress channel, which indicates liquidity type

2022-03-08

• Improvement of Websocket connection holding
• Catalog level repair to enhance readability

2022-03-01

• support user to create , request and cancel order through client-defined OrderId

2022-02-15

• increase the maximum rate limit based on users' feedback
• improve UI of the document

2022-01-20

• Update endpoints for Spot
  • /spot/v1/symbols/detailsAdd a new respond parameter trade_status, to show the trading status of a trading pair symbol.

2022-01-18

• websocket public channel addresswss://ws-manager-compress.bitmart.com?protocol=1.1will be taken down on 2022-02-28 UTC time,The new address iswss://ws-manager-compress.bitmart.com/api?protocol=1.1

2021-11-24

• New endpoints for Spot
  • /spot/v2/ordersGet User Order History V2
  • /spot/v1/batch_ordersBatch Order
• Update endpoints for Spot
  • /spot/v1/symbols/klineAdd new field 'quote_volume'
  • /spot/v1/symbols/tradesAdd optional parameter N to return the number of items, the default is up to 50 items
  • /spot/v1/order_detailAdd new field 'unfilled_volume'
  • /spot/v1/submit_orderThe request parameter type added limit_maker and ioc order types
• New endpoints for Account
  • /account/v2/deposit-withdraw/historyGet Deposit And Withdraw History V2
• Update endpoints for Account
  • /account/v1/walletRemove the account_type,Only respond to currency accounts; you can bring currency parameters (optional)

2021-11-06

• Update endpoints for Spot WebSocket
  • Public-Depth Channel:
  • spot/depth50 50 Level Depth Channel
  • spot/depth100 100 Level Depth Channel
  • User-Trade Channel:
  • Eligible pushes add new orders successfully

2021-01-19

• New endpoints for Spot WebSocket
  • Public - ticket channels
  • Public - K channel
  • Public - trading channels
  • Public - depth channels
  • Login
  • User - Trading Channel

2020-07-15

• New endpoints for Spot
  • /spot/v2/cancel_orderCancel an outstanding order，V2

2020-06-29

• New endpoints for Account
  • /account/v1/currenciesGet Currency
    
  • /account/v1/walletGet Account Balance
    
  • /account/v1/deposit/addressDeposit Address
    
  • /account/v1/withdraw/chargeWithdraw Quota
    
  • /account/v1/withdraw/applyWithdraw
    
  • /account/v1/recharge-withdraw/historyGet Deposit And Withdraw History
  • /account/v1/recharge-withdraw/detailGet A Deposit Or Withdraw Detail

2020-05-14

• New endpoints for Spot
  • /spot/v1/currenciesGet a list of all cryptocurrencies on the platform
  • /spot/v1/symbolsGet a list of all trading pairs on the platform
  • /spot/v1/symbols/detailsGet a detailed list of all trading pairs on the platform
  • /spot/v1/tickerGet ticker
  • /spot/v1/stepsGet K-Line steps
  • /spot/v1/symbols/klineGet k-Line
  • /spot/v1/symbols/bookGet orderbook
  • /spot/v1/symbols/tradesGet trades
  • /spot/v1/walletGet user wallet
  • /spot/v1/submit_orderPlace order
  • /spot/v1/cancel_orderCancel order
  • /spot/v1/cancel_ordersCancel all outstanding orders in the specified direction for the specified trading pair
  • /spot/v1/order_detailGet order details
  • /spot/v1/ordersGet user recent orders
  • /spot/v1/tradesGet user trade history

Introduction

API Key Create

• Many APIs require an API Access Key for access. Please refer to this page to set up.
• When setting up an API Access Key, it is recommended to set up an IP access whitelist for security purposes.
• Never give your API Access key/secret key to anyone.

After creating an API Key, you will receive three pieces of information that you must remember:

• Access Key: represents the identity of the account, this is your api key
• Secret Key: used for API signature
• Memo: used for API signature

The Access Key and Secret Key will be randomly generated and provided by BitMart, and the Memo will be provided by you to ensure the security of API access.

API Key Permission Settings

• The default permission of a newly created API is Read-Only.
• To withdraw funds through the API, you need to modify the permissions in the UI and select Withdraw.
• Permission descriptions:
  • Read-only (query spot trading orders, query contract trading orders, query funds)
  • Spot-Trade (place orders, cancel orders)
  • Withdraw (withdraw funds)
  • Margin-Trade (repayment, borrowing, placing orders, etc.)
  • Future-Trade (long position, short position, closing position, etc.)

Read-Only Permissions:

Withdraw Permissions:

Spot-Trade Permissions:

Margin-Trade Permissions:

Future-Trade Permissions:

Sub-Account Permissions:

You need to enter Institution Verification to use the sub-account endpoints.

After the creation is successful, the sub-account has Read-only permission by default.

Sub-Account Spot-Trade Permissions:

Same as the above spot trading authority

Sub-Account Contract-Trade Permissions:

Same as above futures trading authority

Sub-Account Inter-Account Transfer Permissions:

API Library

In order to facilitate access, we provide SDK in some languages for reference. For more programming codes, please refer to the Quick Start API on the page.

Available SDK:

• Java
• Python
• Nodejs
• Go
• PHP

In addition to the SDK, we also provide code samples in multiple languages, and the samples mainly demonstrate how to use the signed interface. It can be built and run standalone or as part of your codebase.

• Python Signature Example
• Go Signature Example
• Nodejs Signature Example
• Java Signature Example
• PHP Signature Example
• Ruby Signature Example
• C# Signature Example
• Rust Signature Example
• C++ Signature Example
• Postman

FAQ

Here are some frequently asked questions.

Q1. Will different API KEY in the same account return different data?

Q2. How to fill information in when applying for APIKEY?

Q3. How is the HTTP status code 429 created?

Q4. Using ccxt, the API KEY is correctly filled in, but it will also prompt 'message': 'Header X-BM-SIGN is wrong'

Q5. The program I wrote myself always prompts 'message': 'Header X-BM-SIGN is wrong'

Q6. Where is the location of BitMart servers?

Q7. When will the VIP fee I applied for take effect?

Q8. Why does it prompt "IP is forbidden. We recommend enabling IP whitelist for API trading. "

Contact Us

• Get support in our Telegram group BitMart API Club
• Please take 1 minute to help us improve: API Satisfaction Survey

Basic Information

API Basic Information

1. This article lists the rest baseurl of the interfaces: https://api-cloud.bitmart.com
2. All interface responses are in JSON format.

Request Parameter Settings

• For GET and DELETE method interfaces, parameters must be sent in the query string, i.e., the parameters concatenated after the URL?.
• For POST and PUT method interfaces, parameters are sent in the request body in JSON format.

HTTP Response Codes

• HTTP 4XX Error codes are used to indicate wrong request content, behavior, and format. The problem is from the request sender.
• HTTP 403 The error code indicates a violation of the restriction (prohibited call).
• HTTP 429 The error code indicates that the access frequency is overrun and the IP will be blocked.
• HTTP 418 The error code indicates that the IP has been blocked after error code 429.
• HTTP 5XX Error codes are used to indicate problems with BitMart server.

API Returned Codes

• code Error code
• message Error description
• trace Event tracking ID for each request, which is returned by the server for every request
• data User Data

For details, please refer to Error Code List

Signature

The authentication type of each API endpoint will be indicated. If it is marked as SIGNED,it means that the endpoint requires a signature to access. If it is marked as KEYED, it means that the endpoint only requires an API Access KEY to be set in the request header.

Authentication Type

• NONE: Public endpoint, accessible to anyone
• KEYED: Endpoint requires a valid X-BM-KEY to be set in the request header
• SIGNED: Endpoint requires a valid X-BM-KEY and X-BM-SIGN signature to be set in the request header

1. Setting Request Parameters

1.1 Set Request Header Key

Create X-BM-TIMESTAMP

// Java
System.currentTimeMillis();

// Python
int(time.time() * 1000) 

// Golang
time.Now().UnixNano() / int64(time.Millisecond)

// Nodejs & TypeScript
Date.now();

// Javascript
Date.now();

// PHP
round(microtime(true) * 1000)

// C#
DateTimeOffset.UtcNow.ToUnixTimeMilliseconds()

• X-BM-KEY (Your created API Access KEY)
• X-BM-SIGN (Signature using Sha-256)
• X-BM-TIMESTAMP (Current timestamp in milliseconds when the request is sent)

1.2 Set Request Body Params

• For GET/DELETE requests, the query string is in form format, such as symbol=BMX&side=BUY.
• For POST/PUT requests, the query string is in JSON format, such as {"symbol":"BMX","side":"BUY"}.

2. Example

Shell Example

echo -n '1589793796145#test001#{"symbol":"BTC_USDT","price":"8600","count":"100"}' | openssl dgst -sha256 -hmac "6c6c98544461bbe71db2bca4c6d7fd0021e0ba9efc215f9c6ad41852df9d9df9"
    (stdin)= c31dc326bf87f38bfb49a3f8494961abfa291bd549d0d98d9578e87516cee46d

    curl --location --request POST 'localhost:8080/spot/v1/test-post'
    --header 'Content-Type: application/json'
    --header 'X-BM-KEY: 80618e45710812162b04892c7ee5ead4a3cc3e56'
    --header 'X-BM-SIGN: c31dc326bf87f38bfb49a3f8494961abfa291bd549d0d98d9578e87516cee46d'
    --header 'X-BM-TIMESTAMP: 1589793796145'
    --d '{"symbol":"BTC_USDT","price":"8600","count":"100"}'

• Request API: /spot/v1/test-post (SIGNED)
• Request method: POST
• Current timestamp: timestamp=1589793796145
• Request body: {"symbol":"BTC_USDT","price":"8600","count":"100"}

Then set the following:

• X-BM-TIMESTAMP=1589793796145
• X-BM-KEY=Your_api_access_key
• X-BM-SIGN= hmac_sha256(Your_api_secret_key, X-BM-TIMESTAMP + '#' + Your_api_memo + '#' + {"symbol":"BTC_USDT","price":"8600","count":"100"})

Assuming the key you applied for is as follows:

• accessKey=80618e45710812162b04892c7ee5ead4a3cc3e56
• secretKey=6c6c98544461bbe71db2bca4c6d7fd0021e0ba9efc215f9c6ad41852df9d9df9
• memo=test001

then the right side is a complete request

You can also refer to the SDK or Quick Start API below to implement

Rate Limit

The speed of the public interface is limited according to the IP, and the speed of the private interface is limited according to the API KEY. When the requests exceed the rate limit, the 429 status will be returned: the request is too frequent.

The specific interface limits are as follows:

REST API

Speed limit judgment:

Each call to the interface will return 3 Response Headers with limit tags, as shown below:

Example:

X-BM-RateLimit-Remaining: 10
X-BM-RateLimit-Limit: 600
X-BM-RateLimit-Reset: 60
The above setting means that it can be called 600 times within 60 seconds, and currently has been called 10 times

About recvWindow, timestamp

Currently only applicable to v4 interfaces

Time synchronization security

Signed interfaces require the timestamp parameter to be passed, whose value should be the Unix timestamp (in milliseconds) at the time the request is sent, set in the X-BM-TIMESTAMP header of the request. When the server receives the request, it will check the timestamp in the request. If it was sent more than 5000 milliseconds ago, the request will be considered invalid. This time window value can be defined by sending the optional parameter recvWindow.

The pseudo code for this logic is as follows:

  if (timestamp < (serverTime + 1000) && (serverTime - timestamp) <= recvWindow)
  {
    // process request
  } 
  else 
  {
    // reject request
  }

About trade timeliness

The internet is not always stable and reliable, so there may be latency fluctuations between your program and the BitMart server. This is the purpose of setting recvWindow. If you are engaged in high-frequency trading and have high requirements for trade timeliness, you can set recvWindow flexibly to meet your requirements.

Public API Definitions

Field description

• currency Currency refers to the basic unit that can be transferred in and out, such as BTC, ETH, EOS, etc
• symbol Trading pair name, consists of base and quote currency. Taking BTC_USDT as an example, BTC is the base currency, and USDT is the quote currency. Trading pairs are mainly used in spot trading
• orderId Order number, the order ID under the same currency pair of each business line is unique
• tradeId The unique number of the trade

Order State （Field:state)

• 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 by the user.
• partially_canceled=A part of the order has been filled , and the order has been canceled.

Order Side （Field:side)

• buy=Buy
• sell=Sell

Order Type （Field:type)

• limit=Limit Order
• market=Market Order
• limit_maker=PostOnly Order
• ioc=IOC Order

Trade Role （Field:tradeRole)

• taker=Take orders, take the initiative to deal
• maker=Pending order, passive transaction

Timestamp

All the times returned by the system are in the form of timestamps.

System Status

Get System Time

Get system time

Request URL

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

Request Limit

See Detailed Rate Limit

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
  }
}

Get System Service Status

Get system service status

Request URL

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

Request Limit

See Detailed Rate 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
    }
   ]
  }
}

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

See Detailed Rate Limit

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
      }
    ]
  }
}

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

See Detailed Rate 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"
    ]
  }
}

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

See Detailed Rate 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"
        }
    ]
  }
}

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

See Detailed Rate 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"
    ]
  ]
}

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

See Detailed Rate Limit

Request Parameter

Request

curl https://api-cloud.bitmart.com/spot/quotation/v3/ticker?symbol=BTC_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"
  }
}

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

See Detailed Rate Limit

Request Parameter

Request

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

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"
    ]
  ]
}

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

See Detailed Rate Limit

Request Parameter

Request

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

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"
    ]
  ]
}

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

See Detailed Rate Limit

Request Parameter

Request

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

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
      ]
    ]
  }
}

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

See Detailed Rate Limit

Request Parameter

Request

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

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
    ]
  ]
}

Funding Account

Get Account Balance (KEYED)

Gets Account Balance

Request URL

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

Request Limit

See Detailed Rate Limit

Request Parameter

Request

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

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"
            }
        ]
    }
}

Get Currencies

Gets the currency of the asset for withdrawal

Request URL

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

Request Limit

See Detailed Rate Limit

Request Parameter

Request

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

None

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
      },
      {
        "currency": "USDT-TRC20",
        "name": "USDT-TRC20",
        "contract_address": "TR7NHqjeKQxGTCi8q8ZY4pL8otSzgjLj6t",
        "network": "TRC20",
        "withdraw_enabled": true,
        "deposit_enabled": true,
        "withdraw_minsize": "10",
        "withdraw_minfee": "1"
      },
      {
        "currency": "USDT-ERC20",
        "name": "USDT-ERC20",
        "contract_address": "0xdac17f958d2ee523a2206206994597c13d831ec7",
        "network": "ERC20",
        "withdraw_enabled": true,
        "deposit_enabled": true,
        "withdraw_minsize": "26",
        "withdraw_minfee": "13"
      },
      {
        "currency": "USDT-BSC",
        "name": "USDT-BSC",
        "contract_address": "0x55d398326f99059fF775485246999027B3197955",
        "network": "BEP20(BSC)",
        "withdraw_enabled": true,
        "deposit_enabled": true,
        "withdraw_minsize": "2",
        "withdraw_minfee": "1"
      }
    ]
  }
}

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

See Detailed Rate 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",
          },
          ...
    ]
  }
}

Deposit Address (KEYED)

Gets Deposit Address

Request URL

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

Request Limit

See Detailed Rate Limit

Request Parameter

Request

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

Instruction

Response Data

Response

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

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

See Detailed Rate Limit

Request Parameter

Request

curl -H 'X-BM-KEY:{{AccessKey}}' 
https://api-cloud.bitmart.com/account/v1/withdraw/charge?currency=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
    }
}

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

See Detailed Rate Limit

Request Parameter

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

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

Important notes on request parameters

Response Data

Response

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

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 of Get 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】

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

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.

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

See Detailed Rate Limit

Request Parameter

Request

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

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":""
      },
      ...
    ]
  }
}

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

See Detailed Rate Limit

Request Parameter

Request

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

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":""
        }
    }
}

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

See Detailed Rate Limit

Request Parameter

Request

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

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"
          }
        },
        ...
      ]
    }
}

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

See Detailed Rate 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

Response Data

Response

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

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

See Detailed Rate Limit

Request Parameter

Request

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

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"
  }
}

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

See Detailed Rate Limit

Request Parameter

Request

curl -H 'X-BM-KEY:{{AccessKey}}'
https://api-cloud.bitmart.com/spot/v1/trade_fee?symbol=BTC_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"
  }
}

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

See Detailed Rate 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",
    "type":"limit",
    "size":"10",
    "price":"7000"
}'
https://api-cloud.bitmart.com/spot/v2/submit_order

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

Special Parameters for Market Orders (type=market)

• Fill in both, the sell order will give priority to the size field, and the buy order will give priority to the notional field.

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

Response Data

Response

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

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

See Detailed Rate 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",
    "order_id": "112121212"
}'
https://api-cloud.bitmart.com/spot/v3/cancel_order

Response Data

Response

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

New Batch Order(v4) (SIGNED)

Batch order

Request URL

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

Request Limit

See Detailed Rate 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",
    "orderParams":[{
          "clientOrderId":"123456789",
          "size":"0.1",
          "price":"8800",
          "side":"buy",
          "type":"limit"
    }],
    "recvWindow":5000
}'
https://api-cloud.bitmart.com/spot/v4/batch_orders

orderParams

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

Special Parameters for Market Orders (type=market)

• Fill in both, the sell order will give priority to the size field, and the buy order will give priority to the notional field.

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

Response Data

Response

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

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

See Detailed Rate 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",
  "orderIds":[
    "5e925f3981"
  ],
  "recvWindow":5000
}'
https://api-cloud.bitmart.com/spot/v4/cancel_orders

Response Data

Response

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

Cancel All Order(v4) (SIGNED)

Cancel all orders

Request URL

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

Request Limit

See Detailed Rate 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

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

See Detailed Rate 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",
    "type":"limit",
    "size":"10",
    "price":"7000"
}'
https://api-cloud.bitmart.com/spot/v1/margin/submit_order

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

Special Parameters for Market Orders (type=market)

• Fill in both, the sell order will give priority to the size field, and the buy order will give priority to the notional field.

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
    }
}

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

Note

Response Details

Response

{
  "code" : 1000,
  "message" : "success",
  "data" : {
    "orderId" : "118100034543076010",
    "clientOrderId" : "118100034543076010",
    "symbol" : "BTC_USDT",
    "side" : "buy",
    "orderMode" : "spot",
    "type" : "limit",
    "state" : "filled",
    "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"
}

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

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 '{
  "clientOrderId":"118100034543076010",
  "queryState":"open",
  "recvWindow":5000
}'
https://api-cloud.bitmart.com/spot/v4/query/client-order

Note

Response Details

Response

{
  "code" : 1000,
  "message" : "success",
  "data" : {
    "orderId" : "118100034543076010",
    "clientOrderId" : "118100034543076010",
    "symbol" : "BTC_USDT",
    "side" : "buy",
    "orderMode" : "spot",
    "type" : "limit",
    "state" : "filled",
    "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"
}

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

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 '{
  "symbol":"BTC_USDT",
  "orderMode":"spot",
  "startTime":1682239652931,
  "endTime":1682239657931,
  "limit":10,
  "recvWindow":5000
}'
https://api-cloud.bitmart.com/spot/v4/query/open-orders

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 range startTime and endTime 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 of startTime.
• If only startTime is filled in, query the historical records starting from this timestamp.
• If only endTime 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",
    "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"
}

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

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 '{
  "symbol":"BTC_USDT",
  "orderMode":"spot",
  "startTime":1682239502394,
  "endTime":1682239507394,
  "limit":10,
  "recvWindow":5000
}'
https://api-cloud.bitmart.com/spot/v4/query/history-orders

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 range startTime and endTime 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 of startTime.
• If only startTime is filled in, query the historical records starting from this timestamp.
• If only endTime 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",
    "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"
}