GET/api/v1/dict
Standard enumeration dictionary (status / position / event / statistic / VAR / reason)
Description
The single authoritative dictionary of every standard enumeration on this platform, so clients can look up what a code means instead of hard-coding it. Dimensions (dim): match_status, position (player position), event_type, stat_type (match statistic type), var_reason, var_result, event_reason. Omit dim for all of them.
Access
- Request
GET https://api.sports.csap.ai/api/v1/dict- 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
- AvailableAny valid API key can call this endpoint.
- 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 2
| Parameter | Type | required | Example | Description |
|---|---|---|---|---|
| dim | string | optional | Dimension filter: match_status / position / event_type / stat_type / var_reason / var_result / event_reason; omit for all | |
| limit | integer | optional | 2 | Default 2000 |
Example request
curl "https://api.sports.csap.ai/api/v1/dict?limit=2" \ -H "X-API-Key: YOUR_API_KEY"
Try it
Example response
{
"code": 0,
"data": [
{
"code_id": 1,
"compat_code": 1,
"dim": "continent",
"key": "int",
"name_zh": "国际",
"short_code": "INT",
"name": "INT"
},
{
"code_id": 2,
"compat_code": 2,
"dim": "continent",
"key": "eu",
"name_zh": "欧洲",
"short_code": "EU",
"name": "EU"
}
],
"message": "success",
"success": true
}Response fields 7
code_idintegerCode, unique within the dimension
Example: 1dimstringDimension
Example: "continent"keystringMachine name
name_enstringEnglish name
Example: "INT"name_zhstringChinese name
Example: "国际"compat_codeintegerCode used by the compatibility API (/api/v5) (mostly = code_id)
Example: 1short_codestringShort code (e.g. position F/M/D/G)
Example: "INT"Errors
| HTTP | message | When |
|---|---|---|
| 401 | missing API key / unauthorized | No X-API-Key, or the key is invalid or disabled |
| 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 |