cfbd.StatsApi

All URIs are relative to https://api.collegefootballdata.com

Method	HTTP request	Description
get_advanced_game_stats	GET /stats/game/advanced
get_advanced_season_stats	GET /stats/season/advanced
get_categories	GET /stats/categories
get_game_havoc_stats	GET /stats/game/havoc
get_player_game_success_rates	GET /stats/player/success/game
get_player_season_stats	GET /stats/player/season
get_player_season_success_rates	GET /stats/player/success
get_team_stats	GET /stats/season

get_advanced_game_stats

List[AdvancedGameStat] get_advanced_game_stats(year=year, team=team, week=week, opponent=opponent, exclude_garbage_time=exclude_garbage_time, season_type=season_type)

Retrieves advanced statistics aggregated by game

Example

Bearer Authentication (apiKey):

import time
import os
import cfbd
from cfbd.models.advanced_game_stat import AdvancedGameStat
from cfbd.models.season_type import SeasonType
from cfbd.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.collegefootballdata.com
# See configuration.py for a list of all supported configuration parameters.
configuration = cfbd.Configuration(
    host = "https://api.collegefootballdata.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: apiKey
configuration = cfbd.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with cfbd.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cfbd.StatsApi(api_client)
    year = 56 # int | Year filter, required if team not specified (optional)
    team = 'team_example' # str | Team filter, required if year not specified (optional)
    week = 3.4 # float | Optional week filter (optional)
    opponent = 'opponent_example' # str | Optional opponent filter (optional)
    exclude_garbage_time = True # bool | Garbage time exclusion filter, defaults to false (optional)
    season_type = cfbd.SeasonType() # SeasonType | Optional season type filter (optional)

    try:
        api_response = api_instance.get_advanced_game_stats(year=year, team=team, week=week, opponent=opponent, exclude_garbage_time=exclude_garbage_time, season_type=season_type)
        print("The response of StatsApi->get_advanced_game_stats:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling StatsApi->get_advanced_game_stats: %s\n" % e)

Parameters

Name	Type	Description	Notes
year	int	Year filter, required if team not specified	[optional]
team	str	Team filter, required if year not specified	[optional]
week	float	Optional week filter	[optional]
opponent	str	Optional opponent filter	[optional]
exclude_garbage_time	bool	Garbage time exclusion filter, defaults to false	[optional]
season_type	SeasonType	Optional season type filter	[optional]

Return type

List[AdvancedGameStat]

Authorization

apiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Ok	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_advanced_season_stats

List[AdvancedSeasonStat] get_advanced_season_stats(year=year, team=team, exclude_garbage_time=exclude_garbage_time, start_week=start_week, end_week=end_week)

Retrieves advanced season statistics for teams

Example

Bearer Authentication (apiKey):

import time
import os
import cfbd
from cfbd.models.advanced_season_stat import AdvancedSeasonStat
from cfbd.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.collegefootballdata.com
# See configuration.py for a list of all supported configuration parameters.
configuration = cfbd.Configuration(
    host = "https://api.collegefootballdata.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: apiKey
configuration = cfbd.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with cfbd.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cfbd.StatsApi(api_client)
    year = 56 # int | Year filter, required if team not specified (optional)
    team = 'team_example' # str | Team filter, required if year not specified (optional)
    exclude_garbage_time = True # bool | Garbage time exclusion filter, defaults to false (optional)
    start_week = 56 # int | Optional start week range filter (optional)
    end_week = 56 # int | Optional end week range filter (optional)

    try:
        api_response = api_instance.get_advanced_season_stats(year=year, team=team, exclude_garbage_time=exclude_garbage_time, start_week=start_week, end_week=end_week)
        print("The response of StatsApi->get_advanced_season_stats:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling StatsApi->get_advanced_season_stats: %s\n" % e)

Parameters

Name	Type	Description	Notes
year	int	Year filter, required if team not specified	[optional]
team	str	Team filter, required if year not specified	[optional]
exclude_garbage_time	bool	Garbage time exclusion filter, defaults to false	[optional]
start_week	int	Optional start week range filter	[optional]
end_week	int	Optional end week range filter	[optional]

Return type

List[AdvancedSeasonStat]

Authorization

apiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Ok	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_categories

List[str] get_categories()

Gets team statistical categories

Example

Bearer Authentication (apiKey):

import time
import os
import cfbd
from cfbd.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.collegefootballdata.com
# See configuration.py for a list of all supported configuration parameters.
configuration = cfbd.Configuration(
    host = "https://api.collegefootballdata.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: apiKey
configuration = cfbd.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with cfbd.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cfbd.StatsApi(api_client)

    try:
        api_response = api_instance.get_categories()
        print("The response of StatsApi->get_categories:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling StatsApi->get_categories: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

List[str]

Authorization

apiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Ok	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_game_havoc_stats

List[GameHavocStats] get_game_havoc_stats(year=year, team=team, week=week, opponent=opponent, season_type=season_type)

Retrieves havoc statistics aggregated by game

Example

Bearer Authentication (apiKey):

import time
import os
import cfbd
from cfbd.models.game_havoc_stats import GameHavocStats
from cfbd.models.season_type import SeasonType
from cfbd.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.collegefootballdata.com
# See configuration.py for a list of all supported configuration parameters.
configuration = cfbd.Configuration(
    host = "https://api.collegefootballdata.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: apiKey
configuration = cfbd.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with cfbd.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cfbd.StatsApi(api_client)
    year = 56 # int | Year filter, required if team not specified (optional)
    team = 'team_example' # str | Team filter, required if year not specified (optional)
    week = 3.4 # float | Optional week filter (optional)
    opponent = 'opponent_example' # str | Optional opponent filter (optional)
    season_type = cfbd.SeasonType() # SeasonType | Optional season type filter (optional)

    try:
        api_response = api_instance.get_game_havoc_stats(year=year, team=team, week=week, opponent=opponent, season_type=season_type)
        print("The response of StatsApi->get_game_havoc_stats:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling StatsApi->get_game_havoc_stats: %s\n" % e)

Parameters

Name	Type	Description	Notes
year	int	Year filter, required if team not specified	[optional]
team	str	Team filter, required if year not specified	[optional]
week	float	Optional week filter	[optional]
opponent	str	Optional opponent filter	[optional]
season_type	SeasonType	Optional season type filter	[optional]

Return type

List[GameHavocStats]

Authorization

apiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Ok	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_player_game_success_rates

List[PlayerGameSuccessRate] get_player_game_success_rates(year, week=week, season_type=season_type, conference=conference, team=team, player_id=player_id, threshold=threshold, exclude_garbage_time=exclude_garbage_time)

Retrieves player passing and rushing success rates by game

Example

Bearer Authentication (apiKey):

import time
import os
import cfbd
from cfbd.models.player_game_success_rate import PlayerGameSuccessRate
from cfbd.models.season_type import SeasonType
from cfbd.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.collegefootballdata.com
# See configuration.py for a list of all supported configuration parameters.
configuration = cfbd.Configuration(
    host = "https://api.collegefootballdata.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: apiKey
configuration = cfbd.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with cfbd.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cfbd.StatsApi(api_client)
    year = 56 # int | Required year filter
    week = 56 # int | Week filter, required if team and playerId not specified (optional)
    season_type = cfbd.SeasonType() # SeasonType | Optional season type filter (optional)
    conference = 'conference_example' # str | Optional conference abbreviation filter (optional)
    team = 'team_example' # str | Optional team filter (optional)
    player_id = 56 # int | Optional player ID filter (optional)
    threshold = 56 # int | Optional minimum credited passing plus rushing plays (optional)
    exclude_garbage_time = True # bool | Optional flag to exclude garbage time plays (optional)

    try:
        api_response = api_instance.get_player_game_success_rates(year, week=week, season_type=season_type, conference=conference, team=team, player_id=player_id, threshold=threshold, exclude_garbage_time=exclude_garbage_time)
        print("The response of StatsApi->get_player_game_success_rates:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling StatsApi->get_player_game_success_rates: %s\n" % e)

Parameters

Name	Type	Description	Notes
year	int	Required year filter
week	int	Week filter, required if team and playerId not specified	[optional]
season_type	SeasonType	Optional season type filter	[optional]
conference	str	Optional conference abbreviation filter	[optional]
team	str	Optional team filter	[optional]
player_id	int	Optional player ID filter	[optional]
threshold	int	Optional minimum credited passing plus rushing plays	[optional]
exclude_garbage_time	bool	Optional flag to exclude garbage time plays	[optional]

Return type

List[PlayerGameSuccessRate]

Authorization

apiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Ok	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_player_season_stats

List[PlayerStat] get_player_season_stats(year, conference=conference, team=team, start_week=start_week, end_week=end_week, season_type=season_type, category=category)

Retrieves aggregated player statistics for a given season

Example

Bearer Authentication (apiKey):

import time
import os
import cfbd
from cfbd.models.player_stat import PlayerStat
from cfbd.models.season_type import SeasonType
from cfbd.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.collegefootballdata.com
# See configuration.py for a list of all supported configuration parameters.
configuration = cfbd.Configuration(
    host = "https://api.collegefootballdata.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: apiKey
configuration = cfbd.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with cfbd.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cfbd.StatsApi(api_client)
    year = 56 # int | Required year filter
    conference = 'conference_example' # str | Optional conference filter (optional)
    team = 'team_example' # str | Optional team filter (optional)
    start_week = 56 # int | Optional starting week range (optional)
    end_week = 56 # int | Optional ending week range (optional)
    season_type = cfbd.SeasonType() # SeasonType | Optional season type filter (optional)
    category = 'category_example' # str | Optional category filter (optional)

    try:
        api_response = api_instance.get_player_season_stats(year, conference=conference, team=team, start_week=start_week, end_week=end_week, season_type=season_type, category=category)
        print("The response of StatsApi->get_player_season_stats:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling StatsApi->get_player_season_stats: %s\n" % e)

Parameters

Name	Type	Description	Notes
year	int	Required year filter
conference	str	Optional conference filter	[optional]
team	str	Optional team filter	[optional]
start_week	int	Optional starting week range	[optional]
end_week	int	Optional ending week range	[optional]
season_type	SeasonType	Optional season type filter	[optional]
category	str	Optional category filter	[optional]

Return type

List[PlayerStat]

Authorization

apiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Ok	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_player_season_success_rates

List[PlayerSeasonSuccessRate] get_player_season_success_rates(year=year, conference=conference, team=team, player_id=player_id, season_type=season_type, start_week=start_week, end_week=end_week, threshold=threshold, exclude_garbage_time=exclude_garbage_time)

Retrieves player passing and rushing success rates by season

Example

Bearer Authentication (apiKey):

import time
import os
import cfbd
from cfbd.models.player_season_success_rate import PlayerSeasonSuccessRate
from cfbd.models.season_type import SeasonType
from cfbd.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.collegefootballdata.com
# See configuration.py for a list of all supported configuration parameters.
configuration = cfbd.Configuration(
    host = "https://api.collegefootballdata.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: apiKey
configuration = cfbd.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with cfbd.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cfbd.StatsApi(api_client)
    year = 56 # int | Year filter, required if playerId not specified (optional)
    conference = 'conference_example' # str | Optional conference abbreviation filter (optional)
    team = 'team_example' # str | Optional team filter (optional)
    player_id = 56 # int | Player ID filter, required if year not specified (optional)
    season_type = cfbd.SeasonType() # SeasonType | Optional season type filter (optional)
    start_week = 56 # int | Optional starting week range (optional)
    end_week = 56 # int | Optional ending week range (optional)
    threshold = 56 # int | Optional minimum credited passing plus rushing plays (optional)
    exclude_garbage_time = True # bool | Optional flag to exclude garbage time plays (optional)

    try:
        api_response = api_instance.get_player_season_success_rates(year=year, conference=conference, team=team, player_id=player_id, season_type=season_type, start_week=start_week, end_week=end_week, threshold=threshold, exclude_garbage_time=exclude_garbage_time)
        print("The response of StatsApi->get_player_season_success_rates:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling StatsApi->get_player_season_success_rates: %s\n" % e)

Parameters

Name	Type	Description	Notes
year	int	Year filter, required if playerId not specified	[optional]
conference	str	Optional conference abbreviation filter	[optional]
team	str	Optional team filter	[optional]
player_id	int	Player ID filter, required if year not specified	[optional]
season_type	SeasonType	Optional season type filter	[optional]
start_week	int	Optional starting week range	[optional]
end_week	int	Optional ending week range	[optional]
threshold	int	Optional minimum credited passing plus rushing plays	[optional]
exclude_garbage_time	bool	Optional flag to exclude garbage time plays	[optional]

Return type

List[PlayerSeasonSuccessRate]

Authorization

apiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Ok	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_team_stats

List[TeamStat] get_team_stats(year=year, team=team, conference=conference, start_week=start_week, end_week=end_week)

Retrieves aggregated team season statistics

Example

Bearer Authentication (apiKey):

import time
import os
import cfbd
from cfbd.models.team_stat import TeamStat
from cfbd.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.collegefootballdata.com
# See configuration.py for a list of all supported configuration parameters.
configuration = cfbd.Configuration(
    host = "https://api.collegefootballdata.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: apiKey
configuration = cfbd.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with cfbd.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cfbd.StatsApi(api_client)
    year = 56 # int | Year filter, required if team not specified (optional)
    team = 'team_example' # str | Team filter, required if year not specified (optional)
    conference = 'conference_example' # str | Optional conference filter (optional)
    start_week = 56 # int | Optional week start range filter (optional)
    end_week = 56 # int | Optional week end range filter (optional)

    try:
        api_response = api_instance.get_team_stats(year=year, team=team, conference=conference, start_week=start_week, end_week=end_week)
        print("The response of StatsApi->get_team_stats:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling StatsApi->get_team_stats: %s\n" % e)

Parameters

Name	Type	Description	Notes
year	int	Year filter, required if team not specified	[optional]
team	str	Team filter, required if year not specified	[optional]
conference	str	Optional conference filter	[optional]
start_week	int	Optional week start range filter	[optional]
end_week	int	Optional week end range filter	[optional]

Return type

List[TeamStat]

Authorization

apiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Ok	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Uh oh!

FilesExpand file tree

StatsApi.md

Latest commit

History

StatsApi.md

File metadata and controls

cfbd.StatsApi

get_advanced_game_stats

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_advanced_season_stats

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_categories

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_game_havoc_stats

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_player_game_success_rates

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_player_season_stats

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_player_season_success_rates

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_team_stats

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details