Getting Started
Get started with the Broadcast API: use the Try API to call endpoints with your API key, then explore Authentication and Code examples for details.
Try API
The Try API is an interactive tool to run GET requests against the Broadcast API using the API key you validate in the workspace. You can select an endpoint (e.g. schedule, game stats, or SSE streams), fill path and query parameters, run the request, and inspect the JSON response. Response search and copy-to-clipboard are available.
Open the Try API from the workspace by clicking Try API in the Explore pane (after validating your Broadcast API key). You can also go directly to /try?api=broadcast.
- Broadcast API GET endpoints only
- Your API key is sent automatically from the workspace credentials
- Path and query parameters with sensible defaults where defined in the spec
Next steps
For how to pass your API key (query parameter or header) and for connection examples to SSE endpoints (e.g. live game stats), see the subsections below.
- → Authentication — API key usage and options
- → Code examples — Authentication and Stats SSE (JavaScript and Go)
To use the Try API, validate your Broadcast API key in the workspace first.