Sign in
Websocket

List registered real-time queries

Returns every active WebSocket query registration of the API key (totalQueries carries the count), each with its registration_id, the query parameters it was registered with (parameter names in lowercase), and active_clients — the number of devices currently connected to the stream for it. Available on plans with WebSocket access.

The API key must be sent as the apikey query parameter — the X-ACCESS-KEY header is not supported on this endpoint. Consumes no API credits.

get/1/websocket/fetch

Query parameters

apikeystring required

Your API key, passed as a query-string parameter. This endpoint does not accept the X-ACCESS-KEY header.

Response

Success.

status'success' required
totalQueriesinteger required

Number of active registrations for this API key.

Changes