usage and readme

This commit is contained in:
nprasad2077 committed 2023-09-20 00:00:01 -05:00
1 parent 3558b1c154
commit 0701ef19d2
2 files changed
+16 -10

No files matched your search

+11 -10
View File
@@ -8,29 +8,27 @@ This documentation provides the necessary information to use the NBA Stats API.
# [View API Documentation](https://documenter.getpostman.com/view/24232555/2s93shzpR3) # [View API Documentation](https://documenter.getpostman.com/view/24232555/2s93shzpR3)
--- ---
### Base URL ### Base URL
All URLs referenced in this documentation use the following base URL: All URLs referenced in this documentation use the following base URL:
> https://nba-stats-db.herokuapp.com/ > <https://nba-stats-db.herokuapp.com/>
### Endpoints ### Endpoints
Top 20 Scorers by Season Top 20 Scorers by Season
Method: `Get` Method: `Get`
> https://nba-stats-db.herokuapp.com/api/playerdata/topscorers/total/season/2023/ > <https://nba-stats-db.herokuapp.com/api/playerdata/topscorers/total/season/2023/>
Success Response: Success Response:
`Code: 200` `Code: 200`
Content: Content:
``` ```
{ {
"count": 20, "count": 20,
@@ -110,13 +108,14 @@ Content:
Top 20 Scorers in Playoffs Top 20 Scorers in Playoffs
Method: `Get` Method: `Get`
> https://nba-stats-db.herokuapp.com/api/playerdata/topscorers/playoffs/2022/ > <https://nba-stats-db.herokuapp.com/api/playerdata/topscorers/playoffs/2022/>
Success Response: Success Response:
`Code: 200` `Code: 200`
Content: Content:
``` ```
{ {
"count": 20, "count": 20,
@@ -196,13 +195,14 @@ Content:
Top 20 Assists by Season Top 20 Assists by Season
Method: `Get` Method: `Get`
> https://nba-stats-db.herokuapp.com/api/top_assists/totals/2023/ > <https://nba-stats-db.herokuapp.com/api/top_assists/totals/2023/>
Success Response: Success Response:
`Code: 200` `Code: 200`
Content: Content:
``` ```
{ {
"count": 20, "count": 20,
@@ -282,14 +282,14 @@ Content:
Top 20 Assists in Playoffs Top 20 Assists in Playoffs
Method: `Get` Method: `Get`
> https://nba-stats-db.herokuapp.com/api/top_assists/playoffs/2022/ > <https://nba-stats-db.herokuapp.com/api/top_assists/playoffs/2022/>
Success Response: Success Response:
`Code: 200` `Code: 200`
Content: Content:
``` ```
{ {
"count": 20, "count": 20,
@@ -369,13 +369,14 @@ Content:
Top 20 Rebounders (Total Rebounds) by Season Top 20 Rebounders (Total Rebounds) by Season
Method: `Get` Method: `Get`
> https://nba-stats-db.herokuapp.com/api/top_rebounds/totals/2023/ > <https://nba-stats-db.herokuapp.com/api/top_rebounds/totals/2023/>
Success Response: Success Response:
`Code: 200` `Code: 200`
Content: Content:
``` ```
{ {
"count": 20, "count": 20,
+5
View File
@@ -0,0 +1,5 @@
# Activate Python Shell
```
source venv/bin/activate
```