Wallet API
Subscription List

Subscription List#

Query the list of successfully subscribed tasks. If a task has been unsubscribed, it will not be returned by the interface.

Request Path#

GET https://www.okx.com/api/v5/wallet/webhook/subscriptions

Request Parameters#

None

Response Parameters#

ParameterTypeDescription
chainIndexStringUnique identifier of the chain
idStringUnique identifier of the subscription
nameStringName of the subscription
typeStringType of the subscribed data
urlStringWebhook callback URL
feeChangeFilterObjectFee fluctuation filter, applicable only when the type is fee_fluctuation
> minChangeStringMinimum fluctuation
> maxChangeStringMaximum fluctuation

Request Example#

shell
curl --location --request GET 'https://www.okx.com/api/v5/wallet/webhook/subscriptions' \
--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' 

Response Example#

200
{
    "code":"0",
    "data":[
        {
            "chainIndex":"1",
            "id":"1",
            "name":"",
            "type":"transaction",
            "url":"http://your.server.com/webhook"
        }
    ],
    "msg":""
}