Skip to content

Interface: AccountInstrument ​

Properties ​

PropertyTypeDescription
alias?stringLegacy FUTURES contract label. Prefer expTime for delivery time; OKX marks this field deprecated.
auctionEndTimestring-
baseCcystring-
category?stringDeprecated; see instCategory on public Instrument where used.
contTdSwTimestring-
ctMultstring-
ctTypestring-
ctValstring-
ctValCcystring-
elp?stringDeprecated Retired ELP alias. Use rpi; OKX ended alias support after October 31, 2026.
expTimestring-
futureSettlementboolean-
groupId?string-
instCategory?stringAsset 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
instFamilystring-
instIdstring-
instIdCodenumber-
instTypestring-
leverstring-
listTimestring-
longPosRemainingQuota?stringRemaining long position value (USD) the user is permitted to open. Applicable to SWAP/FUTURES.
lotSzstring-
maxIcebergSzstring-
maxLmtAmtstring-
maxLmtSzstring-
maxMktAmtstring-
maxMktSzstring-
maxPlatOICoinLmt?stringPlatform-wide maximum position value (coins) for this instrument. Applicable to SWAP/FUTURES. See 2026-05-19 changelog
maxPlatOILmtstring-
maxStopSzstring-
maxTriggerSzstring-
maxTwapSzstring-
minSzstring-
openTypestring-
optTypestring-
posLmtAmtstring-
posLmtPctstring-
preMktSwTimestring-
quoteCcystring-
rpi?stringRPI maker permission. "0" = not enabled, "1" = enabled but no permission, "2" = enabled with permission
ruleTypestringTrading rule types: normal, pre_market (incl. Pre-market X-Perp FUTURES), rebase_contract, xperp
seriesId?string-
settleCcystring-
shortPosRemainingQuota?stringRemaining short position value (USD) the user is permitted to open. Applicable to SWAP/FUTURES.
statestringInstrument status, such as live, suspend, rebase, post_only, preopen, test or settling. settling applies to EVENTS.
stkstring-
tickSzstring-
tradeQuoteCcyListstring[]-
uly?string-
upcChg?InstrumentUpcomingParamChange[]-

Built by Siebly. Open source SDKs for exchange APIs.