Get a match (v1)

GET

/v1/matches/{matchId}

const url = 'https://api.ligr.live/rest/v1/matches/1';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.ligr.live/rest/v1/matches/1 \
  --header 'Authorization: Bearer <token>'

Return the match with the given ID. Tennis matches are not supported in v1; use v2 instead. Accepts the include query parameter with codes t, v, c, o, p, s, one level deep.

Authorizations

bearer
matches:read
api_key
matches:read

Parameters

Path Parameters

matchId

required

Entity identifier

integer format: int32

>= 1

The match identifier

Query Parameters

include

Comma seperated string of entity abbreviations Allows optional population of nested entities c = competition v = venue t = teams o = overlays p = players s = streams cp = competitors e.g. ‘c,v,t,o,p,cp’

string

Comma seperated string of nested entity abbreviations to include in request

Responses

200

application/json

Any of:

object
object

object

required

Entity identifier

integer format: int32

>= 1

name

required

Match name

string

>= 5 characters <= 42 characters

date

required

string format: date-time

competitionId

required

Entity identifier

integer format: int32

>= 1

sport

required

string

Allowed values: football rugbyUnion rugbyLeague netball cricket futsal iceHockey fieldHockey waterPolo handBall lacrosse touchFootball ausRules basketball rugbySevens gridiron volleyball baseball tennis

liveStatus

required

The liveStatus of the match as defined by the period

string

Allowed values: live break

finishedStatus

required

string

Allowed values: finished pregame cancelled inProgress abandoned retirement finishedEarly

venueId

required

Entity identifier

integer format: int32

>= 1

dataProvider

object

name

required

string

Allowed values: RB OPTA_CRICKET OPTA_FOOTBALL OPTA_RUGBY_UNION STATSLLC GENIUS_BASKETBALL GENIUS_GRIDIRON GENIUS_VOLLEYBALL GENIUS_FOOTBALL GENIUS_ICE_HOCKEY PIXELLOT CLOUDMIX CHAMPION ligr-live-score MLB IMG_FOOTBALL CRIONET_TENNIS SPORT_RADAR_FOOTBALL

required

string

homeTeamId

Entity identifier

integer format: int32

>= 1

awayTeamId

Entity identifier

integer format: int32

>= 1

object

required

Entity identifier

integer format: int32

>= 1

name

required

Match name

string

>= 5 characters <= 42 characters

date

required

string format: date-time

competitionId

required

Entity identifier

integer format: int32

>= 1

sport

required

string

liveStatus

required

The liveStatus of the match as defined by the period

string

Allowed values: live break

finishedStatus

required

string

Allowed values: finished pregame cancelled inProgress abandoned retirement finishedEarly

venueId

required

Entity identifier

integer format: int32

>= 1

dataProvider

object

name

required

string

required

string

homeTeamId

Entity identifier

integer format: int32

>= 1

awayTeamId

Entity identifier

integer format: int32

>= 1

competition

object

required

Entity identifier

integer format: int32

>= 1

name

required

Default Entity name

string

>= 6 characters <= 39 characters

gfxName

required

Name predominantly display in graphics

string

nullable >= 6 characters <= 19 characters

sport

required

string

dataProvider

object

name

required

string

required

string

homeTeam

object

required

Entity identifier

integer format: int32

>= 1

name

required

Default Entity name

string

>= 6 characters <= 39 characters

gfxName

Name predominantly display in graphics

string

>= 6 characters <= 19 characters

gfxFullName

Name predominantly display in graphics

string

>= 6 characters <= 35 characters

abbreviation

Abbreviation

string

>= 2 characters <= 4 characters

primaryBackgroundColor

string

primaryTextColor

string

secondaryBackgroundColor

string

secondaryTextColor

string

defaultVenueId

Entity identifier

integer format: int32

>= 1

sport

required

string

clubId

Entity identifier

integer format: int32

>= 1

isHome

boolean

logoUrl

CDN URL of the team logo, or of the club logo when the team has none. Present only on the team routes.

string

nonPlayerStaff

Coaches and other staff who are not players. Graphics show the manager entry as the coach. If no entry has the manager role, graphics show the first entry.

Array<object>

A coach or other staff member of a team.

object

firstName

required

string

lastName

required

string

role

required

Role of a team staff member. Graphics show the manager as the coach.

string

Allowed values: manager assistantManager

dataProvider

object

name

required

string

required

string

awayTeam

object

required

Entity identifier

integer format: int32

>= 1

name

required

Default Entity name

string

>= 6 characters <= 39 characters

gfxName

Name predominantly display in graphics

string

>= 6 characters <= 19 characters

gfxFullName

Name predominantly display in graphics

string

>= 6 characters <= 35 characters

abbreviation

Abbreviation

string

>= 2 characters <= 4 characters

primaryBackgroundColor

string

primaryTextColor

string

secondaryBackgroundColor

string

secondaryTextColor

string

defaultVenueId

Entity identifier

integer format: int32

>= 1

sport

required

string

clubId

Entity identifier

integer format: int32

>= 1

isHome

boolean

logoUrl

CDN URL of the team logo, or of the club logo when the team has none. Present only on the team routes.

string

nonPlayerStaff

Coaches and other staff who are not players. Graphics show the manager entry as the coach. If no entry has the manager role, graphics show the first entry.

Array<object>

A coach or other staff member of a team.

object

firstName

required

string

lastName

required

string

role

required

Role of a team staff member. Graphics show the manager as the coach.

string

Allowed values: manager assistantManager

dataProvider

object

name

required

string

required

string

overlays

Array<object>

object

name

required

string

>= 1 characters <= 35 characters

required

Entity identifier

integer format: int32

>= 1

matchId

Entity identifier

integer format: int32

>= 1

encodingDelay

Seconds to delay graphic updates

integer format: int32

<= 120

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}/

autoMode

boolean

adType

string

competitionThemeSettingId

integer format: int32

nullable >= 1

controlRoomId

integer format: int32

nullable >= 1

controlRoomUrl

Open this URL with an authenticated dashboard session after setup.

string

monitoringUrl

Read-only monitoring page of this overlay on the overlay host of this environment. Open it to see the graphics that are on air. It does not take control of the overlay.

string

venue

object

required

Entity identifier

integer format: int32

>= 1

name

required

Default Entity name

string

>= 6 characters <= 39 characters

gfxName

required

Name predominantly display in graphics

string

nullable >= 6 characters <= 19 characters

dataProvider

object

name

required

string

required

string

lineup

Array<object>

object

required

Entity identifier

integer format: int32

>= 1

teamId

required

Entity identifier

integer format: int32

>= 1

firstName

required

Default Player first name

string

>= 1 characters <= 35 characters

lastName

required

Default Player first name

string

>= 1 characters <= 35 characters

position

required

string

nullable

positionType

required

string

nullable

number

required

string

0 <= 3 characters

photoUrl

string

nullable /https?:\/\/(www\.)?[-a-zA-Z0-9@:%._\+~#=]{1,256}\.[a-zA-Z0-9()]{1,6}\b([-a-zA-Z0-9()@:%_\+.~#?&//=]*)/

captain

required

boolean

starter

required

boolean

formationNumber

required

The player’s slot in the team’s formation layout, numbered from the goalkeeper through to the forwards. Null when no formation slot is assigned.

number format: double

nullable

lineupPosition

required

The player’s position in the team’s lineup ordering as managed in the control room. Null when no explicit lineup order is set.

number format: double

nullable

streams

Array<object>

object

required

Entity identifier

integer format: int32

>= 1

name

required

string

destinations

required

Array<object>

object

required

Entity identifier

integer format: int32

>= 1

name

required

string

type

required

string

Allowed values: youtube facebook twitter linkedin tiktok twitch custom perform genius img igame fifa+ infront

url

required

string

key

required

string

idleImageUrl

string

Example

{
  "sport": "football",
  "liveStatus": "live",
  "finishedStatus": "finished",
  "dataProvider": {
    "name": "RB"
  }
}

400

Request is invalid

application/json

object

message

required

string

details

required

object

key

additional properties

Example^generated

{
  "message": "example",
  "details": {
    "additionalProperty": "example"
  }
}

401

Missing or invalid api key

application/json

object

message

required

string

Example^generated

{
  "message": "example"
}

403

Api key provides insufficient access for the request

application/json

object

message

required

string

Example^generated

{
  "message": "example"
}

404

Match not found

application/json

object

message

required

string

Example^generated

{
  "message": "example"
}

429

Api key has made too many requests

application/json

object

message

required

string

Example^generated

{
  "message": "example"
}

500

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

application/json

object

message

required

string

Example^generated

{
  "message": "example"
}

Get a match (v1)

Authorizations

Parameters

Path Parameters

Query Parameters

Responses

200

Example

400

Examplegenerated

401

Examplegenerated

403

Examplegenerated

404

Examplegenerated

429

Examplegenerated

500

Examplegenerated

Example^generated

Example^generated

Example^generated

Example^generated

Example^generated

Example^generated