StatsHub Docs
APIAPI v2V2 endpoint referenceCompetitions

/competitions

List competition identities

GET
/competitions

List competition identities

Query Parameters

limit?integer

Maximum resources to return; defaults to 25

Range1 <= value <= 100
Default25
after?string

Opaque cursor for the next page

before?string

Opaque cursor for the previous page

q?string

Case-insensitive competition name search

Lengthlength <= 100
regionId?string

Filter by region

Match^[1-9][0-9]*$
liveAlerts?string

Filter to competitions that do or do not support live alerts

Value in

  • "true"
  • "false"
fixturesFrom?string

Inclusive lower bound of a scheduled, visible fixture window; with either bound set, only competitions with a fixture in the window are returned and each carries fixturesInWindow

Formatdate-time
fixturesTo?string

Exclusive upper bound of the fixture window

Formatdate-time

Response Body

application/json

application/problem+json

application/problem+json

curl -X GET "https://example.com/competitions"
{  "data": [    {      "capabilities": {        "liveAlerts": true,        "performanceGraph": true,        "playerStatistics": true      },      "fixturesInWindow": 0,      "id": "string",      "name": "string",      "primaryColor": "string",      "region": {        "id": "string",        "name": "string",        "slug": "string"      },      "secondaryColor": "string",      "slug": "string"    }  ],  "links": {    "next": "string",    "previous": "string",    "self": "string"  },  "page": {    "hasNext": true,    "hasPrevious": true,    "limit": 0,    "nextCursor": "string",    "previousCursor": "string"  }}