chickenstats-api

API for downloading NHL data

  • API version: 0.1.7
  • Package version: 0.1.7

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)
    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)
    limit = 10000 # int |  (optional) (default to 10000)
    offset = 0 # int |  (optional) (default to 0)

    try:
        # Read Changes
        api_response = api_instance.read_changes(season=season, sessions=sessions, game_id=game_id, event_team=event_team, period=period, include=include, limit=limit, offset=offset)
        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

Class Method HTTP request Description
ChangesApi read_changes GET /api/v1/chicken_nhl/changes Read Changes
ChangesApi read_changes_game_ids GET /api/v1/chicken_nhl/changes/game_ids Read Changes Game Ids
GamesApi read_game GET /api/v1/chicken_nhl/games/{game_id} Read Game
GamesApi read_games GET /api/v1/chicken_nhl/games Read Games
InferenceApi read_pred_goal GET /api/v1/inference/pred_goal Read Pred Goal
LinesApi read_game_lines GET /api/v1/chicken_nhl/lines/game Read Game Lines
LinesApi read_lines_game_ids GET /api/v1/chicken_nhl/lines/game_ids Read Lines Game Ids
LinesApi read_lines_line_ids GET /api/v1/chicken_nhl/lines/line_ids Read Lines Line Ids
LinesApi read_season_lines GET /api/v1/chicken_nhl/lines/season Read Season Lines
LiveApi read_live_games GET /api/v1/live/games Read Live Games
LiveApi read_live_pbp GET /api/v1/live/play_by_play Read Live Pbp
LoginApi login_firebase_token POST /api/v1/login/firebase-token Login Firebase Token
LoginApi login_refresh POST /api/v1/login/refresh Login Refresh
LoginApi login_verify_token POST /api/v1/login/verify-token Login Verify Token
LoginApi recover_password POST /api/v1/password-recovery/{email} Recover Password
LoginApi recover_password_html_content POST /api/v1/password-recovery-html-content/{email} Recover Password Html Content
LoginApi reset_password POST /api/v1/reset-password/ Reset Password
LoginApi test_token POST /api/v1/login/test-token Test Token
PlayByPlayApi read_pbp GET /api/v1/chicken_nhl/play_by_play Read Pbp
PlayByPlayApi read_pbp_game_ids GET /api/v1/chicken_nhl/play_by_play/game_ids Read Pbp Game Ids
PlayByPlayApi read_pbp_play_ids GET /api/v1/chicken_nhl/play_by_play/play_ids Read Pbp Play Ids
PlayersApi read_player GET /api/v1/chicken_nhl/players/{api_id} Read Player
PlayersApi read_players GET /api/v1/chicken_nhl/players Read Players
RapmApi read_rapm GET /api/v1/chicken_nhl/rapm Read Rapm
RostersApi read_roster_game_ids GET /api/v1/chicken_nhl/rosters/game_ids Read Roster Game Ids
RostersApi read_rosters GET /api/v1/chicken_nhl/rosters Read Rosters
ShiftsApi read_shifts GET /api/v1/chicken_nhl/shifts Read Shifts
ShiftsApi read_shifts_game_ids GET /api/v1/chicken_nhl/shifts/game_ids Read Shifts Game Ids
StandingsApi read_standings GET /api/v1/chicken_nhl/standings Read Standings
StatsApi read_game_stats GET /api/v1/chicken_nhl/stats/game Read Game Stats
StatsApi read_season_stats GET /api/v1/chicken_nhl/stats/season Read Season Stats
StatsApi read_stats_game_ids GET /api/v1/chicken_nhl/stats/game_ids Read Stats Game Ids
TeamStatsApi read_game_team_stats GET /api/v1/chicken_nhl/team_stats/game Read Game Team Stats
TeamStatsApi read_season_team_stats GET /api/v1/chicken_nhl/team_stats/season Read Season Team Stats
TeamStatsApi read_team_stats_game_ids GET /api/v1/chicken_nhl/team_stats/game_ids Read Team Stats Game Ids
TeamStatsApi read_team_stats_ids GET /api/v1/chicken_nhl/team_stats/team_stats_ids Read Team Stats Ids
TeamsApi read_teams GET /api/v1/chicken_nhl/teams Read Teams
UsersApi delete_user_me DELETE /api/v1/users/me Delete User Me
UsersApi get_programmatic_credentials GET /api/v1/users/me/programmatic-credentials Get Programmatic Credentials
UsersApi read_user_me GET /api/v1/users/me Read User Me
UsersApi resend_verification POST /api/v1/users/me/resend-verification Resend Verification
UsersApi rotate_programmatic_credentials POST /api/v1/users/me/programmatic-credentials/rotate Rotate Programmatic Credentials
UsersApi signup POST /api/v1/users/signup Signup
UsersApi update_password_me PATCH /api/v1/users/me/password Update Password Me
UsersApi update_user_me PATCH /api/v1/users/me Update User Me

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

OAuth2PasswordBearer

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

Author

chicken@chickenandstats.com

Project links

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Latest release

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for chickenandstats from gravatar.com chickenandstats

Credits

Author: chicken

License expression

MIT
View SPDX License List

Requires

Python >=3.9

Tags

OpenAPI OpenAPI-Generator chickenstats API

Report project as malware

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

chickenstats_api-0.1.7.tar.gz (86.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

chickenstats_api-0.1.7-py3-none-any.whl (167.6 kB view details)

Uploaded Python 3

File details

Details for the file chickenstats_api-0.1.7.tar.gz.

File metadata

  • Download URL: chickenstats_api-0.1.7.tar.gz
  • Upload date:
  • Size: 86.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for chickenstats_api-0.1.7.tar.gz
Algorithm Hash digest
SHA256 11943a82df1fe21df843385085034cc914ba0ade2098b19b6f91506518d364ce
MD5 5ee64284bfe0acc54b750bc0b75c8839
BLAKE2b-256 089b9e2c886e4662dbdfea807d534a6f871ebb238c5468a26392fe882947bf4b

See more details on using hashes here.

Provenance

The following attestation bundles were made for chickenstats_api-0.1.7.tar.gz:

Publisher: publish.yml on chickenstats/chickenstats-api-python

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file chickenstats_api-0.1.7-py3-none-any.whl.

File metadata

File hashes

Hashes for chickenstats_api-0.1.7-py3-none-any.whl
Algorithm Hash digest
SHA256 5ca4ab50607a12c0879b2afe094d5b82340f2a1bae532a60904b9601c715ff83
MD5 743001847671da327da4cea6196b6560
BLAKE2b-256 a1e14d0232e54189e4ed123f157fd5bc0458ccfef2590d0831147d74c23ff1cc

See more details on using hashes here.

Provenance

The following attestation bundles were made for chickenstats_api-0.1.7-py3-none-any.whl:

Publisher: publish.yml on chickenstats/chickenstats-api-python

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

This release

0.1.7 This release

2 files

0.1.6

2 files

0.1.5

2 files

0.1.4

2 files

0.1.3

2 files

0.1.2

2 files

0.1.1

2 files

0.0.1

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page