Skip to content

RankingsApi.md

Latest commit

 

History

History
98 lines (71 loc) · 3.6 KB

RankingsApi.md

File metadata and controls

98 lines (71 loc) · 3.6 KB
Raw

cfbd.RankingsApi

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

Method HTTP request Description
get_rankings GET /rankings

get_rankings

List[PollWeek] get_rankings(year, season_type=season_type, week=week, poll=poll, latest=latest, final=final)

Returns historical poll rankings.

Example

  • Bearer Authentication (apiKey):
import time
import os
import cfbd
from cfbd.models.poll_week import PollWeek
from cfbd.models.ranking_poll import RankingPoll
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.RankingsApi(api_client)
    year = 56 # int | Season year.
    season_type = cfbd.SeasonType() # SeasonType | Season type. (optional)
    week = 3.4 # float | Poll week. (optional)
    poll = cfbd.RankingPoll() # RankingPoll | Poll name. (optional)
    latest = True # bool | Returns the latest CFP snapshot when `true`, preferring the snapshot marked as final. Requires `poll=cfp` and cannot be combined with `final`. (optional)
    final = True # bool | Returns the CFP snapshot marked as final when `true`. Requires `poll=cfp` and cannot be combined with `latest`. (optional)

    try:
        api_response = api_instance.get_rankings(year, season_type=season_type, week=week, poll=poll, latest=latest, final=final)
        print("The response of RankingsApi->get_rankings:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RankingsApi->get_rankings: %s\n" % e)

Parameters

Name Type Description Notes
year int Season year.
season_type SeasonType Season type. [optional]
week float Poll week. [optional]
poll RankingPoll Poll name. [optional]
latest bool Returns the latest CFP snapshot when `true`, preferring the snapshot marked as final. Requires `poll=cfp` and cannot be combined with `final`. [optional]
final bool Returns the CFP snapshot marked as final when `true`. Requires `poll=cfp` and cannot be combined with `latest`. [optional]

Return type

List[PollWeek]

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 -

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