Get Instruments Info
Query for the instrument specification of online trading pairs.
Covers: Spot / USDT perpetual / Inverse contract
caution
- When query by
baseCoin, regardless of category=linearorinverse, the result will have USDT perpetual and Inverse contract symbols.
HTTP Request
GET /cloud/trade/v3/market/instruments-info
Request Parameters
| Parameter | Required | Type | Comments |
|---|---|---|---|
| category | true | string | Product type. spot,linear,inverse |
| symbol | false | string | Symbol name |
| status | false | string | Symbol status filter
|
| baseCoin | false | string | Base coin. Only valid for linear and inverse |
| limit | false | integer | Limit for data size per page. [1, 1000]. Default: 500 |
| cursor | false | string | Cursor. Use the nextPageCursor token from the response to retrieve the next page of the result set |
Response Parameters
- Linear/Inverse
- Spot
| Parameter | Type | Comments |
|---|---|---|
| category | string | Product type |
| nextPageCursor | string | Cursor. Used to pagination |
| list | array | Object |
| > symbol | string | Symbol name |
| > contractType | string | Contract type |
| > status | string | Instrument status |
| > baseCoin | string | Base coin |
| > quoteCoin | string | Quote coin |
| > launchTime | string | Launch timestamp (ms) |
| > priceScale | string | Price scale |
| > leverageFilter | Object | Leverage attributes |
| >> minLeverage | string | Minimum leverage |
| >> maxLeverage | string | Maximum leverage |
| >> leverageStep | string | The step to increase/reduce leverage |
| > priceFilter | Object | Price attributes |
| >> minPrice | string | Minimum order price |
| >> maxPrice | string | Maximum order price |
| >> tickSize | string | The step to increase/reduce order price |
| > lotSizeFilter | Object | Size attributes |
| >> maxOrderQty | string | Maximum order quantity for a single price limit order |
| >> maxMktOrderQty | string | Maximum quantity for Market order |
| >> minOrderQty | string | Minimum order quantity |
| >> minNotionalValue | string | Minimum order notional Value |
| >> qtyStep | string | The step to increase/reduce order quantity |
| >> postOnlyMaxOrderQty | string | Depreciated, please use maxOrderQty |
| > fundingInterval | integer | Funding interval (minute) |
| > settleCoin | string | Settle coin |
| Parameter | Type | Comments |
|---|---|---|
| category | string | Product type |
| list | array | Object |
| > symbol | string | Symbol name |
| > baseCoin | string | Base coin |
| > quoteCoin | string | Quote coin |
| > status | string | Instrument status |
| > lotSizeFilter | Object | Size attributes |
| >> basePrecision | string | The precision of base coin |
| >> quotePrecision | string | The precision of quote coin |
| >> minOrderQty | string | Minimum order quantity |
| >> maxOrderQty | string | Maximum order quantity |
| >> minOrderAmt | string | Minimum order amount |
| >> maxOrderAmt | string | Maximum order amount |
| > priceFilter | Object | Price attributes |
| >> tickSize | string | The step to increase/reduce order price |
| > riskParameters | Object | Price limit parameters |
| >> limitParameter | string | Price limit on Limit order. For example, "0.05" means 5%, so the order price of your buy order cannot exceed 105% of the Last Traded Price, while the order price of your sell order cannot be lower than 95% of the Last Traded Price |
| >> marketParameter | string | Price limit on Market order. For example, assuming the market order limit for MNT/USDT is 5%. When the last traded price is at 2 USDT, a trader places a market order for 100,000 USDT. Any portion that could have been filled at above 2.1 USDT will be canceled. Assuming only 80,000 USDT order value can be filled at a price of 2.1 USDT or below, the remaining 20,000 USDT order value will be canceled since the deviation exceeds the 5% threshold. |
Request Example
- Linear
- Spot
- HTTP
GET /cloud/trade/v3/market/instruments-info?category=linear&symbol=BTCUSDT HTTP/1.1
Host: openapi-testnet.zoomex.com
- HTTP
GET /cloud/trade/v3/market/instruments-info?category=spot&symbol=BTCUSDT HTTP/1.1
Host: openapi-testnet.zoomex.com
Response Example
- Linear
- Spot
{
"retCode": 0,
"retMsg": "OK",
"result": {
"category": "linear",
"list": [
{
"symbol": "BTCUSDT",
"contractType": "LinearPerpetual",
"status": "Trading",
"baseCoin": "BTC",
"quoteCoin": "USDT",
"launchTime": "1585526400000",
"deliveryTime": "0",
"deliveryFeeRate": "",
"priceScale": "2",
"leverageFilter": {
"minLeverage": "1",
"maxLeverage": "100.00",
"leverageStep": "0.01"
},
"priceFilter": {
"minPrice": "0.50",
"maxPrice": "999999.00",
"tickSize": "0.50"
},
"lotSizeFilter": {
"maxOrderQty": "100.000",
"minOrderQty": "0.001",
"qtyStep": "0.001",
"postOnlyMaxOrderQty": "1000.000"
"maxMktOrderQty": "1000.000"
},
"unifiedMarginTrade": true,
"fundingInterval": 480,
"settleCoin": "USDT"
}
],
"nextPageCursor": ""
},
"retExtInfo": {},
"time": 1672712495660
}
{
"retCode": 0,
"retMsg": "OK",
"result": {
"category": "spot",
"list": [
{
"symbol": "BTCUSDT",
"baseCoin": "BTC",
"quoteCoin": "USDT",
"status": "Trading",
"lotSizeFilter": {
"basePrecision": "0.000001",
"quotePrecision": "0.00000001",
"minOrderQty": "0.000048",
"maxOrderQty": "71.73956243",
"minOrderAmt": "1",
"maxOrderAmt": "2000000"
},
"priceFilter": {
"tickSize": "0.01"
}
"riskParameters": {
"limitParameter": "0.05",
"marketParameter": "0.05"
}
}
]
},
"retExtInfo": {},
"time": 1672712468011
}