Skip to content

Latest commit

 

History

History
91 lines (64 loc) · 2.89 KB

RecruitingApi.md

File metadata and controls

91 lines (64 loc) · 2.89 KB

cbbd.RecruitingApi

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

Method HTTP request Description
get_recruits GET /recruiting/players

get_recruits

List[Recruit] get_recruits(year=year, team=team, conference=conference, position=position)

Retrieves historical composite player recruiting ranking and ratings

Example

  • Bearer Authentication (apiKey):
import time
import os
import cbbd
from cbbd.models.recruit import Recruit
from cbbd.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.collegebasketballdata.com
# See configuration.py for a list of all supported configuration parameters.
configuration = cbbd.Configuration(
    host = "https://api.collegebasketballdata.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 = cbbd.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with cbbd.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cbbd.RecruitingApi(api_client)
    year = 56 # int | Optional year filter (optional)
    team = 'team_example' # str | Optional college team filter (optional)
    conference = 'conference_example' # str | Optional college conference filter (optional)
    position = 'position_example' # str | Optional position filter (optional)

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

Parameters

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

Return type

List[Recruit]

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]