chickenstats-api

API for downloading NHL data

• API version: 0.1.8
• Package version: 0.1.8

Requirements

Python 3.9+

Installation

pip install chickenstats-api

import chickenstats_api

Getting Started

import chickenstats_api
from chickenstats_api.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.chickenstats.com
# See configuration.py for a list of all supported configuration parameters.
configuration = chickenstats_api.Configuration(
    host = "https://api.chickenstats.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.

configuration.access_token = os.environ["ACCESS_TOKEN"]


# Enter a context with an instance of the API client
with chickenstats_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = chickenstats_api.ChangesApi(api_client)
    limit = 10000 # int |  (optional) (default to 10000)
    offset = 0 # int |  (optional) (default to 0)
    with_total = True # bool | Include the exact total row count. Set false on broad queries: the count scans every matching row, which on a season-wide filter costs far more than the page itself. `total` is then -1 and `has_next` still works. (optional) (default to True)
    season = [56] # List[int] |  (optional)
    sessions = ['sessions_example'] # List[str] |  (optional)
    game_id = [56] # List[int] |  (optional)
    event_team = ['event_team_example'] # List[str] |  (optional)
    period = [56] # List[int] |  (optional)
    include = ['include_example'] # List[str] |  (optional)

    try:
        # Read Changes
        api_response = api_instance.read_changes(limit=limit, offset=offset, with_total=with_total, season=season, sessions=sessions, game_id=game_id, event_team=event_team, period=period, include=include)
        print("The response of ChangesApi->read_changes:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ChangesApi->read_changes: %s\n" % e)

Documentation for API Endpoints

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

Documentation For Models

• ChangesPublic
• ChangesResponse
• GamePublic
• GameResponse
• HTTPValidationError
• IdToken
• LinesCreate
• LinesGame
• LinesGameResponse
• LinesPublic
• LinesSeason
• LinesSeasonResponse
• LiveGamesPublic
• LivePbpPublic
• LivePbpResponse
• Message
• NewPassword
• PbpPublic
• PbpResponse
• PlayerPublic
• PlayerResponse
• PredGoalResponse
• PredGoalRow
• ProgrammaticCredentials
• RapmResponse
• RapmScores
• RefreshTokenRequest
• RosterPublic
• RosterResponse
• ShiftsPublic
• ShiftsResponse
• StandingsPublic
• StandingsResponse
• StatsCreate
• StatsGame
• StatsGameResponse
• StatsSeason
• StatsSeasonResponse
• TeamPublic
• TeamResponse
• TeamStatsCreate
• TeamStatsGame
• TeamStatsGameResponse
• TeamStatsPublic
• TeamStatsSeason
• TeamStatsSeasonResponse
• Token
• UpdatePassword
• UserCreate
• UserPublic
• UserRegister
• UserUpdate
• UserUpdateMe
• UsersPublic
• ValidationError
• ValidationErrorLocInner

Documentation For Authorization

Authentication schemes defined for the API:

OAuth2PasswordBearer

• Type: OAuth
• Flow: password
• Authorization URL:
• Scopes: N/A

Author

chicken@chickenandstats.com