Skip to content
Get a key
API reference / Cricket
GET/cricket/matches

List cricket matches

Returns a paginated list of cricket matches (Tests, first-class, ODIs, T20s) with optional filtering

In preview, not in plans yetPay per call without a key: $0.002 in USDC

Parameters

  • limitinteger · query

    Maximum results (1-100)

    Default: 50
  • offsetinteger · query

    Results to skip

    Default: 0
  • datestring · query

    Filter by first day (YYYY-MM-DD)

  • date_fromstring · query

    Matches starting on or after this date (YYYY-MM-DD)

  • date_tostring · query

    Matches starting on or before this date (YYYY-MM-DD)

  • statusstring · query

    Filter by status (NS, In Progress, Stumps, Innings Break, Finished)

  • league_idinteger · query

    Filter by series (league) ID

  • team_idinteger · query

    Only matches of this team (home or away, every competition)

  • orderstring · query

    desc for latest first (default: by start time ascending)

    One of: asc, desc
  • futurestring · query

    Filter to matches starting today or later (true)

Response

JSON with success, the result in data, and where the endpoint pages its results meta.

  • dataarray of object
  • attributionstring

    Matches from Cricsheet's history (before the provider's feeds): the notice its licence (ODC-BY) asks for.

  • away_teamobject
  • idinteger
  • inningsarray of object
  • namestring
  • scorestring
  • end_datestring
  • formatstring

    Test, First-class, ODI, T20...

  • home_teamobject
  • idinteger
  • inningsarray of object
  • namestring
  • scorestring
  • idinteger
  • league_idinteger
  • league_namestring
  • match_idinteger
  • match_numstring
  • resultstring
  • seasonstring
  • sportstring
  • start_datestring
  • start_timestring
  • statusstring
  • tossstring
  • toss_winner_idinteger
  • venuestring
  • winner_idinteger
  • errorobject
  • codestring
  • messagestring
  • metaobject
  • attributionstring

    Attribution a data source's licence asks for (Cricsheet's history).

  • limitinteger
  • offsetinteger
  • totalinteger
  • successboolean

Errors

StatusCodeWhen
401UNAUTHORIZEDThe key is missing, mistyped or was rotated.
402x402 offersNo key and no valid payment: the body lists what to pay. Only a 200 answer is charged.
403FORBIDDENThe sport or feature is not in your plan (FEATURE_NOT_IN_PLAN for Insights and other plan features).
429RATE_LIMIT_EXCEEDEDToo many requests (QUOTA_EXCEEDED for the daily limit). Wait for Retry-After.
500INTERNAL_ERROROur side. Try again after a few seconds and check the status page.

All errors have the shape described in Errors and limits.

Generated from the OpenAPI file, version 1.0. See it as JSON

Was this page helpful?