Skip to content
Developers

Create a match (v1)

POST/v1/matches

POST
/v1/matches
curl --request POST \
  --url https://api.ligr.live/rest/v1/matches \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "venueId": 1, "competitionId": 1, "date": "2026-04-15T12:00:00Z", "homeTeamId": 1, "awayTeamId": 1 }'

Create a new match using team competitors. Tennis competitions are not supported in v1; use v2 instead.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
name

Match name

string
>= 5 characters <= 42 characters
venueId
required

Entity identifier

integer format: int32
>= 1
competitionId
required

Entity identifier

integer format: int32
>= 1
date
required
string format: date-time
homeTeamId
required

Entity identifier

integer format: int32
>= 1
awayTeamId
required

Entity identifier

integer format: int32
>= 1
Examplegenerated
{
  "name": "example",
  "venueId": 1,
  "competitionId": 1,
  "date": "2026-04-15T12:00:00Z",
  "homeTeamId": 1,
  "awayTeamId": 1
}

Responses

Section titled “Responses”

201

Section titled “201”
Media typeapplication/json
object
overlays
required
Array<object>
object
name
required
string
key
required

Stringified UUIDv4. See RFC 4112

string
/[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-4[0-9A-Fa-f]{3}-[89ABab][0-9A-Fa-f]{3}-[0-9A-Fa-f]{12}/
id
required
number format: double
streams
required
Array<object>
object
name
required
string
id
required
number format: double
id
required
number format: double
Examplegenerated
{
  "overlays": [
    {
      "name": "example",
      "key": "example",
      "id": 1
    }
  ],
  "streams": [
    {
      "name": "example",
      "id": 1
    }
  ],
  "id": 1
}

400

Section titled “400”

Request is invalid

Media typeapplication/json
object
message
required
string
details
required
object
key
additional properties
Examplegenerated
{
  "message": "example",
  "details": {
    "additionalProperty": "example"
  }
}

401

Section titled “401”

Missing or invalid api key

Media typeapplication/json
object
message
required
string
Examplegenerated
{
  "message": "example"
}

403

Section titled “403”

Api key provides insufficient access for the request

Media typeapplication/json
object
message
required
string
Examplegenerated
{
  "message": "example"
}

404

Section titled “404”

Match not found

Media typeapplication/json
object
message
required
string
Examplegenerated
{
  "message": "example"
}

429

Section titled “429”

Api key has made too many requests

Media typeapplication/json
object
message
required
string
Examplegenerated
{
  "message": "example"
}

500

Section titled “500”

An unexpected error has occured. If problems persist please contact support

Media typeapplication/json
object
message
required
string
Examplegenerated
{
  "message": "example"
}