cfbd.TeamsApi

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

Method	HTTP request	Description
get_fbs_teams	GET /teams/fbs
get_matchup	GET /teams/matchup
get_roster	GET /roster
get_talent	GET /talent
get_teams	GET /teams
get_teams_ats	GET /teams/ats

get_fbs_teams

List[Team] get_fbs_teams(year=year)

Returns Football Bowl Subdivision (FBS) teams for a season.

Example

Bearer Authentication (apiKey):

import time
import os
import cfbd
from cfbd.models.team import Team
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.TeamsApi(api_client)
    year = 56 # int | Season year. (optional)

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

Parameters

Name	Type	Description	Notes
year	int	Season year.	[optional]

Return type

List[Team]

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_matchup

Matchup get_matchup(team1, team2, min_year=min_year, max_year=max_year)

Returns historical matchup results between two teams.

Example

Bearer Authentication (apiKey):

import time
import os
import cfbd
from cfbd.models.matchup import Matchup
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.TeamsApi(api_client)
    team1 = 'team1_example' # str | First team name.
    team2 = 'team2_example' # str | Second team name.
    min_year = 56 # int | Earliest season year to include. (optional)
    max_year = 56 # int | Latest season year to include. (optional)

    try:
        api_response = api_instance.get_matchup(team1, team2, min_year=min_year, max_year=max_year)
        print("The response of TeamsApi->get_matchup:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling TeamsApi->get_matchup: %s\n" % e)

Parameters

Name	Type	Description	Notes
team1	str	First team name.
team2	str	Second team name.
min_year	int	Earliest season year to include.	[optional]
max_year	int	Latest season year to include.	[optional]

Return type

Matchup

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_roster

List[RosterPlayer] get_roster(team=team, year=year, classification=classification)

Returns historical roster data.

Example

Bearer Authentication (apiKey):

import time
import os
import cfbd
from cfbd.models.division_classification import DivisionClassification
from cfbd.models.roster_player import RosterPlayer
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.TeamsApi(api_client)
    team = 'team_example' # str | Team name. (optional)
    year = 56 # int | Season year. Defaults to 2025. (optional)
    classification = cfbd.DivisionClassification() # DivisionClassification | Division classification: `fbs` or `fcs`. (optional)

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

Parameters

Name	Type	Description	Notes
team	str	Team name.	[optional]
year	int	Season year. Defaults to 2025.	[optional]
classification	DivisionClassification	Division classification: `fbs` or `fcs`.	[optional]

Return type

List[RosterPlayer]

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_talent

List[TeamTalent] get_talent(year)

Returns 247Sports Team Talent Composite ratings for a season.

Example

Bearer Authentication (apiKey):

import time
import os
import cfbd
from cfbd.models.team_talent import TeamTalent
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.TeamsApi(api_client)
    year = 56 # int | Season year.

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

Parameters

Name	Type	Description	Notes
year	int	Season year.

Return type

List[TeamTalent]

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_teams

List[Team] get_teams(conference=conference, year=year)

Returns team information and conference affiliations.

Example

Bearer Authentication (apiKey):

import time
import os
import cfbd
from cfbd.models.team import Team
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.TeamsApi(api_client)
    conference = 'conference_example' # str | Conference abbreviation. (optional)
    year = 56 # int | Season year for historical conference affiliations. (optional)

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

Parameters

Name	Type	Description	Notes
conference	str	Conference abbreviation.	[optional]
year	int	Season year for historical conference affiliations.	[optional]

Return type

List[Team]

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_teams_ats

List[TeamATS] get_teams_ats(year, conference=conference, team=team)

Returns against-the-spread (ATS) records by team.

Example

Bearer Authentication (apiKey):

import time
import os
import cfbd
from cfbd.models.team_ats import TeamATS
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.TeamsApi(api_client)
    year = 56 # int | Season year.
    conference = 'conference_example' # str | Conference name or abbreviation. (optional)
    team = 'team_example' # str | Team name. (optional)

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

Parameters

Name	Type	Description	Notes
year	int	Season year.
conference	str	Conference name or abbreviation.	[optional]
team	str	Team name.	[optional]

Return type

List[TeamATS]

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

TeamsApi.md

Latest commit

History

TeamsApi.md

File metadata and controls

cfbd.TeamsApi

get_fbs_teams

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_matchup

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_roster

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_talent

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_teams

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_teams_ats

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details