Interface: Instrument
Properties
| Property | Type | Description |
|---|---|---|
alias | string | Legacy FUTURES contract label, including this_five_years and next_five_years. Prefer expTime for delivery time; OKX marks this field deprecated. |
auctionEndTime | string | - |
baseCcy | string | - |
category | string | - |
contTdSwTime? | string | - |
ctMult | string | - |
ctType | string | - |
ctVal | string | - |
ctValCcy | string | - |
expTime | string | - |
futureSettlement? | boolean | - |
groupId? | string | - |
instCategory? | string | Asset 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 |
instFamily | string | - |
instId | string | - |
instIdCode? | number | - |
instType | InstrumentType | - |
lever | string | - |
listTime | string | - |
longPosRemainingQuota? | string | - |
lotSz | string | - |
maxIcebergSz | string | - |
maxLmtAmt? | string | - |
maxLmtSz | string | - |
maxMktAmt? | string | - |
maxMktSz | string | - |
maxPlatOILmt? | string | - |
maxStopSz | string | - |
maxTriggerSz | string | - |
maxTwapSz | string | - |
minSz | string | - |
openType? | string | - |
optType | string | - |
posLmtAmt? | string | - |
posLmtPct? | string | - |
preMktSwTime? | string | - |
quoteCcy | string | - |
rpiMinLevel? | string | Minimum spacing between RPI bid and RPI ask, in organic price levels. Default 4; 0 for Event Contracts. |
rpiMinPxBand? | string | Minimum distance from opposite-side organic best price for RPI spacing, in bps. |
ruleType | string | e.g. normal, pre_market (incl. Pre-market X-Perp FUTURES), rebase_contract, xperp (after Pre-market X-Perp converts). |
seriesId? | string | Series id for EVENTS, e.g. BTC-ABOVE-DAILY. |
settleCcy | string | - |
shortPosRemainingQuota? | string | - |
state | string | Instrument status, such as live, suspend, rebase, post_only, preopen, test or settling. The instruments WebSocket channel also reports expired. settling applies to EVENTS. |
stk | string | - |
tickSz | string | - |
tradeQuoteCcyList? | string[] | - |
uly | string | - |
upcChg? | InstrumentUpcomingParamChange[] | - |