订阅区块事件和交易事件的相关数据,每次最多可以批量创建20个订阅,参考请求示例内的数组格式。订阅成功后消息通过webhook 推送。
POST https://www.okx.com/api/v5/waas/wallet/webhook/subscribe
Parameter | Type | Required | Description |
---|---|---|---|
url | String | Yes | Webhook 回调地址 详细用法参考这里 |
type | String | Yes | 订阅数据的类型,有效值: transaction :有任何地址相关的交易发生,都会触发 block : 有任何区块产生,都会触发 |
chainIndex | String | Yes | 链唯一标识 |
name | String | No | 订阅的名称 |
Parameter | Type | Description |
---|---|---|
id | String | 订阅的唯一标识 |
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"
}
]'
{
"code":"0",
"data":[
{ "id":"1" }
],
"msg":""
}