Skip to content
Developers

List competitions

GET/v1/competitions

GET
/v1/competitions
curl --request GET \
  --url 'https://api.ligr.live/rest/v1/competitions?sport=football&providerName=RB&limit=200&offset=0' \
  --header 'Authorization: Bearer <token>'

Return a list of competitions for the organization. Filter by sport.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
sport
string
Allowed values: football rugbyUnion rugbyLeague netball cricket futsal iceHockey fieldHockey waterPolo handBall lacrosse touchFootball ausRules basketball rugbySevens gridiron volleyball baseball tennis

Allows filtering by specific sport

providerName
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

Only return competitions from this data provider

providerIds
string

Only return competitions with these ids at the data provider. A comma-separated list of up to 100 ids. Needs providerName.

limit
number format: double
default: 200
offset
number format: double
0

Responses

Section titled “Responses”

200

Section titled “200”

Ok

Media typeapplication/json
object
competitions
required
Array<object>
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
total
required
integer format: int32
returned
required
integer format: int32
Example
{
  "competitions": [
    {
      "id": 24,
      "name": "UEFA Champions League",
      "gfxName": "Champions League",
      "sport": "football"
    }
  ],
  "total": 24,
  "returned": 24
}

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