/nba_api

An API Client package to access the APIs for NBA.com

Primary LanguagePythonMIT LicenseMIT

PyPI CircleCI (all branches) GitHub

nba_api

An API Client package to access the APIs for NBA.com

Development Version: v1.0.7

nba_api is an API Client for www.nba.com. This package is meant to make the API Endpoints more accessible and to provide extensive documentation.

The APIs on www.nba.com are largely undocumented and change frequently.

Please feel free to contribute and have an open discussion regarding improvements and additional APIs to be mapped.

Mapped API Clients

  1. stats.nba.com - stats

Installation

pip install nba_api

Contributing

Development

To get started developing, clone the repo and cd into it. Then, in an environment (conda or virtualenv) where you have not yet installed nba_api, run

python -m pip install -e .

This command will install the package for development, such that any changes you make in the repo will be reflected the next time you import the package in Python.

Testing

TODO

Required and Optional Packages

Endpoint Analysis

A major purpose of this package is to map and analyze as many endpoints on NBA.com as possible. The documentation and analysis on the Endpoints and Parameters found in this package is some of the most extensive information available on these largely undocumented Endpoints. Please open an issue with any additional Endpoints/APIs.

Endpoint Analysis JSON for use with other clients

Usage Examples

Documentation