Skip to content

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

  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.

StatusCauseFix
401The key is missing or invalid, or the authentication headers are invalidUse Authorization: Bearer <api key>. See Authentication
403The key lacks the scope for the route, or the id belongs to another organizationIf code is INSUFFICIENT_SCOPE, create a key with the scope the message names. Else, get the id from the list endpoint
404No match has that idGet the id from the list endpoint
  • 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.