← Back to API docs

GET/api/v1/matches/schedule/param

List fixtures and results by dimension
Realtime data packageactivebetacoreAvailable (scoped)

Description

Returns all fixtures and results for the dimension queried (competition: fixtures of the latest season; sports lottery: fixtures of the lottery type within the last 72 hours)
Request rate: 120/min

Access

Request
GET https://api.sports.csap.ai/api/v1/matches/schedule/param
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 2

ParameterTyperequiredExampleDescription
competition_idintegerrequired287Competition id
lottery_idstringrequiredLottery type: 101 Jingcai football, 301 Beidan win/lose parlay, 404 Beidan handicap 1X2, 401 14-match win/lose

Example request

curl "https://api.sports.csap.ai/api/v1/matches/schedule/param?competition_id=287" \
  -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, 1000 rows, 496 ms (data cut to 2 rows)

{
  "code": 0,
  "data": [
    {
      "agg_score": null,
      "asian_handicap": null,
      "assistant1": null,
      "assistant2": null,
      "assistant_var": null,
      "away_corner": 0,
      "away_ot": 0,
      "away_pen": 0,
      "away_position": null,
      "away_red": 0,
      "away_score": 4,
      "away_scores": 2,
      "away_team": "Portugal U16",
      "away_team_id": "9oj7x9ip26fr7g3",
      "away_yellow": 0,
      "away_zh": null,
      "comp_ref": "mo07dnidvaxknxy",
      "competition_id": "mo07dnidvaxknxy",
      "coverage": null,
      "created_at": "2026-11-03T11:44:09.982905Z",
      "cur_period_start": null,
      "ended": null,
      "environment": null,
      "fourth": null,
      "from_schedule": false,
      "group_num": null,
      "half_away": 2,
      "half_home": 1,
      "has_ot": null,
      "home_corner": 0,
      "home_ot": 0,
      "home_pen": 0,
      "home_position": null,
      "home_red": 0,
      "home_score": 1,
      "home_scores": 1,
      "home_team": "Scotland U16",
      "home_team_id": "jr7owil613b3q0e",
      "home_yellow": 0,
      "home_zh": null,
      "humidity": null,
      "id": 1,
      "inferred_reason": null,
      "intelligence": null,
      "issue": null,
      "issue_num": null,
      "last_change_ts": 1793787334,
      "league": "International Friendly",
      "lineup": null,
      "loss": null,
      "lottery": null,
      "match_time": "2026-11-03T09:30:00Z",
      "minute": null,
      "mlive": null,
      "neutral": null,
      "note": null,
      "ou_line": null,
      "period_initial": null,
      "pressure": null,
      "query": null,
      "referee_id": null,
      "referee_name": null,
      "referees": null,
      "related_id": null,
      "round": null,
      "round_num": null,
      "season_id": null,
      "source": "S5",
      "source_id": "34kgmig2e5dceko",
      "stage_id": null,
      "start_ts": "2026-11-03T09:30:00Z",
      "status_code": 8,
      "status_id": 8,
      "status_inferred": false,
      "status_type": "finished",
      "tbd": null,
      "team_reverse": null,
      "temperature": null,
      "type": null,
      "updated_at": 1793787333971,
      "var": null,
      "venue_id": null,
      "venue_name": null,
      "version": 2,
      "weather": null,
      "wind": null
    },
    {
      "agg_score": null,
      "asian_handicap": null,
      "assistant1": null,
      "assistant2": null,
      "assistant_var": null,
      "away_corner": 4,
      "away_ot": 0,
      "away_pen": 0,
      "away_position": null,
      "away_red": 0,
      "away_score": 3,
      "away_scores": 0,
      "away_team": "Al-BaqaA U20",
      "away_team_id": "g6763i4164cp7ry",
      "away_yellow": 4,
      "away_zh": null,
      "comp_ref": "5xvkjoi8l5br793",
      "competition_id": "5xvkjoi8l5br793",
      "coverage": null,
      "created_at": "2026-11-03T11:44:10.006825Z",
      "cur_period_start": null,
      "ended": null,
      "environment": null,
      "fourth": null,
      "from_schedule": false,
      "group_num": null,
      "half_away": 0,
      "half_home": 1,
      "has_ot": null,
      "home_corner": 3,
      "home_ot": 0,
      "home_pen": 0,
      "home_position": null,
      "home_red": 0,
      "home_score": 2,
      "home_scores": 1,
      "home_team": "Ittihad Al-Ramtha U20",
      "home_team_id": "wv78xin089inkrj",
      "home_yellow": 1,
      "home_zh": null,
      "humidity": null,
      "id": 2,
      "inferred_reason": null,
      "intelligence": null,
      "issue": null,
      "issue_num": null,
      "last_change_ts": 1793721245,
      "league": "JOR C U20",
      "lineup": null,
      "loss": null,
      "lottery": null,
      "match_time": "2026-11-03T14:00:00Z",
      "minute": null,
      "mlive": null,
      "neutral": null,
      "note": null,
      "ou_line": null,
      "period_initial": null,
      "pressure": null,
      "query": null,
      "referee_id": null,
      "referee_name": null,
      "referees": null,
      "related_id": null,
      "round": null,
      "round_num": null,
      "season_id": null,
      "source": "S5",
      "source_id": "34kgmig2e96beko",
      "stage_id": null,
      "start_ts": "2026-11-03T14:00:00Z",
      "status_code": 8,
      "status_id": 8,
      "status_inferred": false,
      "status_type": "finished",
      "tbd": null,
      "team_reverse": null,
      "temperature": null,
      "type": null,
      "updated_at": 1793721550277,
      "var": null,
      "venue_id": null,
      "venue_name": null,
      "version": 22,
      "weather": "23°C",
      "wind": null
    }
  ],
  "message": "success",
  "success": true
}

Response fields 86

agg_scorenullnullableAggregate score over two legs in regular time (including extra time) · example: [3, 6]
asian_handicapnullnullableAsian handicap
assistant1nullnullableAssistant referee 1
assistant2nullnullableAssistant referee 2
assistant_varnullnullableAssistant VAR referees · example: [6261, 6262]
away_cornerintegernullableAway team cornersExample: 0
away_otintegernullableAway team extra-time scoreExample: 0
away_penintegernullableAway team penalty shoot-out scoreExample: 0
away_positionnullnullableAway team rank
away_redintegernullableAway team red cardsExample: 0
away_scoreintegernullableAway team score (regular time, including stoppage time)Example: 4
away_scoresintegernullableScore field · example: [1, 0, 0, 0, -1, 0, 0]Example: 2
away_teamstringAway team name (English)Example: "Portugal U16"
away_team_idstringAway team idExample: "9oj7x9ip26fr7g3"
away_yellowintegernullableAway team yellow cardsExample: 0
away_zhnullnullableAway team Chinese name
comp_refstringCompetition id within the sourceExample: "mo07dnidvaxknxy"
competition_idstringCompetition idExample: "mo07dnidvaxknxy"
coveragenullnullableAnimation, intelligence and lineup fields
created_atstringCreation timeExample: "2026-11-03T11:44:09.982905Z"
cur_period_startnullnullableStart of the current period (Unix seconds)
endednullnullableEnd time (returned when there is data)
environmentnullnullableMatch environment; present only when there is data
fourthnullnullableFourth official
from_schedulebooleanWhether taken from the scheduleExample: false
group_numnullnullableGroup number: 1 = A, 2 = B and so on
half_awayintegernullableAway team half-time scoreExample: 2
half_homeintegernullableHome team half-time scoreExample: 1
has_otnullnullableWent to extra time: 1 yes (returned when there is data)
home_cornerintegernullableHome team cornersExample: 0
home_otintegernullableHome team extra-time scoreExample: 0
home_penintegernullableHome team penalty shoot-out scoreExample: 0
home_positionnullnullableHome team rank
home_redintegernullableHome team red cardsExample: 0
home_scoreintegernullableHome team score (regular time, including stoppage time)Example: 1
home_scoresintegernullableScore field · example: [1, 0, 0, 0, -1, 0, 0]Example: 1
home_teamstringHome team name (English)Example: "Scotland U16"
home_team_idstringHome team idExample: "jr7owil613b3q0e"
home_yellowintegernullableHome team yellow cardsExample: 0
home_zhnullnullableHome team Chinese name
humiditynullnullableHumidity
idintegerRecord id; paging cursor (the id parameter returns records >= this value). In match endpoints it is the platform match id (gmid)Example: 1
inferred_reasonstringnullableReason for the inferenceExample: "notstarted_exceeded_180m"
intelligencenullnullableHas intelligence: 1 yes, 0 no
issuenullnullableLottery issue number (Jingcai has none; empty)
issue_numnullnullableSequence number
last_change_tsintegernullableLast change time (Unix seconds)Example: 1793787334
leaguestringCompetition name (English)Example: "International Friendly"
lineupnullnullableHas lineups: 1 yes, 0 no
lossnullnullableAwarded as a forfeit: 1 yes (returned when there is data)
lotterynullnullableLottery issue and sequence number (present for sports lottery queries)
match_timestringKick-off time (UTC, ISO 8601)Example: "2026-11-03T09:30:00Z"
minutestringnullableMatch minuteExample: "45'"
mlivenullnullableHas animation: 1 yes, 0 no
neutralnullnullableNeutral venue: 1 yes, 0 no
notenullnullableRemark
ou_linenullnullableOver/under line
period_initialnullnullableMinute at which the current period starts
pressurenullnullableAir pressure
querynullnullableQuery info (paging cursor, totals)
referee_idnullnullableReferee id
referee_namenullnullableReferee name
refereesnullnullableReferee team; present only when there is data
related_idnullnullableMatch id of the other leg of a two-legged tie
roundnullnullableRound
round_numnullnullableRound number
season_idnullnullableSeason id
sourcestringSource code (S1, S2…)Example: "S5"
source_idstringId within the sourceExample: "34kgmig2e5dceko"
stage_idnullnullableStage id
start_tsstringKick-off time (UTC, ISO 8601)Example: "2026-11-03T09:30:00Z"
status_codeintegerStatus codeExample: 8
status_idintegerMatch status code (see the status and type code table)Example: 8
status_inferredbooleanWhether the status is inferredExample: false
status_typestringMatch status: notstarted / inprogress / finished and othersExample: "finished"
tbdnullnullableKick-off time to be confirmed: 1 yes (returned when there is data)
team_reversenullnullableHome and away reversed: 1 yes (returned when there is data; e.g. the official site lists A vs B and this platform lists B vs A)
temperaturenullnullableTemperature
typenullnullableType
updated_atintegerLast update time (UTC, ISO 8601; incremental sync with the time parameter goes by it)Example: 1793787333971
varnullnullableVAR referee
venue_idnullnullableVenue id
venue_namenullnullableVenue name
versionintegerVersion number (higher is newer)Example: 2
weatherstringnullableWeather id · 1: partly cloudy · 2: cloudy · 3: partly cloudy / rain · 4: snow · 5: sunny · 6: overcast with rain / thunderstorms in places · 7: overcast · 8: mist · 9: overcast with rain · 10: cloudy with rain · 11: cloudy with rain / thunderstorms in places · 12: partly cloudy / rain and thunderstorms · 13: fogExample: "23°C"
windnullnullableWind speed

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