query.subscription.list

List active subscriptions.

Method

query.subscription.list

Description

Returns a list of active data subscriptions for the current user. Subscriptions include market data (order books) and trading account updates.

Parameters

Field	Type	Required	Description
tradingAccountId	string	No	Filter by trading account
instrumentId	string	No	Filter by instrument
limit	integer	No	Maximum results (default: 100)
offset	integer	No	Pagination offset
cursor	string	No	Pagination cursor

Result

Returns an array of subscription objects.

Subscription Object

Field	Type	Description
subscriptionId	string	Unique subscription identifier
type	string	Subscription type (ORDER_BOOK, TRADING_ACCOUNT)
channel	string	Centrifugo channel name
instrumentId	string	Instrument (for market subscriptions)
tradingAccountId	string	Account (for trading subscriptions)
status	string	Subscription status
createdAt	integer	Creation timestamp (ms)

Subscription Status Values

Status	Description
ACTIVE	Subscription is active
PENDING	Subscription is being set up
TERMINATED	Subscription has ended

Usage

# List all subscriptions
result = await client.rpc("query.subscription.list", {})

# List subscriptions for a specific account
result = await client.rpc("query.subscription.list", {
    "tradingAccountId": "550e8400-e29b-41d4-a716-446655440000"
})

Example Response

{
  "data": [
    {
      "subscriptionId": "sub-001",
      "type": "ORDER_BOOK",
      "channel": "market:orderBook:BINANCE:BTC/USDT",
      "instrumentId": "BINANCE:BTC/USDT",
      "status": "ACTIVE",
      "createdAt": 1703052635110
    },
    {
      "subscriptionId": "sub-002",
      "type": "TRADING_ACCOUNT",
      "channel": "tradingAccount:550e8400-e29b-41d4-a716-446655440000",
      "tradingAccountId": "550e8400-e29b-41d4-a716-446655440000",
      "status": "ACTIVE",
      "createdAt": 1703052635110
    }
  ],
  "pagination": {
    "offset": 0,
    "limit": 100,
    "total": 5
  }
}