Get Instruments Info
Query a list of instruments of online trading pair.
Covers: Spot / USDT perpetual / USDC contract / Inverse contract / Option
caution
- Spot does not support pagination, so
limit
,cursor
are invalid. - When query by
baseCoin
, regardless of category=linear
orinverse
, the result will have USDT perpetual, USDC contract and Inverse contract symbols.
HTTP Request
GET /v5/market/instruments-info
Request Parameters
Parameter | Required | Type | Comments |
---|---|---|---|
category | true | string | Product type. spot ,linear ,inverse ,option |
symbol | false | string | Symbol name |
status | false | string | Symbol status filter
|
baseCoin | false | string | Base coin. linear ,inverse ,option only |
limit | false | integer | Limit for data size per page. [1 , 1000 ]. Default: 500 |
cursor | false | string | Cursor. Used for pagination |
Response Parameters
- Linear/Inverse
- Option
- 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) |
> deliveryTime | string | Delivery timestamp (ms) |
> deliveryFeeRate | string | Delivery fee rate |
> 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 |
>> minOrderQty | string | Minimum order quantity |
>> qtyStep | string | The step to increase/reduce order quantity |
>> postOnlyMaxOrderQty | string | Maximum order qty for PostOnly order |
> unifiedMarginTrade | boolean | Whether to support unified margin trade |
> fundingInterval | integer | Funding interval (minute) |
> settleCoin | string | Settle coin |
Parameter | Type | Comments |
---|---|---|
category | string | Product type |
nextPageCursor | string | Cursor. Used to pagination |
list | array | Object |
> symbol | string | Symbol name |
> optionsType | string | Option type. Call , Put |
> status | string | Instrument status |
> baseCoin | string | Base coin |
> quoteCoin | string | Quote coin |
> settleCoin | string | Settle coin |
> launchTime | string | Launch timestamp (ms) |
> deliveryTime | string | Delivery timestamp (ms) |
> deliveryFeeRate | string | Delivery fee rate |
> 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 |
>> minOrderQty | string | Minimum order quantity |
>> qtyStep | string | The step to increase/reduce order quantity |
Parameter | Type | Comments |
---|---|---|
category | string | Product type |
list | array | Object |
> symbol | string | Symbol name |
> baseCoin | string | Base coin |
> quoteCoin | string | Quote coin |
> innovation | string | Whether to belong to innovation. `0`: false, `1`: true |
> 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 |
Request Example
- Linear
- Option
- Spot
- HTTP
- Python
GET /v5/market/instruments-info?category=linear&symbol=BTCUSDT HTTP/1.1
Host: api-testnet.bybit.com
from pybit.unified_trading import HTTP
session = HTTP(testnet=True)
print(session.get_instruments_info(
category="linear",
symbol="BTCUSDT",
))
- HTTP
- Python
GET /v5/market/instruments-info?category=option&symbol=ETH-3JAN23-1250-P HTTP/1.1
Host: api-testnet.bybit.com
from pybit.unified_trading import HTTP
session = HTTP(testnet=True)
print(session.get_instruments_info(
category="option",
symbol="ETH-3JAN23-1250-P",
))
- HTTP
- Python
GET /v5/market/instruments-info?category=spot&symbol=BTCUSDT HTTP/1.1
Host: api-testnet.bybit.com
from pybit.unified_trading import HTTP
session = HTTP(testnet=True)
print(session.get_instruments_info(
category="spot",
symbol="BTCUSDT",
))
Response Example
- Linear
- Option
- 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"
},
"unifiedMarginTrade": true,
"fundingInterval": 480,
"settleCoin": "USDT"
}
],
"nextPageCursor": ""
},
"retExtInfo": {},
"time": 1672712495660
}
{
"retCode": 0,
"retMsg": "OK",
"result": {
"category": "option",
"nextPageCursor": "",
"list": [
{
"symbol": "ETH-3JAN23-1250-P",
"status": "Trading",
"baseCoin": "ETH",
"quoteCoin": "USD",
"settleCoin": "USDC",
"optionsType": "Put",
"launchTime": "1672560000000",
"deliveryTime": "1672732800000",
"deliveryFeeRate": "0.00015",
"priceFilter": {
"minPrice": "0.1",
"maxPrice": "10000000",
"tickSize": "0.1"
},
"lotSizeFilter": {
"maxOrderQty": "1500",
"minOrderQty": "0.1",
"qtyStep": "0.1"
}
}
]
},
"retExtInfo": {},
"time": 1672712537130
}
{
"retCode": 0,
"retMsg": "OK",
"result": {
"category": "spot",
"list": [
{
"symbol": "BTCUSDT",
"baseCoin": "BTC",
"quoteCoin": "USDT",
"innovation": "0",
"status": "Trading",
"lotSizeFilter": {
"basePrecision": "0.000001",
"quotePrecision": "0.00000001",
"minOrderQty": "0.00004",
"maxOrderQty": "63.01197227",
"minOrderAmt": "1",
"maxOrderAmt": "100000"
},
"priceFilter": {
"tickSize": "0.01"
}
}
]
},
"retExtInfo": {},
"time": 1672712468011
}