Get active orders

GET

https://www.okx.com/api/v5/finance/staking-defi/orders-active

GET

/api/v5/finance/staking-defi/orders-active

curl https://www.okx.com/api/v5/finance/staking-defi/orders-active \
     -H "OK-ACCESS-KEY: <apiKey>"

200onChainEarn_getActiveOrders_example

{
  "code": "0",
  "msg": "",
  "data": [
    {
      "ordId": "2413499",
      "ccy": "DOT",
      "productId": "101",
      "state": "1",
      "protocol": "Polkadot",
      "protocolType": "defi",
      "term": "0",
      "apy": "0.1014",
      "investData": [
        {
          "ccy": "DOT",
          "amt": "2"
        }
      ],
      "earningData": [
        {
          "ccy": "DOT",
          "earningType": "0",
          "earnings": "0.10615025"
        }
      ],
      "purchasedTime": "1729839328000",
      "estSettlementTime": "",
      "cancelRedemptionDeadline": "",
      "tag": "",
      "fastRedemptionData": []
    },
    {
      "ordId": "2213257",
      "ccy": "USDT",
      "productId": "4005",
      "state": "1",
      "protocol": "On-Chain Defi",
      "protocolType": "defi",
      "term": "0",
      "apy": "0.0323",
      "investData": [
        {
          "ccy": "USDT",
          "amt": "1"
        }
      ],
      "earningData": [
        {
          "ccy": "USDT",
          "earningType": "0",
          "earnings": "0.02886582"
        },
        {
          "ccy": "COMP",
          "earningType": "1",
          "earnings": "0.0000627"
        }
      ],
      "purchasedTime": "1725345790000",
      "estSettlementTime": "",
      "cancelRedemptionDeadline": "",
      "tag": "",
      "fastRedemptionData": []
    },
    {
      "ordId": "2210943",
      "ccy": "USDT",
      "productId": "4005",
      "state": "1",
      "protocol": "On-Chain Defi",
      "protocolType": "defi",
      "term": "0",
      "apy": "0.0323",
      "investData": [
        {
          "ccy": "USDT",
          "amt": "1"
        }
      ],
      "earningData": [
        {
          "ccy": "USDT",
          "earningType": "0",
          "earnings": "0.02891823"
        },
        {
          "ccy": "COMP",
          "earningType": "1",
          "earnings": "0.0000632"
        }
      ],
      "purchasedTime": "1725280801000",
      "estSettlementTime": "",
      "cancelRedemptionDeadline": "",
      "tag": "",
      "fastRedemptionData": []
    }
  ]
}

Retrieve your currently active staking and DeFi earn orders, including invested amounts, earnings, and order state.

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

productIdstringOptional

Product ID.

protocolTypeenumOptional

Protocol type.

Allowed values:

ccystringOptional

Investment currency, e.g. BTC.

stateenumOptional

Order state. 8: Pending, 13: Cancelling, 9: On-chain, 1: Earning, 2: Redeeming.

Allowed values:

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 active orders

Authentication

Query parameters

Response

More about OKX

Products

Services

Support

Buy crypto

Crypto calculator

Trade

Trade on the go with OKX