Skip to main content
This guide walks through the first requests most integrations need: verify connectivity, list competitions, list matches, and fetch details for one match.
1

Get your API key

Create an API key in your account dashboard and store it in an environment variable.
2

Check API health

The health endpoint is public and does not require authentication.
A healthy API returns JSON like this:
3

Fetch competitions

List competitions to find stable competition IDs such as comp_3039.
Example response:
4

Fetch matches

Query matches with date filters, competition/season filters, status, stage, or group.
Match list responses include IDs such as mt_838955483 and flags such as xg_available, odds_available, and live_odds_available.
5

Fetch a match detail

Use the match ID from a list response to retrieve the full match record.
After you have IDs, use the reference to fetch seasons, standings, squads, team/player stats, live stats, lineups, timelines, shotmaps, heatmaps, and odds.