钱包 API
订阅数据

订阅数据#

订阅区块事件和交易事件的相关数据,每次最多可以批量创建20个订阅,参考请求示例内的数组格式。订阅成功后消息通过webhook 推送。

请求路径#

POST https://www.okx.com/api/v5/waas/wallet/webhook/subscribe

请求参数#

ParameterTypeRequiredDescription
urlStringYesWebhook 回调地址
详细用法参考这里
typeStringYes订阅数据的类型,有效值:
transaction:有任何地址相关的交易发生,都会触发
block: 有任何区块产生,都会触发
chainIndexStringYes链唯一标识
nameStringNo订阅的名称

响应参数#

ParameterTypeDescription
idString订阅的唯一标识

请求示例#

shell
curl --location --request POST 'https://www.okx.com/api/v5/waas/wallet/webhook/subscribe' \
--header 'Content-Type: application/json' \
--header 'OK-ACCESS-PROJECT: 86af********d1bc' \
--header 'OK-ACCESS-KEY: 37c541a1-****-****-****-10fe7a038418' \
--header 'OK-ACCESS-SIGN: leaV********3uw=' \
--header 'OK-ACCESS-PASSPHRASE: 1****6' \
--header 'OK-ACCESS-TIMESTAMP: 2023-10-18T12:21:41.274Z' \
--data-raw '[
    {
        "chainIndex":"3",
        "url":"http://your.server.com/webhook",
        "type":"transaction"
    }
]'

响应示例#

200
{
    "code":"0",
    "data":[
        { "id":"1" }
    ],
    "msg":""
}