Skip to content

Latest commit

 

History

History
336 lines (240 loc) · 11.4 KB

AdjustedMetricsApi.md

File metadata and controls

336 lines (240 loc) · 11.4 KB

cfbd.AdjustedMetricsApi

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

Method HTTP request Description
get_adjusted_player_passing_stats GET /wepa/players/passing
get_adjusted_player_rushing_stats GET /wepa/players/rushing
get_adjusted_team_season_stats GET /wepa/team/season
get_kicker_paar GET /wepa/players/kicking

get_adjusted_player_passing_stats

List[PlayerWeightedEPA] get_adjusted_player_passing_stats(year=year, team=team, conference=conference, position=position)

Retrieve opponent-adjusted player passing statistics

Example

  • Bearer Authentication (apiKey):
import time
import os
import cfbd
from cfbd.models.player_weighted_epa import PlayerWeightedEPA
from cfbd.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://apinext.collegefootballdata.com
# See configuration.py for a list of all supported configuration parameters.
configuration = cfbd.Configuration(
    host = "https://apinext.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.AdjustedMetricsApi(api_client)
    year = 56 # int | Optional year filter (optional)
    team = 'team_example' # str | Optional team filter (optional)
    conference = 'conference_example' # str | Optional conference abbreviation filter (optional)
    position = 'position_example' # str | Optional position abbreviation filter (optional)

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

Parameters

Name Type Description Notes
year int Optional year filter [optional]
team str Optional team filter [optional]
conference str Optional conference abbreviation filter [optional]
position str Optional position abbreviation filter [optional]

Return type

List[PlayerWeightedEPA]

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_adjusted_player_rushing_stats

List[PlayerWeightedEPA] get_adjusted_player_rushing_stats(year=year, team=team, conference=conference, position=position)

Retrieve opponent-adjusted player rushing statistics

Example

  • Bearer Authentication (apiKey):
import time
import os
import cfbd
from cfbd.models.player_weighted_epa import PlayerWeightedEPA
from cfbd.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://apinext.collegefootballdata.com
# See configuration.py for a list of all supported configuration parameters.
configuration = cfbd.Configuration(
    host = "https://apinext.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.AdjustedMetricsApi(api_client)
    year = 56 # int | Optional year filter (optional)
    team = 'team_example' # str | Optional team filter (optional)
    conference = 'conference_example' # str | Optional conference abbreviation filter (optional)
    position = 'position_example' # str | Optional position abbreviation filter (optional)

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

Parameters

Name Type Description Notes
year int Optional year filter [optional]
team str Optional team filter [optional]
conference str Optional conference abbreviation filter [optional]
position str Optional position abbreviation filter [optional]

Return type

List[PlayerWeightedEPA]

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_adjusted_team_season_stats

List[AdjustedTeamMetrics] get_adjusted_team_season_stats(year=year, team=team, conference=conference)

Retrieve opponent-adjusted team season statistics

Example

  • Bearer Authentication (apiKey):
import time
import os
import cfbd
from cfbd.models.adjusted_team_metrics import AdjustedTeamMetrics
from cfbd.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://apinext.collegefootballdata.com
# See configuration.py for a list of all supported configuration parameters.
configuration = cfbd.Configuration(
    host = "https://apinext.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.AdjustedMetricsApi(api_client)
    year = 56 # int | Optional year filter (optional)
    team = 'team_example' # str | Optional team filter (optional)
    conference = 'conference_example' # str | Optional conference filter (optional)

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

Parameters

Name Type Description Notes
year int Optional year filter [optional]
team str Optional team filter [optional]
conference str Optional conference filter [optional]

Return type

List[AdjustedTeamMetrics]

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_kicker_paar

List[KickerPAAR] get_kicker_paar(year=year, team=team, conference=conference)

Retrieve Points Added Above Replacement (PAAR) ratings for kickers

Example

  • Bearer Authentication (apiKey):
import time
import os
import cfbd
from cfbd.models.kicker_paar import KickerPAAR
from cfbd.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://apinext.collegefootballdata.com
# See configuration.py for a list of all supported configuration parameters.
configuration = cfbd.Configuration(
    host = "https://apinext.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.AdjustedMetricsApi(api_client)
    year = 56 # int | Optional year filter (optional)
    team = 'team_example' # str | Optional team filter (optional)
    conference = 'conference_example' # str | Optional conference abbreviation filter (optional)

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

Parameters

Name Type Description Notes
year int Optional year filter [optional]
team str Optional team filter [optional]
conference str Optional conference abbreviation filter [optional]

Return type

List[KickerPAAR]

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]