Interface: AccountInstrument
Properties
| Property | Type | Description |
|---|---|---|
alias? | string | Legacy FUTURES contract label. Prefer expTime for delivery time; OKX marks this field deprecated. |
auctionEndTime | string | - |
baseCcy | string | - |
category? | string | Deprecated; see instCategory on public Instrument where used. |
contTdSwTime | string | - |
ctMult | string | - |
ctType | string | - |
ctVal | string | - |
ctValCcy | string | - |
elp? | string | Deprecated Retired ELP alias. Use rpi; OKX ended alias support after October 31, 2026. |
expTime | string | - |
futureSettlement | boolean | - |
groupId? | string | - |
instCategory? | string | Asset category of the instrument's base asset (see public Instrument.instCategory for values). 1: Crypto, 3: Stocks, 4: Commodities, 5: Forex, 6: Bonds, "": not available |
instFamily | string | - |
instId | string | - |
instIdCode | number | - |
instType | string | - |
lever | string | - |
listTime | string | - |
longPosRemainingQuota? | string | Remaining long position value (USD) the user is permitted to open. Applicable to SWAP/FUTURES. |
lotSz | string | - |
maxIcebergSz | string | - |
maxLmtAmt | string | - |
maxLmtSz | string | - |
maxMktAmt | string | - |
maxMktSz | string | - |
maxPlatOICoinLmt? | string | Platform-wide maximum position value (coins) for this instrument. Applicable to SWAP/FUTURES. See 2026-05-19 changelog |
maxPlatOILmt | string | - |
maxStopSz | string | - |
maxTriggerSz | string | - |
maxTwapSz | string | - |
minSz | string | - |
openType | string | - |
optType | string | - |
posLmtAmt | string | - |
posLmtPct | string | - |
preMktSwTime | string | - |
quoteCcy | string | - |
rpi? | string | RPI maker permission. "0" = not enabled, "1" = enabled but no permission, "2" = enabled with permission |
ruleType | string | Trading rule types: normal, pre_market (incl. Pre-market X-Perp FUTURES), rebase_contract, xperp |
seriesId? | string | - |
settleCcy | string | - |
shortPosRemainingQuota? | string | Remaining short position value (USD) the user is permitted to open. Applicable to SWAP/FUTURES. |
state | string | Instrument status, such as live, suspend, rebase, post_only, preopen, test or settling. settling applies to EVENTS. |
stk | string | - |
tickSz | string | - |
tradeQuoteCcyList | string[] | - |
uly? | string | - |
upcChg? | InstrumentUpcomingParamChange[] | - |