Skip to main content

Server Endpoint

Authentication

Connect using your username and API key:

Command Line Options

Connection Flow

Connection States

Once connected, you’ll see initialization messages:
After the connection is established, JSON messages begin streaming automatically.

TLS Configuration

By default, connections are made without TLS. To enable TLS encryption, use the appropriate flag provided by your client library.

Connection Best Practices

Keep your connection alive to receive continuous updates. Implement reconnection logic to handle network interruptions gracefully.
  1. Implement Reconnection Logic: Network interruptions can occur; implement exponential backoff for reconnection attempts
  2. Handle Disconnections: Monitor connection state and reconnect when needed
  3. Buffer Messages: Process messages asynchronously to avoid blocking the receive loop
  4. Log Connection Events: Track connection status for debugging and monitoring

Example Connection

Next Steps