行情 API

K线频道#

获取K线数据,推送频率最快是间隔1秒推送一次数据。

URL路径
请联系我们 dexapi@okx.com

请求参数#

ParameterTypeRequiredDescription
opString操作,subscribe unsubscribe
argsArray请求订阅的频道列表
channelString频道名。 candle4H candle2H candle1H candle30m candle15m candle5m candle3m candle1m candle1s candle3M candle1M candle1W candle1D candle12H candle6H candle3Mutc candle1Mutc candle1Wutc candle1Dutc candle12Hutc candle6Hutc
chainIndexString链的唯一标识。 (如1代表Ethereum。更多可查看这里。)
tokenContractAddressString币种合约地址

响应参数#

ParameterTypeDescription
eventString事件, subscribe unsubscribe error
argObject订阅的频道
channelString频道名
chainIndexString链的唯一标识。
tokenContractAddressString币种合约地址
codeString错误码
msgString错误消息
|connIdStringWebSocket连接ID

推送数据参数#

ParameterTypeDescription
argObject订阅成功的频道
> channelString频道名
> chainIndexString链的唯一标识。
> tokenContractAddressString币种合约地址
dataArray频道的数据
> tsString开始时间,Unix时间戳的毫秒数格式,如 1597026383085
> oString开盘价格
> hString最高价格
> lString最低价格
> cString收盘价格
> volString交易量,以目标币种为单位
> volUsdString交易量,以美元为单位
> confirmStringK线状态。
0:K线未完结 1:K线已完结

请求示例#

shell
{
  "op": "subscribe",
  "args": [
    {
      "channel": "candle1D",
      "chainIndex": "1",
      "tokenContractAddress":"0x382bb369d343125bfb2117af9c149795c6c65c50"
    }
  ]
}

响应示例#

200

成功响应示例

{
  "event": "subscribe",
  "arg": {
    "channel": "candle1D",
    "chainIndex": "1"
    "tokenContractAddress":"0x382bb369d343125bfb2117af9c149795c6c65c50"
  },
  "connId": "a4d3ae55"
}

失败响应示例

{
  "event": "error",
  "code": "60012",
  "msg": "Invalid request: {\"op\": \"subscribe\", \"argss\":[{ \"channel\" : \"candle1D\", \"chainIndex\" : \"1\", \"tokenContractAddress\" : \"0x382bb369d343125bfb2117af9c149795c6c65c50\"}]}",
  "connId": "a4d3ae55"
}

推送数据示例

{
  "arg": {
    "channel": "candle1D",
    "chainIndex": "1"
    "tokenContractAddress":"0x382bb369d343125bfb2117af9c149795c6c65c50"
  },
  "data": [
    [
      "1597026383085",
      "8533.02",
      "8553.74",
      "8527.17",
      "8548.26",
      "529.5858061",
      "226348.0482",
      "0"
    ]
  ]
}