Your first request
This page takes about five minutes. You need an API key and a terminal.
-
Create a read key.
Open the LIGR dashboard. In the sidebar, select Organization settings. In the settings menu, select Developers. On the API keys tab, select Create API key. Set Matches to Read, keep the 30 day expiry, and select Create key. Copy the key. LIGR shows it once.
-
List one match.
Replace
YOUR_READ_KEYwith the key you copied.Terminal curl 'https://api.ligr.live/rest/v2/matches?limit=1' \-H 'Authorization: Bearer YOUR_READ_KEY' -
Read the response.
200 OK {"matches": [{"id": 1188213,"name": "Sydney FC v Melbourne City","sport": "football","date": "2026-09-12T09:30:00.000Z","competitionId": 2311,"competitorsType": "teams","liveStatus": "pregame","finishedStatus": "default"}],"total": 412,"returned": 1}totalis the number of matches your organization owns.returnedis the number in this response. Keep theid. Most other endpoints need it. -
Fetch one match with its overlay.
Terminal curl 'https://api.ligr.live/rest/v2/matches/1188213?include=o,cp' \-H 'Authorization: Bearer YOUR_READ_KEY'include=o,cpadds the overlay and the competitors to the response. See Includes & pagination.
If the request fails
Section titled “If the request fails”| Status | Cause | Fix |
|---|---|---|
| 401 | The key is missing or invalid, or the authentication headers are invalid | Use Authorization: Bearer <api key>. See Authentication |
| 403 | The key lacks the scope for the route, or the id belongs to another organization | If code is INSUFFICIENT_SCOPE, create a key with the scope the message names. Else, get the id from the list endpoint |
| 404 | No match has that id | Get the id from the list endpoint |
What to do next
Section titled “What to do next”- Write data: post a fact to a match. See the Facts reference.
- React to changes: subscribe a webhook instead of polling. Webhooks are off by default. Ask your LIGR contact to turn them on. See Webhooks overview.
- Understand the object model: read Concepts.