订阅数据#

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

注意

遇到区块回滚等特殊情况时，Webhook 会有重新推送数据的情况，您在接收时，需要做幂等处理。

请求路径#

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

请求参数#

Parameter	Type	Required	Description
url	String	Yes	Webhook 回调地址，详细的使用案例，请参阅这里回调地址需要审核，审核通过后才能接收到推送消息。联系我们
type	String	Yes	订阅数据的类型，目前支持: `block`: 有任何区块产生，都会触发 `token_issuance`: 代币增发 `fee_fluctuation`: 手续费波动
chainIndex	String	Yes	链唯一标识
name	String	No	订阅的名称
feeChangeFilter	Object	No	手续费变化量筛选，仅适用于 type 为 `fee_fluctuation`
> minChange	String	Yes	最小波动幅度，有效值 0.01 到 100。如 0.01 代表波动幅度为 1%
> maxChange	String	No	最大波动幅度，有效值 0.01 到 100。如 0.01 代表波动幅度为 1%

响应参数#

Parameter	Type	Description
id	String	订阅的唯一标识

请求示例#

shell

curl --location --request POST 'https://www.okx.com/api/v5/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": ""
}