Get spreads

GET

https://www.okx.com/api/v5/sprd/spreads

GET

/api/v5/sprd/spreads

curl https://www.okx.com/api/v5/sprd/spreads

200spreadTrading_getSpreads_example

{
  "code": "0",
  "msg": "",
  "data": [
    {
      "sprdId": "ETH-USD-SWAP_ETH-USD-231229",
      "sprdType": "inverse",
      "state": "live",
      "baseCcy": "ETH",
      "szCcy": "USD",
      "quoteCcy": "USD",
      "tickSz": "0.01",
      "minSz": "10",
      "lotSz": "10",
      "listTime": "1686903000159",
      "expTime": "1703836800000",
      "uTime": "1691376905595",
      "legs": [
        {
          "instId": "ETH-USD-SWAP",
          "side": "sell"
        },
        {
          "instId": "ETH-USD-231229",
          "side": "buy"
        }
      ]
    },
    {
      "sprdId": "BTC-USDT_BTC-USDT-SWAP",
      "sprdType": "linear",
      "state": "live",
      "baseCcy": "BTC",
      "szCcy": "BTC",
      "quoteCcy": "USDT",
      "tickSz": "0.0001",
      "minSz": "0.001",
      "lotSz": "1",
      "listTime": "1597026383085",
      "expTime": "1597029999085",
      "uTime": "1597028888085",
      "legs": [
        {
          "instId": "BTC-USDT",
          "side": "sell"
        },
        {
          "instId": "BTC-USDT-SWAP",
          "side": "buy"
        }
      ]
    },
    {
      "sprdId": "BTC-USDT_BTC-USDT-230317",
      "sprdType": "linear",
      "state": "live",
      "baseCcy": "BTC",
      "szCcy": "BTC",
      "quoteCcy": "USDT",
      "tickSz": "0.0001",
      "minSz": "0.001",
      "lotSz": "1",
      "listTime": "1597026383085",
      "expTime": "1597029999085",
      "uTime": "1597028888085",
      "legs": [
        {
          "instId": "BTC-USDT",
          "side": "sell"
        },
        {
          "instId": "BTC-USDT-230317",
          "side": "buy"
        }
      ]
    }
  ]
}

Retrieve the list of available spreads and their details. This is a public endpoint that does not require authentication.

Query parameters

baseCcystringOptional

Currency of the base leg, e.g. BTC.

instIdstringOptional

Instrument ID of a leg contained in the spread, e.g. BTC-USDT.

sprdIdstringOptional

Spread ID.

stateenumOptional

Spread state.

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 spreads

Query parameters

Response

More about OKX

Products

Services

Support

Buy crypto

Crypto calculator

Trade

Trade on the go with OKX