Get instruments

GET

https://www.okx.com/api/v5/public/instruments

GET

/api/v5/public/instruments

curl -G https://www.okx.com/api/v5/public/instruments \
     -d instType=SPOT

200publicData_getInstruments_example

{
  "code": "0",
  "msg": "",
  "data": [
    {
      "instType": "SPOT",
      "instId": "BTC-USDT",
      "uly": "",
      "instFamily": "",
      "category": "1",
      "baseCcy": "BTC",
      "quoteCcy": "USDT",
      "settleCcy": "",
      "ctVal": "",
      "ctMult": "",
      "ctValCcy": "",
      "optType": "",
      "stk": "",
      "listTime": "1606468572000",
      "expTime": "",
      "lever": "10",
      "tickSz": "0.1",
      "lotSz": "0.00000001",
      "minSz": "0.00001",
      "ctType": "",
      "alias": "",
      "state": "live",
      "maxLmtSz": "9999999999",
      "maxMktSz": "",
      "maxTwapSz": "9999999999.0000000000000000",
      "maxIcebergSz": "9999999999.0000000000000000",
      "maxTriggerSz": "9999999999.0000000000000000",
      "maxStopSz": "",
      "auctionEndTime": "",
      "contTdSwTime": "1704876947000",
      "floatPxLmtPct": "0.03",
      "futureSettlement": false,
      "groupId": "1",
      "initPxLmtPct": "0.05",
      "instCategory": "1",
      "instIdCode": 1000000000,
      "maxLmtAmt": "1000000",
      "maxMktAmt": "1000000",
      "maxPxLmtPct": "0.15",
      "openType": "call_auction",
      "preMktSwTime": "",
      "ruleType": "normal",
      "tradeQuoteCcyList": [
        "USDT"
      ],
      "upcChg": [
        {
          "effTime": "1704876947000",
          "newValue": "0.0001",
          "param": "tickSz"
        }
      ]
    }
  ]
}

Retrieve a list of instruments with open contracts for the given instrument type.

Query parameters

instTypeenumRequired

Instrument type.

ulystringOptional

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

instFamilystringOptional

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

instIdstringOptional

Instrument ID, e.g. BTC-USD-SWAP.

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

Get instruments

Query parameters

Response

More about OKX

Products

Services

Support

Buy crypto

Crypto calculator

Trade

Trade on the go with OKX