Frequently asked questions for Floorball v2
Click on the categories below or browse questions on the right panel.
Categories
.
Coverage
What leagues do you cover, and at what level?
Coverage information can be found via our Coverage Matrix.
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/floorball/trial/v2/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
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
(or offset
) 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
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
1st_period
2nd_period
aet
ended
postponed
cancelled
started
Probabilities
What are the valid outcomes for probabilities?
home_team_winner
away_team_winner
draw
Past Season Data
How do I access past results and stats?
Use the Competition 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 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.
More questions?
Reach out to [email protected] for further assistance.