Get grid orders history

GET

https://www.okx.com/api/v5/tradingBot/grid/orders-algo-history

GET

/api/v5/tradingBot/grid/orders-algo-history

curl -G https://www.okx.com/api/v5/tradingBot/grid/orders-algo-history \
     -H "OK-ACCESS-KEY: <apiKey>" \
     -d algoOrdType=grid

200gridTrading_getGridOrdersHistory_example

{
  "code": "0",
  "msg": "",
  "data": [
    {
      "algoId": "565849588675117056",
      "algoClOrdId": "",
      "instType": "SPOT",
      "instId": "BTC-USDT",
      "cTime": "1681181054927",
      "uTime": "1681181186496",
      "algoOrdType": "grid",
      "state": "stopped",
      "maxPx": "5000",
      "minPx": "400",
      "gridNum": "10",
      "runType": "1",
      "investment": "25",
      "totalPnl": "0",
      "pnlRatio": "0",
      "gridProfit": "0",
      "actualLever": "",
      "arbitrageNum": "0",
      "availEq": "",
      "basePos": false,
      "baseSz": "0",
      "cancelType": "1",
      "copyType": "0",
      "direction": "",
      "fee": "",
      "feeCcy": "",
      "floatProfit": "0",
      "fundingFee": "",
      "instFamily": "",
      "lever": "0",
      "liqPx": "",
      "ordFrozen": "",
      "profitSharingRatio": "",
      "quoteSz": "25",
      "rebateTrans": [
        {
          "rebate": "0",
          "rebateCcy": "BTC"
        },
        {
          "rebate": "0",
          "rebateCcy": "USDT"
        }
      ],
      "slTriggerPx": "0",
      "stopResult": "0",
      "stopType": "1",
      "sz": "",
      "tag": "",
      "tpTriggerPx": "0",
      "tradeQuoteCcy": "USDT",
      "triggerParams": [
        {
          "delaySeconds": "0",
          "triggerAction": "start",
          "triggerStrategy": "instant",
          "triggerTime": "",
          "triggerType": "auto"
        },
        {
          "delaySeconds": "0",
          "stopType": "1",
          "triggerAction": "stop",
          "triggerPx": "1000",
          "triggerStrategy": "instant",
          "triggerTime": "1681181186484",
          "triggerType": "manual"
        }
      ],
      "uly": "BTC-USDT"
    }
  ]
}

Retrieve a list of stopped grid algo orders from the last three months.

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

algoOrdTypeenumRequired

Algo order type grid: Spot grid contract_grid: Contract grid

Allowed values:

algoIdstringOptional

Algo ID

instIdstringOptional

Instrument ID, e.g. BTC-USDT

instTypeenumOptional

Instrument type SPOT MARGIN FUTURES SWAP

Allowed values:

instFamilystringOptional

Instrument family, applicable to contract grid.

afterstringOptional

Pagination of data to return records earlier than the requested algoId.

beforestringOptional

Pagination of data to return records newer than the requested algoId.

limitstringOptional

Number of results per request. The maximum is 100. The default is 100.

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 grid orders history

Authentication

Query parameters

Response

More about OKX

Products

Services

Support

Buy crypto

Crypto calculator

Trade

Trade on the go with OKX