Skip to main content

1. Overview

Plan required: Available data products:
No data is pushed automatically after a successful handshake — you need to send a subscribe message and get an ack before you’ll start receiving pushes. A single connection can subscribe to multiple products at once.
Field requirement conventions used throughout these docs:

2. Establishing the Connection

2.1 Handshake URL

Handshake URL
Filter conditions (league_id / country_id / match_id) belong in the subscribe message’s data object, don’t put them in the URL.

2.2 Handshake Success Response

Handshake success response example
At this point the connection is live, but no business data is flowing yet. The handshake itself can also be rejected at the HTTP layer, for example:
  • 401 / 403: invalid API key
  • 429: too many concurrent connections, or your account is temporarily throttled

3. Full Sequence Diagram

The diagram below shows a full connection lifecycle: handshake → subscribe to two products → receive pushes → heartbeat → unsubscribe. Next: see Heartbeat & Keep-Alive for how to keep this connection open, and Message Format & Codes for the full request/response schema.