NCAA Men's Football v7
Frequently Asked Questions
## NCAA Football API Overview
Sportradar’s NCAA Football API offers a comprehensive suite of game and seasonal stats. Whether looking for the fastest gameday updates or your favorite player’s season stats, Sportradar has you covered.
All game data feeds update in real-time as games are played and are compiled via expert Sportradar in-house operators. Real-time play-by-play coverage is provided for 89% of all FBS games, including 99% of all Power 5 matchups.
Primary feeds return schedules, standings, team and player data, and real-time scores.
Additional feeds provide a host of complementary stats, including:
## NCAA FB v7 API Map
To best utilize the NCAA FB API v7, you will need several parameters to create your API calls. The map below illustrates how you can obtain the parameters you need.
>
## Coverage Levels
We provide two different levels of detail to ensure maximum coverage. We combine coverage levels with the correct feeds to ensure you are getting the most comprehensive data offering in the most efficient manner possible. The coverage level for games are listed in the schedule feeds.
Extended Boxscore - For any game involving an FBS (Division I-A) team, which we are not covering via full coverage, we will provide scores, time remaining, and team leaders (passing, rushing, and receiving), in a timely manner, as the game progresses. We will provide team and player level data for the game within 60 minutes of the official results being posted. For any game involving two FCS (Division-IAA) teams, we will provide scores and time remaining, in a timely manner, as the game progresses. We will provide team and player level data for the game by the close of business on the following Monday.
Full - We provide live play-by-play coverage for the entire game. We provide updated scores and time remaining as well as team and player level data in near real time. Full coverage is available for any game involving an FBS (Division I-A) team and is available via a reliable video broadcast.
Due to the differences between available coverage levels, we recommend using specific game centric feeds based on the coverage level.
## Daily Change Log
Provides IDs and timestamps for teams, players, game statistics, schedules, and standings that have been modified on a given date. To receive the data updates, use these unique IDs to pull relevant API feeds.
> To generate the Daily Change Log for 06/30/2021 replace {your_api_key} with your API key:
```ruby
require 'uri'
require 'net/http'
require 'openssl'
url = URI("https://api.sportradar.us/ncaafb/trial/v7/en/league/2021/06/30/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", "/ncaafb/trial/v7/en/league/2021/06/30/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/ncaafb/trial/v7/en/league/2021/06/30/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/ncaafb/`{access_level}`/`{version}`/`{language_code}`/league/`{year}`/`{month}`/`{day}`/changes.`{format}`?api_key=`{your_api_key}`
| Parameter | Description |
| --------- | ----------- |
| `access_level` | Defines the access level of your API key as Production (production) or Trial (trial). |
| `version` | Version number of the API you are accessing (current version: v7). |
| `language_code` | 2 letter code for supported languages: en (English). |
| `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, use the following URL.
https://feed.elasticstats.com/schema/football/changelog-v7.0.xsd
Return to top
## Game Boxscore
Provides game scoring information for each team, including complete play-by-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/ncaafb/trial/v7/en/games/40fe6fcd-c879-4928-b7fe-24e0a47ea411/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", "/ncaafb/trial/v7/en/games/40fe6fcd-c879-4928-b7fe-24e0a47ea411/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/ncaafb/trial/v7/en/games/40fe6fcd-c879-4928-b7fe-24e0a47ea411/boxscore.xml?api_key={your_api_key}"
```
> The above command returns xml structured like this.
Access the Game Boxscore feed by replacing the parameters in the following URL:
https://api.sportradar.us/ncaafb/`{access_level}`/`{version}`/`{language_code}`/games/`{game_id}`/boxscore.`{format}`?api_key=`{your_api_key}`
| Parameter | Description |
| --------- | ----------- |
| `access_level` | Defines the access level of your API key as Production (production) or Trial (trial). |
| `version` | Version number of the API you are accessing (current version: v7). |
| `language_code` | 2 letter code for supported languages: en (English). |
| `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 use the following URL.
https://feed.elasticstats.com/schema/football/boxscore-v7.0.xsd
Return to top
## Game Roster
Provides complete game roster information for each team, including game status and player profile data.
> 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/ncaafb/trial/v7/en/games/40fe6fcd-c879-4928-b7fe-24e0a47ea411/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", "/ncaafb/trial/v7/en/games/40fe6fcd-c879-4928-b7fe-24e0a47ea411/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/ncaafb/trial/v7/en/games/40fe6fcd-c879-4928-b7fe-24e0a47ea411/roster.xml?api_key={your_api_key}"
```
> The above command returns xml structured like this.
Access the Game Roster feed by replacing the parameters in the following URL:
https://api.sportradar.us/ncaafb/`{access_level}`/`{version}`/`{language_code}`/games/`{game_id}`/roster.`{format}`?api_key=`{your_api_key}`
| Parameter | Description |
| --------- | ----------- |
| `access_level` | Defines the access level of your API key as Production (production) or Trial (trial). |
| `version` | Version number of the API you are accessing (current version: v7). |
| `language_code` | 2 letter code for supported languages: en (English). |
| `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 use the following URL.
https://feed.elasticstats.com/schema/football/roster-v7.0.xsd
Return to top
## Game Statistics
Provides 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/ncaafb/trial/v7/en/games/40fe6fcd-c879-4928-b7fe-24e0a47ea411/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", "/ncaafb/trial/v7/en/games/40fe6fcd-c879-4928-b7fe-24e0a47ea411/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/ncaafb/trial/v7/en/games/40fe6fcd-c879-4928-b7fe-24e0a47ea411/statistics.xml?api_key={your_api_key}"
```
> The above command returns xml structured like this.
Access the Game Statistics feed by replacing the parameters in the following URL:
https://api.sportradar.us/ncaafb/`{access_level}`/`{version}`/`{language_code}`/games/`{game_id}`/statistics.`{format}`?api_key=`{your_api_key}`
| Parameter | Description |
| --------- | ----------- |
| `access_level` | Defines the access level of your API key as Production (production) or Trial (trial). |
| `version` | Version number of the API you are accessing (current version: v7). |
| `language_code` | 2 letter code for supported languages: en (English). |
| `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 use the following URL.
https://feed.elasticstats.com/schema/football/statistics-v7.0.xsd
Return to top
## League Hierarchy
Provides top-level information for each team, including conference and sub-division distinction, and venue information.
> 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/ncaafb/trial/v7/en/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", "/ncaafb/trial/v7/en/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/ncaafb/trial/v7/en/league/hierarchy.xml?api_key={your_api_key}"
```
> The above command returns xml structured like this.
Access the League Hierarchy feed by replacing the parameters in the following URL:
https://api.sportradar.us/ncaafb/`{access_level}`/`{version}`/`{language_code}`/league/hierarchy.`{format}`?api_key=`{your_api_key}`
| Parameter | Description |
| --------- | ----------- |
| `access_level` | Defines the access level of your API key as Production (production) or Trial (trial). |
| `version` | Version number of the API you are accessing (current version: v7). |
| `language_code` | 2 letter code for supported languages: en (English). |
| `format` | xml or json. |
| `your_api_key` | Your API key. |
To retrieve the XML Schema Definition (.XSD) for the League Hierarchy use the following URL.
https://feed.elasticstats.com/schema/football/ncaafb/hierarchy-v7.0.xsd
Return to top
## Play-By-Play
Provides a live play-by-play timeline, including possession and location information as well as all team and player 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/ncaafb/trial/v7/en/games/40fe6fcd-c879-4928-b7fe-24e0a47ea411/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", "/ncaafb/trial/v7/en/games/40fe6fcd-c879-4928-b7fe-24e0a47ea411/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/ncaafb/trial/v7/en/games/40fe6fcd-c879-4928-b7fe-24e0a47ea411/pbp.xml?api_key={your_api_key}"
```
> The above command returns xml structured like this.
Access the Play-By-Play feed by replacing the parameters in the following URL:
https://api.sportradar.us/ncaafb/`{access_level}`/`{version}`/`{language_code}`/games/`{game_id}`/pbp.`{format}`?api_key=`{your_api_key}`
| Parameter | Description |
| --------- | ----------- |
| `access_level` | Defines the access level of your API key as Production (production) or Trial (trial). |
| `version` | Version number of the API you are accessing (current version: v7). |
| `language_code` | 2 letter code for supported languages: en (English). |
| `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 use the following URL.
https://feed.elasticstats.com/schema/football/pbp-v7.0.xsd
Return to top
## Player Profile
Provides player biographical information and seasonal statistics.
> 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/ncaafb/trial/v7/en/players/912d1785-fa9b-4610-87df-b4ee424716e8/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", "/ncaafb/trial/v7/en/players/912d1785-fa9b-4610-87df-b4ee424716e8/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/ncaafb/trial/v7/en/players/912d1785-fa9b-4610-87df-b4ee424716e8/profile.xml?api_key={your_api_key}"
```
> The above command returns xml structured like this.
Access the Player Profile feed by replacing the parameters in the following URL:
https://api.sportradar.us/ncaafb/`{access_level}`/`{version}`/`{language_code}`/players/`{player_id}`/profile.`{format}`?api_key=`{your_api_key}`
| Parameter | Description |
| --------- | ----------- |
| `access_level` | Defines the access level of your API key as Production (production) or Trial (trial). |
| `version` | Version number of the API you are accessing (current version: v7). |
| `language_code` | 2 letter code for supported languages: en (English). |
| `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 use the following URL.
https://feed.elasticstats.com/schema/football/profile-v7.0.xsd
Return to top
## Postgame Standings
Provides standings information for each FBS and FCS team.
> To generate the Postgame 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/ncaafb/trial/v7/en/seasons/2020/REG/standings/season.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", "/ncaafb/trial/v7/en/seasons/2020/REG/standings/season.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/ncaafb/trial/v7/en/seasons/2020/REG/standings/season.xml?api_key={your_api_key}"
```
> The above command returns xml structured like this.
Access the Postgame Standings feed by replacing the parameters in the following URL:
https://api.sportradar.us/ncaafb/`{access_level}`/`{version}`/`{language_code}`/seasons/`{year}`/`{ncaafb_season}`/standings/season.`{format}`?api_key=`{your_api_key}`
| Parameter | Description |
| --------- | ----------- |
| `access_level` | Defines the access level of your API key as Production (production) or Trial (trial). |
| `version` | Version number of the API you are accessing (current version: v7). |
| `language_code` | 2 letter code for supported languages: en (English). |
| `year` | Year in 4 digit format (YYYY). |
| `ncaafb_season` | Regular Season (REG). |
| `format` | xml or json. |
| `your_api_key` | Your API key. |
To retrieve the XML Schema Definition (.XSD) for the Postgame Standings, replace the parameters in the following URL.
https://feed.elasticstats.com/schema/football/ncaafb/postgame-standings-v7.0.xsd
Return to top
## Rankings (By Week)
Provides the top 25 Rankings (Polls) for a given year and week.
> To generate the Rankings (By Week) for the year 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/ncaafb/trial/v7/en/polls/AP25/2020/20/rankings.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", "/ncaafb/trial/v7/en/polls/AP25/2020/20/rankings.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/ncaafb/trial/v7/en/polls/AP25/2020/20/rankings.xml?api_key={your_api_key}"
```
> The above command returns xml structured like this.
Access the Rankings (By Week) feed by replacing the parameters in the following URL:
https://api.sportradar.us/ncaafb/`{access_level}`/`{version}`/`{language_code}`/polls/`{poll_type}`/`{year}`/`{week}`/rankings.`{format}`?api_key=`{your_api_key}`
| Parameter | Description |
| --------- | ----------- |
| `access_level` | Defines the access level of your API key as Production (production), or Trial (trial). |
| `version` | Version number of the API you are accessing (current version: v7). |
| `language_code` | 2 letter code for supported languages: en (English). |
| `poll_type` | Code for supported poll type: Associated Press (AP25), Amway Coaches (EU25), College Football Playoff (CFP25), FCS Media (FCS25), AFCA FCS Coaches (FCSC25). |
| `year` | Year in 4 digit format (YYYY). |
| `week` | Week in 2 digit format (WW). Optional parameter. Omitting displays the current/final week of a given year. |
| `format` | xml or json. |
| `your_api_key` | Your API key. |
To retrieve the XML Schema Definition (.XSD) for the Rankings use the following URL.
https://feed.elasticstats.com/schema/football/ncaafb/rankings-v7.0.xsd
Return to top
## Rankings (Current Week)
Provides the current top 25 Rankings (Polls).
> To generate the Rankings (Current Week) replace {your_api_key} with your API key:
```ruby
require 'uri'
require 'net/http'
require 'openssl'
url = URI("https://api.sportradar.us/ncaafb/trial/v7/en/polls/AP25/2021/rankings.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", "/ncaafb/trial/v7/en/polls/AP25/2021/rankings.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/ncaafb/trial/v7/en/polls/AP25/2021/rankings.xml?api_key={your_api_key}"
```
> The above command returns xml structured like this.
Access the Rankings (Current Week) feed by replacing the parameters in the following URL:
https://api.sportradar.us/ncaafb/`{access_level}`/`{version}`/`{language_code}`/polls/`{poll_type}`/`{year}`/rankings.`{format}`?api_key=`{your_api_key}`
| Parameter | Description |
| --------- | ----------- |
| `access_level` | Defines the access level of your API key as Production (production), or Trial (trial). |
| `version` | Version number of the API you are accessing (current version: v7). |
| `language_code` | 2 letter code for supported languages: en (English). |
| `poll_type` | Code for supported poll type: Associated Press (AP25), Amway Coaches (EU25), College Football Playoff (CFP25), FCS Media (FCS25), AFCA FCS Coaches (FCSC25). |
| `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 Rankings use the following URL.
https://feed.elasticstats.com/schema/football/ncaafb/rankings-v7.0.xsd
Return to top
## Season Schedule
Provides complete schedule information for a given season, including venue and broadcast info, and scoring results by quarter.
> 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/ncaafb/trial/v7/en/games/2020/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", "/ncaafb/trial/v7/en/games/2020/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/ncaafb/trial/v7/en/games/2020/REG/schedule.xml?api_key={your_api_key}"
```
> The above command returns xml structured like this.
Access the Season Schedule feed by replacing the parameters in the following URL:
https://api.sportradar.us/ncaafb/`{access_level}`/`{version}`/`{language_code}`/games/`{year}`/`{ncaafb_season}`/schedule.`{format}`?api_key=`{your_api_key}`
| Parameter | Description |
| --------- | ----------- |
| `access_level` | Defines the access level of your API key as Production (production) or Trial (trial). |
| `version` | Version number of the API you are accessing (current version: v7). |
| `language_code` | 2 letter code for supported languages: en (English). |
| `year` | Year in 4 digit format (YYYY). |
| `ncaafb_season` | Regular Season (REG). |
| `format` | xml or json. |
| `your_api_key` | Your API key. |
To retrieve the XML Schema Definition (.XSD) for the Schedule use the following URL.
https://feed.elasticstats.com/schema/football/schedule-v7.0.xsd
Return to top
## Seasonal Statistics
Provides complete team and player seasonal statistics for a given season.
> To generate the Seasonal Statistics for the Season, Year, and 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/ncaafb/trial/v7/en/seasons/2020/REG/teams/19775492-f1eb-4bc5-9e15-078ebd689c0f/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", "/ncaafb/trial/v7/en/seasons/2020/REG/teams/19775492-f1eb-4bc5-9e15-078ebd689c0f/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/ncaafb/trial/v7/en/seasons/2020/REG/teams/19775492-f1eb-4bc5-9e15-078ebd689c0f/statistics.xml?api_key={your_api_key}"
```
> The above command returns xml structured like this.
Access the Seasonal Statistics feed by replacing the parameters in the following URL:
https://api.sportradar.us/ncaafb/`{access_level}`/`{version}`/`{language_code}`/seasons/`{year}`/`{ncaafb_season}`/teams/`{team_id}`/statistics.`{format}`?api_key=`{your_api_key}`
| Parameter | Description |
| --------- | ----------- |
| `access_level` | Defines the access level of your API key as Production (production) or Trial (trial). |
| `version` | Version number of the API you are accessing (current version: v7). |
| `language_code` | 2 letter code for supported languages: en (English). |
| `year` | Year in 4 digit format (YYYY). |
| `ncaafb_season` | Regular Season (REG). |
| `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 use the following URL.
https://feed.elasticstats.com/schema/football/statistics-v7.0.xsd
Return to top
## Seasons
Provides a list of all available seasons.
> To generate the list of Seasons replace {your_api_key} with your API key:
```ruby
require 'uri'
require 'net/http'
require 'openssl'
url = URI("https://api.sportradar.us/ncaafb/trial/v7/en/league/seasons.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", "/ncaafb/trial/v7/en/league/seasons.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/ncaafb/trial/v7/en/league/seasons.xml?api_key={your_api_key}"
```
> The above command returns xml structured like this.
Access the Seasons feed by replacing the parameters in the following URL:
https://api.sportradar.us/ncaafb/`{access_level}`/`{version}`/`{language_code}`/league/seasons.`{format}`?api_key=`{your_api_key}`
| Parameter | Description |
| --------- | ----------- |
| `access_level` | Defines the access level of your API key as Production (production) or Trial (trial). |
| `version` | Version number of the API you are accessing (current version: v7). |
| `language_code` | 2 letter code for supported languages: en (English). |
| `format` | xml or json. |
| `your_api_key` | Your API key. |
To retrieve the XML Schema Definition (.XSD) for the Seasons use the following URL.
https://feed.elasticstats.com/schema/football/seasons-v7.0.xsd
Return to top
## Team Roster
Provides a complete roster of players for a given team.
> 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/ncaafb/trial/v7/en/teams/19775492-f1eb-4bc5-9e15-078ebd689c0f/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", "/ncaafb/trial/v7/en/teams/19775492-f1eb-4bc5-9e15-078ebd689c0f/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/ncaafb/trial/v7/en/teams/19775492-f1eb-4bc5-9e15-078ebd689c0f/full_roster.xml?api_key={your_api_key}"
```
> The above command returns xml structured like this.
Access the Team Roster feed by replacing the parameters in the following URL:
https://api.sportradar.us/ncaafb/`{access_level}`/`{version}`/`{language_code}`/teams/`{team_id}`/full_roster.`{format}`?api_key=`{your_api_key}`
| Parameter | Description |
| --------- | ----------- |
| `access_level` | Defines the access level of your API key as Production (production) or Trial (trial). |
| `version` | Version number of the API you are accessing (current version: v7). |
| `language_code` | 2 letter code for supported languages: en (English). |
| `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 use the following URL.
https://feed.elasticstats.com/schema/football/team-v7.0.xsd
Return to top
## Weekly Schedule
Provides complete schedule information for a given week of the season, including venue, weather conditions, broadcast info, and scoring results by quarter.
> 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/ncaafb/trial/v7/en/games/2019/REG/02/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", "/ncaafb/trial/v7/en/games/2019/REG/02/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/ncaafb/trial/v7/en/games/2019/REG/02/schedule.xml?api_key={your_api_key}"
```
> The above command returns xml structured like this.
Access the Weekly Schedule feed by replacing the parameters in the following URL:
https://api.sportradar.us/ncaafb/`{access_level}`/`{version}`/`{language_code}`/games/`{year}`/`{ncaafb_season}`/`{ncaafb_season_week}`/schedule.`{format}`?api_key=`{your_api_key}`
| Parameter | Description |
| --------- | ----------- |
| `access_level` | Defines the access level of your API key as Production (production) or Trial (trial). |
| `version` | Version number of the API you are accessing (current version: v7). |
| `language_code` | 2 letter code for supported languages: en (English). |
| `year` | Year in 4 digit format (YYYY). |
| `ncaafb_season` | Regular Season (REG). |
| `ncaafb_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 use the following URL.
https://feed.elasticstats.com/schema/football/schedule-v7.0.xsd
Return to top
## Push Feeds
>To best utilize Push feeds, we have included code samples in Ruby, Java and Python which provide 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 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 can be found below.
## Push Events
```ruby
require 'uri'
require 'net/http'
require 'openssl'
url = URI("https://api.sportradar.us/ncaafb/trial/stream/en/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 requests
import json
r = requests.get("https://api.sportradar.com/ncaafb/trial/stream/en/events/subscribe",
params = {'api_key': 'your_api_key'},
allow_redirects=False)
redirect_url = r.headers['Location']
r = requests.get(redirect_url, stream=True)
for line in r.iter_lines():
# filter out keep-alive new lines
if line:
decoded_line = line.decode('utf-8')
print(json.loads(decoded_line))
```
```shell
curl -L GET 'api.sportradar.us/ncaafb/trial/stream/en/events/subscribe?api_key={your_api_key}'
```
>The above command returns json like this.
Provides detailed, real-time information on every live game event.
https://api.sportradar.us/ncaafb/`{access_level}`/stream/`{language_code}`/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 (production), or Trial (trial). |
| `language_code` | Optional code for supported languages: en (English). |
| `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("https://api.sportradar.us/ncaafb/trial/stream/en/events/subscribe?api_key={your_api_key}&status=inprogress")
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 requests
import json
r = requests.get("https://api.sportradar.com/ncaafb/trial/stream/en/events/subscribe",
params = {'api_key': 'your_api_key', 'status': 'inprogress'},
allow_redirects=False)
redirect_url = r.headers['Location']
r = requests.get(redirect_url, stream=True)
for line in r.iter_lines():
# filter out keep-alive new lines
if line:
decoded_line = line.decode('utf-8')
print(json.loads(decoded_line))
```
```shell
curl -L GET 'api.sportradar.us/ncaafb/trial/stream/en/events/subscribe?api_key={your_api_key}&status=inprogress'
```
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.
Replace placeholders with the following query parameters:
| Parameter | Description |
| --------- | ----------- |
| `event_category` | Event category expressed as: {event_category}.
Example: event_category=redzone
Valid event categories: redzone, two_minute, scoring_play, big_play, turnover | | `event_type` | Event type expressed as: {event_type}.
Example: event_type=timeout
Valid event types: setup, timeout, tv_timeout, two_minute_warning, comment, period_end, game_over | | `locale` | Locale expressed as 2 letter code: locale={language_code}
Example: locale:en | | `match` | Match id expressed as: sd:match:{match_id}.
Example: sd:match:0f23d300-5bec-4dc2-a7b0-1b8e05751d11 | | `status` | Status type expressed as: inprogress or created.
Example: status=inprogress | | `team` | Team id expressed as: sd:team:{team_id}.
Example: sd:team:19775492-f1eb-4bc5-9e15-078ebd689c0f | Return to top ## Push Statistics ```ruby require 'uri' require 'net/http' require 'openssl' url = URI("https://api.sportradar.us/ncaafb/trial/stream/en/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 requests import json r = requests.get("https://api.sportradar.com/ncaafb/trial/stream/en/statistics/subscribe", params = {'api_key': 'your_api_key'}, allow_redirects=False) redirect_url = r.headers['Location'] r = requests.get(redirect_url, stream=True) for line in r.iter_lines(): # filter out keep-alive new lines if line: decoded_line = line.decode('utf-8') print(json.loads(decoded_line)) ``` ```shell curl -L GET api.'sportradar.us/ncaafb/trial/stream/en/statistics/subscribe?api_key={your_api_key}' ``` >The above command returns json like this. Provides detailed, real-time game stats at the team and player level for all live games. https://api.sportradar.us/ncaafb/`{access_level}`/stream/`{language_code}`/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 (production) or Trial (trial). | | `language_code` | Optional code for supported languages: en (English). | | `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("https://api.sportradar.us/ncaafb/trial/stream/en/statistics/subscribe?api_key={your_api_key}&status=inprogress") 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 requests import json r = requests.get("https://api.sportradar.com/ncaafb/trial/stream/en/statistics/subscribe", params = {'api_key': 'your_api_key', 'status': 'inprogress'}, allow_redirects=False) redirect_url = r.headers['Location'] r = requests.get(redirect_url, stream=True) for line in r.iter_lines(): # filter out keep-alive new lines if line: decoded_line = line.decode('utf-8') print(json.loads(decoded_line)) ``` ```shell curl -L GET 'api.sportradar.us/ncaafb/trial/stream/en/statistics/subscribe?api_key={your_api_key}&status=inprogress' ``` 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.
Replace placeholders with the following query parameters:
| Parameter | Description |
| --------- | ----------- |
| `locale` | Locale expressed as 2 letter code: locale={language_code}
Example: locale:en | | `match` | Match id expressed as: sd:match:{match_id}.
Example: sd:match:0f23d300-5bec-4dc2-a7b0-1b8e05751d11 | | `status` | Status type expressed as: inprogress or created.
Example: status=inprogress | | `team` | Team id expressed as: sd:team:{team_id}.
Example: sd:team:19775492-f1eb-4bc5-9e15-078ebd689c0f | Return to top ## Frequently Asked Questions
| Quick Access | |
| Postman Collection | XSD Schema |
 |
Download |
- Player profiles
- Team rosters
- Top 25 rankings
- Seasonal statistics
| API | API Version |
| NCAA FB | v7 |
| Note: Authentication is required for all API calls. |
Examples:
>- 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.
## Coverage Levels
We provide two different levels of detail to ensure maximum coverage. We combine coverage levels with the correct feeds to ensure you are getting the most comprehensive data offering in the most efficient manner possible. The coverage level for games are listed in the schedule feeds.
Extended Boxscore - For any game involving an FBS (Division I-A) team, which we are not covering via full coverage, we will provide scores, time remaining, and team leaders (passing, rushing, and receiving), in a timely manner, as the game progresses. We will provide team and player level data for the game within 60 minutes of the official results being posted. For any game involving two FCS (Division-IAA) teams, we will provide scores and time remaining, in a timely manner, as the game progresses. We will provide team and player level data for the game by the close of business on the following Monday.
Full - We provide live play-by-play coverage for the entire game. We provide updated scores and time remaining as well as team and player level data in near real time. Full coverage is available for any game involving an FBS (Division I-A) team and is available via a reliable video broadcast.
| Note: Coverage levels may be adjusted up to the scheduled start time at the discretion of our data entry managers for such reasons as resource availability as well as possible broadcast and technical difficulties. |
| Feeds | ||||
|---|---|---|---|---|
| Boxscore | ||||
| Extended Boxscore | ||||
| Game Roster | ||||
| Game Statistics | ||||
| Game Summary | ||||
| Play-By-Play | ||||
| Play Summary | ||||
| Note: All FCS Playoff games will be covered via our Full coverage level. |
| TTL / Cache: | 300 seconds | ||
| Update Frequency: | As Necessary | ||
| Content Type: | Raw XML or JSON | ||
| Game Information Data Points: | Id | Last Modified | Season Id |
| 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 |
| Update Frequency: | Realtime | ||
| TTL / Cache: | Live - 2s Non-Live - 120s |
Note: This endpoint will update to a 2s TTL (time to live) upon a game moving to inprogress. Upon closed, it will transfer to 120s. | |
| Content Type: | Styled XML or Raw JSON | ||
| Boxscore Information Data Points: | Attendance Away Team Challenges Remaining Away Team Challenges Used Away Team Coin Toss Decision Away Team Coin Toss Direction Away Team Coin Toss Outcome Away Team Points for Quarter Away Team Timeouts Remaining Away Team Timeouts Used Away Team Total Points Clock Coin Toss Quarter Current Situation Clock Current Situation Down Current Situation Team Alias Current Situation Team Id Current Situation Team Market Current Situation Team Name |
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 Yards to First Down Home Team Challenges Remaining Home Team Challenges Used Home Team Coin Toss Decision Home Team Coin Toss Direction Home Team Coin Toss Outcome Home Team Points for Quarter Home Team Timeouts Remaining Home Team Timeouts Used Home Team Total Points |
Last Event Clock Last Event Description Last Event Id Last Event Sequence Last Event Type Overtime Id Overtime Number Overtime Sequence Quarter Quarter Id Quarter Number Quarter Sequence |
| Game Information Data Points: | Away Team Alias Away Team Id Away Team Market Away Team Name Conference Game Coverage Duration Entry Mode Game Type Home Team Alias |
Home Team Id Home Team Market Home Team Name Game Id Game Scheduled Start Date/Time Playoff Game Type |
Status Weather Condition Weather Humidity Weather Temp Weather - Wind Direction Weather - Wind Speed |
| 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 Sequence Detail Start Location - Team Alias Detail Start Location - Yardline Drive Created At 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 Drive Updated At 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 Yardline |
Ending Situation - Possession - Team Alias Ending Situation - Possession - Team Id Ending Situation - Possession - Team Market Ending Situation - Possession - Team Name Ending Situation - Yards to First Down Event Clock Event Created At Event Deleted Event Description Event Id Event Sequence Event Type Event Updated At Play Away Points Play Clock Play Created At Play Deleted Play Description Play Fake Field Goal Play Fake Punt Play Goal to Go Play Home Points Play Id Play Run Pass Option Play Scoring Description Play Scoring Play Play Screen Pass Play Sequence |
Play Type Play Updated At Play Wall Clock Points After - Play Id Points After - Score Type Points After - Sequence Points After - Wall Clock Quarter Id Quarter Number Quarter 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 Yardline Starting Situation Possession - Team Alias Starting Situation Possession - Team Id Starting Situation Possession - Team Market Starting Situation Possession - Team Name Starting Situation Yards to First Down |
| Play Statistics Data Points: | Blocked - Block Blocked - Category Blocked - Nullified Conversion Attempt Conversion Category Conversion Complete Conversion Nullified Conversion Safety Defense Assisted Sacks Defense Assisted Tackles Defense Assisted Tackles for Loss Defense Block Defense Category Defense Conversion Attempt Defense Conversion Category Defense Conversion Complete Defense Conversion Nullified Defense Forced Fumble Defense Interception Defense Interception Touchdown Defense Interception Yards 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 Down Conversions Attempt Down Conversions Complete Down Conversions Down Down Conversions Nullified Extra Point Attempt Extra Point Blocked Extra Point Made Extra Point Missed Extra Point Nullified Extra Point Returned Extra Point Safety Field Goal Attempt Field Goal Attempt Yards Field Goal Blocked Field Goal Made Field Goal Missed Field Goal Returned Field Goal Nullified Field Goal Yards First Down Category First Down Nullified |
Fumbles Forced Fumbles Fumble Fumbles Lost Fumbles Nullified Fumbles Opponent Recovery Fumbles Opponent Recovery Touchdown Fumbles Opponent Recovery Yards Fumbles Out of Bounds Fumbles Own Recovery Fumbles Own Recovery Touchdown Fumbles Own Recovery Yards Fumbles Play Category Kickoffs End Zone Kickoffs Gross Yards Kickoffs Inside 20 Kickoffs Kickoff Kickoffs Nullified Kickoffs Touchback Kickoffs Yards Passing Attempt Passing Completion Passing First Down Passing Goal to Go Passing Inside 20 Passing Interception Passing Interception Touchdown Passing Nullified Passing Sack Passing Sack Yards Passing Safety Passing Touchdown Passing Yards Penalties Nullified Penalties Penalty Penalties Yards Punting Attempt Punting Blocked Punting Endzone |
Punting Inside 20 Punting Net Yards Punting Nullified Punting Touchback Punting Yards Receiving First Down Receiving Goal to Go Receiving Inside 20 Receiving Nullified Receiving Reception Receiving Safety Receiving Target Receiving Touchdown Receiving Yards Receiving Yards After Catch Returns Category Returns Fair Catch Returns Nullified Returns Return Returns Touchback Returns Touchdown Returns Yards Rushing Attempt Rushing First Down Rushing Goal to Go Rushing Inside 20 Rushing Nullified Rushing Safety Rushing Tackle for Loss Rushing Tackle for Loss Yards Rushing Touchdown Rushing Yards Timeout Description |
| Player Information Data Points: | Id Jersey Number |
Name Position |
Role |
| Standings Information Data Points: | Overall Losses | Overall Ties | Overall Wins |
| Team Information Data Points: | Alias Id |
Market | Name |
| Venue Information Data Points: | Address Capacity City Country |
Id Name Roof Type |
State Surface Zip |
| Update Frequency: | As Necessary | ||
| TTL / Cache: | Live - 2s Non-Live - 120s |
Note: This endpoint will update to a 2s TTL (time to live) upon a game moving to inprogress. Upon closed, it will transfer to 120s. | |
| Content Type: | Styled XML or JSON | ||
| Boxscore Information Data Points: | Attendance | Clock | Quarter |
| Game Information Data Points: | Away Team Alias Away Team Id Away Team Market Away Team Name Conference Game Coverage Duration Entry Mode Game Type Home Team Alias |
Home Team Id Home Team Market Home Team Name Game Id Game Scheduled Start Date/Time Playoff Game Type |
Status Weather Condition Weather Humidity Weather Temp Weather - Wind Direction Weather - Wind Speed |
| League Information Data Points: | Season Id Season Name Season Type |
Season Year Week Id |
Week Sequence Week Title |
| Player Information Data Points: | Abbreviated Name Birth Place Eligibility First Name |
Game Status Height Id Jersey Number Last Name |
Name Name Suffix Position Weight |
| Standings Information Data Points: | Overall Losses | Overall Ties | Overall Wins |
| Team Information Data Points: | Coach First Name Coach Full Name |
Coach Id Coach Last Name |
Coach Name Suffix Coach Position |
| Venue Information Data Points: | Address Capacity City Country |
Id Name Roof Type |
State Surface Zip |
| Update Frequency: | Realtime | ||
| TTL / Cache: | Live - 2s Non-Live - 120s |
Note: This endpoint will update to a 2s TTL (time to live) upon a game moving to inprogress. Upon closed, it will transfer to 120s. | |
| Content Type: | Styled XML or Raw JSON | ||
| Boxscore Information Data Points: | Attendance Away Team Challenges Remaining Away Team Challenges Used Away Team Timeouts Remaining Away Team Timeouts Used |
Away Team Total Points Clock Home Team Challenges Remaining Home Team Challenges Used Home Team Timeouts Remaining |
Home Team Timeouts Used Home Team Total Points Quarter |
| Game Information Data Points: | Away Team Alias Away Team Id Away Team Market Away Team Name Conference Game Coverage Duration Entry Mode Game Type Home Team Alias |
Home Team Id Home Team Market Home Team Name Game Id Game Scheduled Start Date/Time Playoff Game Type |
Status Weather Condition Weather Humidity Weather Temp Weather - Wind Direction Weather - Wind Speed |
| Player Game Statistics 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 Extra Points Kicking Missed Extra Points Kicking Percent Field Goals Attempts Field Goals Attempts 1-19 Yards Field Goals Attempts 20-29 Yards Field Goals Attempts 30-39 Yards Field Goals Attempts 40-49 Yards Field Goals Attempts 50+ Yards Field Goals Average Yards Field Goals Blocked Field Goals Longest Field Goals Made Field Goals Made 1-19 Yards Field Goals Made 20-29 Yards Field Goals Made 30-39 Yards Field Goals Made 40-49 Yards Field Goals Made 50+ Yards Field Goals Missed Field Goals Percent 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 Interception Returns Touchdowns Interception Returns Yards Kick Returns Average Yards Kick Returns Fair Catches Kick Returns Longest 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 Passing Air Yards Passing Attempts Passing Average Yards Passing Completion Percentage Passing Completions Passing Defended Passes Passing First Downs Passing Interception Touchdowns Passing Interceptions Passing Longest Passing Longest Touchdown Passing Rating Passing Red Zone Attempts |
Passing Sack Yards Passing Sacks Passing Touchdowns Passing Yards Penalties Penalty First Downs Penalty Yards Punt Return Average Yards Punt Return Fair Catches Punt Return Longest 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 First Downs 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 First Downs Rushing Longest Rushing Longest Touchdown Rushing Red Zone Attempts Rushing Tackle for Loss Rushing Tackle for Loss Yards Rushing Touchdowns Rushing Yards |
| 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 4th Down Stops 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 Defense Three and Outs Forced 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 Extra Points Kicking Missed Extra Points Kicking Percent Field Goals Attempts Field Goals Attempts 1-19 Yards Field Goals Attempts 20-29 Yards Field Goals Attempts 30-39 Yards Field Goals Attempts 40-49 Yards Field Goals Attempts 50+ Yards Field Goals Average Yards Field Goals Blocked Field Goals Longest Field Goals Made Field Goals Made 1-19 Yards Field Goals Made 20-29 Yards Field Goals Made 30-39 Yards Field Goals Made 40-49 Yards Field Goals Made 50+ Yards |
Field Goals Missed Field Goals Net Attempts Field Goals Percent 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 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 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 Completion Percentage Passing Completions Passing First Downs Passing Interception Touchdowns Passing Interceptions Passing Longest Passing Longest Touchdown Passing Net Yards |
Passing Rating Passing Red Zone Attempts Passing Sack Yards Passing Sacks Passing Touchdowns Passing Yards Penalties Penalty First Downs Penalty Yards Punt Returns Average Yards Punt Returns Fair Catches Punt Returns Longest 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 First Downs 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 First Downs 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: | Id Jersey Number |
Name | Position |
| Standings Information Data Points: | Overall Losses | Overall Ties | Overall Wins |
| Team Information Data Points: | Alias Id |
Market | Name |
| Venue Data Points: | Address Capacity City Country |
Id Name Roof Type |
State Surface Zip |
| TTL / Cache: | 300 seconds | ||
| Update Frequency: | As Necessary | ||
| Content Type: | Raw XML or JSON | ||
| Franchise Information Data Points: | Id | Name | |
| 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 |
Subdivision |
| Venue Information Data Points: | Address Capacity City Country |
Id Name Roof Type |
State Surface Zip |
| Update Frequency: | Realtime | ||
| TTL / Cache: | Live - 2s Non-Live - 120s |
Note: This endpoint will update to a 2s TTL (time to live) upon a game moving to inprogress. Upon closed, it will transfer to 120s. | |
| Content Type: | Raw XML or JSON | ||
| Boxscore Data Points: | Attendance Away Team Challenges Remaining Away Team Challenges Used Away Team Coin Toss Decision Away Team Coin Toss Direction Away Team Coin Toss Outcome Away Team Points for Quarter Away Team Timeouts Remaining Away Team Timeouts Used Away Team Total Points Clock |
Coin Toss Quarter Home Team Challenges Remaining Home Team Challenges Used Home Team Coin Toss Decision Home Team Coin Toss Direction Home Team Coin Toss Outcome 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 Id Away Team Market Away Team Name Conference Game Coverage Duration Entry Mode Game Type Home Team Alias |
Home Team Id Home Team Market Home Team Name Game Id Game Scheduled Start Date/Time Playoff Game Type |
Status Weather Condition Weather Humidity Weather Temp Weather - Wind Direction Weather - Wind Speed |
| 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 Sequence Detail Start Location - Team Alias Detail Start Location - Yardline Drive Created At Drive Defensive Team Id Drive Defensive Team Points Drive Duration Drive End Clock Drive End Reason Drive First Downs Drive First Drive Yardline Drive Gain Drive Id Drive Inside 20 Flag Drive Last Drive Yardline Drive Net Yards Drive Offensive Team Id Drive Offensive Team Points Drive PAT Points Attempted Drive PAT Successful Drive Penalty Yards Drive Play Count Drive Scoring Drive Flag Drive Sequence Drive Start Clock Drive Start Reason Drive Team Sequence Drive Updated At 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 Yardline |
Ending Situation - Possession - Team Alias Ending Situation - Possession - Team Id Ending Situation - Possession - Team Market Ending Situation - Possession - Team Name Ending Situation - Yards to First Down Event Clock Event Created At Event Deleted Event Description Event Id Event Sequence Event Type Event Updated At Play Away Points Play Clock Play Created At Play Deleted Play Description Play Fake Field Goal Play Fake Punt Play Goal to Go Play Home Points Play Id Play Run Pass Option Play Scoring Description Play Scoring Play Play Screen Pass Play Sequence |
Play Type Play Updated At Play Wall Clock Points After - Play Id Points After - Score Type Points After - Sequence Points After - Wall Clock Quarter Id Quarter Number Quarter 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 Yardline Starting Situation Possession - Team Alias Starting Situation Possession - Team Id Starting Situation Possession - Team Market Starting Situation Possession - Team Name Starting Situation Yards to First Down |
| Play Statistics Data Points: | Blocked - Block Blocked - Category Blocked - Nullified Conversion Attempt Conversion Category Conversion Complete Conversion Nullified Conversion Safety Defense Assisted Sacks Defense Assisted Tackles Defense Assisted Tackles for Loss Defense Block Defense Category Defense Conversion Attempt Defense Conversion Category Defense Conversion Complete Defense Conversion Nullified Defense Forced Fumble Defense Interception Defense Interception Touchdown Defense Interception Yards 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 Down Conversions Attempt Down Conversions Complete Down Conversions Down Down Conversions Nullified Extra Point Attempt Extra Point Blocked Extra Point Made Extra Point Missed Extra Point Nullified Extra Point Returned Extra Point Safety Field Goal Attempt Field Goal Attempt Yards Field Goal Blocked Field Goal Made Field Goal Missed Field Goal Returned Field Goal Nullified Field Goal Yards First Down Category First Down Nullified |
Fumbles Forced Fumbles Fumble Fumbles Lost Fumbles Nullified Fumbles Opponent Recovery Fumbles Opponent Recovery Touchdown Fumbles Opponent Recovery Yards Fumbles Out of Bounds Fumbles Own Recovery Fumbles Own Recovery Touchdown Fumbles Own Recovery Yards Fumbles Play Category Kickoffs End Zone Kickoffs Gross Yards Kickoffs Inside 20 Kickoffs Kickoff Kickoffs Nullified Kickoffs Touchback Kickoffs Yards Passing Attempt Passing Completion Passing First Down Passing Goal to Go Passing Inside 20 Passing Interception Passing Nullified Passing Sack Passing Sack Yards Passing Safety Passing Touchdown Passing Yards Penalties Nullified Penalties Penalty Penalties Yards Punting Attempt Punting Blocked Punting Endzone |
Punting Inside 20 Punting Net Yards Punting Nullified Punting Touchback Punting Yards Receiving First Down Receiving Goal to Go Receiving Inside 20 Receiving Nullified Receiving Reception Receiving Safety Receiving Target Receiving Touchdown Receiving Yards Receiving Yards After Catch Returns Category Returns Fair Catch Returns Nullified Returns Return Returns Touchback Returns Touchdown Returns Yards Rushing Attempt Rushing First Down Rushing Goal to Go Rushing Inside 20 Rushing Nullified Rushing Safety Rushing Tackle for Loss Rushing Tackle for Loss Yards Rushing Touchdown Rushing Yards Timeout Description |
| Player Information Data Points: | Id Jersey Number |
Name Position |
Role |
| Standings Information Data Points: | Overall Losses | Overall Ties | Overall Wins |
| Team Information Data Points: | Alias Id |
Market | Name |
| Venue Information Data Points: | Address Capacity City Country |
Id Name Roof Type |
State Surface Zip |
| TTL / Cache: | 120 seconds | ||
| 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 Place Eligibility First Name |
Height Id Jersey Number Last Name |
Name Name Suffix Position 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 Extra Points Missed Extra Points Kicking Percent Field Goals Attempts Field Goals Attempts 1-19 Yards Field Goals Attempts 20-29 Yards Field Goals Attempts 30-39 Yards Field Goals Attempts 40-49 Yards Field Goals Attempts 50+ Yards Field Goals Average Yards Field Goals Blocked Field Goals Longest Field Goals Made Field Goals Made 1-19 Yards Field Goals Made 20-29 Yards Field Goals Made 30-39 Yards Field Goals Made 40-49 Yards Field Goals Made 50+ Yards Field Goals Missed Field Goals Percent |
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 Returns Interception Returns Touchdowns Interception Returns Yards Kick Returns Average Yards Kick Returns Fair Catches Kick Returns Longest 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 First Downs Passing Gross Yards Passing Interception Touchdowns Passing Interceptions Passing Longest Passing Longest Touchdown Passing Net Yards |
Passing Rating Passing Red Zone Attempts Passing Sack Yards Passing Sacks Passing Touchdowns Passing Yards Penalties Penalties Yards Punt Returns Average Yards Punt Returns Fair Catches Punt Returns Longest 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 First Downs 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 First Downs Rushing Longest Rushing Longest Touchdown Rushing Red Zone Attempts Rushing Tackles for Loss Rushing Tackles for Loss Yards Rushing Touchdowns Rushing Yards |
| Team Information Data Points: | Alias Id |
Market | Name |
| TTL / Cache: | 120 seconds | ||
| 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 |
| Standings Information Data Points: | Category Conference Losses Conference Points Against Conference Points For Conference Ties Conference Winning Perc. Conference Wins D2 Losses D2 Points Against D2 Points For D2 Ties D2 Winning Perc. D2 Wins D3 Losses D3 Points Against D3 Points For D3 Ties D3 Winning Perc. D3 Wins Division Losses Division Points Against Division Points For Division Rank Division Ties |
Division Winning Perc. Division Wins FBS Losses FBS Points Against FBS Points For FBS Ties FBS Winning Perc. FBS Wins FCS Losses FCS Points Against FCS Points For FCS Ties FCS Winning Perc. FCS Wins Home Losses Home Points Against Home Points For Home Ties Home Winning Perc. Home Wins NAIA Losses NAIA Points Against NAIA Points For NAIA Ties |
NAIA Winning Perc. NAIA Wins Overall Losses Overall Points Against Overall Points For Overall Ties Overall Winning Perc. Overall Wins Road Losses Road Points Against Road Points Fpr Road Ties Road Winning Perc. Road Wins Streak Description Streak Length Streak Type USCAA Losses USCAA Points Against USCAA Points For USCAA Ties USCAA Winning Perc. USCAA Wins |
| Team Information Data Points: | Alias Id |
Market | Name |
| TTL / Cache: | 2 seconds | ||
| Update Frequency: | As Necessary | ||
| Content Type: | Raw XML or JSON | ||
| Team Information Data Points: | Id | Market | Name |
| Rankings Information Data Points: | Poll Alias Poll Id Poll Name Poll Season Poll Season Type |
Poll Week Team FP Votes Team Losses Team Points |
Team Previous Rank Team Rank Team Ties Team Wins |
| TTL / Cache: | 2 seconds | ||
| Update Frequency: | As Necessary | ||
| Content Type: | Raw XML or JSON | ||
| Team Information Data Points: | Id | Market | Name |
| Rankings Information Data Points: | Poll Alias Poll Id Poll Name Poll Season Poll Season Type |
Poll Week Team FP Votes Team Losses Team Points |
Team Previous Rank Team Rank Team Ties Team Wins |
| TTL / Cache: | 10 seconds | ||
| 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 |
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 Id Away Team Name Broadcast Internet Broadcast Network Broadcast Satellite Conference Game |
Duration Entry Mode Game Type Home Team Alias Home Team Id Home Team Name Id Neutral Site Playoff Game Type |
Scheduled Start Date/Time Status Weather Condition Weather Humidity Weather Temp Weather - Wind Direction Weather - Wind Speed |
| League Information Data Points: | Bye Week Team Alias Bye Week Team Id Bye Week Team Name |
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 |
| TTL / Cache: | 120 seconds | ||
| 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: | Id Jersey Number |
Name | Position |
| 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 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 Extra Points Kicking Missed Extra Points Kicking Percent Field Goals Attempts Field Goals Attempts 1-19 Yards Field Goals Attempts 20-29 Yards Field Goals Attempts 30-39 Yards Field Goals Attempts 40-49 Yards Field Goals Attempts 50+ Yards Field Goals Average Yards Field Goals Blocked Field Goals Longest Field Goals Made Field Goals Made 1-19 Yards Field Goals Made 20-29 Yards |
Field Goals Made 30-39 Yards Field Goals Made 40-49 Yards Field Goals Made 50+ Yards Field Goals Missed Field Goals Percent 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 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 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 Net Yards |
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 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 |
| 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 Extra Points Missed Extra Points Kicking Percent Field Goals Attempts Field Goals Attempts 1-19 Yards Field Goals Attempts 20-29 Yards Field Goals Attempts 30-39 Yards Field Goals Attempts 40-49 Yards Field Goals Attempts 50+ Yards Field Goals Average Yards Field Goals Blocked Field Goals Longest Field Goals Made Field Goals Made 1-19 Yards Field Goals Made 20-29 Yards Field Goals Made 30-39 Yards Field Goals Made 40-49 Yards Field Goals Made 50+ Yards Field Goals Missed Field Goals Percent |
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 Returns Interception Returns Touchdowns Interception Returns Yards Kick Returns Average Yards Kick Returns Fair Catches Kick Returns Longest 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 First Downs Passing Gross Yards Passing Interception Touchdowns Passing Interceptions Passing Longest Passing Longest Touchdown Passing Net Yards |
Passing Rating Passing Red Zone Attempts Passing Sack Yards Passing Sacks Passing Touchdowns Passing Yards Penalties Penalties Yards Punt Returns Average Yards Punt Returns Fair Catches Punt Returns Longest 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 First Downs 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 First Downs Rushing Longest Rushing Longest Touchdown Rushing Red Zone Attempts Rushing Tackles for Loss Rushing Tackles for Loss Yards Rushing Touchdowns Rushing Yards |
| 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 4th Down Stops 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 Defense Three and Outs Forced 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 Extra Points Kicking Missed Extra Points Kicking Percent Field Goals Attempts Field Goals Attempts 1-19 Yards Field Goals Attempts 20-29 Yards Field Goals Attempts 30-39 Yards Field Goals Attempts 40-49 Yards Field Goals Attempts 50+ Yards Field Goals Average Yards Field Goals Blocked Field Goals Longest Field Goals Made Field Goals Made 1-19 Yards Field Goals Made 20-29 Yards |
Field Goals Made 30-39 Yards Field Goals Made 40-49 Yards Field Goals Made 50+ Yards Field Goals Missed Field Goals Percent 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 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 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 Interception Touchdowns Passing Interceptions Passing Longest Passing Longest Touchdown Passing Net Yards |
Passing Rating Passing Red Zone Attempts Passing Sack Yards Passing Sacks Passing Touchdowns Passing Yards Penalties Penalty Yards Punt Returns Average Yards Punt Returns Fair Catches Punt Returns Longest Punt Returns 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 |
| TTL / Cache: | 300 seconds | ||
| Update Frequency: | As Necessary | ||
| Content Type: | Raw XML or JSON | ||
| League Information Data Points: | Alias Id Name |
Season End Date Season Id Season Start Date |
Season Status Season Type Code Season Year |
| TTL / Cache: | 300 seconds | ||
| Update Frequency: | As Necessary | ||
| Content Type: | Raw XML or JSON | ||
| Franchise Information Data Points: | Id | Name | |
| League Information Data Points: | Conference Alias Conference Id |
Conference Name Division Alias |
Division Id Division Name |
| Player Information Data Points: | Abbreviated Name Birth Place Eligibility First Name |
Height Id Jersey Number Last Name |
Name Name Suffix Position Status Weight |
| Team Information Data Points: | Alias Coach First Name Coach Full Name Coach Id |
Coach Last Name Coach Name Suffix Coach Position |
Id Market Name |
| Venue Data Points: | Address Capacity City Country |
Id Name Roof Type |
State Surface Zip |
| TTL / Cache: | 10 seconds | ||
| 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 |
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 Id Away Team Name Broadcast Internet Broadcast Network Broadcast Satellite Conference Game |
Duration Entry Mode Game Type Home Team Alias Home Team Id Home Team Name Id Neutral Site Playoff Game Type |
Scheduled Start Date/Time Status Weather Condition Weather Humidity Weather Temp Weather - Wind Direction Weather - Wind Speed |
| League Information Data Points: | Bye Week Team Alias Bye Week Team Id Bye Week Team Name |
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 |
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 = "
| 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. |
Example: event_category=redzone
Valid event categories: redzone, two_minute, scoring_play, big_play, turnover | | `event_type` | Event type expressed as: {event_type}.
Example: event_type=timeout
Valid event types: setup, timeout, tv_timeout, two_minute_warning, comment, period_end, game_over | | `locale` | Locale expressed as 2 letter code: locale={language_code}
Example: locale:en | | `match` | Match id expressed as: sd:match:{match_id}.
Example: sd:match:0f23d300-5bec-4dc2-a7b0-1b8e05751d11 | | `status` | Status type expressed as: inprogress or created.
Example: status=inprogress | | `team` | Team id expressed as: sd:team:{team_id}.
Example: sd:team:19775492-f1eb-4bc5-9e15-078ebd689c0f | Return to top ## Push Statistics ```ruby require 'uri' require 'net/http' require 'openssl' url = URI("https://api.sportradar.us/ncaafb/trial/stream/en/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 requests import json r = requests.get("https://api.sportradar.com/ncaafb/trial/stream/en/statistics/subscribe", params = {'api_key': 'your_api_key'}, allow_redirects=False) redirect_url = r.headers['Location'] r = requests.get(redirect_url, stream=True) for line in r.iter_lines(): # filter out keep-alive new lines if line: decoded_line = line.decode('utf-8') print(json.loads(decoded_line)) ``` ```shell curl -L GET api.'sportradar.us/ncaafb/trial/stream/en/statistics/subscribe?api_key={your_api_key}' ``` >The above command returns json like this. Provides detailed, real-time game stats at the team and player level for all live games. https://api.sportradar.us/ncaafb/`{access_level}`/stream/`{language_code}`/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 (production) or Trial (trial). | | `language_code` | Optional code for supported languages: en (English). | | `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("https://api.sportradar.us/ncaafb/trial/stream/en/statistics/subscribe?api_key={your_api_key}&status=inprogress") 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 requests import json r = requests.get("https://api.sportradar.com/ncaafb/trial/stream/en/statistics/subscribe", params = {'api_key': 'your_api_key', 'status': 'inprogress'}, allow_redirects=False) redirect_url = r.headers['Location'] r = requests.get(redirect_url, stream=True) for line in r.iter_lines(): # filter out keep-alive new lines if line: decoded_line = line.decode('utf-8') print(json.loads(decoded_line)) ``` ```shell curl -L GET 'api.sportradar.us/ncaafb/trial/stream/en/statistics/subscribe?api_key={your_api_key}&status=inprogress' ``` 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. |
Example: locale:en | | `match` | Match id expressed as: sd:match:{match_id}.
Example: sd:match:0f23d300-5bec-4dc2-a7b0-1b8e05751d11 | | `status` | Status type expressed as: inprogress or created.
Example: status=inprogress | | `team` | Team id expressed as: sd:team:{team_id}.
Example: sd:team:19775492-f1eb-4bc5-9e15-078ebd689c0f | Return to top ## 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 valid season types?
A: The only valid season for NCAAFB is REG. All FBS bowl and FCS playoff games will appear in the specific week number the game is taking place in. As these games get announced, an additional week will be added to the schedule that will include all scheduled games.
Q: What are the valid game types and their definitions?
A: Here are the valid game types and their descriptions:
- regular – This is a regular season game.
- bowl – This is a bowl game (FBS postseason game).
- playoff – This is a playoff game.
- conference_championship – This is the conference championship game.
Q: What are the valid playoff game types?
A: Here are the valid playoff game types:
- CFP Semifinal
- CFP National Championship
- FCS First Round
- FCS Second Round
- FCS Quarterfinal
- FCS Semifinal
- FCS Championship
Q: What are the possible values for game coverage levels?
A: The valid coverage levels are:
- full
- extended_boxscore
Q: What are the player positions I can expect to see?
A: Below is a list of player positions that appear in our feeds and their descriptions. Note that additional decommissioned positions may appear in older seasons.
- ATH - Athlete
- C - Center
- CB - Cornerback
- DB - Defensive Back
- DE - Defensive End
- DL - Defensive Lineman
- DT - Defensive Tackle
- FB - Fullback
- FS - Free Safety
- G - Offensive Guard
- ILB - Inside Linebacker
- K - Kicker
- K/P - Kicker/Punter
- KR - Kick Returner
- LB - Linebacker
- LS - Long Snapper
- MLB - Middle Linebacker
- NT - Nose Tackle
- OG - Offensive Guard
- OL - Offensive Lineman
- OLB - Outside Linebacker
- OT - Offensive Tackle
- P - Punter
- QB - Quarterback
- RB - Running Back
- S - Safety
- SS - Strong Safety
- T - Offensive Tackle
- TE - Tight End
- WR - Wide Receiver
Q: How are player positions handled in the feeds?
A: Players may receive a “game” position, that position may not match the position listed on the player’s profile outside the game.
Q: What are the player statuses and their descriptions?
A: Below is a list of the currently valid player statuses and their descriptions. Note that additional decommissioned statuses may appear in older seasons.
- ACT - Active
- DUP - Duplicate player profile. All profiles marked as duplicates can be ignored.
- EXE - Exempt
- NWT - Not with team
- PRA - Practice Squad
- SUS - Suspended
Q: What are the player game statuses and when can I expect them to populate?
A: Below is a list of currently valid player game statuses.
deactivateddnp(Did Not Play)playedstarted
These player game statuses will appear within the Game Roster feed exclusively. When a game is set to created all players are marked as dnp (Did Not Play). At the conclusion of the game players are adjusted to started and played as necessary.
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 scheduled to occur.
- created – Game data (rosters, officials, etc) are being pre-loaded in preparation for the game.
- inprogress – The game is in progress.
- halftime – The game is currently at halftime.
- complete – The game is over, but stat validation is not complete.
- closed – The game is over and the stats have been validated.
- cancelled – The game has been cancelled. No makeup game will be played as a result.
- postponed – The game has been postponed, to be made up at another day and time. Once the makeup game is announced, a new game and ID will be created and scheduled on the announced makeup date. You should request the scheduled feed(s) regularly to identify the re-scheduled makeup game(s).
- 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 has been scheduled, but a time has yet to be announced.
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
- tv_timeout
- two_minute_warning
- 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: 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: How do I locate the TTL (Time to Live)/cache on an API endpoint?
A: The cache (in seconds) can be accessed in the returned header information on each RESTful API call, under cache-control.
ex. cache-control: max-age=1, public, s-maxage=1 or
cache-control: public, must-revalidate, max-age=120
Note that, for select game-centric endpoints, the TTL may adjust when an event is live. This information is available for each endpoint on our developer portal.
Docs Navigation
- Documentation
- Football (American Football)
- Football (Soccer)
- Australian Rules Football
- Baseball
- Basketball
- NBA v8
- NBA v7
- NBA v5
- NBA v4
- WNBA v8
- WNBA v7
- WNBA v4
- WNBA v3
- NBA G League v8
- NBA G League v7
- NBA G League v5
- NCAA Men's Basketball v8
- NCAA Men's Basketball v7
- NCAA Men's Basketball v4
- NCAA Men's Basketball v3
- NCAA Women's Basketball v8
- NCAA Women's Basketball v7
- NCAA Women's Basketball v3
- Global Basketball v2
- Global Basketball v1
- NBA Historical v1
- Combat Sports
- Cricket
- Editorial Content
- Golf
- Handball
- Hockey
- Images
- Insights
- Betting Insights
- Odds
- Racing
- Rugby
- Tennis
- Widgets
- Baseline Sports Coverage
- Badminton v2
- Badminton v1
- Bandy v2
- Bandy v1
- Beach Soccer v2
- Beach Soccer v1
- Curling v2
- Curling v1
- Cycling v2
- Cycling v1
- Darts v2
- Darts v1
- Field Hockey v2
- Field Hockey v1
- Floorball v2
- Floorball v1
- Futsal v2
- Futsal v1
- Pesapallo v2
- Pesapallo v1
- Snooker v2
- Snooker v1
- Squash v2
- Squash v1
- Table Tennis v2
- Volleyball (Beach) v2
- Volleyball (Beach) v1
- Volleyball (Indoor) v2
- Volleyball (Indoor) v1
- Waterpolo v2
- Waterpolo v1
- Winter Sports v1
