Create a match (v2)
POST/v2/matches
const url = 'https://api.ligr.live/rest/v2/matches';const options = { method: 'POST', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"name":"example","venueId":1,"competitionId":1,"date":"2026-04-15T12:00:00Z","competitorsType":"singles","competitors":[{"entityId":1,"entityType":"team","meta":{"isHome":true}}],"description":"example","config":"example"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://api.ligr.live/rest/v2/matches \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "name": "example", "venueId": 1, "competitionId": 1, "date": "2026-04-15T12:00:00Z", "competitorsType": "singles", "competitors": [ { "entityId": 1, "entityType": "team", "meta": { "isHome": true } } ], "description": "example", "config": "example" }'Create a new match for the organization. The response lists the overlays and streams that the competition templates made for the match.
Authorizations
Section titled “Authorizations”Request Bodyrequired
Section titled “Request Bodyrequired”object
Match name
Entity identifier
Entity identifier
The match format: singles, doubles, teams or group. It is one value for the match.
Each row in competitors has its own entityType. For example, a doubles match has
competitorsType: doubles and four entityType: player rows. A group match has player rows.
object
Entity identifier
The kind of one competitor row: team or player. A teams match has team rows.
A singles, doubles or group match has player rows.
object
Free text about the match.
Match rules for this match only. The value applies onto the competition matchConfig: a key that
you omit keeps the competition value, and a nested object merges the same way. An array, such as
periods.overtime, replaces the competition array. Send null for rules, periods.overtime,
periods.shootout or dataCoverage.players to remove it. A config equal to the competition rules
is not stored, so the match follows later changes to the competition.
The API checks rules and, for tennis, the scoring. A value that fails the check returns 400
with the reason, and no match is created.
Responses
Section titled “Responses”object
The overlays that the competition overlay templates made for the new match. Empty when the competition has no overlay template.
object
The streams that the competition stream templates made for the new match. Empty when the competition has no stream template.
object
Examplegenerated
{ "overlays": [ { "name": "example", "key": "example", "id": 1 } ], "streams": [ { "name": "example", "id": 1 } ], "id": 1}Request is invalid
object
object
Examplegenerated
{ "message": "example", "details": { "additionalProperty": "example" }}Missing or invalid api key
object
Examplegenerated
{ "message": "example"}Api key provides insufficient access for the request
object
Examplegenerated
{ "message": "example"}Match not found
object
Examplegenerated
{ "message": "example"}Organization has made too many requests
object
Examplegenerated
{ "message": "example"}An unexpected error has occured. If problems persist please contact support
object
Examplegenerated
{ "message": "example"}