swar / nba_api

An API Client package to access the APIs for NBA.com
MIT License
2.54k stars 542 forks source link

Proposal: Add Documentation for game_id Parameter in parameters.md #455

Open gmortensen opened 3 months ago

gmortensen commented 3 months ago

The parameters.md file includes a section for the game_id parameter but currently lacks detailed information. To improve clarity and usability, the following details could be added:

Expected Format: The game_id should be a 10-digit number. The expected format can be validated using the regex ^\d{10}$.

Meaning of the Third Digit: The third digit in the game_id indicates the type of season. Here are the details:

1: Preseason game 2: Regular season game 3: All-Star weekend game 4: Playoff game 5: Play-in game

Examples:

0022200147: Regular season game (third digit is 2) 0012200147: Preseason game (third digit is 1)

Proposal: Update the game_id section in the parameters.md file to include the expected format and an explanation of the third digit's significance.

gmortensen commented 3 months ago

NBA API Version V1.5.0