Skip to navigation
API ReferencePublic Data

Get open interest

Retrieve the total open interest for contracts on OKX.

Query parameters

instTypeenumRequired
Instrument type.
Allowed values:
ulystringOptional

Underlying, e.g. BTC-USD. Applicable to FUTURES/SWAP/OPTION; required for OPTION.

instFamilystringOptional

Instrument family, e.g. BTC-USD. Applicable to FUTURES/SWAP/OPTION.

instIdstringOptional

Instrument ID, e.g. BTC-USD-SWAP. Only applicable to FUTURES/SWAP/OPTION.

Response

Successful response
codestringOptional

Result code. 0 means success; any other value is an error code.

msgstringOptional
Error message. Empty on success.
datalist of objectsOptional