Official NFL v1
Frequently Asked Questions
## Official NFL v1 API Map
To best utilize the NFL API, 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:
>
## Official NFL v1 Failover Information
If the Official NFL feed goes down or becomes available Sportradar takes over Live Data Entry (LDE) to provide a failover for the NFL. During a failover, some official data will not be available. We have provided a list of this data below.
Please note that when the game is over, all data entered by Sportradar US is deleted and replaced with the official data provided by t¬he NFL.
Boxscore Information
> 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-ot1/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-ot1/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-ot1/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). |
| `version` | Version number of the API you are accessing (current version: 1). |
| `year` | Year in 4 digit format (YYYY). |
| `month` | Month in 2 digit format (MM). |
| `day` | Day in 2 digit format (DD). |
| `format` | xml or json. |
| `your_api_key` | Your API key. |
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.
> 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-ot1/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-ot1/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-ot1/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). |
| `version` | Version number of the API you are accessing (current version: 1). |
| `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-v2.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.
> 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-ot1/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-ot1/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-ot1/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). |
| `version` | Version number of the API you are accessing (current version: 1). |
| `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.
> 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-ot1/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-ot1/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-ot1/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). |
| `version` | Version number of the API you are accessing (current version: 1). |
| `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-v2.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.
> 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-ot1/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-ot1/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-ot1/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). |
| `version` | Version number of the API you are accessing (current version: 1). |
| `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.
> 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-ot1/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-ot1/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-ot1/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). |
| `version` | Version number of the API you are accessing (current version: 1). |
| `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-v2.0.xsd?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.
> 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-ot1/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-ot1/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-ot1/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). |
| `version` | Version number of the API you are accessing (current version: 1). |
| `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.
> 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-ot1/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-ot1/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-ot1/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). |
| `version` | Version number of the API you are accessing (current version: 1). |
| `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-v2.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.
> 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-ot1/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-ot1/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-ot1/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). |
| `version` | Version number of the API you are accessing (current version: 1). |
| `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-v2.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.
> 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-ot1/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-ot1/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-ot1/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). |
| `version` | Version number of the API you are accessing (current version: 1). |
| `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 the complete roster of players.
> 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-ot1/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-ot1/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-ot1/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). |
| `version` | Version number of the API you are accessing (current version: 1). |
| `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
## 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.
> 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-ot1/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-ot1/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-ot1/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). |
| `version` | Version number of the API you are accessing (current version: 1). |
| `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-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.
> 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-ot1/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-ot1/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-ot1/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). |
| `version` | Version number of the API you are accessing (current version: 1). |
| `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 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.
> 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-ot1/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-ot1/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-ot1/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). |
| `version` | Version number of the API you are accessing (current version: 1). |
| `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
## Frequently Asked Questions
| API | API Version |
| Official NFL | v1 |
| Note: Authentication is required for all API calls. |
- Call the season or weekly schedule and find a Game Id that they played in
- Call the Game Roster using the Game Id to get the Player Id
- Call the Player Profile and locate the Player Draft Team Alias.
- Call the season or weekly schedule and find the desired Team Id
- Call the Seasonal Statistics using the Team Id
- Locate the Team Defense Sacks.
## Official NFL v1 Failover Information
If the Official NFL feed goes down or becomes available Sportradar takes over Live Data Entry (LDE) to provide a failover for the NFL. During a failover, some official data will not be available. We have provided a list of this data below.
Please note that when the game is over, all data entered by Sportradar US is deleted and replaced with the official data provided by t¬he NFL.
Boxscore Information
- Attendance
- Away team timeouts used - Always 0
- Home team timeouts used - Always 0
- Last event information - Alternate description
- Last event information – Reference
- New data point – Element = play, attribute = source, code will be ”SRUS”
- Drive information – Included in the feed, but may be inaccurate. This includes duration, end reason, first downs, gain, inside 20 flag, penalty yards, scoring drive flag, and start reason
- Event information - Alternate description
- Event information - Reference
- Play information - Alternate description
- Play information – Reference
- New data point – Element = play, attribute = source, code will be ”SRUS”
- Points after data - Reference
- First down category - Always displays 0
- Pass - Attempt yards missing. Goal to go and inside 20 is there, but always 0
- Punt - Downed, fair catch, and out of bounds
- Receiving - Goal to go is missing, and inside 20 is there, but always 0
- Returns - Category and touchback is always 0. Downed and out of bounds are missing
- Rush - Goal to go, tackles for loss, and tackles for loss yards are missing and inside 20 is there, but always 0
- Conversion information – Pass attempts
- Conversion information - Rush attempts
- Conversion information - Turnover successes
- Defense – Tackles for loss yards
- Field goals – Average yards
- Fumbles – End zone recovery touchdowns
- Interception Returns – Average yards
- Interception Returns - Longest touchdown
- Kick returns – Longest touchdown
- Kickoffs – Out of bounds
- Kickoffs - Return yards
- Misc returns – End zone recovery touchdowns
- Misc returns – Returns
- Misc returns – Touchdowns
- Misc returns – Yards
- Passing – Air yards
- Passing – Longest touchdown
- Punt returns – Longest touchdown
- Receiving – Air yards
- Receiving - Longest touchdown
- Rushing – Longest touchdown
- Rushing - Tackles for loss
- Rushing - Tackles for loss yards
- Touchdowns – Fumble return
- Touchdowns – Other
- Touchdowns - Total return
- Defense – Tackles for loss yards
- Field goals – Average yards
- Fumbles – End zone recovery touchdowns
- Kick returns – Longest touchdown
- Kickoffs – Out of bounds
- Passing – Air yards
- Passing – Longest touchdown
- Punt returns – Longest touchdown
- Receiving – Air yards
- Receiving - Longest touchdown
- Rushing – Longest touchdown
| Update Frequency: | 5am CST Daily | ||
| Content Type: | Raw XML or JSON | ||
| Data Points: | Game Id League Alias League Id League Name |
League Season Id Player Full Name Player Id Team Alias |
Team Id Team Market Team Name |
| Update Frequency: | Real-time | ||
| Content Type: | Styled XML or Raw JSON | ||
| Data Points: | Attendance Away Team Points for Quarter Away Team Timeouts Remaining Away Team Timeouts Used Away Team Total Points Clock 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 Quarter Quarter Id Quarter Number Quarter Sequence |
| Update Frequency: | As Necessary | ||
| Content Type: | Styled XML or JSON | ||
| Data Points: | Boxscore Attendance Boxscore Clock Boxscore Quarter Game Away Team Alias Game Away Team Game Reference Game Away Team Id Game Away Team Market Game Away Team Name Game Home Team Alias Game Home Team Game Reference Game Home Team Id Game Home Team Market Game Home Team Name Game Id Game Number Game Reference Game Scheduled Start Date/Time Game Status Game Weather League Season Id League Season Name |
League Season Type League Season Year League Week Id League Week Sequence League Week Title Player Abbreviated Name Player Age (at time of game) Player Birth Date Player Birth Place Player College Player College Conference Player Draft Number Player Draft Round Player Draft Year Player First Name Player Full Name Player Height Player High School Player Id Player Jersey Number Player Last Name |
Player Position Player Preferred Name Player Reference Id Player Reference Origin Player Rookie Year Player Status Player Weight Team Alias Team Id Team Market Team Name Venue Address Venue Capacity Venue City Venue Country Venue Id Venue Name Venue Roof Type Venue State Venue Surface Venue Zip |
| Update Frequency: | Real-time | ||
| Content Type: | Styled XML or Raw JSON | ||
| Boxscore Data Points: | Attendance Away Team Timeouts Remaining Away Team Timeouts Used |
Away Team Total Points Clock Home Team Timeouts Remaining |
Home Team Timeouts Used Home Team Total Points Quarter |
| Game Info Data Points: | Away Team Alias Away Team Game Reference Away Team Id Away Team Market Away Team Name Home Team Alias |
Home Team Game Reference Home Team Id Home Team Market Home Team Name Id Number |
Reference Scheduled Start Date/Time Status Weather |
| Player Data Points: | Conversions Attempts Conversion Category Conversion Successes Defense Assisted Tackles Defense Combined Tackles Defense Forced Fumbles Defense Fumble Recoveries Defense Interceptions Defense Miscellaneous Assisted Tackles Defense Miscellaneous Forced Fumbles Defense Miscellaneous Fumble Recoveries Defense Miscellaneous 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 Out of Bounds Kickoffs Return Yards Kickoffs Touchbacks Kickoffs Yards Passing Air Yards Passing Attempts Passing Average Yards Passing Completion Percentage Passing Completions Passing Interceptions Passing Longest Passing Longest Touchdown Passing Rating Passing Red Zone Attempts Passing Sack Yards |
Passing Sacks Passing Touchdowns Passing 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 Net Yards Punts Average Yards Punts Blocked Punts Inside 20 Punts Longest Punts Net Yards Punts Return Yards Punts Touchbacks Punts Yards Receiving Air Yards Receiving Average Yards Receiving Longest Receiving Longest Touchdown Receiving Receptions Receiving Red Zone Targets Receiving Targets Receiving Touchdowns Receiving Yards Receiving Yards After Catch Rushing Attempts Rushing Average Yards Rushing Longest Rushing Longest Touchdown Rushing Red Zone Attempts Rushing Touchdowns Rushing Yards |
| Team 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 Combined Tackles Defense Forced Fumbles Defense Fumble Recoveries Defense Interceptions Defense Miscellaneous Assisted Tackles Defense Miscellaneous Forced Fumbles Defense Miscellaneous Fumble Recoveries Defense Miscellaneous 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 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 Completion Percentage Passing Completions Passing Gross Yards Passing Interceptions Passing Longest |
Passing Longest Touchdown Passing Rating Passing Red Zone Attempts Passing Sack Yards Passing Sacks 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 Net Yards Punts Average Yards Punts Blocked Punts Inside 20 Punts Longest Punts Net Yards Punts Return Yards Punts Touchbacks Punts Yards Receiving Air Yards Receiving Average Yards Receiving Longest Receiving Longest Touchdown Receiving Receptions Receiving Red Zone Targets Receiving Targets Receiving Touchdowns Receiving Yards Receiving Yards After Catch Rushing Attempts Rushing Average Yards Rushing Longest Rushing Longest Touchdown Rushing Red Zone Attempts 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 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 |
| Update Frequency: | As Necessary | ||
| Content Type: | Raw XML or JSON | ||
| Data Points: | League Alias League Conference Alias League Conference Id League Conference Name League Division Alias League Division Id League Division Name League Id League Name |
Team Alias Team Id Team Market Team Name Team Reference Id Team Reference Origin Venue Address Venue Capacity |
Venue City Venue Country Venue Id Venue Name Venue Roof Type Venue State Venue Surface Venue Zip |
| 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 Home Team Points for Quarter Home Team Timeouts Remaining Home Team Timeouts Used Home Team Total Points |
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 Home Team Alias |
Home Team Game Reference Home Team Id Home Team Market Home Team Name 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 |
| Play-By-Play Data Points: | 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 Home Points Play Id Play Clock Play Reference 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 Attempts Conversions Complete Conversions Down Defense Assisted Tackles Defense Interception Defense Interception Yards Defense Nullified Play Flag Defense Pass Defended Defense Primary Defense QB Hit Defense Sack Defense Sack Yards Defense Tackle for Loss Defense Tackle for Loss Yards Defense Tackles Extra Points Attempt Field Goals Attempt Field Goals Attempt Yards Field Goals Missed Field Goals Yards First Down Category Kickoffs End Zone Kickoffs Gross Yards Kickoffs Inside 20 |
Kickoffs Kickoffs Touchback Kickoffs Yards Passing Attempt Passing Attempt Yards Passing Completion Passing First Down Passing Goal to Go Passing Inside 20 Passing Interception Passing Sack Passing Sack Yards Passing Touchdown Passing Yards Penalties Penalties Yards Punting Attempt Punting Downed Punting Fair Catch Punting Inside 20 Punting Out of Bounds Punting Touchback Punting Yards |
Receiving First Down Receiving Goal to Go Receiving Inside 20 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 First Down Rushing Goal to Go Rushing Inside 20 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 |
| Team Information Data Points: | Alias Game Reference |
Id Market |
Name |
| Venue Data Points: | Address Capacity City Country |
Id Name Roof Type |
State Surface Zip |
| 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 Combined Tackles Defense Forced Fumbles Defense Fumble Recoveries Defense Interceptions Defense Miscellaneous Assisted Tackles Defense Miscellaneous Forced Fumbles Defense Miscellaneous Fumble Recoveries Defense Miscellaneous 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 Out of Bounds Kickoffs Return Yards Kickoffs Touchbacks Kickoffs Yards Passing Air Yards Passing Attempts Passing Average Yards Passing Completion Percentage Passing Completions Passing Gross Yards Passing Interceptions Passing Longest Passing Longest Touchdown |
Passing Rating Passing Red Zone Attempts Passing Sack Yards Passing Sacks Passing Touchdowns Passing 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 Net Yards Punts Average Yards Punts Blocked Punts Inside 20 Punts Longest Punts Net Yards Punts Return Yards Punts Touchbacks Punts Yards Receiving Air Yards Receiving Average Yards Receiving Longest Receiving Longest Touchdown Receiving Receptions Receiving Red Zone Targets Receiving Targets Receiving Touchdowns Receiving Yards Receiving Yards After Catch Rushing Attempts Rushing Average Yards Rushing Longest Rushing Longest Touchdown Rushing Red Zone Attempts Rushing Touchdowns Rushing Yards |
| Team Data Points: | Alias Id |
Market | Name |
| Update Frequency: | As Necessary | ||
| Content Type: | Raw XML or JSON | ||
| Boxscore Data Points: | Attendance | Clock | Quarter |
| Game Information Data Points: | Away Team Alias Away Team Full Name Away Team Game Number Away Team Id Broadcast Internet Broadcast Network |
Broadcast Satellite Home Team Alias Home Team Full Name Home Team Game Number Home Team Id |
Id Number Reference Scheduled Start Date/Time Status |
| 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 |
| 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 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 Combined Tackles Defense Forced Fumbles Defense Fumble Recoveries Defense Interceptions Defense Miscellaneous Assisted Tackles Defense Miscellaneous Forced Fumbles Defense Miscellaneous Fumble Recoveries Defense Miscellaneous 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 Out of Bounds Kickoffs Return Yards Kickoffs Returned Kickoffs Touchbacks Kickoffs Yards Passing Air Yards Passing Attempts Passing Average Yards Passing Completion Percentage Passing Completions Passing Gross Yards Passing Interceptions Passing Longest Passing Longest Touchdown Passing Rating |
Passing Red Zone Attempts Passing Sack Yards Passing Sacks 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 Net Yards Punts Average Yards Punts Blocked Punts Inside 20 Punts Longest Punts Net Yards Punts Return Yards Punts Touchbacks Punts Yards Receiving Air Yards Receiving Average Yards Receiving Longest Receiving Longest Touchdown Receiving Receptions Receiving Red Zone Targets Receiving Targets Receiving Touchdowns Receiving Yards Receiving Yards After Catch Rushing Attempts Rushing Average Yards Rushing Longest Rushing Longest Touchdown Rushing Red Zone Attempts 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 |
| Player Seasonal 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 Combined Tackles Defense Forced Fumbles Defense Fumble Recoveries Defense Interceptions Defense Miscellaneous Assisted Tackles Defense Miscellaneous Forced Fumbles Defense Miscellaneous Fumble Recoveries Defense Miscellaneous 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 Player Games Played Games Started 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 Kick Returns Touchdowns Kick Returns Yards Kickoffs End Zone Kickoffs Inside 20 Kickoffs Kickoffs Out of Bounds Kickoffs Return Yards Kickoffs Touchbacks Kickoffs Yards Passing Air Yards Attempts Passing Average Yards Passing Completion Percentage Passing Completions Passing Gross Yards Passing Interceptions Passing Longest Passing Longest Touchdown |
Passing Rating Passing Red Zone Attempts Passing Sack Yards Passing Sacks 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 Net Yards Punts Average Yards Punts Blocked Punts Inside 20 Punts Longest Punts Net Yards Punts Return Yards Punts Touchbacks Punts Yards Receiving Air Yards Receiving Average Yards Receiving Longest Receiving Longest Touchdown Receiving Receptions Receiving Red Zone Targets Receiving Targets Receiving Touchdowns Receiving Yards Receiving Yards After Catch Rushing Attempts Rushing Average Yards Rushing Longest Rushing Longest Touchdown Rushing Red Zone Attempts Rushing Touchdowns Rushing Yards |
| Team Seasonal 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 Combined Tackles Defense Forced Fumbles Defense Fumble Recoveries Defense Interceptions Defense Miscellaneous Assisted Tackles Defense Miscellaneous Forced Fumbles Defense Miscellaneous Fumble Recoveries Defense Miscellaneous 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 Out of Bounds Kickoffs Return Yards Kickoffs Returned Kickoffs Touchbacks Kickoffs Yards Passing Air Yards Passing Attempts Passing Average Yards Passing Completion Percentage Passing Completions Passing Gross Yards Passing Interceptions Passing Longest Passing Longest Touchdown Passing Rating |
Passing Red Zone Attempts Passing Sack Yards Passing Sacks 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 Net Yards Punts Average Yards Punts Blocked Punts Inside 20 Punts Longest Punts Net Yards Punts Return Yards Punts Touchbacks Punts Yards Receiving Air Yards Receiving Average Yards Receiving Longest Receiving Longest Touchdown Receiving Receptions Receiving Red Zone Targets Receiving Targets Receiving Touchdowns Receiving Yards Receiving Yards After Catch Rushing Attempts Rushing Average Yards Rushing Longest Rushing Longest Touchdown Rushing Red Zone Attempts 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 |
| 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 Rank Conference Ties Conference Winning Perc. Conference Wins Division Losses 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 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 |
| 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 |
| Update Frequency: | As Necessary | ||
| Content Type: | Raw XML or JSON | ||
| Boxscore Data Points: | Attendance | Clock | Quarter |
| Game Information Data Points: | Away Team Alias Away Team Full Name Away Team Game Number Away Team Id Broadcast Internet Broadcast Network |
Broadcast Satellite Home Team Alias Home Team Full Name Home Team Game Number Home Team Id |
Id Number Reference Scheduled Start Date/Time Status |
| 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 |
| Update Frequency: | As Necessary | ||
| Content Type: | Raw XML or JSON | ||
| Injury Data Points: | Status Status Date |
Practice Status | Description |
| Player Data Points: | Full Name Id |
Jersey Number Position |
Reference |
| League Information Data Points: | Season Id Season Name Season Type |
Season Year Week Id |
Week Sequence Week Title |
| Team Data Points: | Alias Id |
Market | Name |
| 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 | |
| Player Data Points: | Full Name Id |
Jersey Number Position |
Reference |
| League Information Data Points: | Season Id Season Name Season Type |
Season Year Week Id |
Week Sequence Week Title |
| Team Data Points: | Alias Id |
Market | Name |
Q: Are simulations available for Official NFL v1?
A: Simulations for Official NFL v1 are not currently available.
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
