cfbd.MetricsApi

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

Method	HTTP request	Description
get_fgep	GET /metrics/fg/ep	Field Goal Expected Points
get_game_ppa	GET /ppa/games	Team Predicated Points Added (PPA/EPA) by game
get_player_game_ppa	GET /ppa/players/games	Player Predicated Points Added (PPA/EPA) broken down by game
get_player_season_ppa	GET /ppa/players/season	Player Predicated Points Added (PPA/EPA) broken down by season
get_predicted_points	GET /ppa/predicted	Predicted Points (i.e. Expected Points or EP)
get_pregame_win_probabilities	GET /metrics/wp/pregame	Pregame win probability data
get_team_ppa	GET /ppa/teams	Predicted Points Added (PPA/EPA) data by team
get_win_probability_data	GET /metrics/wp	Win probability chart data

get_fgep

list[FieldGoalExpectedPoints] get_fgep()

Field Goal Expected Points

Field Goal Expected Poitns

Example

from __future__ import print_function
import time
import cfbd
from cfbd.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
configuration = cfbd.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = cfbd.MetricsApi(cfbd.ApiClient(configuration))

try:
    # Field Goal Expected Points
    api_response = api_instance.get_fgep()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MetricsApi->get_fgep: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

list[FieldGoalExpectedPoints]

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

get_game_ppa

list[GamePPA] get_game_ppa(year, week=week, team=team, conference=conference, exclude_garbage_time=exclude_garbage_time, season_type=season_type)

Team Predicated Points Added (PPA/EPA) by game

Predicted Points Added (PPA) by game

Example

from __future__ import print_function
import time
import cfbd
from cfbd.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
configuration = cfbd.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = cfbd.MetricsApi(cfbd.ApiClient(configuration))
year = 56 # int | Year filter
week = 56 # int | Week filter (optional)
team = 'team_example' # str | Team filter (optional)
conference = 'conference_example' # str | Conference filter (optional)
exclude_garbage_time = true # bool | Filter to remove garbage time plays from calculations (optional)
season_type = 'regular' # str | Season type filter (regular or postseason) (optional) (default to regular)

try:
    # Team Predicated Points Added (PPA/EPA) by game
    api_response = api_instance.get_game_ppa(year, week=week, team=team, conference=conference, exclude_garbage_time=exclude_garbage_time, season_type=season_type)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MetricsApi->get_game_ppa: %s\n" % e)

Parameters

Name	Type	Description	Notes
year	int	Year filter
week	int	Week filter	[optional]
team	str	Team filter	[optional]
conference	str	Conference filter	[optional]
exclude_garbage_time	bool	Filter to remove garbage time plays from calculations	[optional]
season_type	str	Season type filter (regular or postseason)	[optional] [default to regular]

Return type

list[GamePPA]

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

get_player_game_ppa

list[PlayerGamePPA] get_player_game_ppa(year=year, week=week, team=team, position=position, player_id=player_id, threshold=threshold, exclude_garbage_time=exclude_garbage_time, season_type=season_type)

Player Predicated Points Added (PPA/EPA) broken down by game

Predicted Points Added (PPA) by player game

Example

from __future__ import print_function
import time
import cfbd
from cfbd.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
configuration = cfbd.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = cfbd.MetricsApi(cfbd.ApiClient(configuration))
year = 56 # int | Year filter (optional)
week = 56 # int | Week filter (optional)
team = 'team_example' # str | Team filter (optional)
position = 'position_example' # str | Position abbreviation filter (optional)
player_id = 56 # int | Player id filter (optional)
threshold = 'threshold_example' # str | Minimum play threshold filter (optional)
exclude_garbage_time = true # bool | Filter to remove garbage time plays from calculations (optional)
season_type = 'regular' # str | Season type filter (regular or postseason) (optional) (default to regular)

try:
    # Player Predicated Points Added (PPA/EPA) broken down by game
    api_response = api_instance.get_player_game_ppa(year=year, week=week, team=team, position=position, player_id=player_id, threshold=threshold, exclude_garbage_time=exclude_garbage_time, season_type=season_type)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MetricsApi->get_player_game_ppa: %s\n" % e)

Parameters

Name	Type	Description	Notes
year	int	Year filter	[optional]
week	int	Week filter	[optional]
team	str	Team filter	[optional]
position	str	Position abbreviation filter	[optional]
player_id	int	Player id filter	[optional]
threshold	str	Minimum play threshold filter	[optional]
exclude_garbage_time	bool	Filter to remove garbage time plays from calculations	[optional]
season_type	str	Season type filter (regular or postseason)	[optional] [default to regular]

Return type

list[PlayerGamePPA]

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

get_player_season_ppa

list[PlayerSeasonPPA] get_player_season_ppa(year=year, team=team, conference=conference, position=position, player_id=player_id, threshold=threshold, exclude_garbage_time=exclude_garbage_time)

Player Predicated Points Added (PPA/EPA) broken down by season

Predicted Points Added (PPA) by player season

Example

from __future__ import print_function
import time
import cfbd
from cfbd.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
configuration = cfbd.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = cfbd.MetricsApi(cfbd.ApiClient(configuration))
year = 56 # int | Year filter (optional)
team = 'team_example' # str | Team filter (optional)
conference = 'conference_example' # str | Conference abbreviation filter (optional)
position = 'position_example' # str | Position abbreviation filter (optional)
player_id = 56 # int | Player id filter (optional)
threshold = 'threshold_example' # str | Minimum play threshold filter (optional)
exclude_garbage_time = true # bool | Filter to remove garbage time plays from calculations (optional)

try:
    # Player Predicated Points Added (PPA/EPA) broken down by season
    api_response = api_instance.get_player_season_ppa(year=year, team=team, conference=conference, position=position, player_id=player_id, threshold=threshold, exclude_garbage_time=exclude_garbage_time)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MetricsApi->get_player_season_ppa: %s\n" % e)

Parameters

Name	Type	Description	Notes
year	int	Year filter	[optional]
team	str	Team filter	[optional]
conference	str	Conference abbreviation filter	[optional]
position	str	Position abbreviation filter	[optional]
player_id	int	Player id filter	[optional]
threshold	str	Minimum play threshold filter	[optional]
exclude_garbage_time	bool	Filter to remove garbage time plays from calculations	[optional]

Return type

list[PlayerSeasonPPA]

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

get_predicted_points

list[PredictedPoints] get_predicted_points(down, distance)

Predicted Points (i.e. Expected Points or EP)

Predicted Points

Example

from __future__ import print_function
import time
import cfbd
from cfbd.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
configuration = cfbd.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = cfbd.MetricsApi(cfbd.ApiClient(configuration))
down = 56 # int | Down filter
distance = 56 # int | Distance filter

try:
    # Predicted Points (i.e. Expected Points or EP)
    api_response = api_instance.get_predicted_points(down, distance)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MetricsApi->get_predicted_points: %s\n" % e)

Parameters

Name	Type	Description	Notes
down	int	Down filter
distance	int	Distance filter

Return type

list[PredictedPoints]

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

get_pregame_win_probabilities

list[PregameWP] get_pregame_win_probabilities(year=year, week=week, team=team, season_type=season_type)

Pregame win probability data

Pregame win probabilities

Example

from __future__ import print_function
import time
import cfbd
from cfbd.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
configuration = cfbd.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = cfbd.MetricsApi(cfbd.ApiClient(configuration))
year = 56 # int | Year filter (optional)
week = 56 # int | Week filter (optional)
team = 'team_example' # str | Team filter (optional)
season_type = 'season_type_example' # str | regular or postseason (optional)

try:
    # Pregame win probability data
    api_response = api_instance.get_pregame_win_probabilities(year=year, week=week, team=team, season_type=season_type)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MetricsApi->get_pregame_win_probabilities: %s\n" % e)

Parameters

Name	Type	Description	Notes
year	int	Year filter	[optional]
week	int	Week filter	[optional]
team	str	Team filter	[optional]
season_type	str	regular or postseason	[optional]

Return type

list[PregameWP]

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

get_team_ppa

list[TeamPPA] get_team_ppa(year=year, team=team, conference=conference, exclude_garbage_time=exclude_garbage_time)

Predicted Points Added (PPA/EPA) data by team

Predicted Points Added (PPA)

Example

from __future__ import print_function
import time
import cfbd
from cfbd.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
configuration = cfbd.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = cfbd.MetricsApi(cfbd.ApiClient(configuration))
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 | Conference filter (optional)
exclude_garbage_time = true # bool | Filter to remove garbage time plays from calculations (optional)

try:
    # Predicted Points Added (PPA/EPA) data by team
    api_response = api_instance.get_team_ppa(year=year, team=team, conference=conference, exclude_garbage_time=exclude_garbage_time)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MetricsApi->get_team_ppa: %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	Conference filter	[optional]
exclude_garbage_time	bool	Filter to remove garbage time plays from calculations	[optional]

Return type

list[TeamPPA]

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

get_win_probability_data

list[PlayWP] get_win_probability_data(game_id)

Win probability chart data

Win probability data

Example

from __future__ import print_function
import time
import cfbd
from cfbd.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
configuration = cfbd.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = cfbd.MetricsApi(cfbd.ApiClient(configuration))
game_id = 56 # int | Game id filter

try:
    # Win probability chart data
    api_response = api_instance.get_win_probability_data(game_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MetricsApi->get_win_probability_data: %s\n" % e)

Parameters

Name	Type	Description	Notes
game_id	int	Game id filter

Return type

list[PlayWP]

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

Files

MetricsApi.md

Latest commit

History

MetricsApi.md

File metadata and controls

cfbd.MetricsApi

get_fgep

Example

Parameters

Return type

Authorization

HTTP request headers

get_game_ppa

Example

Parameters

Return type

Authorization

HTTP request headers

get_player_game_ppa

Example

Parameters

Return type

Authorization

HTTP request headers

get_player_season_ppa

Example

Parameters

Return type

Authorization

HTTP request headers

get_predicted_points

Example

Parameters

Return type

Authorization

HTTP request headers

get_pregame_win_probabilities

Example

Parameters

Return type

Authorization

HTTP request headers

get_team_ppa

Example

Parameters

Return type

Authorization

HTTP request headers

get_win_probability_data

Example

Parameters

Return type

Authorization

HTTP request headers