WebSocket Connections

Returns your API key's live WebSocket slot usage: open connections with their state, and how many slots remain under your plan's limit. Check it before reconnecting so a restart never exceeds your connection limit. This endpoint does not count against your quota.

GET/v2/ws/connections

Plans All plansDoes not count toward monthly usage

Parameters

No parameters required.

Response

successboolean

Always true on a 2xx response.

tierstring

Plan tier of the calling key (free, dev, pro, enterprise).

max_connectionsinteger

Concurrent WebSocket connections allowed for your key. 0 means your plan has no WebSocket access.

connectedinteger | null

Connections currently holding a slot (active plus closing).

activeinteger | null

Connections that are open and receiving data.

closinginteger | null

Connections in a close handshake. They hold a slot until it finishes.

availableinteger | null

Slots left before a new connection is rejected with CONNECTION_LIMIT. Never negative.

as_ofstring

When the counts were last recorded (ISO 8601, UTC). At most about 10 seconds old while connections are open.

connectionsarray

Connections holding a slot, oldest first.

Show 5 fields

idstring

Opaque identifier, stable for the connection's lifetime.

statestring

active or closing. Both hold a slot.

connected_atstring

When the connection authenticated and took its slot (UTC).

last_message_atstring | null

When your client last sent a frame (subscribe, unsubscribe or heartbeat). null if none since authenticating.

subscriptionsinteger

Subscriptions held across all channels.

slot_releaseobject

How slots are released.

Show 3 fields

graceful_closestring

immediate: a close frame from your client frees the slot as soon as the close completes.

unexpected_disconnect_max_secondsinteger

Upper bound, after your client's last frame, before a connection that dropped without closing frees its slot.

heartbeat_interval_secondsinteger

Seconds of silence after which the server pings your client. A missing pong closes the connection.