Skip to main content

Async NBA statistics API client

Project description

fastbreak

PyPI Python License CI

Async Python client for the NBA Stats API, fully typed with Pydantic. Pandas and polars exports are optional.

Installation

Requires Python 3.12+.

pip install fastbreak

With DataFrame support:

pip install fastbreak pandas   # or polars

Quick Start

import asyncio
from fastbreak.clients import NBAClient
from fastbreak.endpoints import LeagueStandings

async def main():
    async with NBAClient() as client:
        standings = await client.get(LeagueStandings(season="2025-26"))

        for team in standings.standings[:5]:
            print(f"{team.team_name}: {team.wins}-{team.losses}")

asyncio.run(main())

Convert to DataFrame

from fastbreak.models import TeamStanding

# To pandas
df = TeamStanding.to_pandas(standings.standings)

# To polars
df = TeamStanding.to_polars(standings.standings)

Batch Requests

Fetch multiple endpoints concurrently with get_many():

from fastbreak.clients import NBAClient
from fastbreak.endpoints import BoxScoreTraditional

game_ids = ["0022500001", "0022500002", "0022500003"]

async with NBAClient() as client:
    results = await client.get_many(
        [BoxScoreTraditional(game_id=gid) for gid in game_ids],
        max_concurrency=5,
    )

Results come back in the same order as the input. If any request fails, all in-flight requests are cancelled and an ExceptionGroup is raised.

Caching

Pass cache_ttl to avoid hitting the API twice for the same response:

from fastbreak.clients import NBAClient
from fastbreak.endpoints import LeagueStandings

async with NBAClient(cache_ttl=300, cache_maxsize=256) as client:
    result = await client.get(LeagueStandings(season="2025-26"))  # cached for 5 min
    print(client.cache_info)  # {'size': 1, 'maxsize': 256, 'ttl': 300}
    await client.clear_cache()

Features

  • Async I/O via aiohttp (asyncio only)
  • Strict mypy typing
  • Pydantic models for all responses, with pandas/polars export
  • Retries and rate-limit handling built in
  • get_many() for concurrent batch requests
  • Optional TTL response caching
  • Pure-computation analytics: BPM, VORP, PER, true shooting, win shares, Pythagorean wins

Utility Modules

Skip the endpoint boilerplate for common operations. Import directly and pass client as the first argument.

Data Access

Module Key Functions
fastbreak.players search_players, get_player_game_log, get_player_stats, get_league_leaders
fastbreak.teams search_teams, get_team_stats, get_team_game_log, get_lineup_stats
fastbreak.games get_todays_games, get_games_on_date, get_box_scores, get_play_by_play
fastbreak.standings get_standings, get_conference_standings, magic_number
fastbreak.schedule get_team_schedule, is_back_to_back, travel_distance, schedule_density
fastbreak.seasons get_season_from_date, season_start_year — sync, no client needed

Shooting & Defense

Module Key Functions
fastbreak.shots get_shot_chart, zone_breakdown, shot_quality_vs_league, xfg_pct
fastbreak.defense get_team_defense_zones, get_team_opponent_stats, defensive_shot_quality_vs_league
fastbreak.tracking get_player_tracking_profile, get_team_tracking_profile, get_player_shot_defense

Matchups, Lineups & Rotations

Module Key Functions
fastbreak.matchups get_primary_defenders, get_defensive_assignments, get_team_matchup_summary
fastbreak.lineups get_league_lineups, get_top_lineups, get_two_man_combos, get_lineup_efficiency
fastbreak.rotations get_game_rotations, get_rotation_summary, lineup_stints, minutes_distribution

Analytics & Comparison

Module Key Functions
fastbreak.metrics bpm, vorp, per, true_shooting, usage_pct, pythagorean_win_pct
fastbreak.compare get_player_comparison, comparison_deltas, comparison_edges, stat_leader
fastbreak.clutch get_player_clutch_profile, get_league_clutch_leaders, clutch_score
fastbreak.estimated get_player_estimated_metrics, get_team_estimated_metrics, get_estimated_leaders
fastbreak.splits get_player_splits_profile, get_team_splits_profile
fastbreak.hot_hand get_hot_hand_stats, hot_hand_result, miller_sanjurjo_bias, extract_shot_sequences
fastbreak.transition get_transition_stats, classify_possessions, transition_frequency, transition_efficiency
from fastbreak.players import search_players, get_player_game_log
from fastbreak.games import get_todays_games

async with NBAClient() as client:
    players = await search_players(client, "Jokić")
    log     = await get_player_game_log(client, player_id=players[0].person_id)
    games   = await get_todays_games(client)

Available Endpoints

Over 115 endpoints covering:

Category Examples
Box Scores BoxScoreTraditional, BoxScoreAdvanced, BoxScoreFourFactors, BoxScorePlayerTrack, BoxScoreHustle, BoxScoreMatchups
Players PlayerCareerStats, PlayerGameLogs, PlayerDashboardByClutch, PlayerEstimatedMetrics
Teams TeamDetails, TeamGameLog, TeamPlayerDashboard, TeamEstimatedMetrics
League LeagueStandings, LeagueLeaders, LeagueGameLog, LeagueDashLineups
Tracking PlayerDashPtShots, PlayerDashPtPass, PlayerDashPtReb, PlayerDashPtShotDefend
Matchups BoxScoreMatchupsV3, LeagueSeasonMatchups, MatchupsRollup, PlayerVsPlayer
Shooting ShotChartDetail, ShotChartLeaguewide, LeagueDashTeamShotLocations
Play-by-Play PlayByPlay, GameRotation
Hustle HustleStatsBoxscore, LeagueHustleStatsPlayer, LeagueHustleStatsTeam
Splits PlayerDashboardByGeneralSplits, PlayerDashboardByShootingSplits, TeamDashboardByGeneralSplits
Draft DraftHistory, DraftCombineStats, DraftCombineDrillResults

See fastbreak.endpoints for the full list.

Contributing

See CONTRIBUTING.md for development setup and guidelines.

License

MIT License - see LICENSE for details.

Stargazers

Stargazers

Project details


Download files

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

Source Distribution

fastbreak-0.3.5.tar.gz (832.8 kB view details)

Uploaded Source

Built Distribution

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

fastbreak-0.3.5-py3-none-any.whl (398.7 kB view details)

Uploaded Python 3

File details

Details for the file fastbreak-0.3.5.tar.gz.

File metadata

  • Download URL: fastbreak-0.3.5.tar.gz
  • Upload date:
  • Size: 832.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.26 {"installer":{"name":"uv","version":"0.11.26","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for fastbreak-0.3.5.tar.gz
Algorithm Hash digest
SHA256 1f2540d39ac0386285e80d92596959eeb7101de5c6dbf773d812d001c0d02c10
MD5 8de0c59c6a1678a867451007a4b2ed35
BLAKE2b-256 ee07cabb63495a57f4004d10a6f156f4d9f74ea3536b580a5b458e7a01adc858

See more details on using hashes here.

File details

Details for the file fastbreak-0.3.5-py3-none-any.whl.

File metadata

  • Download URL: fastbreak-0.3.5-py3-none-any.whl
  • Upload date:
  • Size: 398.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.26 {"installer":{"name":"uv","version":"0.11.26","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for fastbreak-0.3.5-py3-none-any.whl
Algorithm Hash digest
SHA256 109edb5c71fc02e0576e9955585fa2713148ddabf60b08dee15007fd6d84f5be
MD5 cefe3b5f64f4be66a9e8bbe158e8b8c5
BLAKE2b-256 26d935808b1f078b0efc9d9474fac7cd38ea805d61c9d9d51e36e21c2ad77aaa

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page