Categories

Coverage
Sport Event Statuses

Integration
Languages

.

Coverage

How do I find out the coverage for a particular match?

This is available in our coverage properties within Match Timeline. Coverage levels are:

Post-match - Lowest level of coverage. Data is entered after the completion of the match
Core - Includes basic data such as scores, players, current over stats, required run rate
Advanced - More granular coverage. Includes more datapoints such as shot and ball types, wagon wheel data
Fielding - More enhanced coverage currently only for major ICC events (World Cup Mens, Womens, U19) and the Caribbean Premier League (CPL). Data points include richer data for fielding events, fielding position coordinates and multiple-player events

How will a sport event behave when it is not covered with live scores?

When a sport_event is not covered live, the status and match_status will remain as not_started until results are entered post-match.

Integration

How can I find the values for various enum data points within the API?

Many enum values are listed in the FAQ below. For the most up-to-date values, please see the Schema section of the OpenAPI specification here.

What format are date fields presented in?

Date values are presented in the ISO 8601 standard format.

Timestamp fields are in UTC. These could include scheduled start times or play-by-play event timestamps. Examples: scheduled="2024-02-11T23:30:00+00:00", created_at="2024-02-11T23:43:20+00:00"

Date-only fields reflect local league convention and are not UTC-adjusted. These could include season start dates and birth dates. Examples: start_date="2024-08-16", date_of_birth="1984-09-22"

How do I locate the TTL (Time to Live)/cache on an API endpoint?

The cache (in seconds) can be accessed in the returned header information on each RESTful API call, under cache-control.

ex. cache-control: max-age=1, public, s-maxage=1 or
cache-control: public, must-revalidate, max-age=120

What does the `batting_params.trace` attribute represent?

The trace attribute is a Boolean value signifying whether or not the ball was hit in the air.

Sport Event Statuses

What are the valid `sport_event_status` – `status` values?

not_started – The match is scheduled to be played
live – The match is currently in progress
postponed – The match has been postponed to a future date
suspended – The match has been suspended
delayed – The match has been temporarily delayed and will be continued
cancelled – The match has been cancelled and will not be played
abandoned – The match began, but was abandoned
interrupted - The match began, but coverage has stopped for a short time. Note that match scores may not be updated during this period, the last recorded match score will be displayed instead
ended – The match is over
closed – The match is over and the results have been confirmed
started – The match has begun
start_delayed– The match has been temporarily delayed and will be continued

What are the valid `sport_event_status` – `match_status` values?

abandoned
awaiting_super_over
cancelled
dinner
drinks
ended
first_innings_away_team
first_innings_home_team
fourth_innings_away_team
fourth_innings_home_team
innings_break
interrupted
lunch_break
not_started
postponed
second_innings_away_team
second_innings_home_team
start_delayed
started
stumps
super_over
tea_break
third_innings_away_team
third_innings_home_team

Languages

What valid languages you support?

Currently only English (en)