Includes & pagination

Includes

Many GET endpoints accept the include query parameter. It populates the response with related entities, so you make fewer requests.

Value	Entity
`m`	matches
`o`	overlays
`t`	teams
`c`	competitions
`v`	venues
`p`	players
`s`	streams
`cp`	competitors

Send a comma-separated list. Each endpoint accepts a subset. The reference page for the endpoint lists the values. The v1 match endpoints accept t for teams. The v2 match endpoints accept cp for competitors instead.

curl 'https://api.ligr.live/rest/v1/matches/1188213?include=t,o,c' \
  -H 'Authorization: Bearer YOUR_READ_KEY'

Limits

Includes apply one level deep. An included team does not carry its own includes.
Each endpoint has its own allow-list. The reference page of each endpoint names the values it accepts.
An unknown or unsupported value is ignored. The request succeeds and the response omits that object. The API returns no error. Check the response for the objects you asked for.

Pagination

List endpoints take limit and offset.

Parameter	Meaning	Default
`limit`	The number of items in this response	Set by the endpoint
`offset`	The number of items to skip	`0`

The maximum limit is 100 on match lists. It is 500 on the other lists.

Response shape

Most list endpoints return the item array, a total and a returned count.

{
  "matches": [ /* … */ ],
  "total": 412,
  "returned": 50
}

total is the number of items that match the filter, across all pages.
returned is the number of items in this response.

Some smaller lists return a count instead of total and returned. The reference page of each endpoint shows the exact shape.

Page through a list

Increase offset by limit until offset reaches total.

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