Interface Permission
Whether you have permission to call the interface requires attention to the following two aspects:
- Interface authentication
- API Permission
Interface authentication
When the user calls, APIKEY and verification parameters need to be passed in the way specified by the interface. The first line of each interface will have a description of what authentication the interface needs.
Simply put, the interface authentication is divided into the following three cases:
| Interface Type | Authentication Type | Description |
|---|---|---|
| Public | NONE | X-BM-KEY is not required, X-BM-SIGN is not required |
| Private | KEYED | X-BM-KEY is required, X-BM-SIGN is not required |
| Private | SIGNED | X-BM-KEY is required, X-BM-SIGN is required |
API KEY Permission
Refers to the user specified authorization to the API when applying for the API. That is, when users apply for API KEY on the BitMart website page, they can check API permissions, such as: trading permissions (including contract transactions and spot transactions). (Default: read-only permission).
Details:
| Interface | Description | Authentication Type | Permissions |
|---|---|---|---|
| /account/v1/currencies | Get currency | NONE | No Permission Required |
| /account/v1/wallet | Get account balance | KEYED | Read-only permission |
| /account/v1/deposit/address | Deposit address | KEYED | Read-only permission |
| /account/v1/withdraw/charge | Withdraw quota | KEYED | Withdraw permission |
| /account/v1/withdraw/apply | Withdraw | SIGNED | Withdraw permission |
| /account/v1/recharge-withdraw/history | Get deposit and withdraw history | KEYED | Read-only permission |
| /account/v1/recharge-withdraw/detail | Get a deposit or withdraw detail | KEYED | Read-only permission |
| /contract/v1/ifcontract/contracts | Get Contract List | NONE | No Permission Required |
| /contract/v1/ifcontract/indexes | Query the index price of all contracts | NONE | No permission required |
| /contract/v1/ifcontract/pnls | Get ADL list | NONE | No permission required |
| /contract/v1/ifcontract/depth | Get Contract Depth | NONE | No Permission Required |
| /contract/v1/ifcontract/fundingrate | Get funding rates | NONE | No permission required |
| /contract/v1/ifcontract/indexquote | Get Index Price K-line | NONE | No Permission Required |
| /contract/v1/ifcontract/quote | Get K-Line data | NONE | No permission required |
| /contract/v1/ifcontract/tickers | Get tickers data | NONE | No permission required |
| /contract/v1/ifcontract/trades | Get historical contract trade records | NONE | No permission required |
| /contract/v1/ifcontract/accounts | Get user account information | KEYED | Read-only permission |
| /contract/v1/ifcontract/batchOrders | Batch Order | SIGNED | Trading Permission |
| /contract/v1/ifcontract/cancelOrders | Cancel Order | SIGNED | Trading Permission |
| /contract/v1/ifcontract/marginOper | Adjust Margin | SIGNED | Trading Permission |
| /contract/v1/ifcontract/orderTrades | Order transaction records | KEYED | Read-only permission |
| /contract/v1/ifcontract/positionFee | Get Position Fees | KEYED | Read-Only Permission |
| /contract/v1/ifcontract/submitOrder | Submit Order | SIGNED | Trading Permission |
| /contract/v1/ifcontract/userLiqRecords | Get liquidation records | KEYED | read-only Permission |
| /contract/v1/ifcontract/userOrderInfo | Get Order Details | KEYED | Read-Only Permission |
| /contract/v1/ifcontract/userOrders | Get User Orders | KEYED | Read-Only Permission |
| /contract/v1/ifcontract/userPositions | Query user positions | KEYED | read-only permission |
| /contract/v1/ifcontract/userTrades | Query user trades | KEYED | read-only permission |
| /spot/v1/currencies | Get a list of all cryptocurrencies on the platform | NONE | No permission required |
| /spot/v1/symbols | Get a list of all trading pairs on the platform | NONE | No permission required |
| /spot/v1/symbols/details | Get a detailed list of all trading pairs on the platform | NONE | No permission required |
| /spot/v1/ticker | Get ticker | NONE | No permission required |
| /spot/v1/steps | Get K-Line steps | NONE | No permission required |
| /spot/v1/symbols/kline | Get K-Line | NONE | No permission required |
| /spot/v1/symbols/book | Get orderbook | NONE | No permission required |
| /spot/v1/symbols/trades | Get recent trades | NONE | No permission required |
| /spot/v1/wallet | Get user wallet | KEYED | Read-Only Permission |
| /spot/v1/submit_order | Place order | SIGNED | Trading Permission |
| /spot/v1/cancel_order | Cancel order | SIGNED | Trading Permission |
| /spot/v1/cancel_orders | Cancel all orders | SIGNED | Trading Permission |
| /spot/v1/order_detail | Get order detail | KEYED | Read-Only Permission |
| /spot/v1/orders | Get user orders | KEYED | Read-Only Permission |
| /spot/v1/trades | Get user trades | KEYED | Read-Only Permission |