Giter VIP home page Giter VIP logo

nba-api-rest's Introduction

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

nba-api-rest's People

Contributors

franpanozzo avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.