From 0701ef19d2ba573cc602742d24d0a92ea29bdae6 Mon Sep 17 00:00:00 2001
From: nprasad2077 <114438461+nprasad2077@users.noreply.github.com>
Date: Wed, 20 Sep 2023 00:00:01 -0500
Subject: [PATCH] usage and readme
---
README.md | 51 ++++++++++++++++++++++++++-------------------------
USAGE.md | 5 +++++
2 files changed, 31 insertions(+), 25 deletions(-)
create mode 100644 USAGE.md
diff --git a/README.md b/README.md
index 6daf3fc..bd42e92 100644
--- a/README.md
+++ b/README.md
@@ -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)
-
-
---
-
### Base URL
All URLs referenced in this documentation use the following base URL:
-> https://nba-stats-db.herokuapp.com/
+>
### Endpoints
Top 20 Scorers by Season
Method: `Get`
-> https://nba-stats-db.herokuapp.com/api/playerdata/topscorers/total/season/2023/
+>
Success Response:
`Code: 200`
Content:
+
```
{
"count": 20,
@@ -101,22 +99,23 @@ Content:
"team": "PHI",
"season": 2023
},
- ...
- ]
-}
+ ...
+ ]
+}
```
Top 20 Scorers in Playoffs
Method: `Get`
-> https://nba-stats-db.herokuapp.com/api/playerdata/topscorers/playoffs/2022/
+>
Success Response:
`Code: 200`
Content:
+
```
{
"count": 20,
@@ -187,22 +186,23 @@ Content:
"team": "GSW",
"season": 2022
},
- ...
- ]
-}
+ ...
+ ]
+}
```
Top 20 Assists by Season
Method: `Get`
-> https://nba-stats-db.herokuapp.com/api/top_assists/totals/2023/
+>
Success Response:
`Code: 200`
Content:
+
```
{
"count": 20,
@@ -273,23 +273,23 @@ Content:
"team": "DEN",
"season": 2023
},
- ...
- ]
-}
+ ...
+ ]
+}
```
Top 20 Assists in Playoffs
Method: `Get`
-> https://nba-stats-db.herokuapp.com/api/top_assists/playoffs/2022/
-
+>
Success Response:
`Code: 200`
Content:
+
```
{
"count": 20,
@@ -360,22 +360,23 @@ Content:
"team": "GSW",
"season": 2022
},
- ...
- ]
-}
+ ...
+ ]
+}
```
Top 20 Rebounders (Total Rebounds) by Season
Method: `Get`
-> https://nba-stats-db.herokuapp.com/api/top_rebounds/totals/2023/
+>
Success Response:
`Code: 200`
Content:
+
```
{
"count": 20,
@@ -446,9 +447,9 @@ Content:
"team": "CHI",
"season": 2023
},
- ...
- ]
-}
+ ...
+ ]
+}
```
diff --git a/USAGE.md b/USAGE.md
new file mode 100644
index 0000000..5a0fbf2
--- /dev/null
+++ b/USAGE.md
@@ -0,0 +1,5 @@
+# Activate Python Shell
+
+```
+source venv/bin/activate
+```