Skip to content

Latest commit

 

History

History
73 lines (53 loc) · 2.45 KB

CoachesApi.md

File metadata and controls

73 lines (53 loc) · 2.45 KB
Raw

cfbd.CoachesApi

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

Method HTTP request Description
get_coaches GET /coaches Coaching records and history

get_coaches

list[Coach] get_coaches(first_name=first_name, last_name=last_name, team=team, year=year, min_year=min_year, max_year=max_year)

Coaching records and history

Coaching history

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.CoachesApi(cfbd.ApiClient(configuration))
first_name = 'first_name_example' # str | First name filter (optional)
last_name = 'last_name_example' # str | Last name filter (optional)
team = 'team_example' # str | Team name filter (optional)
year = 56 # int | Year filter (optional)
min_year = 56 # int | Minimum year filter (inclusive) (optional)
max_year = 56 # int | Maximum year filter (inclusive) (optional)

try:
    # Coaching records and history
    api_response = api_instance.get_coaches(first_name=first_name, last_name=last_name, team=team, year=year, min_year=min_year, max_year=max_year)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CoachesApi->get_coaches: %s\n" % e)

Parameters

Name Type Description Notes
first_name str First name filter [optional]
last_name str Last name filter [optional]
team str Team name filter [optional]
year int Year filter [optional]
min_year int Minimum year filter (inclusive) [optional]
max_year int Maximum year filter (inclusive) [optional]

Return type

list[Coach]

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]