List competitions
GET/v1/competitions
const url = 'https://api.ligr.live/rest/v1/competitions?sport=football&providerName=RB&limit=200&offset=0';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/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”Allows filtering by specific sport
Only return competitions from this data provider
Only return competitions with these ids at the data provider. A comma-separated list of up to 100 ids. Needs providerName.
Responses
Section titled “Responses”Ok
object
object
Entity identifier
Default Entity name
Name predominantly display in graphics
object
CDN URL of the competition logo. Present only on the competition routes.
CDN URL of the primary watermark. Present only on the competition routes.
CDN URL of the secondary watermark. Present only on the competition routes.
The match rules that every match of the competition inherits: the periods, the clock, the data
coverage and, for some sports, rules. The shape depends on the sport. A match config overrides
these values for one match. Change them with PATCH /v1/competitions/{competitionId}.
Example
{ "competitions": [ { "id": 24, "name": "UEFA Champions League", "gfxName": "Champions League", "sport": "football", "matchConfig": { "startingLineupSize": 11, "maxBenchSize": 7, "periods": { "regular": { "number": 2, "name": "Regular", "length": 45, "breakLength": 15 } }, "dataCoverage": { "stats": "minimum" } } } ], "total": 24, "returned": 24}Request is invalid
object
object
Examplegenerated
{ "message": "example", "details": { "additionalProperty": "example" }}Missing or invalid api key
object
Examplegenerated
{ "message": "example"}Api key provides insufficient access for the request
object
Examplegenerated
{ "message": "example"}Competition not found
object
Examplegenerated
{ "message": "example"}Organization has made too many requests
object
Examplegenerated
{ "message": "example"}An unexpected error has occured. If problems persist please contact support
object
Examplegenerated
{ "message": "example"}