NFL v2

Frequently Asked Questions
API API Version Failover
Official NFL v2 Failover Details
Failover Summary
Note: Authentication is required for all API calls.
## NFL API v2 Map To best utilize the NFL API v2, you will need several parameters to create your API calls. The map below illustrates how you can obtain the parameters you need. >Examples: >To find the team a player was drafted by: >
  1. Call the season or weekly schedule and find a Game Id that they played in
  2. Call the Game Roster using the Game Id to get the Player Id
  3. Call the Player Profile and locate the Player Draft Team Alias.
>The Alias maps to the team that drafted the player. >To find a teams number of defensive sacks: >
  1. Call the season or weekly schedule and find the desired Team Id
  2. Call the Seasonal Statistics using the Team Id
  3. Locate the Team Defense Sacks.
>The teams number of defensive sacks is displayed. Primary and additional feeds only require dates or human-readable parameters, while other feeds require a global unique identifier (GUID) to identify the game, team, or player that the feed will describe. The primary feeds provide GUIDs for games and teams, while games and teams provide GUIDS for players. ## NFL API v2 Simulations The live simulations give you the opportunity to test your code against a simulation of live data before the preseason starts or any time! Our simulation system replays select completed games allowing you to view our API feeds as if they were happening live. Below are the details regarding the simulations for our NFL Official API (v2) Simulations run every day at the following times (Eastern Time): 11:00 am - Data is reset for the day’s simulations.
1:00 pm - PST week 1 games will run – Oakland at Houston, Detroit at Seattle, Miami at Pittsburgh, and New York at Green Bay
2:00 pm – PST week 2 games will run - Seattle at Atlanta, Houston at New England, Green Bay at Dallas, and Pittsburgh at Kansas City
3:00 pm – PST week 3 games will run – Green Bay at Atlanta and Pittsburgh at New England
4:00 pm – PST week 4 games will run – New England vs Atlanta
By retrieving the Season Schedule feed for the 2016 postseason, you can obtain the game ID for each game listed above. All pull-based feeds are available for simulation. Simulations of push delivery are available for the Push Statistics and Push Event feeds, but we are currently unable to provide the Push Clock as a simulation. If you have an existing API key, simply replace the access_level (ot or o) in the URL of a feed with sim. ## Daily Change Log This feed displays information on teams, players, game statistics, schedules, and standings that have changed after initial posting. If a statistic has been modified, the Daily Change Log will display the Id and Last Modified timestamp. Using the Id for the team, player, game, schedule, or standing you can use another feed to view the change.
Update Frequency: 5am CST Daily
Content Type: Raw XML or JSON
Game Information Data Points: Game Id
Last Modified
League Alias
League Id
League Name
League Season Id
Player Full Name
Player Id
Team Alias
Team Id
Team Market
Team Name
League Information Data Points: Alias
Id
Name Season Id
Player Information Data Points: Full Name Id Last Modified
Team Information Data Points: Alias
Id
Last Modified
Market
Name
> To generate the Daily Change Log for 05/24/2016 replace {your_api_key} with your API key: ```ruby require 'uri' require 'net/http' require 'openssl' url = URI("https://api.sportradar.us/nfl-ot2/league/2016/05/24/changes.xml?api_key={your_api_key}") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) response = http.request(request) puts response.read_body ``` ```python import http.client conn = http.client.HTTPSConnection("api.sportradar.us") conn.request("GET", "/nfl-ot2/league/2016/05/24/changes.xml?api_key={your_api_key}") res = conn.getresponse() data = res.read() print(data.decode("utf-8")) ``` ```shell curl -X GET "https://api.sportradar.us/nfl-ot2/league/2016/05/24/changes.xml?api_key={your_api_key}" ``` > The above command returns xml structured like this. Access the Daily Change Log feed by replacing the parameters in the following URL: https://api.sportradar.us/nfl-`{access_level}{version}`/league/`{year}`/`{month}`/`{day}`/changes.`{format}`?api_key=`{your_api_key}` Replace placeholders with the following query parameters: | Parameter | Description | | --------- | ----------- | | `access_level` | Defines the access level of your API key as Production (o), Trial (ot), or Simulation (sim).
For more information on simulations, see NFL Official API v2 Simulations. | | `version` | Version number of the API you are accessing (current version: 2). | | `year` | Year in 4 digit format (YYYY). | | `month` | Month in 2 digit format (MM). | | `day` | Day of month in 2 digit format (DD). | | `format` | xml or json. | | `your_api_key` | Your API key. | To retrieve the XML Schema Definition (.XSD) for the Daily Change Log, replace the parameters in the following URL. https://api.sportradar.us/nfl-`{access_level}{version}`/schema/changelog-v2.0.xsd?api_key=`{your_api_key}` Return to API map ## Game Boxscore This feed displays game scoring information for each team, including complete play information for all scoring drives.
Update Frequency: Real-time
Content Type: Styled XML or Raw JSON
Boxscore Information Data Points: Attendance
Away Team Points for Quarter
Away Team Timeouts Remaining
Away Team Timeouts Used
Away Team Total Points
Clock
Clock Offset
Current Situation Clock
Current Situation Down
Current Situation Team Alias
Current Situation Team Id
Current Situation Team Market
Current Team Name
Current Situation Team Ref
Current Situation Team Yardline
Current Situation Possession Team Alias
Current Situation Possession Team Id
Current Situation Possession Team Market
Current Situation Possession Team Name
Current Situation Possession Team Ref
Current Situation Yards to First Down
Home Team Points for Quarter
Home Team Timeouts Remaining
Home Team Timeouts Used
Home Team Total Points
Last Event Alternate Description
Last Event Clock
Last Event Description
Last Event Id
Last Event Reference
Last Event Sequence
Last Event Type
Officials Assignment
Officials Full Name
Officials Number
Overtime Id
Overtime Number
Overtime Sequence
Quarter
Quarter Id
Quarter Number
Quarter Sequence
Game Information Data Points: Away Team Alias
Away Team Game Reference
Away Team Id
Away Team Market
Away Team Name
Entry Mode
Home Team Alias
Home Team Game Reference
Home Team Id
Home Team Market
Home Team Name
Game Id
Game Number
Game Reference
Game Scheduled Start Date/Time
Status
Weather
League Information Data Points: Season Id
Season Name
Season Type
Season Year
Week Id
Week Sequence
Week Title
Play By Play Information Data Points: Detail Category
Detail Description
Detail Direction
Detail End Location - Team Alias
Detail End Location - Yardline
Detail No Attempt
Detail Penalty - Description
Detail Penalty - Result
Detail Penalty - Safety
Detail Penalty - Yards
Detail Result
Detail Sequence
Detail Start Location - Team Alias
Detail Start Location - Yardline
Detail Yards
Drive Duration
Drive End Reason
Drive First Downs
Drive Gain
Drive Id
Drive Inside 20 Flag
Drive Penalty Yards
Drive Play Count
Drive Scoring Drive Flag
Drive Sequence
Drive Start Reason
Ending Situation Clock
Ending Situation Down
Ending Situation Location - Team Alias
Ending Situation - Location - Team Id
Ending Situation - Location - Team Market
Ending Situation - Location - Team Name
Ending Situation - Location - Team Reference
Ending Situation - Location - Team Yardline
Ending Situation - Possession - Team Alias
Ending Situation - Possession - Team Id
Ending Situation - Possession - Team Market
Ending Situation - Possession - Team Name
Ending Situation - Possession - Team Reference
Ending Situation - Yards to First Down
Event Alternate Description
Event Clock
Event Description
Event Id
Event Reference
Event Sequence
Event Type
Play Alternate Description
Play Away Points
Play Clock
Play Description
Play Fake Field Goal
Play Fake Punt
Play Home Points
Play Id
Play Play Clock
Play Reference
Play Scoring Play
Play Screen Pass
Play Sequence
Play Type
Play Wall Clock
Points After - Play Id
Points After - Reference
Points After - Score Type
Points After - Sequence
Scoring - Away Team Score
Scoring - Clock
Scoring - Home Team Score
Scoring - Points
Scoring - Sequence
Starting Situation Clock
Starting Situation Down
Starting Situation Location - Team Alias
Starting Situation Location - Team Id
Starting Situation Location - Team Market
Starting Situation Location - Team Name
Starting Situation Location - Team Reference
Starting Situation Location - Team Yardline
Starting Situation Possession - Team Alias
Starting Situation Possession - Team Id
Starting Situation Possession - Team Market
Starting Situation Possession - Team Name
Starting Situation Possession - Team Reference
Starting Situation Yards to First Down
Play Statistics Data Points: Conversion Attempt
Conversion Complete
Conversion Down
Defense Assisted Sacks
Defense Assisted Tackles
Defense Blitz
Defense Defensive Completion
Defense Defensive Target
Defense Hurry
Defense Interception
Defense Interception Yards
Defense Knockdown
Defense Nullified Play Flag
Defense Pass Defended
Defense Primary
Defense QB Hit
Defense Sack
Defense Sack Yards
Defense Safety
Defense Tackle for Loss
Defense Tackle for Loss Yards
Defense Tackle
Extra Point Attempt
Field Goal Attempt
Field Goal Attempt Yards
Field Goal Missed
Field Goal Yards
First Down Category
Fumbles Forced
Fumbles Fumble
Fumbles Nullified
Fumbles Out of Bounds
Kickoffs End Zone
Kickoffs Gross Yards
Kickoffs Inside 20
Kickoffs Kickoff
Kickoffs Onside Attempt
Kickoffs Onside Success
Kickoffs Squib Kick
Kickoffs Touchback
Kickoffs Yards
Passing Attempt
Passing Attempt Yards
Passing Blitz
Passing Completion
Passing First Down
Passing Goal to Go
Passing Hurry
Passing Inside 20
Passing Interception
Passing Knockdown
Passing Nullified
Passing Sack
Passing Sack Yards
Passing Touchdown
Passing Yards
Penalties Penalty
Penalties Yards
Punting Attempt
Punting Downed
Punting Fair Catch
Punting Inside 20
Punting Out of Bounds
Punting Touchback
Punting Yards
Receiving Catchable
Receiving First Down
Receiving Goal to Go
Receiving Inside 20
Receiving Nullified
Receiving Reception
Receiving Target
Receiving Touchdown
Receiving Yards
Receiving Yards After Catch
Returns Category
Returns Downed
Returns Fair Catch
Returns Out of Bounds
Returns Return
Returns Touchback
Returns Yards
Rushing Attempt
Rushing Broken Tackles
Rushing First Down
Rushing Goal to Go
Rushing Inside 20
Rushing Kneel Down
Rushing Scramble
Rushing Tackle for Loss
Rushing Tackle for Loss Yards
Rushing Touchdown
Rushing Yards
Player Information Data Points: Full Name
Game Reference
Id
Jersey Number
Position
Role
Team Information Data Points: Alias
Game Reference
Id
Market
Name
Venue Information Data Points: Address
Capacity
City
Country
Id
Name
Roof Type
State
Surface
Zip
> To generate the Game Boxscore for the Game ID below replace {your_api_key} with your API key: ```ruby require 'uri' require 'net/http' require 'openssl' url = URI("https://api.sportradar.us/nfl-ot2/games/b7aeb58f-7987-4202-bc41-3ad9a5b83fa4/boxscore.xml?api_key={your_api_key}") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) response = http.request(request) puts response.read_body ``` ```python import http.client conn = http.client.HTTPSConnection("api.sportradar.us") conn.request("GET", "/nfl-ot2/games/b7aeb58f-7987-4202-bc41-3ad9a5b83fa4/boxscore.xml?api_key={your_api_key}") res = conn.getresponse() data = res.read() print(data.decode("utf-8")) ``` ```shell curl -X GET "https://api.sportradar.us/nfl-ot2/games/b7aeb58f-7987-4202-bc41-3ad9a5b83fa4/boxscore.xml?api_key={your_api_key}" ``` > The above command returns xml structured like this. This endpoint retrieves the boxscore information for a specific game. https://api.sportradar.us/nfl-`{access_level}{version}`/games/`{game_id}`/boxscore.`{format}`?api_key=`{your_api_key}` Replace placeholders with the following query parameters: | Parameter | Description | | --------- | ----------- | | `access_level` | Defines the access level of your API key as Production (o), Trial (ot), or Simulation (sim).
For more information on simulations, see NFL Official API v2 Simulations. | | `version` | Version number of the API you are accessing (current version: 2). | | `game_id` | ID for a given game. | | `format` | xml or json. | | `your_api_key` | Your API key. | To retrieve the XML Schema Definition (.XSD) for the Game Boxscore, replace the parameters in the following URL. https://api.sportradar.us/nfl-`{access_level}{version}`/schema/boxscore-v4.0.xsd?api_key=`{your_api_key}` Return to API map ## Game Roster Game roster information for each team as well as player profile data, including NFL related reference ids.
Update Frequency: As Necessary
Content Type: Styled XML or JSON
Boxscore Information Data Points: Attendance
Clock
Clock Offset Quarter
Game Information Data Points: Away Team Alias
Away Team Game Reference
Away Team Id
Away Team Market
Away Team Name
Entry Mode
Home Team Alias
Home Team Game Reference
Home Team Id
Home Team Market
Home Team Name
Game Id
Game Number
Game Reference
Game Scheduled Start Date/Time
Status
Weather
League Information Data Points: Season Id
Season Name
Season Type
Season Year
Week Id
Week Sequence
Week Title
Player Information Data Points: Abbreviated Name
Age (at time of game)
Birth Date
Birth Place
College
College Conference
Draft Number
Draft Round
Draft Year
Draft Team Alias
Draft Team Id
Draft Team Market
Draft Team Name
First Name
Full Name
Height
High School
Id
Jersey Number
Last Name
Position
Preferred Name
Reference Id
Reference Origin
Rookie Year
Status
Weight
Team Information Data Points: Alias
Id
Market Name
Venue Information Data Points: Address
Capacity
City
Country
Id
Name
Roof Type
State
Surface
Zip
> To generate the Game Roster for the Game ID below replace {your_api_key} with your API key: ```ruby require 'uri' require 'net/http' require 'openssl' url = URI("https://api.sportradar.us/nfl-ot2/games/b7aeb58f-7987-4202-bc41-3ad9a5b83fa4/roster.xml?api_key={your_api_key}") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) response = http.request(request) puts response.read_body ``` ```python import http.client conn = http.client.HTTPSConnection("api.sportradar.us") conn.request("GET", "/nfl-ot2/games/b7aeb58f-7987-4202-bc41-3ad9a5b83fa4/roster.xml?api_key={your_api_key}") res = conn.getresponse() data = res.read() print(data.decode("utf-8")) ``` ```shell curl -X GET "https://api.sportradar.us/nfl-ot2/games/b7aeb58f-7987-4202-bc41-3ad9a5b83fa4/roster.xml?api_key={your_api_key}" ``` > The above command returns xml structured like this. This endpoint retrieves the roster information for a specific game. https://api.sportradar.us/nfl-`{access_level}{version}`/games/`{game_id}`/roster.`{format}`?api_key=`{your_api_key}` Replace placeholders with the following query parameters: | Parameter | Description | | --------- | ----------- | | `access_level` | Defines the access level of your API key as Production (o), Trial (ot), or Simulation (sim).
For more information on simulations, see NFL Official API v2 Simulations. | | `version` | Version number of the API you are accessing (current version: 2). | | `game_id` | ID for a given game. | | `format` | xml or json. | | `your_api_key` | Your API key. | To retrieve the XML Schema Definition (.XSD) for the Game Roster, replace the parameters in the following URL. https://api.sportradar.us/nfl-`{access_level}{version}`/schema/roster-v2.0.xsd?api_key=`{your_api_key}` Return to API map ## Game Statistics Team and player level game statistics for each team.
Update Frequency: Real-time
Content Type: Styled XML or Raw JSON
Boxscore Information Data Points: Attendance
Away Team Timeouts Remaining
Away Team Timeouts Used
Away Team Total Points
Clock
Clock Offset
Home Team Timeouts Remaining
Home Team Timeouts Used
Home Team Total Points
Quarter
Game Information Data Points: Away Team Alias
Away Team Game Reference
Away Team Id
Away Team Market
Away Team Name
Entry Mode
Home Team Alias
Home Team Game Reference
Home Team Id
Home Team Market
Home Team Name
Game Id
Game Number
Game Reference
Game Scheduled Start Date/Time
Status
Weather
Player Game Statistics Data Points: Conversions Attempts
Conversion Category
Conversion Successes
Defense Assisted Tackles
Defense Assisted Tackles
Defense Combined Tackles
Defensive Completions
Defensive Targets
Defense Forced Fumbles
Defense Fumble Recoveries
Defense Hurries
Defense Interceptions
Defense Knockdowns
Defense Miscellaneous Assisted Tackles
Defense Miscellaneous Forced Fumbles
Defense Miscellaneous Fumble Recoveries
Defense Miscellaneous Tackles
Defense Missed Tackles
Defense Passes Defended
Defense QB Hits
Defense Sack Yards
Defense Sacks
Defense Safeties
Defense Special Teams Assisted Tackles
Defense Special Teams Blocks
Defense Special Teams Forced Fumbles
Defense Special Teams Fumble Recoveries
Defense Special Teams Tackles
Defense Tackles
Defense Tackles for Loss
Defense Tackles for Loss Yards
Extra Points Kicking Attempts
Extra Points Kicking Blocked
Extra Points Kicking Made
Field Goals Attempts
Field Goals Average Yards
Field Goals Blocked
Field Goals Longest
Field Goals Made
Field Goal Yards
Fumbles End Zone Touchdowns
Fumbles Force Fumbles
Fumbles Fumbles
Fumbles Lost Fumbles
Fumbles Opponent Recovery
Fumbles Opponent Recovery Touchdowns
Fumbles Opponent Recovery Yards
Fumbles Out of Bounds
Fumbles Own Recovery
Fumbles Own Recovery Touchdowns
Fumbles Own Recovery Yards
Interception Returns Average Yards
Interception Returns Longest
Interception Returns Longest Touchdown
Interception Returns
Interception Returns Touchdowns
Interception Returns Yards
Kick Returns Average Yards
Kick Returns Fair Catches
Kick Returns Longest
Kick Returns Longest Touchdown
Kick Returns Returns
Kick Returns Touchdowns
Kick Returns Yards
Kickoffs End Zone
Kickoffs Inside 20
Kickoffs
Kickoffs Onside Attempts
Kickoffs Onside Successes
Kickoffs Out of Bounds
Kickoffs Return Yards
Kickoffs Squib Kicks
Kickoffs Total Endzone
Kickoffs Touchbacks
Kickoffs Yards
Passing Air Yards
Passing Attempts
Passing Average Pocket Time
Passing Average Yards
Passing Blitzes
Passing Completion Percentage
Passing Completions
Passing Defended Passes
Passing Dropped Passes
Passing Hurries
Passing Interceptions
Passing Knockdowns
Passing Longest
Passing Longest Touchdown
Passing Pocket Time
Passing Poor Throws
Passing Rating
Passing Red Zone Attempts
Passing Sack Yards
Passing Sacks
Passing Spikes
Passing Throw Aways
Passing Touchdowns
Passing Yards
Penalties
Penalty Yards
Punt Return Average Yards
Punt Return Fair Catches
Punt Return Longest
Punt Return Longest Touchdown
Punt Returns
Punt Return Touchdowns
Punt Return Yards
Punts Attempts
Punts Average Hang Time
Punts Average Net Yards
Punts Average Yards
Punts Blocked
Punts Hang Time
Punts Inside 20
Punts Longest
Punts Net Yards
Punts Return Yards
Punts Touchbacks
Punts Yards
Receiving Air Yards
Receiving Average Yards
Receiving Broken Tackles
Receiving Catchable Passes
Receiving Dropped Passes
Receiving Longest
Receiving Longest Touchdown
Receiving Receptions
Receiving Red Zone Targets
Receiving Targets
Receiving Touchdowns
Receiving Yards
Receiving Yards After Catch
Receiving Yards After Contact
Rushing Attempts
Rushing Average Yards
Rushing Broken Tackles
Rushing Kneel Downs
Rushing Longest
Rushing Longest Touchdown
Rushing Red Zone Attempts
Rushing Scrambles
Rushing Tackle for Loss
Rushing Tackle for Loss Yards
Rushing Touchdowns
Rushing Yards
Rushing Yards After Contact
Team Game Statistics Data Points: Conversions Defense Attempts
Conversions Defense Successes
Conversions Pass Attempts
Conversions Pass Successes
Conversions Rush Attempts
Conversions Rush Successes
Conversions Turnover Successes
Defense Assisted Tackles
Defense Blitzes
Defense Combined Tackles
Defensive Completions
Defensive Targets
Defense Forced Fumbles
Defense Fumble Recoveries
Defense Hurries
Defense Interceptions
Defense Knockdowns
Defense Miscellaneous Assisted Tackles
Defense Miscellaneous Forced Fumbles
Defense Miscellaneous Fumble Recoveries
Defense Miscellaneous Tackles
Defense Missed Tackles
Defense Passes Defended
Defense QB Hits
Defense Sack Yards
Defense Sacks
Defense Safeties
Defense Special Teams Assisted Tackles
Defense Special Teams Blocks
Defense Special Teams Forced Fumbles
Defense Special Teams Fumble Recoveries
Defense Special Teams Tackles
Defense Tackles
Defense Tackles for Loss
Defense Tackles for Loss Yards
Efficiency 3rd Down Attempts
Efficiency 3rd Down Conversions
Efficiency 3rd Down Percentage
Efficiency 4th Down Attempts
Efficiency 4th Down Conversions
Efficiency 4th Down Percentage
Efficiency Goal to Go Attempts
Efficiency Goal to Go Conversions
Efficiency Goal to Go Percentage
Efficiency Red Zone Attempts
Efficiency Red Zone Conversions
Efficiency Red Zone Percentage
Extra Points Kicking Attempts
Extra Points Kicking Blocked
Extra Points Kicking Made
Field Goals Attempts
Field Goals Average Yards
Field Goals Blocked
Field Goals Longest
Field Goals Made
Field Goals Net Attempts
Field Goals Yards
First Downs Passing
First Downs Penalty
First Downs Rushing
First Downs Total
Fumbles End Zone Touchdowns
Fumbles Force Fumbles
Fumbles Fumbles
Fumbles Lost Fumbles
Fumbles Opponent Recovery
Fumbles Opponent Recovery Touchdowns
Fumbles Opponent Recovery Yards
Fumbles Out of Bounds
Fumbles Own Recovery
Fumbles Own Recovery Touchdowns
Fumbles Own Recovery Yards
Interception Returns Average Yards
Interception Returns Longest
Interception Returns Longest Touchdown
Interception Returns Returns
Interception Returns Touchdowns
Interception Returns Yards
Interceptions
Interceptions Return Yards
Interceptions Returned
Kick Returns Average Yards
Kick Returns Fair Catches
Kick Returns Longest
Kick Returns Longest Touchdown
Kick Returns Returns
Kick Returns Touchdowns
Kick Returns Yards
Kickoffs End Zone
Kickoffs Inside 20
Kickoffs
Kickoffs Out of Bounds
Kickoffs Return Yards
Kickoffs Total Endzone
Kickoffs Touchbacks
Kickoffs Yards
Misc Returns Blocked Field Goal Touchdowns
Misc Returns Blocked Punt Touchdowns
Misc Returns End Zone Recovery Touchdowns
Misc Returns Field Goal Return Touchdowns
Misc Returns Returns
Misc Returns Touchdowns
Misc Returns Yards
Passing Air Yards
Passing Attempts
Passing Average Yards
Passing Blitzes
Passing Completion Percentage
Passing Completions
Passing Defended Passes
Passing Dropped Passes
Passing Gross Yards
Passing Hurries
Passing Interceptions
Passing Knockdowns
Passing Longest
Passing Longest Touchdown
Passing Net Yards
Passing Pocket Time
Passing Rating
Passing Red Zone Attempts
Passing Sack Yards
Passing Sacks
Passing Spikes
Passing Throw Aways
Passing Touchdowns
Passing Yards
Penalties
Penalty Yards
Punt Returns Average Yards
Punt Returns Fair Catches
Punt Returns Longest
Punt Returns Longest Touchdown
Punt Returns
Punt Returns Touchdowns
Punt Returns Yards
Punts Attempts
Punts Average Hang Time
Punts Average Net Yards
Punts Average Yards
Punts Blocked
Punts Hang Time
Punts Inside 20
Punts Longest
Punts Net Yards
Punts Return Yards
Punts Touchbacks
Punts Yards
Receiving Air Yards
Receiving Average Yards
Receiving Broken Tackles
Receiving Catachable Passes
Receiving Dropped Passes
Receiving Longest
Receiving Longest Touchdown
Receiving Receptions
Receiving Red Zone Targets
Receiving Targets
Receiving Touchdowns
Receiving Yards
Receiving Yards After Catch
Receiving Yards After Contact
Rushing Attempts
Rushing Average Yards
Rushing Broken Tackles
Rushing Kneel Downs
Rushing Longest
Rushing Longest Touchdown
Rushing Red Zone Attempts
Rushing Scrambles
Rushing Tackles for Loss
Rushing Tackles for Loss Yards
Rushing Touchdowns
Rushing Yards
Rushing Yards After Contact
Touchdowns Fumble Return
Touchdowns Interception Return
Touchdowns Kick Return
Touchdowns Other
Touchdowns Pass
Touchdowns Punt Return
Touchdowns Rush
Touchdowns Total
Touchdowns Total Return
Team Summary Data Points: Average Gain
Fumbles
Fumbles Lost
Penalties
Penalty Yards
Play Count
Possession Time
Return Yards
Rushing Plays
Safeties
Total Yards
Turnovers
League Information Data Points: Season Id
Season Name
Season Type
Season Year
Week Id
Week Sequence
Week Title
Player Information Data Points: Full Name
Game Reference
Id
Jersey Number
Position
Team Information Data Points: Alias
Game Reference
Id
Market
Name
Venue Data Points: Address
Capacity
City
Country
Id
Name
Roof Type
State
Surface
Zip
> To generate the Game Statistics for the Game ID below replace {your_api_key} with your API key: ```ruby require 'uri' require 'net/http' require 'openssl' url = URI("https://api.sportradar.us/nfl-ot2/games/b7aeb58f-7987-4202-bc41-3ad9a5b83fa4/statistics.xml?api_key={your_api_key}") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) response = http.request(request) puts response.read_body ``` ```python import http.client conn = http.client.HTTPSConnection("api.sportradar.us") conn.request("GET", "/nfl-ot2/games/b7aeb58f-7987-4202-bc41-3ad9a5b83fa4/statistics.xml?api_key={your_api_key}") res = conn.getresponse() data = res.read() print(data.decode("utf-8")) ``` ```shell curl -X GET "https://api.sportradar.us/nfl-ot2/games/b7aeb58f-7987-4202-bc41-3ad9a5b83fa4/statistics.xml?api_key={your_api_key}" ``` > The above command returns xml structured like this. This endpoint retrieves the game statistics for a specific game. https://api.sportradar.us/nfl-`{access_level}{version}`/games/`{game_id}`/statistics.`{format}`?api_key=`{your_api_key}` Replace placeholders with the following query parameters: | Parameter | Description | | --------- | ----------- | | `access_level` | Defines the access level of your API key as Production (o), Trial (ot), or Simulation (sim).
For more information on simulations, see NFL Official API v2 Simulations. | | `version` | Version number of the API you are accessing (current version: 2). | | `game_id` | ID for a given game. | | `format` | xml or json. | | `your_api_key` | Your API key. | To retrieve the XML Schema Definition (.XSD) for Game Statistics, replace the parameters in the following URL. https://api.sportradar.us/nfl-`{access_level}{version}`/schema/statistics-v4.0.xsd?api_key=`{your_api_key}` Return to API map ## League Hierarchy Complete league hierarchy information including team information such as venues and NFL reference ids.
Update Frequency: As Necessary
Content Type: Raw XML or JSON
League Information Data Points: League Alias
Conference Alias
Conference Id
Conference Name
Division Alias
Division Id
Division Name
League Id
League Name
Team Information Data Points: Alias
Id
Market
Name
Reference Id
Reference Origin
Venue Information Data Points: Address
Capacity
City
Country
Id
Name
Roof Type
State
Surface
Zip
> To generate the League Hierarchy replace {your_api_key} with your API key: ```ruby require 'uri' require 'net/http' require 'openssl' url = URI("https://api.sportradar.us/nfl-ot2/league/hierarchy.xml?api_key={your_api_key}") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) response = http.request(request) puts response.read_body ``` ```python import http.client conn = http.client.HTTPSConnection("api.sportradar.us") conn.request("GET", "/nfl-ot2/league/hierarchy.xml?api_key={your_api_key}") res = conn.getresponse() data = res.read() print(data.decode("utf-8")) ``` ```shell curl -X GET "https://api.sportradar.us/nfl-ot2/league/hierarchy.xml?api_key={your_api_key}" ``` > The above command returns xml structured like this. This endpoint retrieves the League Hierarchy. https://api.sportradar.us/nfl-`{access_level}{version}`/league/hierarchy.`{format}`?api_key=`{your_api_key}` Replace placeholders with the following query parameters: | Parameter | Description | | --------- | ----------- | | `access_level` | Defines the access level of your API key as Production (o), Trial (ot), or Simulation (sim).
For more information on simulations, see NFL Official API v2 Simulations. | | `version` | Version number of the API you are accessing (current version: 2). | | `format` | xml or json. | | `your_api_key` | Your API key. | To retrieve the XML Schema Definition (.XSD) for the League Hierarchy, replace the parameters in the following URL. https://api.sportradar.us/nfl-`{access_level}{version}`/schema/hierarchy-v2.0.xsd?api_key=`{your_api_key}` Return to API map ## Play-By-Play Complete play by play narrative including possession and location information as well as team and statistics earned on each play.
Update Frequency: Real-Time
Content Type: Raw XML or JSON
Boxscore Data Points: Attendance
Away Team Points for Quarter
Away Team Timeouts Remaining
Away Team Timeouts Used
Away Team Total Points
Clock
Clock Offset
Home Team Points for Quarter
Home Team Timeouts Remaining
Home Team Timeouts Used
Home Team Total Points
Overtime Id
Overtime Number
Overtime Sequence
Quarter
Quarter Id
Quarter Number
Quarter Sequence
Game Information Data Points: Away Team Alias
Away Team Game Reference
Away Team Id
Away Team Market
Away Team Name
Entry Mode
Home Team Alias
Home Team Game Reference
Home Team Id
Home Team Market
Home Team Name
Game Id
Game Number
Game Reference
Game Scheduled Start Date/Time
Status
Weather
League Information Data Points: Season Id
Season Name
Season Type
Season Year
Week Id
Week Sequence
Week Title
Play By Play Information Data Points: Detail Category
Detail Description
Detail Direction
Detail End Location - Team Alias
Detail End Location - Yardline
Detail No Attempt
Detail Penalty - Description
Detail Penalty - Result
Detail Penalty - Safety
Detail Penalty - Yards
Detail Result
Detail Sequence
Detail Start Location - Team Alias
Detail Start Location - Yardline
Detail Yards
Drive Duration
Drive End Reason
Drive First Downs
Drive Gain
Drive Id
Drive Inside 20 Flag
Drive Penalty Yards
Drive Play Count
Drive Scoring Drive Flag
Drive Sequence
Drive Start Reason
Ending Situation Clock
Ending Situation Down
Ending Situation Location - Team Alias
Ending Situation - Location - Team Id
Ending Situation - Location - Team Market
Ending Situation - Location - Team Name
Ending Situation - Location - Team Reference
Ending Situation - Location - Team Yardline
Ending Situation - Possession - Team Alias
Ending Situation - Possession - Team Id
Ending Situation - Possession - Team Market
Ending Situation - Possession - Team Name
Ending Situation - Possession - Team Reference
Ending Situation - Yards to First Down
Event Alternate Description
Event Clock
Event Description
Event Id
Event Reference
Event Sequence
Event Type
Play Alternate Description
Play Away Points
Play Clock
Play Description
Play Fake Field Goal
Play Fake Punt
Play Home Points
Play Id
Play Play Clock
Play Reference
Play Scoring Play
Play Screen Pass
Play Sequence
Play Type
Play Wall Clock
Points After - Play Id
Points After - Reference
Points After - Score Type
Points After - Sequence
Scoring - Away Team Score
Scoring - Clock
Scoring - Home Team Score
Scoring - Points
Scoring - Sequence
Starting Situation Clock
Starting Situation Down
Starting Situation Location - Team Alias
Starting Situation Location - Team Id
Starting Situation Location - Team Market
Starting Situation Location - Team Name
Starting Situation Location - Team Reference
Starting Situation Location - Team Yardline
Starting Situation Possession - Team Alias
Starting Situation Possession - Team Id
Starting Situation Possession - Team Market
Starting Situation Possession - Team Name
Starting Situation Possession - Team Reference
Starting Situation Yards to First Down
Play Statistics Data Points: Conversion Attempt
Conversion Complete
Conversion Down
Defense Assisted Sacks
Defense Assisted Tackles
Defense Blitz
Defense Defensive Completion
Defense Defensive Target
Defense Hurry
Defense Interception
Defense Interception Yards
Defense Knockdown
Defense Nullified Play Flag
Defense Pass Defended
Defense Primary
Defense QB Hit
Defense Sack
Defense Sack Yards
Defense Safety
Defense Tackle for Loss
Defense Tackle for Loss Yards
Defense Tackle
Extra Point Attempt
Field Goal Attempt
Field Goal Attempt Yards
Field Goal Missed
Field Goal Yards
First Down Category
Fumbles Forced
Fumbles Fumble
Fumbles Nullified
Fumbles Out of Bounds
Kickoffs End Zone
Kickoffs Gross Yards
Kickoffs Inside 20
Kickoffs Kickoff
Kickoffs Onside Attempt
Kickoffs Onside Success
Kickoffs Squib Kick
Kickoffs Touchback
Kickoffs Yards
Passing Attempt
Passing Attempt Yards
Passing Blitz
Passing Completion
Passing First Down
Passing Goal to Go
Passing Hurry
Passing Inside 20
Passing Interception
Passing Knockdown
Passing Nullified
Passing Sack
Passing Sack Yards
Passing Touchdown
Passing Yards
Penalties Penalty
Penalties Yards
Punting Attempt
Punting Downed
Punting Fair Catch
Punting Inside 20
Punting Out of Bounds
Punting Touchback
Punting Yards
Receiving Catchable
Receiving First Down
Receiving Goal to Go
Receiving Inside 20
Receiving Nullified
Receiving Reception
Receiving Target
Receiving Touchdown
Receiving Yards
Receiving Yards After Catch
Returns Category
Returns Downed
Returns Fair Catch
Returns Out of Bounds
Returns Return
Returns Touchback
Returns Yards
Rushing Attempt
Rushing Broken Tackles
Rushing First Down
Rushing Goal to Go
Rushing Inside 20
Rushing Kneel Down
Rushing Scramble
Rushing Tackle for Loss
Rushing Tackle for Loss Yards
Rushing Touchdown
Rushing Yards
Player Information Data Points: Full Name
Game Reference
Id
Jersey Number
Position
Role
Team Information Data Points: Alias
Game Reference
Id
Market
Name
Venue Information Data Points: Address
Capacity
City
Country
Id
Name
Roof Type
State
Surface
Zip
> To generate the Play-By-Play for the Game ID below replace {your_api_key} with your API key: ```ruby require 'uri' require 'net/http' require 'openssl' url = URI("https://api.sportradar.us/nfl-ot2/games/b7aeb58f-7987-4202-bc41-3ad9a5b83fa4/pbp.xml?api_key={your_api_key}") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) response = http.request(request) puts response.read_body ``` ```python import http.client conn = http.client.HTTPSConnection("api.sportradar.us") conn.request("GET", "/nfl-ot2/games/b7aeb58f-7987-4202-bc41-3ad9a5b83fa4/pbp.xml?api_key={your_api_key}") res = conn.getresponse() data = res.read() print(data.decode("utf-8")) ``` ```shell curl -X GET "https://api.sportradar.us/nfl-ot2/games/b7aeb58f-7987-4202-bc41-3ad9a5b83fa4/pbp.xml?api_key={your_api_key}" ``` > The above command returns xml structured like this. This endpoint retrieves the Play-By-Play information for a specific game. https://api.sportradar.us/nfl-`{access_level}{version}`/games/`{game_id}`/pbp.`{format}`?api_key=`{your_api_key}` Replace placeholders with the following query parameters: | Parameter | Description | | --------- | ----------- | | `access_level` | Defines the access level of your API key as Production (o), Trial (ot), or Simulation (sim).
For more information on simulations, see NFL Official API v2 Simulations. | | `version` | Version number of the API you are accessing (current version: 2). | | `game_id` | ID for a given game. | | `format` | xml or json. | | `your_api_key` | Your API key. | To retrieve the XML Schema Definition (.XSD) for Play-By-Play, replace the parameters in the following URL. https://api.sportradar.us/nfl-`{access_level}{version}`/schema/pbp-v4.0.xsd?api_key=`{your_api_key}` Return to API map ## Player Participation Participation Data is complementary data collected by the NFL that indicates all 22 players on the field for every play of every game.
Update Frequency: Every Friday following a game
Content Type: XML or JSON
Boxscore Information Data Points: Attendance
Clock
Clock Offset Quarter
Game Information Data Points: Away Team Alias
Away Team Game Reference
Away Team Id
Away Team Market
Away Team Name
Entry Mode
Home Team Alias
Home Team Game Reference
Home Team Id
Home Team Market
Home Team Name
Game Id
Game Number
Game Reference
Game Scheduled Start Date/Time
Player Snap Count
Status
Weather
League Information Data Points: Season Id
Season Name
Season Type
Season Year
Week Id
Week Sequence
Week Title
Play By Play Data Points: Play Clock
Play Description
Play Id
Play Reference
Play Sequence
Play Type
Play Wall Clock
Player Information Data Points: Full Name
Game Reference
Id
Jersey Number
Position
Venue Data Points: Address
Capacity
City
Country
Id
Name
Roof Type
State
Surface
Zip
> To generate Participation Data replace {your_api_key} with your API key: ```ruby require 'uri' require 'net/http' require 'openssl' url = URI("https://api.sportradar.us/nfl-ot2/plays/b7aeb58f-7987-4202-bc41-3ad9a5b83fa4/participation.xml?api_key={your_api_key}") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) response = http.request(request) puts response.read_body ``` ```python import http.client conn = http.client.HTTPSConnection("api.sportradar.us") conn.request("GET", "/nfl-ot2/plays/b7aeb58f-7987-4202-bc41-3ad9a5b83fa4/participation.xml?api_key={your_api_key}") res = conn.getresponse() data = res.read() print(data.decode("utf-8")) ``` ```shell curl -X GET "https://api.sportradar.us/nfl-ot2/plays/b7aeb58f-7987-4202-bc41-3ad9a5b83fa4/participation.xml?api_key={your_api_key}" ``` > The above command returns xml structured like this. Access the Participation feed by replacing the parameters in the following URL: https://api.sportradar.us/nfl-`{access_level}{version}`/plays/`{game_id}`/participation.`{format}`?api_key=`{your_api_key}` Replace placeholders with the following query parameters: | Parameter | Description | | --------- | ----------- | | `access_level` | Defines the access level of your API key as Production (o), Trial (ot), or Simulation (sim).
For more information on simulations, see NFL Official API v2 Simulations. | | `version` | Version number of the API you are accessing (current version: 2). | | `game_id` | ID of a given game. | | `format` | xml or json. | | `your_api_key` | Your API key. | Return to API map ## Player Profile Player biographical information, NFL related reference ids, draft information, as well as seasonal statistics for the regular and post season.
Update Frequency: As Necessary
Content Type: Raw XML or JSON
League Information Data Points: Season Id
Season Name
Season Type Season Year
Player Information Data Points: Abbreviated Name
Birth Date
Birth Place
College
College Conference
Draft Info Number
Draft Info Round
Draft Info Year
Draft Team Alias
Draft Team Id
Draft Team Market
Draft Team Name
First Name
Full Name
Height
High School
Id
Jersey Number
Last Name
Position
Preferred Name
Reference Id
Reference Origin
Rookie Year
Status
Weight
Seasonal Player Statistics Data Points: Conversions Defense Attempts
Conversions Defense Successes
Conversions Pass Attempts
Conversions Pass Successes
Conversions Receiving Attempts
Conversions Receiving Successes
Conversions Rush Attempts
Conversions Rush Successes
Defense Assisted Tackles
Defense Blitzes
Defense Combined Tackles
Defensive Completions
Defensive Targets
Defense Forced Fumbles
Defense Fumble Recoveries
Defense Hurries
Defense Interceptions
Defense Knockdowns
Defense Miscellaneous Assisted Tackles
Defense Miscellaneous Forced Fumbles
Defense Miscellaneous Fumble Recoveries
Defense Miscellaneous Tackles
Defense Missed Tackles
Defense Passes Defended
Defense QB Hits
Defense Sack Yards
Defense Sacks
Defense Safeties
Defense Special Teams Assisted Tackles
Defense Special Teams Blocks
Defense Special Teams Forced Fumbles
Defense Special Teams Fumble Recoveries
Defense Special Teams Tackles
Defense Tackles
Defense Tackles for Loss
Defense Tackles for Loss Yards
Extra Points Kicking Attempts
Extra Points Kicking Blocked
Extra Points Kicking Made
Field Goals Attempts
Field Goals Average Yards
Field Goals Blocked
Field Goals Longest
Field Goals Made
Field Goals Yards
Fumbles End Zone Recovery Touchdowns
Fumbles Force Fumbles
Fumbles
Fumbles Lost
Fumbles Opponent Recovery
Fumbles Opponent Recovery Touchdowns
Fumbles Opponent Recovery Yards
Fumbles Out of Bounds
Fumbles Own Recovery
Fumbles Own Recovery Touchdowns
Fumbles Own Recovery Yards
Games Played
Games Started
Interception Returns Average Yards
Interception Returns Longest
Interception Returns Longest Touchdown
Interception Returns Returns
Interception Returns Touchdowns
Interception Returns Yards
Kick Returns Average Yards
Kick Returns Fair Catches
Kick Returns Longest
Kick Returns Longest Touchdown
Kick Returns
Kick Returns Touchdowns
Kick Returns Yards
Kickoffs End Zone
Kickoffs Inside 20
Kickoffs
Kickoffs Onside Attempts
Kickoffs Onside Successes
Kickoffs Out of Bounds
Kickoffs Return Yards
Kickoffs Squib Kicks
Kickoffs Touchbacks
Kickoffs Yards
Passing Air Yards
Passing Attempts
Passing Average Pocket Time
Passing Average Yards
Passing Blitzes
Passing Completion Percentage
Passing Completions
Passing Defended Passes
Passing Dropped Passes
Passing Gross Yards
Passing Hurries
Passing Interceptions
Passing Knockdowns
Passing Longest
Passing Longest Touchdown
Passing Net Yards
Passing Pocket Time
Passing Rating
Passing Red Zone Attempts
Passing Sack Yards
Passing Sacks
Passing Spikes
Passing Throw Aways
Passing Touchdowns
Passing Yards
Penalties
Penalties Yards
Punt Returns Average Yards
Punt Returns Fair Catches
Punt Returns Longest
Punt Returns Longest Touchdown
Punt Returns Returns
Punt Returns Touchdowns
Punt Returns Yards
Punts Attempts
Punts Average Hang Time
Punts Average Net Yards
Punts Average Yards
Punts Blocked
Punts Hang Time
Punts Inside 20
Punts Longest
Punts Net Yards
Punts Return Yards
Punts Touchbacks
Punts Yards
Receiving Air Yards
Receiving Average Yards
Receiving Broken Tackles
Receiving Catchable Passes
Receiving Dropped Passes
Receiving Longest
Receiving Longest Touchdown
Receiving Receptions
Receiving Red Zone Targets
Receiving Targets
Receiving Touchdowns
Receiving Yards
Receiving Yards After Catch
Receiving Yards After Contact
Rushing Attempts
Rushing Average Yards
Rushing Broken Tackles
Rushing Kneel Downs
Rushing Longest
Rushing Longest Touchdown
Rushing Red Zone Attempts
Rushing Scrambles
Rushing Tackles for Loss
Rushing Tackles for Loss Yards
Rushing Touchdowns
Rushing Yards
Rushing Yards After Contact
Team Information Data Points: Alias
Id
Market Name
> To generate a Player Profile for the Player ID below replace {your_api_key} with your API key: ```ruby require 'uri' require 'net/http' require 'openssl' url = URI("https://api.sportradar.us/nfl-ot2/players/0acdcd3b-5442-4311-a139-ae7c506faf88/profile.xml?api_key={your_api_key}") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) response = http.request(request) puts response.read_body ``` ```python import http.client conn = http.client.HTTPSConnection("api.sportradar.us") conn.request("GET", "/nfl-ot2/players/0acdcd3b-5442-4311-a139-ae7c506faf88/profile.xml?api_key={your_api_key}") res = conn.getresponse() data = res.read() print(data.decode("utf-8")) ``` ```shell curl -X GET "https://api.sportradar.us/nfl-ot2/players/0acdcd3b-5442-4311-a139-ae7c506faf88/profile.xml?api_key={your_api_key}" ``` > The above command returns xml structured like this. This endpoint retrieves the Player Profile for a specific player. https://api.sportradar.us/nfl-`{access_level}{version}`/players/`{player_id}`/profile.`{format}`?api_key=`{your_api_key}` Replace placeholders with the following query parameters: | Parameter | Description | | --------- | ----------- | | `access_level` | Defines the access level of your API key as Production (o), Trial (ot), or Simulation (sim).
For more information on simulations, see NFL Official API v2 Simulations. | | `version` | Version number of the API you are accessing (current version: 2). | | `player_id` | ID for a given player. | | `format` | xml or json. | | `your_api_key` | Your API key. | To retrieve the XML Schema Definition (.XSD) for the Player Profile, replace the parameters in the following URL. https://api.sportradar.us/nfl-`{access_level}{version}`/schema/profile-v2.0.xsd?api_key=`{your_api_key}` Return to API map ## Season Schedule Complete schedule information for the entire season, including game, team, and venue information.
Update Frequency: As Necessary
Content Type: Raw XML or JSON
Boxscore Information Data Points: Attendance
Away Team Overtime Points
Away Team Points for Quarter
Away Team Total Points
Clock Offset
Home Team Overtime Points
Home Team Points for Quarter
Home Team Total Points
Overtime Id
Overtime Number
Overtime Sequence
Quarter Id
Quarter Number
Quarter Sequence
Game Information Data Points: Away Team Alias
Away Team Full Name
Away Team Game Number
Away Team Id
Broadcast Internet
Broadcast Network
Broadcast Satellite
Entry Mode
Home Team Alias
Home Team Full Name
Home Team Game Number
Home Team Id
Id
Number
Reference
Scheduled Start Date/Time
Status
Weather
League Information Data Points: Season Id
Season Name
Season Type
Season Year
Week Id
Week Sequence
Week Title
Venue Data Points: Address
Capacity
City
Country
Id
Name
Roof Type
State
Surface
Zip
> To generate the Schedule for the Season and Year below replace {your_api_key} with your API key: ```ruby require 'uri' require 'net/http' require 'openssl' url = URI("https://api.sportradar.us/nfl-ot2/games/2006/reg/schedule.xml?api_key={your_api_key}") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) response = http.request(request) puts response.read_body ``` ```python import http.client conn = http.client.HTTPSConnection("api.sportradar.us") conn.request("GET", "/nfl-ot2/games/2006/reg/schedule.xml?api_key={your_api_key}") res = conn.getresponse() data = res.read() print(data.decode("utf-8")) ``` ```shell curl -X GET "https://api.sportradar.us/nfl-ot2/games/2006/reg/schedule.xml?api_key={your_api_key}" ``` > The above command returns xml structured like this. This endpoint retrieves the Schedule for a specific season. https://api.sportradar.us/nfl-`{access_level}{version}`/games/`{year}`/`{nfl_season}`/schedule.`{format}`?api_key=`{your_api_key}` Replace placeholders with the following query parameters: | Parameter | Description | | --------- | ----------- | | `access_level` | Defines the access level of your API key as Production (o), Trial (ot), or Simulation (sim).
For more information on simulations, see NFL Official API v2 Simulations. | | `version` | Version number of the API you are accessing (current version: 2). | | `year` | Year in 4 digit format (YYYY). | | `nfl_season` | Preseason (PRE), Regular Season (REG), or Post-Season (PST). | | `format` | xml or json. | | `your_api_key` | Your API key. | To retrieve the XML Schema Definition (.XSD) for the Schedule, replace the parameters in the following URL. https://api.sportradar.us/nfl-`{access_level}{version}`/schema/schedule-v4.0.xsd?api_key=`{your_api_key}` Return to API map ## Seasonal Statistics Complete team and player seasonal statistics for the specific season and season type.
Update Frequency: As Necessary
Content Type: Raw XML or JSON
League Information Data Points: Season Id
Season Name
Season Type Season Year
Player Information Data Points: Full Name
Id
Jersey Number
Position
Reference
Opponent Seasonal Statistics Data Points: Conversions Defense Attempts
Conversions Defense Successes
Conversions Pass Attempts
Conversions Pass Successes
Conversions Rush Attempts
Conversions Rush Successes
Conversions Turnover Successes
Defense Assisted Tackles
Defense Blitzes
Defense Combined Tackles
Defensive Completions
Defensive Targets
Defense Forced Fumbles
Defense Fumble Recoveries
Defense Hurries
Defense Interceptions
Defense Knockdowns
Defense Miscellaneous Assisted Tackles
Defense Miscellaneous Forced Fumbles
Defense Miscellaneous Fumble Recoveries
Defense Miscellaneous Tackles
Defense Missed Tackles
Defense Passes Defended
Defense QB Hits
Defense Sack Yards
Defense Sacks
Defense Safeties
Defense Special Teams Assisted Tackles
Defense Special Teams Blocks
Defense Special Teams Forced Fumbles
Defense Special Teams Fumble Recoveries
Defense Special Teams Tackles
Defense Tackles
Defense Tackles for Loss
Defense Tackles for Loss Yards
Efficiency 3rd Down Attempts
Efficiency 3rd Down Conversions
Efficiency 3rd Down Percentage
Efficiency 4th Down Attempts
Efficiency 4th Down Conversions
Efficiency 4th Down Percentage
Efficiency Goal to Go Attempts
Efficiency Goal to Go Conversions
Efficiency Goal to Go Percentage
Efficiency Red Zone Attempts
Efficiency Red Zone Conversions
Efficiency Red Zone Percentage
Extra Points Kicking Attempts
Extra Points Kicking Blocked
Extra Points Kicking Made
Field Goals Attempts
Field Goals Average Yards
Field Goals Blocked
Field Goals Longest
Field Goals Made
Field Goals Yards
First Downs Passing
First Downs Penalty
First Downs Rushing
First Downs Total
Fumbles End Zone Recovery Touchdowns
Fumbles Force Fumbles
Fumbles
Fumbles Lost
Fumbles Opponent Recovery
Fumbles Opponent Recovery Touchdowns
Fumbles Opponent Recovery Yards
Fumbles Out of Bounds
Fumbles Own Recovery
Fumbles Own Recovery Touchdowns
Fumbles Own Recovery Yards
Games Played
Interception Returns Average Yards
Interception Returns Longest
Interception Returns Longest Touchdown
Interception Returns Returns
Interception Returns Touchdowns
Interception Returns Yards
Interceptions
Interceptions Return Yards
Interceptions Returned
Kick Returns Average Yards
Kick Returns Fair Catches
Kick Returns Longest
Kick Returns Longest Touchdown
Kick Returns Returns
Kick Returns Touchdowns
Kick Returns Yards
Kickoffs End Zone
Kickoffs Inside 20
Kickoffs
Kickoffs Onside Attempts
Onside Successes
Out of Bounds
Kickoffs Return Yards
Kickoffs Returned
Kickoffs Squib Kicks
Kickoffs Touchbacks
Kickoffs Yards
Passing Air Yards
Passing Attempts
Passing Average Yards
Passing Blitzes
Passing Completion Percentage
Passing Completions
Passing Defended Passes
Passing Dropped Passes
Passing Gross Yards
Passing Hurries
Passing Interceptions
Passing Knockdowns
Passing Longest
Passing Longest Touchdown
Passing Net Yards
Passing Pocket Time
Passing Rating
Passing Red Zone Attempts
Passing Sack Yards
Passing Sacks
Passing Spikes
Passing Throw Aways
Passing Touchdowns
Passing Yards
Punt Returns Average Yards
Punt Returns Fair Catches
Punt Returns Longest
Punt Returns Longest Touchdown
Punt Returns
Punt Returns Touchdowns
Punt Returns Yards
Punts Attempts
Punts Average Hang Time
Punts Average Net Yards
Punts Average Yards
Punts Blocked
Punts Hang Time
Punts Inside 20
Punts Longest
Punts Net Yards
Punts Return Yards
Punts Touchbacks
Punts Yards
Receiving Air Yards
Receiving Average Yards
Receiving Broken Tackles
Receiving Catchable Passes
Receiving Dropped Passes
Receiving Longest
Receiving Longest Touchdown
Receiving Receptions
Receiving Red Zone Targets
Receiving Targets
Receiving Touchdowns
Receiving Yards
Receiving Yards After Catch
Receiving Yards After Contact
Rushing Attempts
Rushing Average Yards
Rushing Broken Tackles
Rushing Kneel Downs
Rushing Longest
Rushing Longest Touchdown
Rushing Red Zone Attempts
Rushing Scrambles
Rushing Tackles for Loss
Rushing Tackles for Loss Yards
Rushing Touchdowns
Rushing Yards
Touchdowns Fumble Return
Touchdowns Interception Return
Touchdowns Kick Return
Touchdowns Other
Touchdowns Pass
Touchdowns Punt Return
Touchdowns Rush
Touchdowns Total
Touchdowns Total Return
Seasonal Player Statistics Data Points: Conversions Defense Attempts
Conversions Defense Successes
Conversions Pass Attempts
Conversions Pass Successes
Conversions Receiving Attempts
Conversions Receiving Successes
Conversions Rush Attempts
Conversions Rush Successes
Defense Assisted Tackles
Defense Blitzes
Defense Combined Tackles
Defensive Completions
Defensive Targets
Defense Forced Fumbles
Defense Fumble Recoveries
Defense Hurries
Defense Interceptions
Defense Knockdowns
Defense Miscellaneous Assisted Tackles
Defense Miscellaneous Forced Fumbles
Defense Miscellaneous Fumble Recoveries
Defense Miscellaneous Tackles
Defense Missed Tackles
Defense Passes Defended
Defense QB Hits
Defense Sack Yards
Defense Sacks
Defense Safeties
Defense Special Teams Assisted Tackles
Defense Special Teams Blocks
Defense Special Teams Forced Fumbles
Defense Special Teams Fumble Recoveries
Defense Special Teams Tackles
Defense Tackles
Defense Tackles for Loss
Defense Tackles for Loss Yards
Extra Points Kicking Attempts
Extra Points Kicking Blocked
Extra Points Kicking Made
Field Goals Attempts
Field Goals Average Yards
Field Goals Blocked
Field Goals Longest
Field Goals Made
Field Goals Yards
Fumbles End Zone Recovery Touchdowns
Fumbles Force Fumbles
Fumbles
Fumbles Lost
Fumbles Opponent Recovery
Fumbles Opponent Recovery Touchdowns
Fumbles Opponent Recovery Yards
Fumbles Out of Bounds
Fumbles Own Recovery
Fumbles Own Recovery Touchdowns
Fumbles Own Recovery Yards
Games Played
Games Started
Interception Returns Average Yards
Interception Returns Longest
Interception Returns Longest Touchdown
Interception Returns Returns
Interception Returns Touchdowns
Interception Returns Yards
Kick Returns Average Yards
Kick Returns Fair Catches
Kick Returns Longest
Kick Returns Longest Touchdown
Kick Returns
Kick Returns Touchdowns
Kick Returns Yards
Kickoffs End Zone
Kickoffs Inside 20
Kickoffs
Kickoffs Onside Attempts
Kickoffs Onside Successes
Kickoffs Out of Bounds
Kickoffs Return Yards
Kickoffs Squib Kicks
Kickoffs Touchbacks
Kickoffs Yards
Passing Air Yards
Passing Attempts
Passing Average Pocket Time
Passing Average Yards
Passing Blitzes
Passing Completion Percentage
Passing Completions
Passing Defended Passes
Passing Dropped Passes
Passing Gross Yards
Passing Hurries
Passing Interceptions
Passing Knockdowns
Passing Longest
Passing Longest Touchdown
Passing Net Yards
Passing Pocket Time
Passing Rating
Passing Red Zone Attempts
Passing Sack Yards
Passing Sacks
Passing Spikes
Passing Throw Aways
Passing Touchdowns
Passing Yards
Penalties
Penalties Yards
Punt Returns Average Yards
Punt Returns Fair Catches
Punt Returns Longest
Punt Returns Longest Touchdown
Punt Returns Returns
Punt Returns Touchdowns
Punt Returns Yards
Punts Attempts
Punts Average Hang Time
Punts Average Net Yards
Punts Average Yards
Punts Blocked
Punts Hang Time
Punts Inside 20
Punts Longest
Punts Net Yards
Punts Return Yards
Punts Touchbacks
Punts Yards
Receiving Air Yards
Receiving Average Yards
Receiving Broken Tackles
Receiving Catchable Passes
Receiving Dropped Passes
Receiving Longest
Receiving Longest Touchdown
Receiving Receptions
Receiving Red Zone Targets
Receiving Targets
Receiving Touchdowns
Receiving Yards
Receiving Yards After Catch
Receiving Yards After Contact
Rushing Attempts
Rushing Average Yards
Rushing Broken Tackles
Rushing Kneel Downs
Rushing Longest
Rushing Longest Touchdown
Rushing Red Zone Attempts
Rushing Scrambles
Rushing Tackles for Loss
Rushing Tackles for Loss Yards
Rushing Touchdowns
Rushing Yards
Rushing Yards After Contact
Seasonal Team Statistics Data Points: Conversions Defense Attempts
Conversions Defense Successes
Conversions Pass Attempts
Conversions Pass Successes
Conversions Rush Attempts
Conversions Rush Successes
Conversions Turnover Successes
Defense Assisted Tackles
Defense Blitzes
Defense Combined Tackles
Defense Combined Tackles
Defensive Completions
Defensive Targets
Defense Forced Fumbles
Defense Fumble Recoveries
Defense Hurries
Defense Interceptions
Defense Knockdowns
Defense Miscellaneous Assisted Tackles
Defense Miscellaneous Forced Fumbles
Defense Miscellaneous Fumble Recoveries
Defense Miscellaneous Tackles
Defense Missed Tackles
Defense Passes Defended
Defense QB Hits
Defense Sack Yards
Defense Sacks
Defense Safeties
Defense Special Teams Assisted Tackles
Defense Special Teams Blocks
Defense Special Teams Forced Fumbles
Defense Special Teams Fumble Recoveries
Defense Special Teams Tackles
Tackles
Defense Tackles for Loss
Defense Tackles for Loss Yards
Efficiency 3rd Down Attempts
Efficiency 3rd Down Conversions
Efficiency 3rd Down Percentage
Efficiency 4th Down Attempts
Efficiency 4th Down Conversions
Efficiency 4th Down Percentage
Efficiency Goal to Go Attempts
Efficiency Goal to Go Conversions
Efficiency Goal to Go Percentage
Efficiency Red Zone Attempts
Efficiency Red Zone Conversions
Efficiency Red Zone Percentage
Extra Points Kicking Attempts
Extra Points Kicking Blocked
Extra Points Kicking Made
Field Goals Attempts
Field Goals Average Yards
Field Goals Blocked
Field Goals Longest
Field Goals Made
Field Goals Yards
First Downs Passing
First Downs Penalty
First Downs Rushing
First Downs Total
Fumbles End Zone Recovery Touchdowns
Fumbles Force Fumbles
Fumbles
Fumbles Lost Fumbles
Fumbles Opponent Recovery
Fumbles Opponent Recovery Touchdowns
Fumbles Opponent Recovery Yards
Fumbles Out of Bounds
Fumbles Own Recovery
Fumbles Own Recovery Touchdowns
Fumbles Own Recovery Yards
Team Games Played
Interception Returns Average Yards
Interception Returns Longest
Interception Returns Longest Touchdown
Interception Returns
Interception Returns Touchdowns
Interception Returns Yards
Interceptions
Interceptions Return Yards
Interceptions Returned
Kick Returns Average Yards
Kick Returns Fair Catches
Kick Returns Longest
Kick Returns Longest Touchdown
Kick Returns
Kick Returns Touchdowns
Kick Returns Yards
Kickoffs End Zone
Kickoffs Inside 20
Kickoffs
Kickoffs Onside Attempts
Kickoffs Onside Successes
Kickoffs Out of Bounds
Kickoffs Return Yards
Kickoffs Returned
Kickoffs Squib Kicks
Kickoffs Touchbacks
Kickoffs Yards
Passing Air Yards
Passing Attempts
Passing Average Yards
Passing Blitzes
Passing Completion Percentage
Passing Completions
Passing Defended Passes
Passing Dropped Passes
Passing Gross Yards
Passing Hurries
Passing Interceptions
Passing Knockdowns
Passing Longest
Passing Longest Touchdown
Passing Net Yards
Passing Pocket Time
Passing Rating
Passing Red Zone Attempts
Passing Sack Yards
Passing Sacks
Passing Spikes
Passing Throw Aways
Passing Touchdowns
Passing Yards
Penalties
Penalty Yards
Punt Returns Average Yards
Punt Returns Fair Catches
Punt Returns Longest
Punt Returns Longest Touchdown
Punt Returns
Punt Returns Touchdowns
Punt Returns Yards
Punts Attempts
Punts Average Hang Time
Punts Average Net Yards
Punts Average Yards
Punts Blocked
Punts Hang Time
Punts Inside 20
Punts Longest
Punts Net Yards
Punts Return Yards
Punts Touchbacks
Punts Yards
Receiving Air Yards
Receiving Average Yards
Receiving Broken Tackles
Receiving Catchable Passes
Receiving Dropped Passes
Receiving Longest
Receiving Longest Touchdown
Receiving Receptions
Receiving Red Zone Targets
Receiving Targets
Receiving Touchdowns
Receiving Yards
Receiving Yards After Catch
Receiving Yards After Contact
Rushing Attempts
Rushing Average Yards
Rushing Broken Tackles
Rushing Kneel Downs
Rushing Longest
Rushing Longest Touchdown
Rushing Red Zone Attempts
Rushing Scrambles
Rushing Tackles for Loss
Rushing Tackles for Loss Yards
Rushing Touchdowns
Rushing Yards
Touchdowns Fumble Return
Touchdowns Interception Return
Touchdowns Kick Return
Touchdowns Other
Touchdowns Pass
Touchdowns Punt Return
Touchdowns Rush
Touchdowns Total
Touchdowns Total Return
Team Information Data Points: Alias
Id
Market Name
> To generate the Seasonal Statistics for the Season, Year, and Game ID below replace {your_api_key} with your API key: ```ruby require 'uri' require 'net/http' require 'openssl' url = URI("https://api.sportradar.us/nfl-ot2/seasontd/2006/PST/teams/0d855753-ea21-4953-89f9-0e20aff9eb73/statistics.xml?api_key={your_api_key}") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) response = http.request(request) puts response.read_body ``` ```python import http.client conn = http.client.HTTPSConnection("api.sportradar.us") conn.request("GET", "/nfl-ot2/seasontd/2006/PST/teams/0d855753-ea21-4953-89f9-0e20aff9eb73/statistics.xml?api_key={your_api_key}") res = conn.getresponse() data = res.read() print(data.decode("utf-8")) ``` ```shell curl -X GET "https://api.sportradar.us/nfl-ot2/seasontd/2006/PST/teams/0d855753-ea21-4953-89f9-0e20aff9eb73/statistics.xml?api_key={your_api_key}" ``` > The above command returns xml structured like this. This endpoint retrieves the Seasonal Statistics for a season. https://api.sportradar.us/nfl-`{access_level}{version}`/seasontd/`{year}`/`{nfl_season}`/teams/`{team_id}`/statistics.`{format}`?api_key=`{your_api_key}` Replace placeholders with the following query parameters: | Parameter | Description | | --------- | ----------- | | `access_level` | Defines the access level of your API key as Production (o), Trial (ot), or Simulation (sim).
For more information on simulations, see NFL Official API v2 Simulations. | | `version` | Version number of the API you are accessing (current version: 2). | | `year` | Year in 4 digit format (YYYY). | | `nfl_season` | Preseason (PRE), Regular Season (REG), or Post-Season (PST). | | `team_id` | ID of a given team. | | `format` | xml or json. | | `your_api_key` | Your API key. | To retrieve the XML Schema Definition (.XSD) for the Seasonal Statistics, replace the parameters in the following URL. https://api.sportradar.us/nfl-`{access_level}{version}`/schema/statistics-v4.0.xsd?api_key=`{your_api_key}` Return to API map ## Standings Standings information for each team, including strength of schedule and strength of victory information.
Update Frequency: As Necessary
Content Type: Raw XML or JSON
League Information Data Points: Conference Alias
Conference Id
Conference Name
Division Alias
Division Id
Division Name
Season Id
Season Name
Season Type
Season Year
Week Id
Week Sequence
Week Title
Standings Information Data Points: Category
Conference Head to Head
Conference Losses
Conference Points Against
Conference Points For
Conference Points Rank
Conference Rank
Conference Ties
Conference Winning Perc.
Conference Wins
Division Losses
Division Points Against
Division Points For
Division Rank
Division Ties
Division Winning Perc.
Division Wins
Home Losses
Home Ties
Home Winning Perc.
Home Wins
Overall Losses
Overall Points Against
Overall Points For
Overall Points Rank
Overall Ties
Overall Winning Perc.
Overall Wins
Points Against
Points For
Points Rank
Recent Streak
Road Losses
Road Ties
Road Winning Perc.
Road Wins
Streak Description
Strength of Schedule Total
Strength of Schedule SOS
Strength of Schedule Wins
Strength of Victory Total
Strength of Victory SOV
Strength of Victory Wins
Touchdown Differential
Vs AFC Losses
Vs AFC Ties
Vs AFC Winning Perc.
Vs AFC Wins
Vs NFC Losses
Vs NFC Ties
Vs NFC Winning Perc.
Vs NFC Wins
Team Information Data Points: Alias
Id
Market Name
> To generate the Standings for the Season below replace {your_api_key} with your API key: ```ruby require 'uri' require 'net/http' require 'openssl' url = URI("https://api.sportradar.us/nfl-ot2/seasontd/2006/standings.xml?api_key={your_api_key}") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) response = http.request(request) puts response.read_body ``` ```python import http.client conn = http.client.HTTPSConnection("api.sportradar.us") conn.request("GET", "/nfl-ot2/seasontd/2006/standings.xml?api_key={your_api_key}") res = conn.getresponse() data = res.read() print(data.decode("utf-8")) ``` ```shell curl -X GET "https://api.sportradar.us/nfl-ot2/seasontd/2006/standings.xml?api_key={your_api_key}" ``` > The above command returns xml structured like this. This endpoint retrieves the Standings for a season. https://api.sportradar.us/nfl-`{access_level}{version}`/seasontd/`{year}`/standings.`{format}`?api_key=`{your_api_key}` Replace placeholders with the following query parameters: | Parameter | Description | | --------- | ----------- | | `access_level` | Defines the access level of your API key as Production (o), Trial (ot), or Simulation (sim).
For more information on simulations, see NFL Official API v2 Simulations. | | `version` | Version number of the API you are accessing (current version: 2). | | `year` | Year in 4 digit format (YYYY). | | `format` | xml or json. | | `your_api_key` | Your API key. | To retrieve the XML Schema Definition (.XSD) for the Standings, replace the parameters in the following URL. https://api.sportradar.us/nfl-`{access_level}{version}`/schema/standings-v2.0.xsd?api_key=`{your_api_key}` Return to API map ## Team Profile Franchise team information, including NFL references, as well as a roster of active players.
Update Frequency: As Necessary
Content Type: Raw XML or JSON
Franchise Information Data Points: Alias
Id
Name
Reference Id
Reference Origin
League Information Data Points: Conference Alias
Conference Id
Conference Name
Division Alias
Division Id
Division Name
Player Information Data Points: Abbreviated Name
Birth Date
Birth Place
College
College Conference
Draft Info Number
Draft Info Round
Draft Info Year
Draft Team Alias
Draft Team Id
Draft Team Market
Draft Team Name
First Name
Full Name
Height
High School
Id
Jersey Number
Last Name
Position
Preferred Name
Reference Id
Reference Origin
Rookie Year
Status
Weight
Team Information Data Points: Alias
Coach First Name
Coach Full Name
Coach Id
Coach Last Name
Coach Position
Id
Market
Name
Reference Id
Reference Origin
Venue Data Points: Address
Capacity
City
Country
Id
Name
Roof Type
State
Surface
Zip
> To generate a team profile for the Team ID below replace {your_api_key} with your API key: ```ruby require 'uri' require 'net/http' require 'openssl' url = URI("https://api.sportradar.us/nfl-ot2/teams/0d855753-ea21-4953-89f9-0e20aff9eb73/profile.xml?api_key={your_api_key}") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) response = http.request(request) puts response.read_body ``` ```python import http.client conn = http.client.HTTPSConnection("api.sportradar.us") conn.request("GET", "/nfl-ot2/teams/0d855753-ea21-4953-89f9-0e20aff9eb73/profile.xml?api_key={your_api_key}") res = conn.getresponse() data = res.read() print(data.decode("utf-8")) ``` ```shell curl -X GET "https://api.sportradar.us/nfl-ot2/teams/0d855753-ea21-4953-89f9-0e20aff9eb73/profile.xml?api_key={your_api_key}" ``` > The above command returns xml structured like this. This endpoint retrieves the Team Profile for a team. https://api.sportradar.us/nfl-`{access_level}{version}`/teams/`{team_id}`/profile.`{format}`?api_key=`{your_api_key}` Replace placeholders with the following query parameters: | Parameter | Description | | --------- | ----------- | | `access_level` | Defines the access level of your API key as Production (o), Trial (ot), or Simulation (sim).
For more information on simulations, see NFL Official API v2 Simulations. | | `version` | Version number of the API you are accessing (current version: 2). | | `team_id` | ID of a given team. | | `format` | xml or json. | | `your_api_key` | Your API key. | To retrieve the XML Schema Definition (.XSD) for the Team Profile, replace the parameters in the following URL. https://api.sportradar.us/nfl-`{access_level}{version}`/schema/team-v2.0.xsd?api_key=`{your_api_key}` Return to API map ## Team Roster Franchise team information, including NFL references, as well as the complete roster of players.
Update Frequency: As Necessary
Content Type: Raw XML or JSON
Franchise Information Data Points: Alias
Id
Name
Reference Id
Reference Origin
League Information Data Points: Conference Alias
Conference Id
Conference Name
Division Alias
Division Id
Division Name
Player Information Data Points: Abbreviated Name
Birth Date
Birth Place
College
College Conference
Draft Info Number
Draft Info Round
Draft Info Year
Draft Team Alias
Draft Team Id
Draft Team Market
Draft Team Name
First Name
Full Name
Height
High School
Id
Jersey Number
Last Name
Position
Preferred Name
Reference Id
Reference Origin
Rookie Year
Status
Weight
Team Information Data Points: Alias
Coach First Name
Coach Full Name
Coach Id
Coach Last Name
Coach Position
Id
Market
Name
Reference Id
Reference Origin
Venue Data Points: Address
Capacity
City
Country
Id
Name
Roof Type
State
Surface
Zip
> To generate a team roster for the Team ID below replace {your_api_key} with your API key: ```ruby require 'uri' require 'net/http' require 'openssl' url = URI("https://api.sportradar.us/nfl-ot2/teams/0d855753-ea21-4953-89f9-0e20aff9eb73/full_roster.xml?api_key={your_api_key}") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) response = http.request(request) puts response.read_body ``` ```python import http.client conn = http.client.HTTPSConnection("api.sportradar.us") conn.request("GET", "/nfl-ot2/teams/0d855753-ea21-4953-89f9-0e20aff9eb73/full_roster.xml?api_key={your_api_key}") res = conn.getresponse() data = res.read() print(data.decode("utf-8")) ``` ```shell curl -X GET "https://api.sportradar.us/nfl-ot2/teams/0d855753-ea21-4953-89f9-0e20aff9eb73/full_roster.xml?api_key={your_api_key}" ``` > The above command returns xml structured like this. This endpoint retrieves the Team Roster for a team. https://api.sportradar.us/nfl-`{access_level}{version}`/teams/`{team_id}`/full_roster.`{format}`?api_key=`{your_api_key}` Replace placeholders with the following query parameters: | Parameter | Description | | --------- | ----------- | | `access_level` | Defines the access level of your API key as Production (o), Trial (ot), or Simulation (sim).
For more information on simulations, see NFL Official API v2 Simulations. | | `version` | Version number of the API you are accessing (current version: 2). | | `team_id` | ID of a given team. | | `format` | xml or json. | | `your_api_key` | Your API key. | To retrieve the XML Schema Definition (.XSD) for the Team Roster, replace the parameters in the following URL. https://api.sportradar.us/nfl-`{access_level}{version}`/schema/team-v2.0.xsd?api_key=`{your_api_key}` Return to API map ## Weekly Depth Charts Obtain depth charts for the NFL for a given week. Pre-Season (PRE) valid weeks 1-4, Regular Season (REG) weeks 1-17, Post-Season (PST) weeks 1-4.
Update Frequency: Updated shortly before the game, but may be updated during or post game.
Content Type: Raw XML or JSON
Depth Chart Data Points: Position Name Depth
League Information Data Points: Season Id
Season Name
Season Type
Season Year
Week Id
Week Sequence
Week Title
Player Data Points: Full Name
Id
Jersey Number
Position
Reference
Team Data Points: Alias
Id
Market Name
> To generate the Weekly Depth Charts enter the Year, Season, Week below, and replace {your_api_key} with your API key: ```ruby require 'uri' require 'net/http' require 'openssl' url = URI("https://api.sportradar.us/nfl-ot2/seasontd/2015/REG/17/depth_charts.xml?api_key={your_api_key}") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) response = http.request(request) puts response.read_body ``` ```python import http.client conn = http.client.HTTPSConnection("api.sportradar.us") conn.request("GET", "/nfl-ot2/seasontd/2015/REG/17/depth_charts.xml?api_key={your_api_key}") res = conn.getresponse() data = res.read() print(data.decode("utf-8")) ``` ```shell curl -X GET "https://api.sportradar.us/nfl-ot2/seasontd/2015/REG/17/depth_charts.xml?api_key={your_api_key}" ``` > The above command returns xml structured like this. This endpoint retrieves the Weekly Depth Charts. https://api.sportradar.us/nfl-`{access_level}{version}`/seasontd/`{year}`/`{nfl_season}`/`{nfl_season_week}`/depth_charts.`{format}`?api_key=`{your_api_key}` Replace placeholders with the following query parameters: | Parameter | Description | | --------- | ----------- | | `access_level` | Defines the access level of your API key as Production (o), Trial (ot), or Simulation (sim).
For more information on simulations, see NFL Official API v2 Simulations. | | `version` | Version number of the API you are accessing (current version: 2). | | `year` | Year in 4 digit format (YYYY). | | `nfl_season` | Preseason (PRE), Regular Season (REG), or Post-Season (PST). | | `nfl_season_week` | The number of weeks into the season in 2 digit format (WW). | | `format` | xml or json. | | `your_api_key` | Your API key. | To retrieve the XML Schema Definition (.XSD) for the Weekly Depth Charts, replace the parameters in the following URL. https://api.sportradar.us/nfl-`{access_level}{version}`/schema/depth_charts-v2.0.xsd?api_key=`{your_api_key}` Return to API map ## Weekly Injuries Obtain injuries for the NFL for a given week. Pre-Season (PRE) valid weeks 1-4, Regular Season (REG) weeks 1-17, Post-Season (PST) weeks 1-4.
Update Frequency: As Necessary
Content Type: Raw XML or JSON
Injury Data Points: Status
Status Date
Practice Status Description
League Information Data Points: Season Id
Season Name
Season Type
Season Year
Week Id
Week Sequence
Week Title
Player Data Points: Full Name
Id
Jersey Number
Position
Reference
Team Data Points: Alias
Id
Market Name
> To generate the Weekly Injuries enter the Year, Season, Week below, and replace {your_api_key} with your API key: ```ruby require 'uri' require 'net/http' require 'openssl' url = URI("https://api.sportradar.us/nfl-ot2/seasontd/2015/PST/4/injuries.xml?api_key={your_api_key}") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) response = http.request(request) puts response.read_body ``` ```python import http.client conn = http.client.HTTPSConnection("api.sportradar.us") conn.request("GET", "/nfl-ot2/seasontd/2015/PST/4/injuries.xml?api_key={your_api_key}") res = conn.getresponse() data = res.read() print(data.decode("utf-8")) ``` ```shell curl -X GET "https://api.sportradar.us/nfl-ot2/seasontd/2015/PST/4/injuries.xml?api_key={your_api_key}" ``` > The above command returns xml structured like this. This endpoint retrieves the Weekly Injuries. https://api.sportradar.us/nfl-`{access_level}{version}`/seasontd/`{year}`/`{nfl_season}`/`{nfl_season_week}`/injuries.`{format}`?api_key=`{your_api_key}` Replace placeholders with the following query parameters: | Parameter | Description | | --------- | ----------- | | `access_level` | Defines the access level of your API key as Production (o), Trial (ot), or Simulation (sim).
For more information on simulations, see NFL Official API v2 Simulations. | | `version` | Version number of the API you are accessing (current version: 2). | | `year` | Year in 4 digit format (YYYY). | | `nfl_season` | Preseason (PRE), Regular Season (REG), or Post-Season (PST). | | `nfl_season_week` | The number of weeks into the season in 2 digit format (WW). | | `format` | xml or json. | | `your_api_key` | Your API key. | To retrieve the XML Schema Definition (.XSD) for the Weekly Injuries, replace the parameters in the following URL. https://api.sportradar.us/nfl-`{access_level}{version}`/schema/injuries-v2.0.xsd?api_key=`{your_api_key}` Return to API map ## Weekly Schedule Complete schedule information for the specific week of the NFL season, including game, team, and venue information. Pre-Season (PRE) valid weeks 1-4, Regular Season (REG) weeks 1-17, Post-Season (PST) weeks 1-4.
Update Frequency: As Necessary
Content Type: Raw XML or JSON
Boxscore Information Data Points: Attendance
Away Team Overtime Points
Away Team Points for Quarter
Away Team Total Points
Clock Offset
Home Team Overtime Points
Home Team Points for Quarter
Home Team Total Points
Overtime Id
Overtime Number
Overtime Sequence
Quarter Id
Quarter Number
Quarter Sequence
Game Information Data Points: Away Team Alias
Away Team Full Name
Away Team Game Number
Away Team Id
Broadcast Internet
Broadcast Network
Broadcast Satellite
Entry Mode
Home Team Alias
Home Team Full Name
Home Team Game Number
Home Team Id
Id
Number
Reference
Scheduled Start Date/Time
Status
Weather
League Information Data Points: Season Id
Season Name
Season Type
Season Year
Week Id
Week Sequence
Week Title
Venue Data Points: Address
Capacity
City
Country
Id
Name
Roof Type
State
Surface
Zip
> To generate the Weekly Schedule for the Year, Season, and Week below replace {your_api_key} with your API key: ```ruby require 'uri' require 'net/http' require 'openssl' url = URI("https://api.sportradar.us/nfl-ot2/games/2006/REG/03/schedule.xml?api_key={your_api_key}") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) response = http.request(request) puts response.read_body ``` ```python import http.client conn = http.client.HTTPSConnection("api.sportradar.us") conn.request("GET", "/nfl-ot2/games/2006/REG/03/schedule.xml?api_key={your_api_key}") res = conn.getresponse() data = res.read() print(data.decode("utf-8")) ``` ```shell curl -X GET "https://api.sportradar.us/nfl-ot2/games/2006/REG/03/schedule.xml?api_key={your_api_key}" ``` > The above command returns xml structured like this. This endpoint retrieves the Weekly Schedule. https://api.sportradar.us/nfl-`{access_level}{version}`/games/`{year}`/`{nfl_season}`/`{nfl_season_week}`/schedule.`{format}`?api_key=`{your_api_key}` Replace placeholders with the following query parameters: | Parameter | Description | | --------- | ----------- | | `access_level` | Defines the access level of your API key as Production (o), Trial (ot), or Simulation (sim).
For more information on simulations, see NFL Official API v2 Simulations. | | `version` | Version number of the API you are accessing (current version: 2). | | `year` | Year in 4 digit format (YYYY). | | `nfl_season` | Preseason (PRE), Regular Season (REG), or Post-Season (PST). | | `nfl_season_week` | The number of weeks into the season in 2 digit format (WW). | | `format` | xml or json. | | `your_api_key` | Your API key. | To retrieve the XML Schema Definition (.XSD) for the Weekly Schedule, replace the parameters in the following URL. https://api.sportradar.us/nfl-`{access_level}{version}`/schema/schedule-v4.0.xsd?api_key=`{your_api_key}` Return to API map ## Push Feeds >To best utilize Push feeds, we have included code samples in Ruby and Java which provides an example of a way you can consume the feeds. Using these samples will output the feeds content to STDOUT.
For Java, we have also provided a Stream Client to assist your integration.

Note: In the provided Java sample, replace "URL GOES HERE" with the desired Push feed URL. ```ruby require 'httpclient' module Sportradar module HTTP module Stream class Client attr_reader :url, :logger def initialize(url, publisher, logger) @url = url @logger = logger @publisher = publisher @client = ::HTTPClient.new(:agent_name => 'SportsData/1.0') end def start @thread ||= Thread.new do logger.debug "Starting loop" @client.get_content(url, :follow_redirect => true) do |chunk| @publisher.publish(::JSON.parse(chunk)) if @publisher end logger.debug "finished loop" end end def stop @thread.terminate if @thread end end end end end ``` ```java package com.sportradar.http.stream.client; import org.junit.After; import org.junit.Before; import org.junit.Test; public class StreamClientTest { private StreamClient client; private static String SERVICE_URL = ""; @Before public void setup() { client = new StreamClient(); } @After public void cleanup() { client.terminate(); } @Test public void testStream() throws Exception { Handler handler = new ConsoleHandler(); client.stream(SERVICE_URL, handler); System.out.println("Connecting...."); Thread.sleep(1 * 60 * 1000); System.out.println("Disconnecting...."); } } ``` Some of our APIs include Push feeds that allow you to get updates as soon as they are available. Push API feeds automatically send JSON payload to you via a push service, and can dramatically reduce the number of calls you need to make to our RESTful API feeds. The structure of the Push feeds are similar to the structure of the corresponding RESTful API feed (i.e. Push Clock, Push Events, and Push Statistics). The push service ensures reliable and efficient delivery of the most up to date information. Our Push services are based on a HTTP publish/subscribe model. When making a call to the Push APIs, you "subscribe" to various data feeds provided by our service; whenever new content is available on one of those feeds, the server pushes that information out to your client. When no new information is available on the feed, a heartbeat message is sent every 5 seconds to keep the connection active. If you want to filter the results of the feeds, there are several optional query string parameters that can be applied to the API call. If left unfiltered, than all data for the feed is displayed (i.e. all games, events, or statistics). For your applications to accept data from our Push feeds, ensure that your application can: * Can follow a HTTP redirect or use the location provided in the feeds header within one minute of your initial request. * Can accept HTTP data transfer encoded as chunked. Our Push service does not provide a "stateful session", there is no memory of what data has been sent previously. If you are disconnected from the Push session, you can use the RESTful API to catch up or recover from the disconnection. Syntax for using our Push feeds and examples of the JSON payloads can be found below. ## Push - Clock ```ruby require 'uri' require 'net/http' require 'openssl' url = URI("http://api.sportradar.us/nfl-ot2/stream/clock/subscribe?api_key={your_api_key}") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) response = http.request(request) puts response.read_body ``` ```python import http.client conn = http.client.HTTPSConnection("api.sportradar.us") conn.request("GET", "/nfl-ot2/stream/clock/subscribe?api_key={your_api_key}") res = conn.getresponse() data = res.read() print(data.decode("utf-8")) ``` ```shell curl -L GET api.sportradar.us/nfl-ot2/stream/clock/subscribe?api_key={your_api_key} ``` > The above command returns json like this. This endpoint retrieves the Clock information via Push. https://api.sportradar.us/nfl-`{access_level}{version}`/stream/clock/subscribe?api_key=`{your_api_key}` Replace placeholders with the following query parameters: | Parameter | Description | | --------- | ----------- | | `access_level` | Defines the access level of your API key as Production (o), Trial (ot), or Simulation (sim).
For more information on simulations, see NFL Official API v2 Simulations. | | `version` | Version number of the API you are accessing (current version: 2). | | `your_api_key` | Your API key. | ### Optional Query String Parameters >Example including optional query string parameters: ```ruby require 'uri' require 'net/http' require 'openssl' url = URI("http://api.sportradar.us/nfl-ot2/stream/clock/subscribe?api_key={your_api_key}&status=inprogress&match=sd:match:673b459c-7506-4c11-9273-1b9502537f1d") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) response = http.request(request) puts response.read_body ``` ```python import http.client conn = http.client.HTTPSConnection("api.sportradar.us") conn.request("GET", "/nfl-ot2/stream/clock/subscribe?api_key={your_api_key}&status=inprogress&match=sd:match:673b459c-7506-4c11-9273-1b9502537f1d") res = conn.getresponse() data = res.read() print(data.decode("utf-8")) ``` ```shell curl -L GET 'api.sportradar.us/nfl-ot2/stream/clock/subscribe?api_key={your_api_key}&status=inprogress&match=sd:match:673b459c-7506-4c11-9273-1b9502537f1d' ``` In addition to the URL parameters listed above, you can filter the Clock information with one or more of the following optional query string parameters.
Note: Optional query string parameters must be added after your API key with an ampersand (&). If you are filtering for more than one result, separate the results with a comma (,) and no spaces.
Replace placeholders with the following query parameters: | Parameter | Description | | --------- | ----------- | | `match` | Match id expressed as: sd:match:`{match_id}`.
Example: sd:match:4d1c4eb9-69d4-46fc-a42b-12be98227964 | Return to API map ## Push - Events ```ruby require 'uri' require 'net/http' require 'openssl' url = URI("http://api.sportradar.us/nfl-ot2/stream/events/subscribe?api_key={your_api_key}") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) response = http.request(request) puts response.read_body ``` ```python import http.client conn = http.client.HTTPSConnection("api.sportradar.us") conn.request("GET", "/nfl-ot2/stream/events/subscribe?api_key={your_api_key}") res = conn.getresponse() data = res.read() print(data.decode("utf-8")) ``` ```shell curl -L GET api.sportradar.us/nfl-ot2/stream/events/subscribe?api_key={your_api_key} ``` > The above command returns json like this. This endpoint retrieves the Events information via Push. https://api.sportradar.us/nfl-`{access_level}{version}`/stream/events/subscribe?api_key=`{your_api_key}` Replace placeholders with the following query parameters: | Parameter | Description | | --------- | ----------- | | `access_level` | Defines the access level of your API key as Production (o), Trial (ot), or Simulation (sim).
For more information on simulations, see NFL Official API v2 Simulations. | | `version` | Version number of the API you are accessing (current version: 2). | | `your_api_key` | Your API key. | ### Optional Query String Parameters >Example including optional query string parameters: ```ruby require 'uri' require 'net/http' require 'openssl' url = URI("http://api.sportradar.us/nfl-ot2/stream/events/subscribe?api_key={your_api_key}&status=inprogress&match=sd:match:673b459c-7506-4c11-9273-1b9502537f1d") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) response = http.request(request) puts response.read_body ``` ```python import http.client conn = http.client.HTTPSConnection("api.sportradar.us") conn.request("GET", "/nfl-ot2/stream/events/subscribe?api_key={your_api_key}&status=inprogress&match=sd:match:673b459c-7506-4c11-9273-1b9502537f1d") res = conn.getresponse() data = res.read() print(data.decode("utf-8")) ``` ```shell curl -L GET 'api.sportradar.us/nfl-ot2/stream/events/subscribe?api_key={your_api_key}&status=inprogress&match=sd:match:673b459c-7506-4c11-9273-1b9502537f1d' ``` In addition to the URL parameters listed above, you can filter the Events information with one or more of the following optional query string parameters.
Note: Optional query string parameters must be added after your API key with an ampersand (&). If you are filtering for more than one result, separate the results with a comma (,) and no spaces.
Replace placeholders with the following query parameters: | Parameter | Description | | --------- | ----------- | | `event_category` | Event category expressed as: `{event_category}`.
Example: event_category=shot | | `event_type` | Event type expressed as: `{event_type}`.
Example: event_type=stoppage | | `match` | Match id expressed as: sd:match:`{match_id}`.
Example: sd:match:673b459c-7506-4c11-9273-1b9502537f1d | | `status` | Status type expressed as: inprogress or created.
Example: status=inprogress | | `team` | Team id expressed as: sd:team:{team_id}.
Example: sd:team:4415b0a7-0f24-11e2-8525-18a905767e44 | Return to API map ## Push - Statistics ```ruby require 'uri' require 'net/http' require 'openssl' url = URI("http://api.sportradar.us/nfl-ot2/stream/statistics/subscribe?api_key={your_api_key}") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) response = http.request(request) puts response.read_body ``` ```python import http.client conn = http.client.HTTPSConnection("api.sportradar.us") conn.request("GET", "/nfl-ot2/stream/statistics/subscribe?api_key={your_api_key}") res = conn.getresponse() data = res.read() print(data.decode("utf-8")) ``` ```shell curl -L GET api.sportradar.us/nfl-ot2/stream/statistics/subscribe?api_key={your_api_key} ``` > The above command returns json like this. This endpoint retrieves the Statistics information via Push. https://api.sportradar.us/nfl-`{access_level}{version}`/stream/statistics/subscribe?api_key=`{your_api_key}` Replace placeholders with the following query parameters: | Parameter | Description | | --------- | ----------- | | `access_level` | Defines the access level of your API key as Production (o), Trial (ot), or Simulation (sim).
For more information on simulations, see NFL Official API v2 Simulations. | | `version` | Version number of the API you are accessing (current version: 2). | | `your_api_key` | Your API key. | ### Optional Query String Parameters >Example including optional query string parameters: ```ruby require 'uri' require 'net/http' require 'openssl' url = URI("http://api.sportradar.us/nfl-ot2/stream/statistics/subscribe?api_key={your_api_key}&status=inprogress&match=sd:match:673b459c-7506-4c11-9273-1b9502537f1d") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) response = http.request(request) puts response.read_body ``` ```python import http.client conn = http.client.HTTPSConnection("api.sportradar.us") conn.request("GET", "/nfl-ot2/stream/statistics/subscribe?api_key={your_api_key}&status=inprogress&match=sd:match:673b459c-7506-4c11-9273-1b9502537f1d") res = conn.getresponse() data = res.read() print(data.decode("utf-8")) ``` ```shell curl -L GET 'api.sportradar.us/nfl-ot2/stream/statistics/subscribe?api_key={your_api_key}&status=inprogress&match=sd:match:673b459c-7506-4c11-9273-1b9502537f1d' ``` In addition to the URL parameters listed above, you can filter the Statistics information with one or more of the following optional query string parameters.
Note: Optional query string parameters must be added after your API key with an ampersand (&). If you are filtering for more than one result, separate the results with a comma (,) and no spaces.
Replace placeholders with the following query parameters: | Parameter | Description | | --------- | ----------- | | `match` | Match id expressed as: sd:match:`{match_id}`.
Example: sd:match:4d1c4eb9-69d4-46fc-a42b-12be98227964 | | `participant` | Team or player id expressed as: sd:team:`{team_id}` or sd:player:`{player_id}` Examples: sd:team:82cf9565-6eb9-4f01-bdbd-5aa0d472fcd9 or sd:player:e3181493-6a2a-4e95-aa6f-3fc1ddeb7512 | | `status` | Status type expressed as: inprogress or created.
Example: status=inprogress | 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: When are the game scores added to the Schedule feeds?

A: Game and period scores will be added to the feed when the game status changes to complete.

Q: What are the season types and their descriptions?

A: Here are the valid season types and their descriptions:

  • PRE – Pre-season
  • REG – Regular season
  • PST – Post-season

Q: What are the player positions I can expect to see?

A: Here are the valid player positions:

  • C
  • C/G
  • CB
  • CB/RS
  • CB/S
  • DB
  • DE
  • DE/LB
  • DL
  • DT
  • FB
  • FB/RB
  • FS
  • G
  • G/C
  • G/T
  • H/B
  • H/B/T
  • HB
  • ILB
  • K
  • KR
  • L
  • LB
  • LB/DE
  • LS
  • MLB
  • NT
  • OG
  • OL
  • OLB
  • OT
  • P
  • QB
  • RB
  • RB/ST
  • RB/WR
  • RS
  • S
  • SS
  • T
  • T/G
  • TE
  • TE/DT
  • TE/FB
  • TE/LS
  • TEW
  • WR
  • WR/CB
  • WR/KR
  • WR/PR
  • WR/RB
  • WR/RS

Q: What are the player statuses and their descriptions?

A: Here are the valid player statuses and their descriptions:

  • A01 – Active
  • A02 – Active/Physically Unable to Perform
  • A03 – Active/Non-Football Injury
  • A06 – Active/Non-Football Illness
  • E02 – Exempt/Commissioner Permission
  • E08 – Exempt/Left Squad; Does not count on 90
  • E14 – Exempt/National Player Exemption
  • I01 – Inactive
  • I01R - INACTIVE
  • P01 – Practice squad
  • P02 – Practice squad; Injured
  • P06 – Practice squad Exception
  • R01 – Reserve/Injured
  • R04 – Reserve/Physically Unable To Perform
  • R05 – Reserve/Non-Football Injury
  • R23 – Reserve/Future
  • R27 – Reserve/Non-Football Illness
  • R34 – Reserve/Injured from Waived/Injured
  • R36 – Reserve/Injured; Vested Vet; Does not count on 90
  • R37 – R/PUP from W/FP; Does not count on 90
  • R41 – Reserve/PUP; Does not count against 90
  • R48 – Reserve/Injured; Designated For Return
  • R51 – Reserve/Franchise Player
  • NWT – Not With Team

Q: What are the venue roof types I can expect to see?

A: Here are the valid roof types: outdoor, dome, or retractable_dome

Q: What are the venue surfaces I can expect to see?

A: Here are the valid venue surfaces: turf or artifical

Q: What are the game statuses and their descriptions?

A: Here are the valid game statuses and their descriptions:

  • scheduled – The game is currently scheduled to occur.
  • created – Game data (rosters, officials, etc) are being pre-loaded in preparation for the game.
  • inprogress – The game is currently in progress.
  • halftime – The game is currently at the half.
  • complete – The game is over, but the statistics validation process has not been completed.
  • closed – The game is over and the game statistics have been validated.
  • cancelled – The game has been cancelled.
  • postponed – The scheduled game has been postponed for some reason.
  • delayed – The scheduled game, or a game that was in progress, is now delayed for some reason.
  • flex-schedule – The game is currently scheduled to occur on a specific date and time, however, it will more than likely be moved to a different time for broadcast purposes.
  • time-tbd – The game is scheduled to occur, the date is known, but the start time has not been determined.

Q: What are the start and end reasons for a drive that I can expect to see in the feeds?

A: Here are the end reasons for a drive:

  • UNKNOWN – Start/End
  • Touchdown – Start/End
  • Safety – End
  • Field Goal – Start/End
  • Missed FG – Start/End
  • Blocked FG – Start/End
  • Blocked FG, Downs – Start/End
  • Blocked FG, Safety – End
  • Punt – Start/End
  • Blocked Punt – Start/End
  • Blocked Punt, Downs – Start/End
  • Blocked Punt, Safety – End
  • Downs – Start/End
  • Interception – Start/End
  • Fumble – Start/End
  • Fumble, Safety - End
  • Muffed FG – Start/End
  • Muffed Punt – Start
  • Muffed Kickoff – Start
  • Kickoff – Start
  • Own Kickoff – Start
  • Onside Kick – Start
  • Kickoff, No Play – Start
  • End of Half – End
  • End of Game – End

Q: What are the event types I can expect to see in the feeds?

A: Here are the valid event types:

  • setup
  • timeout
  • comment
  • period_end
  • game_over

Q: What are the play types I can expect to see in the feeds?

A: Here are the valid play types:

  • pass
  • rush
  • faircatch_kick
  • extra_point
  • conversion
  • free_kick
  • kickoff
  • punt
  • field_goal
  • penalty

Q: What are the point after score types I can expect to see in the feeds?

A: Here are the valid score types:

  • extra_point
  • conversion
  • penalty

Q: What are the possible official assignments I can expect to see in the feeds?

A: Here are the valid official assignments:

  • referee
  • umpire
  • headlinesman
  • linejudge
  • fieldjudge
  • sidejudge
  • backjudge
  • downjudge
  • replayofficial

Q: How are assisted sacks calculated in the feeds?

A: Assisted sacks are credited when two player sack the quarterback. We provide this in the play-by-play feed and game boxscore as an integer. Those sacks are rolled up into the sacks stat and can be a float, so if a player had 3 ast_sacks and 2 sacks in a game his game-level sack number would be 3.5.

Q: What are the possible detail categories I can expect to see in the feeds?

A: Here are the valid detail categories:

  • aborted_snap
  • aborted_snap_recovery
  • blocked_kick
  • blocked_kick_recovery
  • defensive_conversion_fumble_recovery
  • defensive_conversion_interception_recovery
  • defensive_conversion_recovery
  • downed
  • extra_point_attempt
  • fair_catch
  • field_goal
  • field_goal_return
  • forced_fumble
  • fumble
  • fumble_out_of_bounds
  • kick_off
  • kick_off_return
  • lateral
  • muffed_kick
  • onside_kick_off
  • onside_kick_off_recovery
  • opponent_fumble_recovery
  • out_of_bounds
  • own_fumble_recovery
  • pass_completion
  • pass_incompletion
  • pass_interception
  • pass_interception_return
  • pass_reception
  • penalty
  • punt
  • punt_return
  • review
  • rush
  • sack
  • safety
  • tackle
  • touchback
  • touchdown
  • two_point_pass
  • two_point_return
  • two_point_rush

Q: What are subjective stats and how are they handled?

A: Subjective stats are variety of data points that go beyond typical stats like yards, pass attempts, and touchdowns. Due to how the data is collected, it requires an operator to re-watch the game, thus there is a delay on when it is provided in the feeds. 

These data points are delivered the following Tuesday by the end of the day (6:00 pm ET) and will show up in the existing NFL Official API feeds. The data is available in both XML and JSON feed formats. As the demand rises for additional data points we will continue to refine the data set collected.

Q: Which statistics are subjective?

A: Here are the valid subjective statistics:

  • Broken Tackles
  • Catchable Pass
  • Defender Blitz
  • Defensive Completion
  • Defensive Target
  • Dropped Pass
  • Fake Field Goal
  • Fake Punt
  • Hang Time
  • Hash Mark
  • Huddle
  • Hurry
  • Incompletion Type
  • Kneel down
  • Knockdown
  • Left Tightends
  • Men in Box
  • Missed Tackle
  • Onside Attempt
  • Onside Success
  • Pass Route
  • Play Direction
  • Players Rushed
  • Pocket Location
  • Pocket Time
  • QB at Snap
  • QB Blitz
  • QB Hurry
  • QB Knockdown
  • Right Tightends
  • Running Lane
  • Scramble
  • Screen Pass
  • TE Location
  • Team Blitz
  • Yards After Contact
Return to top