Skip to content
Developers

Get a competition

GET/v1/competitions/{competitionId}

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

Return the competition with the given ID. Accepts the include query parameter with code t, one level deep.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
competitionId
required

Entity identifier

integer format: int32
>= 1

The competition identifier

Query Parameters

Section titled “Query Parameters”
include

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

string

Responses

Section titled “Responses”

200

Section titled “200”

Ok

Media typeapplication/json
Any of:
object
id
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
Allowed values: football rugbyUnion rugbyLeague netball cricket futsal iceHockey fieldHockey waterPolo handBall lacrosse touchFootball ausRules basketball rugbySevens gridiron volleyball baseball tennis
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
teams
Array<object>
object
id
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
Allowed values: football rugbyUnion rugbyLeague netball cricket futsal iceHockey fieldHockey waterPolo handBall lacrosse touchFootball ausRules basketball rugbySevens gridiron volleyball baseball tennis
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
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
Example
{
  "id": 24,
  "name": "UEFA Champions League",
  "gfxName": "Champions League",
  "sport": "football"
}

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”

Competition 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"
}