Frequently asked questions for Aussie Rules Football v3
Click on the categories below or browse questions on the right panel.
Categories
.
Coverage
What leagues or tournaments do you cover for Aussie Rules Football?
We cover the AFL tournament.
How do I find out the coverage for a particular match?
Within the Summaries and Timeline feeds, find the node for coverage
. Coverage nodes have two types: season
level and sport_event
level.
- The
season
level describes data coverage you can expect for matches involved in that given season. - The
sport_event
level describes the data depth of a specific match within the group and season.
Note: There are occasions when the sport_event
coverage can vary from the anticipated season
coverage. This node exists to highlight that in that event to assist in handling any discrepancies.
Why do different groups have coverage information for a tournament?
The notion of “groups” is versatile and is used to distinguish between playoffs and our tournaments structures. Therefore, it is necessary to describe coverage at a group level for consistency.
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: https://api.sportradar.com/australianrules/trial/v3/openapi/swagger/index.html
What format are date fields presented in?
When we present date only values we present these in the ISO 8601 standard format.
ex: 2013-04-03
We use these for attributes that have date and no time (such as birthdate). For more information: https://en.wikipedia.org/wiki/ISO_8601
What format are the date/time fields presented in?
All of our Date/Time attributes are in UTC, presented in the ISO 8601 standard format.
ex: 2013-04-03T18:15:00+00:00
For more information: https://en.wikipedia.org/wiki/ISO_8601
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
Sport Event Statuses
What are the valid sport_event_status
– status
values?
sport_event_status
– status
values?not_started
– The match is scheduled to be playedstarted
- The match has begunlive
– The match is currently in progresspostponed
– The match has been postponed to a future datesuspended
- The match has been suspendedmatch_about_to_start
- The match is about to begindelayed
– The match has been temporarily delayed and will be continued. Typically appears prior to match startinterrupted
- 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 insteadcancelled
– The match has been cancelled and will not be playedended
– The match is overclosed
– The match results have been confirmed
What are the valid sport_event_status
– match_status
values?
sport_event_status
– match_status
values?not_started
aet
ended
postponed
cancelled
1st_period
2nd_period
3rd_period
4th_period
overtime
penalties
pause
awaiting_extra_time
awaiting_penalties
interrupted
abandoned
start_delayed
started
Probabilities
What are markets and what are the different markets?
Markets is something you can bet on that we provide probabilities for. Over time we intend to provide more and more markets in the API. Currently the only market we provide is 3-way (will the home team win? Or the away team? Or will it be a draw?).
What are the valid outcomes for probabilities?
home_team_winner
away_team_winner
What are the possible values for next_period
?
next_period
?1st_quarter
2nd_quarter
3rd_quarter
4th_quarter
extra_time
half_time
Past Season Data
How far back does the data go?
Only the current season and the previous season will be available in the API.
Player Data
Why do some score_change
events not have player data?
score_change
events not have player data?No player data will be displayed for a rushed behind. A rushed behind occurs when the ball passes through the goalposts and was last touched by a defending player.
Are lineups and player data available for both Men's and Women's competitions?
No. Player data is currently only available for the Men's competition.
Event Types
What are the possible event types logged?
match_started
period_start
score_change
break_start
period_score
match_ended
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.
< 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 200 entries by default. To return more matches, an additional query string parameter must be used after your API key. For example, appending &start=200
will return the next 200 entries per page, &start=400
will return the next 200, and so on.
Standings / Tournaments
What are the valid standings types in the Standings feed?
Listed below are the values for standing
– type
.
total
home
away
first_half_total
first_half_home
first_half_away
second_half_total
second_half_home
second_half_away
What are the valid tournament types?
group
playoff
What are the possible values for cup_round
– state
in the Season Links endpoint?
cup_round
– state
in the Season Links endpoint?Listed below are the values and definitions for cup_round
- state
. 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.
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.
More questions?
Reach out to [email protected] for further assistance.