Your first request

This page takes about five minutes. You need an API key and a terminal.

1. Create a read key.

   Open the LIGR dashboard. Open the account menu at the bottom of the sidebar and 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.

2. List one match.

   Replace YOUR_READ_KEY with the key you copied.

   Terminal

   curl 'https://api.ligr.live/rest/v2/matches?limit=1' \
     -H 'Authorization: Bearer YOUR_READ_KEY'

3. 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
   }

   total is the number of matches your organization owns. returned is the number in this response. Keep the id. Most other endpoints need it.

4. 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,cp adds the overlay and the competitors to the response. See Includes & pagination.

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	Create a key with the scope the message names
404	The id belongs to another organization	Search the list endpoint first

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. See Webhooks overview.
• Understand the object model: read Concepts.