Skip to main content

List subscriptions message format

List subscriptions requests must be sent as JSON in text frames, one request per frame. This message is different from other as it doesn't require you to provide subscription ID. Thus, the response for this message is different too.

Example of request


_10
{
_10
"action": "list_subscriptions"
_10
}

Example of response


_16
{
_16
"subscriptions": [
_16
{
_16
"subscription_id": "uuid-1",
_16
"topic": "blocks",
_16
"parameters": {
_16
"start_block_height": "123456789"
_16
}
_16
},
_16
{
_16
"subscription_id": "uuid-2",
_16
"topic": "events",
_16
"parameters": {}
_16
}
_16
]
_16
}

If there are no active subscriptions, subscriptions array will be empty.

Request fields

NameTypeMandatoryDescription
actionSTRINGYESAction to perform. Must be list_subscriptions to initiate a list subscription request