Skip to content

Interface: Instrument ​

Properties ​

PropertyTypeDescription
aliasstringLegacy FUTURES contract label, including this_five_years and next_five_years. Prefer expTime for delivery time; OKX marks this field deprecated.
auctionEndTimestring-
baseCcystring-
categorystring-
contTdSwTime?string-
ctMultstring-
ctTypestring-
ctValstring-
ctValCcystring-
expTimestring-
futureSettlement?boolean-
groupId?string-
instCategory?stringAsset category of the instrument's base asset (first segment of instId). E.g. BTC-USDT-SWAP → category of BTC. 1: Crypto, 3: Stocks, 4: Commodities, 5: Forex, 6: Bonds, "": not available
instFamilystring-
instIdstring-
instIdCode?number-
instTypeInstrumentType-
leverstring-
listTimestring-
longPosRemainingQuota?string-
lotSzstring-
maxIcebergSzstring-
maxLmtAmt?string-
maxLmtSzstring-
maxMktAmt?string-
maxMktSzstring-
maxPlatOILmt?string-
maxStopSzstring-
maxTriggerSzstring-
maxTwapSzstring-
minSzstring-
openType?string-
optTypestring-
posLmtAmt?string-
posLmtPct?string-
preMktSwTime?string-
quoteCcystring-
rpiMinLevel?stringMinimum spacing between RPI bid and RPI ask, in organic price levels. Default 4; 0 for Event Contracts.
rpiMinPxBand?stringMinimum distance from opposite-side organic best price for RPI spacing, in bps.
ruleTypestringe.g. normal, pre_market (incl. Pre-market X-Perp FUTURES), rebase_contract, xperp (after Pre-market X-Perp converts).
seriesId?stringSeries id for EVENTS, e.g. BTC-ABOVE-DAILY.
settleCcystring-
shortPosRemainingQuota?string-
statestringInstrument status, such as live, suspend, rebase, post_only, preopen, test or settling. The instruments WebSocket channel also reports expired. settling applies to EVENTS.
stkstring-
tickSzstring-
tradeQuoteCcyList?string[]-
ulystring-
upcChg?InstrumentUpcomingParamChange[]-

Built by Siebly. Open source SDKs for exchange APIs.