OKX API 文档

主题

Status ​

GET / Status ​

获取系统升级事件的状态。

由计划系统维护引起的短暂不可用（<5秒）和WebSocket闪断连接（用户可以立即重连）将不会公布。此类维护只会在市场波动性低的时期进行。

限速：1次/5s ​

HTTP请求 ​

GET /api/v5/system/status

请求示例

shell
GET /api/v5/system/status

GET /api/v5/system/status?state=canceled
python
import okx.Status as Status

flag = "0"  # 实盘:0 , 模拟盘：1
statusAPI = Status.StatusAPI(
    domain="https://openapi.okx.com",
    flag=flag,
)

# 获取系统升级事件的状态
result = statusAPI.status()
print(result)

请求参数 ​

请求示例 ​

参数名类型是否必须描述
stateString否系统的状态
scheduled：等待中
ongoing：进行中
pre_open：预开放
completed：已完成
canceled：已取消
当维护时间过长，会存在预开放时间，一般持续10分钟左右。
不填写此参数，默认返回 等待中、进行中和预开放 的数据

返回结果

json
{
    "code": "0",
    "data": [
        {
            "begin": "1672823400000",
            "end": "1672823520000",
            "href": "",
            "preOpenBegin": "",
            "scheDesc": "",
            "serviceType": "8",
            "state": "completed",
            "maintType": "1",
            "env": "1",
            "system": "unified",
            "title": "Trading account system upgrade (in batches of accounts)"
        }
    ],
    "msg": ""
}

返回参数 ​

参数名类型描述
titleString系统维护说明的标题
stateString系统维护的状态
beginString系统维护的开始时间，Unix时间戳的毫秒数格式 如：1617788463867
endString交易全面开放的时间，Unix时间戳的毫秒数格式 如：1617788463867
在维护完成前，是预期结束时间；维护完成后，会变更为实际结束时间。
preOpenBeginString预开放开始的时间，开放撤单、Post Only 下单和资金转入功能的时间
hrefString系统维护详情的超级链接,若无返回值，默认值为空，如 ""
serviceTypeString服务类型
0：WebSocket
5：交易服务
6：大宗交易
7：策略交易
8：交易服务 (按账户分批次)
9：交易服务 (按产品分批次)
10：价差交易
11：跟单交易
99：其他（如：停止部分产品交易）
systemString系统
unified：交易账户
scheDescString改期进度说明，如 由 2021-01-26T16:30:00.000Z改期到2021-01-28T16:30:00.000Z
maintTypeString维护类型
1：计划维护
2：临时维护
3：系统故障
envString环境
1：实盘
2：模拟盘

WS / Status 频道 ​

获取系统维护的状态，当系统维护状态改变，改期，以及修改结束时间时推送。首次订阅：”推送最新一条的变化数据“；后续每次有状态变化，推送变化的内容。

由计划系统维护引起的短暂不可用（<5秒）和WebSocket闪断连接（用户可以立即重连）将不会公布。此类维护只会在市场波动性低的时期进行。

URL Path ​

/ws/v5/public

请求示例

shell
{
    "id": "1512",
    "op": "subscribe",
    "args": [{
        "channel": "status"
    }]
}
python
import asyncio
from okx.websocket.WsPublicAsync import WsPublicAsync

def callbackFunc(message):
    print(message)

async def main():
    ws = WsPublicAsync(url="wss://wspap.okx.com:8443/ws/v5/public")
    await ws.start()
    args = [{
        "channel": "status"
    }]

    await ws.subscribe(args, callback=callbackFunc)
    await asyncio.sleep(10)

    await ws.unsubscribe(args, callback=callbackFunc)
    await asyncio.sleep(10)

asyncio.run(main())

请求参数 ​

参数类型是否必须描述
idString否消息的唯一标识。
用户提供，返回参数中会返回以便于找到相应的请求。
字母（区分大小写）与数字的组合，可以是纯字母、纯数字且长度必须要在1-32位之间。
opString是操作
subscribe
unsubscribe
argsArray of objects是请求订阅的频道列表
> channelString是频道名
status

成功返回示例

json
{
    "id": "1512",
    "event": "subscribe",
    "arg": {
        "channel": "status"
    },
    "connId": "a4d3ae55"
}

失败返回示例

json
{
    "id": "1512",
    "event": "error",
    "code": "60012",
    "msg": "Invalid request: {\"op\": \"subscribe\", \"argss\":[{ \"channel\" : \"statuss\"}]}",
    "connId": "a4d3ae55"
}

返回参数 ​

参数类型是否必须描述
idString否消息的唯一标识
eventString是事件
subscribe
unsubscribe
error
argObject否订阅的频道
> channelString是频道名
status
codeString否错误码
msgString否错误消息
connIdString是WebSocket连接ID

推送示例

json
{
    "arg": {
        "channel": "status"
    },
    "data": [
        {
            "begin": "1672823400000",
            "end": "1672825980000",
            "href": "",
            "preOpenBegin": "",
            "scheDesc": "",
            "serviceType": "0",
            "state": "completed",
            "system": "unified",
            "maintType": "1",
            "env": "1",
            "title": "Trading account WebSocket system upgrade",
            "ts": "1672826038470"
        }
    ]
}

推送数据参数 ​

参数名类型描述
argObject订阅成功的频道
> channelString频道名
status
dataArray of objects订阅的数据
> titleString系统维护说明的标题
> stateString系统的状态，scheduled:等待中 ; ongoing:进行中 ; pre_open:预开放；completed:已完成 canceled: 已取消
当维护时间过长，会存在预开放时间，一般持续10分钟左右。
> beginString系统维护的开始时间，Unix时间戳的毫秒数格式 如：1617788463867
> endString交易全面开放的时间，Unix时间戳的毫秒数格式 如：1617788463867
在维护完成前，是预期结束时间；维护完成后，会变更为实际结束时间。
> preOpenBeginString预开放开始的时间，开放撤单、Post Only 下单和资金转入功能的时间
> hrefString系统维护详情的超级链接,若无返回值，默认值为空，如：“”
> serviceTypeString服务类型， 0：WebSocket ; 5：交易服务；6：大宗交易；7：策略交易；8：交易服务 (按账户分批次)；9：交易服务 (按产品分批次)；10：价差交易；11：跟单交易；99：其他（如：停止部分产品交易）
> systemString系统，unified：交易账户
> scheDescString改期进度说明，如： 由 2021-01-26T16:30:00.000Z 改期到 2021-01-28T16:30:00.000Z
> maintTypeString维护类型。
1：计划维护；2：临时维护；3：系统故障
> envString环境。
1：实盘，2：模拟盘
> tsString事件变更的推送时间，Unix时间戳的毫秒数格式，如：1617788463867