Skip to main content
WebSockets are only available on the Pro and Enterprise tiers. If you connect with a Free tier key, the server will instantly drop your connection. Use GET /alerts/latest instead if you’re on Free.

The Endpoint

Hook your client into this URL. Do not put your API key in the Authorization header—WebSocket libraries are notoriously inconsistent with custom headers. Pass it exactly as shown in the query string.

Setup Example

Payload Specifications

connected

Fired exactly once the millisecond your connection is successfully authenticated.

alert

A live insider alert. The data property contains the exact Alert Object you get from the REST API.

pong

Sent by the server immediately after you send a ping.
Keep-Alives are mandatory. The server unapologetically drops connections that fail to send a ping string within any rolling 30-second window. Set your interval to 20-25 seconds to be safe.

Handling Disconnects

Networks hiccup. Servers redeploy. Your bot should be resilient. Always use exponential backoff when reconnecting so you don’t get banned for hammering the auth server if something goes down.
Reconnection Logic