Get account instruments

GET

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

GET

/api/v5/account/instruments

curl -G https://www.okx.com/api/v5/account/instruments \
     -H "OK-ACCESS-KEY: <apiKey>" \
     -d instType=SPOT

200account_getInstruments_example

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

Retrieve tradable instruments available to the current account. Reflects the account's trading permissions and settings.

Authentication

OK-ACCESS-KEYstring

Your API key.

OK-ACCESS-SIGNstring

Base64-encoded HMAC-SHA256 signature of the prehash string.

OK-ACCESS-TIMESTAMPstring

ISO 8601 UTC timestamp, e.g. 2020-12-08T09:08:57.715Z.

OK-ACCESS-PASSPHRASEstring

The passphrase you set when creating the API key.

Query parameters

instTypeenumRequired

Instrument type.

ulystringOptional

Underlying, only applicable to FUTURES/SWAP/OPTION.

instFamilystringOptional

Instrument family, only applicable to FUTURES/SWAP/OPTION.

instIdstringOptional

Instrument ID.

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 account instruments

Authentication

Query parameters

Response

More about OKX

Products

Services

Support

Buy crypto

Crypto calculator

Trade

Trade on the go with OKX