← Back to API docs

GET/api/v1/dict

Standard enumeration dictionary (status / position / event / statistic / VAR / reason)
DictionaryEnumerationsactivebetacoreAvailable

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

ParameterTyperequiredExampleDescription
dimstringoptionalDimension filter: match_status / position / event_type / stat_type / var_reason / var_result / event_reason; omit for all
limitintegeroptional2Default 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

Real response with an external key at 09/11/2026, 14:28 UTC: HTTP 200, 2 rows, 105 ms (data cut to 2 rows)

{
  "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 dimensionExample: 1
dimstringDimensionExample: "continent"
keystringMachine name
name_enstringEnglish nameExample: "INT"
name_zhstringChinese nameExample: "国际"
compat_codeintegerCode used by the compatibility API (/api/v5) (mostly = code_id)Example: 1
short_codestringShort code (e.g. position F/M/D/G)Example: "INT"

Errors

HTTPmessageWhen
401missing API key / unauthorizedNo X-API-Key, or the key is invalid or disabled
429rate limit exceeded / daily quota exceededThe key's per-minute rate or daily quota is exceeded
429server busy, retry laterThe server's concurrency slots are full (only 2 heavy requests at a time); retry after Retry-After seconds
500query errorThe query failed on the server; you may retry