Skip to content

PlayoffsApi.md

Latest commit

 

History

History
248 lines (175 loc) · 7.14 KB

PlayoffsApi.md

File metadata and controls

248 lines (175 loc) · 7.14 KB
Raw

cfbd.PlayoffsApi

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

Method HTTP request Description
get_cfp_games GET /playoffs/cfp/games
get_cfp_participants GET /playoffs/cfp/participants
get_cfp_playoff GET /playoffs/cfp

get_cfp_games

List[PlayoffMatchup] get_cfp_games(year, round=round)

Retrieves College Football Playoff matchups for a season

Example

  • Bearer Authentication (apiKey):
import time
import os
import cfbd
from cfbd.models.playoff_matchup import PlayoffMatchup
from cfbd.models.playoff_round import PlayoffRound
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.PlayoffsApi(api_client)
    year = 56 # int | Required year filter
    round = cfbd.PlayoffRound() # PlayoffRound | Optional playoff round filter (optional)

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

Parameters

Name Type Description Notes
year int Required year filter
round PlayoffRound Optional playoff round filter [optional]

Return type

List[PlayoffMatchup]

Authorization

apiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Ok -
400 Validation error -
404 -

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

get_cfp_participants

List[PlayoffParticipant] get_cfp_participants(year)

Retrieves College Football Playoff participants for a season

Example

  • Bearer Authentication (apiKey):
import time
import os
import cfbd
from cfbd.models.playoff_participant import PlayoffParticipant
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.PlayoffsApi(api_client)
    year = 56 # int | Required year filter

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

Parameters

Name Type Description Notes
year int Required year filter

Return type

List[PlayoffParticipant]

Authorization

apiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Ok -
400 Validation error -
404 -

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

get_cfp_playoff

CfpPlayoff get_cfp_playoff(year)

Retrieves the complete College Football Playoff bracket for a season

Example

  • Bearer Authentication (apiKey):
import time
import os
import cfbd
from cfbd.models.cfp_playoff import CfpPlayoff
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.PlayoffsApi(api_client)
    year = 56 # int | Required year filter

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

Parameters

Name Type Description Notes
year int Required year filter

Return type

CfpPlayoff

Authorization

apiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Ok -
400 Validation error -
404 -

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