Instruments
Retrieve a list of instruments with open contracts.
Rate Limit: 20 requests per 2 seconds
Rate limit rule: IP + instrumentType
HTTP Request
Request Example
Request Parameters
instType
String
Yes
Instrument type
PERP: Perpetual Futures
uly
String
Conditional
Underlying
Only applicable to PERP.
instFamily
String
Conditional
Instrument family
Only applicable to PERP.
instId
String
No
Instrument ID
Response Parameters
Parameter
Type
Description
instType
String
Instrument type
instId
String
Instrument ID, e.g. BTC-USD
uly
String
Underlying, e.g. BTC-USD
Only applicable to PERP
instFamily
String
Instrument family, e.g. BTC-USD
Only applicable to PERP
category
String
Currency category. Note: this parameter is already deprecated
baseCcy
String
Base currency, e.g. BTC inBTC-USDT
Only applicable to SPOT/MARGIN
quoteCcy
String
Quote currency, e.g. USDT in BTC-USDT
Only applicable to SPOT/MARGIN
settleCcy
String
Settlement and margin currency, e.g. BTC
Only applicable to PERP
ctVal
String
Contract value
Only applicable to PERP
ctMult
String
Contract multiplier
Only applicable to PERP
ctValCcy
String
Contract value currency
Only applicable to PERP
listTime
String
Listing time, Unix timestamp format in milliseconds, e.g. 1597026383085
expTime
String
Expiry time
Applicable to PERP. It is the instrument offline time when there is PERP manual offline. Update once change.
tickSz
String
Tick size, e.g. 0.0001
For Option, it is minimum tickSz among tick band, please use "Get option tick bands" if you want get option tickBands.
lotSz
String
Lot size If it is a derivatives contract, the value is the number of contracts.
minSz
String
Minimum order size If it is a derivatives contract, the value is the number of contracts.
ctType
String
Contract type
linear: linear contract
inverse: inverse contract
Only applicable to PERP
state
String
Instrument status
live
suspend
preopen. e.g.
maxLmtSz
String
The maximum order quantity of a single limit order. If it is a derivatives contract, the value is the number of contracts.
maxMktSz
String
The maximum order quantity of a single market order. If it is a derivatives contract, the value is the number of contracts.
maxLmtAmt
String
Max USD amount for a single limit order
maxMktAmt
String
Max USD amount for a single market order
maxTwapSz
String
The maximum order quantity of a single TWAP order. If it is a derivatives contract, the value is the number of contracts.
maxIcebergSz
String
The maximum order quantity of a single iceBerg order. If it is a derivatives contract, the value is the number of contracts.
maxTriggerSz
String
The maximum order quantity of a single trigger order. If it is a derivatives contract, the value is the number of contracts.
maxStopSz
String
The maximum order quantity of a single stop market order. If it is a derivatives contract, the value is the number of contracts.
Last updated