Global American Football v1
API | API Version | XSD Schema |
Global American Football | v1 | Download |
Note: Authentication is required for all API calls. |
Examples:
>To find the home team win probability for a game: >- Call the Daily Schedule and find the match id for the game in question
- Call the Sport Event Probabilties using the match id
- Find the outcome element with the probability attribute
- Call the Daily Results, or Daily Schedule and find match id the game you want
- Call the Sport Event Timeline using the match id
- Find the Venue element and locate the name attribute
Update Frequency: | As Necessary | ||
Content Type: | XML or JSON | ||
Category & Sport Data Points: | Category Country Code Category Id |
Category Name Sport Id |
Sport Name |
Competitor Data Points: | Abbreviation Country Country Code |
Id Name Manager Country Code |
Manager Id Manager Name Manager Nationality |
Player Data Points: | Country Code Date of Birth Height |
Id Jersey Number Name |
Nationality Type Weight |
Venue Data Points: | Capacity City Country Code |
Country Name Id |
Map Coordinates Name |
Chinese - simplified (zh), English (en)
Click here for a tabular list of available languages per competition. | | `competitor_id` | Id of a given competitor. | | `format` | xml or json. | | `your_api_key` | Your API key. | Return to API map ## Competitor Results Provides match info and scoring for the past 10 games for a given team.
Update Frequency: | As Necessary | ||
Content Type: | XML or JSON | ||
Category & Sport Info Data Points: | Category Country Code Category Id |
Category Name Sport Id |
Sport Name |
Tournament Info Data Points: | Season End Date Season Id Season Name Season Start Date |
Season Year Tournament Id Tournament Name |
Tournament Round Name Tournament Round Number Tournament Round Type |
Competitor Info Data Points: | Abbreviation Country |
Country Code Id |
Name Qualifier |
Sport Event Info Data Points: | Period Score Away Score Period Score Home Score Period Score Number Period Score Type Sport Event Id Sport Event Scheduled Date/Time |
Sport Event Id Sport Event Scheduled Date/Time Sport Event Start Time to be Determined |
Sport Event Away Score Sport Event Status Home Score Sport Event Status Winner Id |
Venue Data Points: | Capacity Changed City Country Code |
Country Name Id Map Coordinates |
Name Reduced Capacity Reduced Capacity Max |
Chinese - simplified (zh), English (en)
Click here for a tabular list of available languages per competition. | | `competitor_id` | Id of a given competitor. | | `format` | xml or json. | | `your_api_key` | Your API key. | Return to API map ## Competitor Schedule Provides a list of scheduled games for a given team.
Update Frequency: | As Necessary | ||
Content Type: | XML or JSON | ||
Category & Sport Info Data Points: | Category Country Code Category Id |
Category Name Sport Id |
Sport Name |
Tournament Info Data Points: | Season End Date Season Id Season Name Season Start Date |
Season Year Tournament Id Tournament Name |
Tournament Round Name Tournament Round Number Tournament Round Type |
Competitor Info Data Points: | Abbreviation Country |
Country Code Id |
Name Qualifier |
Sport Event Info Data Points: | Sport Event Id Sport Event Scheduled Date/Time |
Sport Event Start Time to be Determined |
Sport Event Status |
Venue Data Points: | Capacity Changed City Country Code |
Country Name Id Map Coordinates |
Name Reduced Capacity Reduced Capacity Max |
Chinese - simplified (zh), English (en)
Click here for a tabular list of available languages per competition. | | `competitor_id` | Id of a given competitor. | | `format` | xml or json. | | `your_api_key` | Your API key. | Return to API map ## Daily Results Provides all game results for a given date.
Update Frequency: | As Necessary | ||
Content Type: | XML or JSON | ||
Category & Sport Info Data Points: | Category Country Code Category Id |
Category Name Sport Id |
Sport Name |
Tournament Info Data Points: | Season End Date Season Id Season Name Season Start Date |
Season Year Tournament Id Tournament Name |
Tournament Round Name Tournament Round Number Tournament Round Type |
Competitor Info Data Points: | Abbreviation Country |
Country Code Id |
Name Qualifier |
Sport Event Info Data Points: | Period Score Away Score Period Score Home Score Period Score Number Period Score Type Sport Event Id Sport Event Scheduled Date/Time |
Sport Event Id Sport Event Scheduled Date/Time Sport Event Start Time to be Determined |
Sport Event Away Score Sport Event Status Home Score Sport Event Status Winner Id |
Venue Data Points: | Capacity Changed City Country Code |
Country Name Id Map Coordinates |
Name Reduced Capacity Reduced Capacity Max |
Chinese - simplified (zh), English (en)
Click here for a tabular list of available languages per competition. | | `year` | Year in 4 digit format (YYYY). | | `month` | Month in 2 digit format (MM). | | `day` | Day in 2 digit format (DD). | | `format` | xml or json. | | `your_api_key` | Your API key. | Return to API map ## Daily Schedule Provides a list of all scheduled games for a given date.
Update Frequency: | As Necessary | ||
Content Type: | XML or JSON | ||
Category & Sport Info Data Points: | Category Country Code Category Id |
Category Name Sport Id |
Sport Name |
Tournament Info Data Points: | Season End Date Season Id Season Name Season Start Date |
Season Year Tournament Id Tournament Name |
Tournament Round Name Tournament Round Number Tournament Round Type |
Competitor Info Data Points: | Abbreviation Country |
Country Code Id |
Name Qualifier |
Sport Event Info Data Points: | Sport Event Id Sport Event Scheduled Date/Time |
Sport Event Start Time to be Determined |
Sport Event Status |
Venue Data Points: | Capacity Changed City Country Code |
Country Name Id Map Coordinates |
Name Reduced Capacity Reduced Capacity Max |
Chinese - simplified (zh), English (en)
Click here for a tabular list of available languages per competition. | | `year` | Year in 4 digit format (YYYY). | | `month` | Month in 2 digit format (MM). | | `day` | Day in 2 digit format (DD). | | `format` | xml or json. | | `your_api_key` | Your API key. | Return to API map ## Head To Head Provides previous and upcoming games between two teams, including game results.
Update Frequency: | As Necessary | ||
Content Type: | XML or JSON | ||
Category & Sport Info Data Points: | Category Country Code Category Id |
Category Name Sport Id |
Sport Name |
Tournament Info Data Points: | Season End Date Season Id Season Name Season Start Date |
Season Year Tournament Id Tournament Name |
Tournament Round Name Tournament Round Number Tournament Round Type |
Competitor Info Data Points: | Abbreviation Country |
Country Code Id |
Name Qualifier |
Sport Event Info Data Points: | Period Score Away Score Period Score Home Score Period Score Number Period Score Type Sport Event Id Sport Event Scheduled Date/Time |
Sport Event Id Sport Event Scheduled Date/Time Sport Event Start Time to be Determined |
Sport Event Away Score Sport Event Status Home Score Sport Event Status Winner Id |
Venue Data Points: | Capacity Changed City Country Code |
Country Name Id Map Coordinates |
Name Reduced Capacity Reduced Capacity Max |
Chinese - simplified (zh), English (en)
Click here for a tabular list of available languages per competition. | | `competitor_id` | Id of a given competitor. | | `competitor_id2` | Id of a given competitor. | | `format` | xml or json. | | `your_api_key` | Your API key. | Return to API map ## Player Profile Provides biographical information for a given player.
Update Frequency: | As Necessary | ||
Content Type: | XML or JSON | ||
Player Data Points: | Country Code Date of Birth Height |
Id Name Nationality |
Type Weight |
Chinese - simplified (zh), English (en)
Click here for a tabular list of available languages per competition. | | `player_id` | Id of a given player. | | `format` | xml or json. | | `your_api_key` | Your API key. | Return to API map ## Seasons Provides a list of current and past season IDs for a given tournament. Season IDs can be interchanged with tournament IDs to retrieve historical data.
Update Frequency: | As Necessary | ||
Content Type: | XML or JSON | ||
Category & Sport Info Data Points: | Category Country Code Category Id |
Category Name Sport Id |
Sport Name |
Tournament Info Data Points: | Season End Date Season Id Season Name |
Season Start Date Season Year |
Tournament Id Tournament Name |
Chinese - simplified (zh), English (en)
Click here for a tabular list of available languages per competition. | | `tournament_id or season_id` | Id of a given tournament or season. | | `format` | xml or json. | | `your_api_key` | Your API key. | Return to API map ## Sport Event Probabilities Provides probabilities (home team win, away team win) for a given game.
Update Frequency: | As Necessary | ||
Content Type: | XML or JSON | ||
Category & Sport Info Data Points: | Category Country Code Category Id |
Category Name Sport Id |
Sport Name |
Tournament Info Data Points: | Season End Date Season Id Season Name Season Start Date |
Season Year Tournament Id Tournament Name Tournament Round Match Number |
Tournament Round Matches Tournament Round Name Tournament Round Number Tournament Round Type |
Competitor Info Data Points: | Abbreviation Country |
Country Code Id |
Name Qualifier |
Probability Info Data Points: | Away Team Win Probability Home Team Win Probability |
Market Name | Outcome Name |
Sport Event Info Data Points: | Sport Event Id |
Sport Event Scheduled Date/Time |
Sport Event Start Time to be Determined |
Venue Data Points: | Capacity Changed City Country Code |
Country Name Id Map Coordinates |
Name Reduced Capacity Reduced Capacity Max |
Chinese - simplified (zh), English (en)
Click here for a tabular list of available languages per competition. | | `match_id` | Id of a given match. | | `format` | xml or json. | | `your_api_key` | Your API key. | Return to API map ## Sport Event Timeline Provides scoring information for a given game. Please note that data returned is determined by coverage level.
Update Frequency: | As Necessary | ||
Content Type: | XML or JSON | ||
Category & Sport Info Data Points: | Category Country Code Category Id |
Category Name Sport Id |
Sport Name |
Tournament Info Data Points: | Season End Date Season Id Season Name Season Start Date |
Season Year Tournament Id Tournament Name |
Tournament Round Name Tournament Round Number Tournament Round Type |
Competitor Info Data Points: | Abbreviation Country |
Country Code Id |
Name Qualifier |
Venue Data Points: | Capacity Changed City Country Code |
Country Name Id Map Coordinates |
Name Reduced Capacity Reduced Capacity Max |
Sport Event Info Data Points: | Coverage Info Period Score Away Score Period Score Home Score Period Score Number Period Score Type |
Sport Event Id Sport Event Scheduled Date/Time Sport Event Start Time to be Determined Sport Event Status |
Sport Event Status Away Score Sport Event Status Home Score Sport Event Status - Status Sport Event Status Winner Id |
Timeline Info Data Points: | Event Away Score Event Home Score Event Id |
Event Period Event Period Name Event Team |
Event Time Event Type |
Chinese - simplified (zh), English (en)
Click here for a tabular list of available languages per competition. | | `match_id` | Id of a given match. | | `format` | xml or json. | | `your_api_key` | Your API key. | Return to API map ## Tournament Info Provides information for a given tournament or season, including current season, participating teams, and tournament structure.
Update Frequency: | As Necessary | ||
Content Type: | XML or JSON | ||
Category & Sport Info Data Points: | Category Country Code Category Id |
Category Name Sport Id |
Sport Name |
Tournament Info Data Points: | Current Season End Date Current Season Id Current Season Name Current Season Start Date Current Season Year Info Tournament Status Info Venue Reduced Capacity |
Info Venue Reduced Capacity Max Season End Date Season Id Season Name Season Start Date Season Year Tournament Id |
Tournament Name Tournament Round Match Number Tournament Round Matches Tournament Round Name Tournament Round Number Tournament Round Type |
Competitor Info Data Points: | Abbreviation Country |
Country Code Id |
Name |
Sport Event Data Points: | Coverage Info |
Chinese - simplified (zh), English (en)
Click here for a tabular list of available languages per competition. | | `tournament_id or season_id` | Id of a given tournament or season. | | `format` | xml or json. | | `your_api_key` | Your API key. | Return to API map ## Tournament List Provides a list of all available tournaments in the API.
Update Frequency: | As Necessary | ||
Content Type: | XML or JSON | ||
Category & Sport Info Data Points: | Category Country Code Category Id |
Category Name Sport Id |
Sport Name |
Tournament Info Data Points: | Current Season End Date Current Season Id Current Season Name |
Current Season Start Date Current Season Year |
Tournament Id Tournament Name |
Chinese - simplified (zh), English (en)
Click here for a tabular list of available languages per competition. | | `format` | xml or json. | | `your_api_key` | Your API key. | Return to API map ## Tournament Live Standings Provides standings which are updated live according to games currently in progress. Note that not all tournaments or seasons are covered live.
Update Frequency: | As Necessary | ||
Content Type: | XML or JSON | ||
Category & Sport Info Data Points: | Category Country Code Category Id |
Category Name Sport Id |
Sport Name |
Tournament Info Data Points: | Current Season End Date Current Season Id Current Season Name Current Season Start Date |
Current Season Year Group Id Group Name Group Parent |
Group Type Tournament Id Tournament Name |
Standings Info Data Points: | Change Draw Loss Played Points |
Rank Score Against Score Difference Score For Team Id |
Team Name Tie Break Rule Type Win |
Chinese - simplified (zh), English (en)
Click here for a tabular list of available languages per competition. | | `tournament_id or season_id` | Id of a given tournament or season. | | `format` | xml or json. | | `your_api_key` | Your API key. | Return to API map ## Tournament Results Provides results for all matches within a given tournament or season.
Update Frequency: | As Necessary | ||
Content Type: | XML or JSON | ||
Category & Sport Info Data Points: | Category Country Code Category Id |
Category Name Sport Id |
Sport Name |
Tournament Info Data Points: | Season End Date Season Id Season Name Season Start Date |
Season Year Tournament Id Tournament Name |
Tournament Round Name Tournament Round Number Tournament Round Type |
Competitor Info Data Points: | Abbreviation Country |
Country Code Id |
Name Qualifier |
Sport Event Info Data Points: | Period Score Away Score Period Score Home Score Period Score Number Period Score Type Sport Event Id Sport Event Scheduled Date/Time |
Sport Event Id Sport Event Scheduled Date/Time Sport Event Start Time to be Determined |
Sport Event Away Score Sport Event Status Home Score Sport Event Status Winner Id |
Venue Data Points: | Capacity Changed City Country Code |
Country Name Id Map Coordinates |
Name Reduced Capacity Reduced Capacity Max |
Chinese - simplified (zh), English (en)
Click here for a tabular list of available languages per competition. | | `tournament_id or season_id` | Id of a given tournament or season. | | `format` | xml or json. | | `your_api_key` | Your API key. | Return to API map ## Tournament Schedule Provides scheduling information for all matches within a given tournament or season.
Update Frequency: | As Necessary | ||
Content Type: | XML or JSON | ||
Category & Sport Info Data Points: | Category Country Code Category Id |
Category Name Sport Id |
Sport Name |
Tournament Info Data Points: | Season End Date Season Id Season Name Season Start Date |
Season Year Tournament Id Tournament Name |
Tournament Round Name Tournament Round Number Tournament Round Type |
Competitor Info Data Points: | Abbreviation Country |
Country Code Id |
Name Qualifier |
Sport Event Info Data Points: | Sport Event Id Sport Event Scheduled Date/Time |
Sport Event Start Time to be Determined |
Sport Event Status |
Venue Data Points: | Capacity Changed City Country Code |
Country Name Id Map Coordinates |
Name Reduced Capacity Reduced Capacity Max |
Chinese - simplified (zh), English (en)
Click here for a tabular list of available languages per competition. | | `tournament_id or season_id` | Id of a given tournament or season. | | `format` | xml or json. | | `your_api_key` | Your API key. | Return to API map ## Tournament Standings Provides detailed standings info for a given season.
Update Frequency: | As Necessary | ||
Content Type: | XML or JSON | ||
Category & Sport Info Data Points: | Category Country Code Category Id |
Category Name Sport Id |
Sport Name |
Tournament Info Data Points: | Current Season End Date Current Season Id Current Season Name Current Season Start Date |
Current Season Year Group Id Group Name Group Parent |
Group Type Tournament Id Tournament Name |
Standings Info Data Points: | Change Draw Loss Played Points |
Rank Score Against Score Difference Score For Team Id |
Team Name Tie Break Rule Type Win |
Chinese - simplified (zh), English (en)
Click here for a tabular list of available languages per competition. | | `tournament_id or season_id` | Id of a given tournament or season. | | `format` | xml or json. | | `your_api_key` | Your API key. | Return to API map ## Venues Provides information for a given venue.
Update Frequency: | As Necessary | ||
Content Type: | XML or JSON | ||
Category & Sport Info Data Points: | Category Country Code Category Id |
Category Name Sport Id |
Sport Name |
Competitor Info Data Points: | Abbreviation Country |
Country Code Id |
Name |
Venue Data Points: | Capacity Changed City Country Code |
Country Name Id Map Coordinates |
Name Reduced Capacity Reduced Capacity Max |
Chinese - simplified (zh), English (en)
Click here for a tabular list of available languages per competition. | | `venue_id` | Id of a given venue. | | `format` | xml or json. | | `your_api_key` | Your API key. | Return to API map ## Frequently Asked Questions
Q: What format are date fields presented in?
A: 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
Q: What format are the date/time fields presented in?
A: 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
Q: What leagues or tournaments do you cover for Global American Football?
A: We cover the following tournaments:
- NFL
- CFL
- NFL Pro Bowl
- EFAF European Championship
Q: What are the valid sport_event_status – status values?
A: Here are the valid match status values and their definitions:
- 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
- delayed – The match has been temporarily delayed and will be continued
- 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
- cancelled – The match has been cancelled and will not be played
- ended – The match is over
- closed – The match results have been confirmed.
Q: What are the valid sport_event_status – match_status values?
A: Here are the valid match_status values:
- 1st_quarter
- 2nd_quarter
- 3rd_quarter
- 4th_quarter
- abandoned
- aet
- awaiting_extra_time
- cancelled
- closed
- delayed
- ended
- extra_time
- full-time
- halftime
- interrupted
- live
- not_started
- overtime
- pause
- postponed
Q: How do I access past seasons’ result and stats?
A: TournamentID and SeasonID are interchangeable. To access a previous season, first interrogate the tournaments/[tournamentID]/seasons endpoint to ascertain the required seasonID, then use that seasonID in place of the tournamentID for any of the following endpoints:
- Tournaments/seasonID/results
- Tournaments/seasonID/schedule
- Tournaments/seasonID/teams/teamID/statistics
- Tournaments/seasonID/standings
Q: What are the valid outcomes for probabilities?
A: Here are the valid outcome probabilities:
- home_team_winner
- away_team_winner
Q: How do I find out the coverage for a particular match?
A: Find the node called “coverage_info” in the Sport Event Timeline or Tournament Info endpoints. The attribute live_coverage reports whether Sportradar has live coverage of the match or not.
Q: Why do different groups have coverage information for a tournament?
A: The notion of “groups” is versatile and is used to distinguish between playoffs, and our tournaments structures and is therefore necessary to describe coverage at a group level for consistency.
Q: What are the possible event types logged?
A: Here are all of the possible event types we log:
- Match started
- Score change
- Match ended
Q: What are the valid tournament types?
A: Here are the valid tournament types:
- group
- playoff
Q: What are markets and what are the different markets?
A: 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?)
Q: What are the possible outcomes?
A: Different markets have different outcomes. The available markets are currently:
- home_team_winner
- away_team_winner
Q: How will a sport event behave when it is not covered with live scores?
A: When a sport_event is not covered live, the status and match_status will remain as not_started until results are entered post-match.
Return to topDocs Navigation
- Documentation
- Football (American Football)
- Football (Soccer)
- Australian Rules Football
- Baseball
- Basketball
- NBA v8
- NBA v7
- NBA v5
- NBA v4
- WNBA v8
- WNBA v7
- WNBA v4
- WNBA v3
- NBA G League v8
- NBA G League v7
- NBA G League v5
- NCAA Men's Basketball v8
- NCAA Men's Basketball v7
- NCAA Men's Basketball v4
- NCAA Men's Basketball v3
- NCAA Women's Basketball v8
- NCAA Women's Basketball v7
- NCAA Women's Basketball v3
- Global Basketball v2
- Global Basketball v1
- Combat Sports
- Cricket
- Editorial Content
- Golf
- Handball
- Hockey
- Images
- Insights
- Insights User Interface
- NBA Insights v2
- NFL Insights v2
- NHL Insights v2
- MLB Insights v2
- NBA Betting Splits v2
- NHL Betting Splits v2
- MLB Betting Splits v2
- NFL Betting Splits v2
- NCAAFB Betting Splits v2
- NCAAMB Betting Splits v2
- NCAAWB Betting Splits v2
- Soccer Betting Splits v2
- NBA Insights v1
- NHL Insights v1
- MLB Insights v1
- NFL Insights v1
- Odds
- Broadcast Graphics
- Racing
- Rugby
- Tennis
- Widgets
- Baseline Sports Coverage
- Badminton v2
- Badminton v1
- Bandy v2
- Bandy v1
- Beach Soccer v2
- Beach Soccer v1
- Curling v2
- Curling v1
- Cycling v2
- Darts v2
- Darts v1
- Field Hockey v2
- Field Hockey v1
- Floorball v2
- Floorball v1
- Futsal v2
- Futsal v1
- Pesapallo v2
- Pesapallo v1
- Snooker v2
- Snooker v1
- Squash v2
- Squash v1
- Table Tennis v2
- Volleyball (Beach) v2
- Volleyball (Beach) v1
- Volleyball (Indoor) v2
- Volleyball (Indoor) v1
- Waterpolo v2
- Waterpolo v1
- Winter Sports v1