Description
Returns all competition formats, with incremental updates by timestamp.
1. First full sync: page through everything with the id parameter.
2. Afterwards: fetch what changed with the time parameter (suggested frequency: once a minute).
1. First full sync: page through everything with the id parameter.
2. Afterwards: fetch what changed with the time parameter (suggested frequency: once a minute).
Access
- Request
GET https://api.sports.csap.ai/api/v1/competition/rules- Auth
- Header X-API-Key: <your key> (Authorization: Bearer <key> also works; ?key= is still accepted but discouraged, because the key ends up in URLs and logs)
- External keys
- Available (scoped)External keys can call it, but only data inside the open scope is returned.
- Rate limits
- 3000 per minute · 200000 per day · Set per key (rate_per_min and quota_daily returned by /api/v1/account are authoritative; the numbers above are a trial key's). Beyond them the answer is 429. In addition, heavy requests such as whole-table snapshots and statistics lists without a match id are processed 2 at a time for the whole platform; a request that cannot get a slot receives 429 with Retry-After. Responses do not carry X-RateLimit-* headers for now. See the general guide
Request parameters 3
| Parameter | Type | required | Example | Description |
|---|---|---|---|---|
| id | integer | optional | 287 | Records with id greater than or equal to this value, ordered by id |
| time | integer | optional | Records updated at or after this time (timestamp), ordered by update time | |
| limit | integer | optional | 2 | Maximum number of rows, default 1000, maximum 1000 |
Example request
curl "https://api.sports.csap.ai/api/v1/competition/rules?limit=2" \ -H "X-API-Key: YOUR_API_KEY"
Try it
Example response
{
"code": 0,
"data": [
{
"category_id": "1",
"category_name": "England",
"comp_id": "17",
"competition_id": "17",
"country_id": null,
"id": 1,
"kind": null,
"limit": null,
"logo_hash": null,
"logo_url": "http://43.99.60.51:8080/logos/111451bfcfb3f00ac16f90d9240e175ce41561d85fd83baff92a4bcedd73d0a6.webp",
"max_id": null,
"max_time": null,
"min_id": null,
"min_time": null,
"name_zh": null,
"name_zht": null,
"query": null,
"season_ids": null,
"short_name_zh": null,
"slug": "premier-league",
"source": "S2",
"text": null,
"time": null,
"type": null,
"updated_at": 1794127801097,
"user_count": 1186113,
"name": "Premier League"
},
{
"category_id": "1",
"category_name": "England",
"comp_id": "18",
"competition_id": "18",
"country_id": null,
"id": 2,
"kind": null,
"limit": null,
"logo_hash": null,
"logo_url": "http://43.99.60.51:8080/logos/93688a52d86dca1ec1fbf0a2103ff23dfa2a6321dee0706fc96555355164416a.webp",
"max_id": null,
"max_time": null,
"min_id": null,
"min_time": null,
"name_zh": null,
"name_zht": null,
"query": null,
"season_ids": null,
"short_name_zh": null,
"slug": "championship",
"source": "S2",
"text": null,
"time": null,
"type": null,
"updated_at": 1794127801098,
"user_count": 126287,
"name": "Championship"
}
],
"message": "success",
"success": true
}Response fields 28
category_idstring
Example: "1"category_namestringCategory name
Example: "England"comp_idstringCompetition id
Example: "17"competition_idstringCompetition id
Example: "17"country_idnullnullableCountry / region id
idintegerRecord id; paging cursor (the id parameter returns records >= this value). In match endpoints it is the platform match id (gmid)
Example: 1kindnullnullableKind
limitnullnullableMaximum number of rows in this response
logo_hashnullnullableSHA-256 of the logo file
logo_urlstringLogo (image address on this platform; empty when there is none)
max_idnullnullableLargest id on this page
max_timenullnullableLatest update time on this page (Unix seconds)
min_idnullnullableSmallest id on this page
min_timenullnullableEarliest update time on this page (Unix seconds)
name_enstringEnglish name
Example: "Premier League"name_zhnullnullableChinese name
name_zhtnullnullableTraditional Chinese name
querynullnullableQuery info (paging cursor, totals)
season_idsnullnullableList of season ids · example: [8021]
short_name_ennullnullableEnglish short name
short_name_zhnullnullable
slugstringEnglish slug (for URLs)
Example: "premier-league"sourcestringSource code (S1, S2…)
Example: "S2"textnullnullableFormat description
timenullnullableTime / minute
typenullnullableType
updated_atintegerLast update time (UTC, ISO 8601; incremental sync with the time parameter goes by it)
Example: 1794127801097user_countinteger
Example: 1186113Errors
| HTTP | message | When |
|---|---|---|
| 401 | missing API key / unauthorized | No X-API-Key, or the key is invalid or disabled |
| 400 | bad param … | Malformed parameter (e.g. id is neither a number nor u<uid>) |
| 301 | match merged into <gmid> | Queried by an old match id that has been merged into a new gmid: Location points to the new address and the body carries moved_to |
| 404 | not found | The match / team / competition does not exist, or is outside what this key can see (external keys see only matches inside the open coverage) |
| 429 | rate limit exceeded / daily quota exceeded | The key's per-minute rate or daily quota is exceeded |
| 429 | server busy, retry later | The server's concurrency slots are full (only 2 heavy requests at a time); retry after Retry-After seconds |
| 500 | query error | The query failed on the server; you may retry |