Skip to content

Franpanozzo/nba-api-rest

Repository files navigation

NBA REST API

Open Source REST API for the best league in the world!

We are not affiliated, associated, authorized, endorsed by, or in any way officially connected with NBA, or any of its subsidiaries or its affiliates. The names NBA as well as related names, marks, emblems and images are registered trademarks of their respective owners.



Technologies used in this project:



Documentation

Run in Postman

Players

Get All Players

This endpoint retrieves all players from all seasons.

  • HTTP Request:

GET https://klqn0hf9bk.execute-api.us-east-1.amazonaws.com/prod/v1/players

  • Query parameters

Parameter Default Description
page 1 The page number used for pagination
limit 20 the number of results returned per call, used for pagination. Max 100
search Used to filter players based on their name. For example, ?search=davis will return players that have 'davis' in their first or last name.

Post Player

This endpoint let´s you post a new player (for example to upload a new draft class) - You need a special API-KEY to do this.

  • HTTP Request

POST https://klqn0hf9bk.execute-api.us-east-1.amazonaws.com/prod/v1/players

  • Body example

image

  • Headers

x-api-key: secretValue

Delete Player

This endpoint let's you delete a player (for example a player retires) - You need a special API-KEY to do this.

  • HTTP Request

DELETE https://klqn0hf9bk.execute-api.us-east-1.amazonaws.com/prod/v1/players/<ID>

  • URL Parameters

Parameter Description
ID ID of the player to Delete
  • Headers

x-api-key: secretValue

Teams

Get All Teams

This endpoint retrieves all teams for the current season.

  • HTTP Request

GET https://klqn0hf9bk.execute-api.us-east-1.amazonaws.com/prod/v1/teams

Get Specific Team

  • HTTP Request

GET https://klqn0hf9bk.execute-api.us-east-1.amazonaws.com/prod/v1/teams/<ID>

  • URL Parameters

Parameter Description
ID ID of the team to retrieve

About

🏀🗑️ RESTful API about the best league in the world!

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published