Skip to content

RatingsApi.md

Latest commit

 

History

History
251 lines (178 loc) · 8.15 KB

RatingsApi.md

File metadata and controls

251 lines (178 loc) · 8.15 KB
Raw

cbbd.RatingsApi

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

Method HTTP request Description
get_adjusted_efficiency GET /ratings/adjusted
get_elo GET /ratings/elo
get_srs GET /ratings/srs

get_adjusted_efficiency

List[AdjustedEfficiencyInfo] get_adjusted_efficiency(season=season, team=team, conference=conference)

Returns adjusted offensive and defensive efficiency ratings.

Example

  • Bearer Authentication (apiKey):
import time
import os
import cbbd
from cbbd.models.adjusted_efficiency_info import AdjustedEfficiencyInfo
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.RatingsApi(api_client)
    season = 56 # int | Filters results to the specified season. (optional)
    team = 'team_example' # str | Filters results to the specified team name. (optional)
    conference = 'conference_example' # str | Filters results to the specified conference abbreviation. (optional)

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

Parameters

Name Type Description Notes
season int Filters results to the specified season. [optional]
team str Filters results to the specified team name. [optional]
conference str Filters results to the specified conference abbreviation. [optional]

Return type

List[AdjustedEfficiencyInfo]

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_elo

List[TeamElo] get_elo(season=season, team=team, conference=conference)

Returns historical Elo ratings.

Example

  • Bearer Authentication (apiKey):
import time
import os
import cbbd
from cbbd.models.team_elo import TeamElo
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.RatingsApi(api_client)
    season = 56 # int | Filters results to the specified season. (optional)
    team = 'team_example' # str | Filters results to the specified team name. (optional)
    conference = 'conference_example' # str | Filters results to the specified conference abbreviation. (optional)

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

Parameters

Name Type Description Notes
season int Filters results to the specified season. [optional]
team str Filters results to the specified team name. [optional]
conference str Filters results to the specified conference abbreviation. [optional]

Return type

List[TeamElo]

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_srs

List[SrsInfo] get_srs(season=season, team=team, conference=conference)

Returns Simple Rating System (SRS) ratings.

Example

  • Bearer Authentication (apiKey):
import time
import os
import cbbd
from cbbd.models.srs_info import SrsInfo
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.RatingsApi(api_client)
    season = 56 # int | Filters results to the specified season. (optional)
    team = 'team_example' # str | Filters results to the specified team name. (optional)
    conference = 'conference_example' # str | Filters results to the specified conference abbreviation. (optional)

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

Parameters

Name Type Description Notes
season int Filters results to the specified season. [optional]
team str Filters results to the specified team name. [optional]
conference str Filters results to the specified conference abbreviation. [optional]

Return type

List[SrsInfo]

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]