Get an overlay (v2)

GET

/v2/overlays/{overlayId}

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

• LIGR REST API

Return the overlay with the given ID. The include query parameter accepts m to add the match. cp has no effect alone; combine it with m (include=m,cp) to nest competitors under the match.

Authorizations

• bearer
  overlays:read
• api_key
  overlays:read

Parameters

Path Parameters

overlayId

required

Entity identifier

integer format: int32

>= 1

The overlays identifier

Query Parameters

include

Comma seperated string of entity abbreviations Allows optional population of nested entities m = match e.g. ‘m’

string

Responses

200

Ok

Media typeapplication/json

Any of:

object

object

name

required

string

>= 1 characters <= 35 characters

id

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

object

object

name

required

string

>= 1 characters <= 35 characters

id

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

match

object

id

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

id

required

string

competitorsType

required

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.

string

Allowed values: singles doubles teams group

Example

{
  "matchId": 703,
  "id": 2300003,
  "name": "Overlay 1",
  "encodingDelay": 6,
  "key": "3b2bbcc8-0544-4edb-b847-8179ba026086"
}

400

Request is invalid

Media typeapplication/json

object

message

required

string

details

required

object

key

additional properties

Example^generated

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

401

Missing or invalid api key

Media typeapplication/json

object

message

required

string

Example^generated

{
  "message": "example"
}

403

Api key provides insufficient access for the request

Media typeapplication/json

object

message

required

string

Example^generated

{
  "message": "example"
}

404

Overlay not found

Media typeapplication/json

object

message

required

string

Example^generated

{
  "message": "example"
}

429

Api key has made too many requests

Media typeapplication/json

object

message

required

string

Example^generated

{
  "message": "example"
}

500

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

Media typeapplication/json

object

message

required

string

Example^generated

{
  "message": "example"
}