Get Contract List
Get contract list information (Authentication type: None, See Interface Permission)
Request Format
GET https://api-cloud.bitmart.com/contract/v1/ifcontract/contracts
Request Limit
Request Parameter
| Field | Type | Required? | Description |
|---|---|---|---|
| contractID | long | No | Contract ID, if the contract ID parameter is empty or 0, it means to obtain all contracts |
| exchange | string | Yes | Fixed value, BitMart |
Request example
curl https://api-cloud.bitmart.com/contract/v1/ifcontract/contracts?exchange=bitmart
Response Data
| Field | Type | Description |
|---|---|---|
| contract_id | long | contract ID |
| index_id | int | Index ID |
| name | string | contract name |
| display_name | string | Contract display name (Chinese) |
| display_name_en | string | Contract display name (English) |
| contract_type | int | Contract type, 1: perpetual, 2: future |
| base_coin | string | Base coin |
| quote_coin | string | Quote coin |
| price_coin | string | Contract size unit currency |
| contract_size | decimal | Contract size, indicating how many base coins a contract is worth |
| delivery_cycle | int | Delivery cycle in seconds |
| min_leverage | decimal | Minimum leverage |
| max_leverage | decimal | Maximum leverage |
| price_unit | decimal | Price precision |
| vol_unit | decimal | Volume precision |
| value_unit | decimal | Value precision |
| min_vol | decimal | Minimum volume |
| max_vol | decimal | Maximum volum |
| liquidation_warn_ratio | decimal | Liquidation warning ratio |
| fast_liquidation_ratio | decimal | Fast liquidation ratio |
| settle_type | int | Settlement type, 1: Automatic, 2: Manual |
| open_type | int | Open type, 1: Cross Margin, 2: Fixed Margin, 3: Both |
| status | int | Status |
1 Approving, internal code |
||
2 Testing, internal code |
||
3 Available, now trading |
||
4 Paused, trading stopped |
||
5 Delivering, after the contract expires, matching is suspended and settlement begins |
||
6 Completion of delivery and settlement |
||
7 Offline, the contract has been offline, and the life cycle of the contract is over |
||
| compensate_type | int | Position compensation method 1:ADL, 2: Profit sharing |
| created_at | time | Create time |
| base_limit | decimal | Risk limit base |
| step | decimal | Step |
| maintenance_margin | decimal | Maintenance margin ratio |
| initial_margin | decimal | Initial margin ratio |
| maker_fee | decimal | Maker fee |
| taker_fee | decimal | Taker fee |
| settlement_fee | decimal | Delivery fee rate, only when the contract expires |
| long_funding | decimal | Long funding rate, only for swap contracts |
| short_funding | decimal | Short funding rate, only for swap contracts |
| funding_interval | int64 | Time period of funding rate, only for swap contracts, in seconds |
| created_at | string | Create time |
Instruction
Return a list of contracts
Example of returned data format
{
"code": 1000,
"trace":"886fb6ae-456b-4654-b4e0-d681ac05cea1",
"message": "OK",
"data": {
"contracts": [
{
"contract": {
"contract_id": 1,
"index_id": 1,
"name": "BTCUSDT",
"display_name": "BTCUSDT永续合约",
"display_name_en": "BTCUSDT_SWAP",
"contract_type": 1,
"base_coin": "USDT",
"quote_coin": "BTC",
"price_coin": "USDT",
"contract_size": "1",
"delivery_cycle": 0,
"min_leverage": "1",
"max_leverage": "100",
"price_unit": "0.01",
"vol_unit": "1",
"min_vol": "1",
"value_unit": "0.01",
"max_vol": "100000",
"liquidation_warn_ratio": "0.85",
"fast_liquidation_ratio": "0.3",
"settle_type": 1,
"open_type": 3,
"status": 3,
"compensate_type": 1,
"created_at": "2018-07-12T19:16:57Z"
},
"risk_limit": {
"contract_id": 1,
"base_limit": "10",
"step": "5",
"initial_margin": "0.1"
},
"fee_config": {
"contract_id": 1,
"maker_fee": "0.00025",
"taker_fee": "0.00075",
"settlement_fee": "0",
"long_funding": "0.03",
"short_funding": "0.06",
"funding_interval": 28800,
"created_at": "2018-07-12T20:47:22Z"
}
}
]
}
}