Table of Contents

Getting Started

Coverage

What leagues do you cover, and at what level?

Coverage information can be found via our Coverage Matrix.

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

Find the node called coverage in any Summary, Lineups, or Timeline endpoint. The attribute coverage - live reports whether Sportradar has live coverage of a match.

Within the coverage node is a coverage property type and value. Use these attributes to determine whether a match includes:

• Boxscore coverage (property type="boxscore") - Rugby Union only
• Match clock values (property type="match_clock") - Rugby Union only
• Lineups (property type="lineups") - Union, League, & Sevens

<sport_event id="sr:sport_event:513632" start_time="2008-04-13T14:00:00+00:00" start_time_confirmed="true">
    <sport_event_context> --snip--
    </sport_event_context>
    <coverage live="true">
        <properties>
            <property type="boxscore" value="true"/>
            <property type="match_clock" value="true"/>
            <property type="lineups" value="true"/>
        </properties>
    </coverage>

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.

What statistics are available when Boxscore is marked as true?

When boxscore is available, the following statistics are available live:

• Penalties Conceded, Total Scrums, Scrums Won, Scrums Lost, Lineouts Won, Turnovers Won.

Post-match the following statistics are available for competitors and players:

• Meters Run, Clean Breaks, Carries, Tackles Missed, Try Assists, Tackles, Offloads, Passes.

Matches with these additional team and player statistics are indicated by <property type="boxscore" value="true"/>

• Please note that for Rugby Union Champions Cup, we can only provide team boxscore due to source restrictions.

Why do different groups have coverage information for a competition?

The notion of “groups” is versatile and is used to distinguish between playoffs, and our competition structures and is therefore necessary to describe coverage at a group level for consistency. Generally, however, within a competition in Rugby, there will be no difference between competition coverage.

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:

• Rugby Union
• Rugby League
• Rugby Sevens

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

Pagination

How can I tell if an endpoint is paginated?

To determine if a RESTful API endpoint uses pagination, visit the endpoint's page on our developer portal, its OpenAPI specification, or check the X-Result and X-Max-Results headers in the API response.

• X-Result: This header indicates the number of items returned for this request.
• X-Max-Results: This header specifies the total number of items available for a specified request.

If both headers are present and the response data is truncated (i.e., X-Result value is less than X-Max-Results), you can infer that pagination is in use. To fetch the remaining data, make use of the limit and start query string parameters.

In the below Season Summary response, the header specifies 100 sports events are returned (x-result), but 381 sport events are available (x-max-results). Make an additional API request – such as appending &start=100 to the end of your call – to obtain additional events.

Response Header Sample
< HTTP/2 200 
< content-type: application/json
< content-length: 1725369
< date: Wed, 13 Nov 2024 21:06:18 GMT
< x-amzn-requestid: c10fe405-ce81-46fb-a3db-38d153dd2a6c
< x-offset: 0
< x-amz-apigw-id: BNAvVGCUliAEKJA=
< cache-control: max-age=300, public, s-maxage=300
< x-result: 100
< etag: "341dc78002bc578c62a6878519ba0404"
< x-max-results: 381
< link: <https://schemas.sportradar.com/sportsapi/soccer/v4/schemas/season_summaries.json#>; rel="describedBy"
< x-amzn-trace-id: Root=1-673514c8-7a887f81636af0110ecce2d3
< x-amzn-remapped-date: Wed, 13 Nov 2024 21:06:17 GMT
< vary: Accept-Encoding
< x-cache: Hit from cloudfront
< via: 1.1 f2f0cb8191da3bf07a9ca31ece94ab68.cloudfront.net (CloudFront)
< x-amz-cf-pop: IAD61-P4
< x-amz-cf-id: 1cyji-XQZuBlAUsR8QoHdNLWD-jn1HvBC-ShaCMhXl5mMDiFTDRVyQ==
< age: 16

Why can't I find a particular match in the Daily Summaries, Season Summaries or Sport Events Updated endpoints?

These endpoints support pagination and return a select number of results by default. To return more matches, include an additional query string parameter. Visit an endpoint page for minimum and maximum result values.

Back to top ↑

Game Data

Sport Event Statuses

What are the valid sport_event_status - status values?

Here are the valid sport_event_status values and their definitions:

• not_started - The match is scheduled to be played
• started - The match has begun
• live - The match is currently in progress
• postponed - The match has been postponed to a future date
• suspended - The match began, but has been suspended to a later time
• match_about_to_start - The match is about to begin
• delayed - The match has been temporarily delayed and will be continued
• cancelled - The match has been cancelled and will not be played
• 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. Any interrupted match that remains in this status for more than 48 hours will receive limited coverage upon resumption; coverage up to the point of interruption remains at the level originally specified for the match.
• ended - The match is over
• closed - The match results have been confirmed
• abandoned - The match began, but was then cancelled

What are the valid sport_event_status - match_status values?

Here are the valid match_status values:

• 1st_half
• 2nd_half
• aet
• abandoned
• overtime
• 1st_extra
• 2nd_extra
• penalties
• postponed
• pause
• halftime
• cancelled
• awaiting_extra_time
• extra_time_halftime
• awaiting_penalties
• interrupted
• not_started
• ended
• start_delayed

Event Types

What are the possible event types logged?

Here are the valid event types:

• match_started
• match_ended
• period_start
• break_start
• score_change
• penalty_awarded
• period_score
• change_of_possession
• ball_kicked
• line_out
• line_out_won
• ball_recycled
• scrum
• kick_to_touch
• scrum_reset
• scrum_won
• try
• conversion
• turnover
• denied_try
• penalty
• drop_out
• yellow_card
• red_card
• tap_and_go
• drop_goal
• substitution

What are the possible player event types logged?

Here are the valid player event types:

• scorer
• substituted_in (League and Union only)
• substituted_out (League and Union only)

Probabilities

What are markets, and which ones are available?

A market represents a betting option for which we provide probability data. Over time, additional markets may be added to the API.

Currently, we offer one market: 3-way, which indicates the probability of each possible outcome — home win, away win, or draw.

What are the valid outcomes for probabilities?

Here are the valid probability outcomes:

• home_team_winner
• away_team_winner
• draw

Back to top ↑

Reference Data

Past Season Data

How do I access past seasons results and stats?

Use the Seasons endpoint to locate the season_id for the season you want to access. Use that season_id to interrogate the various seasons endpoints.

Standings / Tournaments

What are the possible standings types in the Standings endpoint?

Here are the valid standings types:

• total
• home
• away
• first_half_total
• first_half_home
• first_half_away
• second_half_total
• second_half_home
• second_half_away

What are the possible values for cup_round - state in the Season Links endpoint?

Here are the valid cup_round.state values and their definitions. These can be leveraged to determine the status of a cup round.

• empty - A matchup has been created but neither the match details nor the competitors are known.
• unseeded_fixture - Match details are known but competitors are unknown.
• partial_seeded - One competitor is known.
• partial_seeded_fixture - Match details and one competitor are known.
• seeded - Both competitors are known.
• seeded_fixture - Match details and both competitors are known.
• unstarted - Match(es) have been added.
• on_going - The first match has started.
• decided - The last match has ended.
• winner - The winner is known.
• cancelled - The matchup has been cancelled.

When are bonus points tallied for Rugby Union?

Bonus points for Rugby Union matches are entered the following morning after a match, and will be reflected in the Season Standings endpoint.

For more information on how these are calculated, see this Rugby Union bonus points system article.

How are group IDs delivered in the stage array with the various types?

With the type of "league" they will have a sr:league prefix.
With the type of "cup" they will have a sr:cup prefix.

Player Data

What are the valid player positions/types?

Here are the valid player positions/types:

• FB - Full-back
• FH - Fly-half (only used in rugby union)
• SH - Scrum-half
• C - Centre
• PR - Prop
• L - Lock (alternative name for second row; only used in rugby union)
• BR - Back row
• W - Wing or winger
• HB - Half-back
• N8 - Number 8 (only used in rugby union)
• HO - Hooker
• SR - Second row (used in rugby union and rugby league; in rugby union, it's also known as lock)
• FL - Flanker (only used in rugby union)
• LF - Loose forward (only used in rugby league, but these players are now often back rows or props)
• UB - Utility back
• UF - Utility forward
• Back - same as utility back
• Outside Back - a name that encompasses someone who can play at centre, wing or full-back
• SO - Stand-off (only used in rugby league, often just known as a half-back)
• FR - Front row forward; someone who can play as a prop or hooker
• Threequarter - a name that encompasses someone who can play at centre or wing
• Forward - same as utility forward

Back to top ↑