Skip to content

Latest commit

 

History

History
102 lines (60 loc) · 2.16 KB

README.md

File metadata and controls

102 lines (60 loc) · 2.16 KB

Nba News Api

About

https://nba-stories.onrender.com/

Api providing endpoints that allow for:

  • Getting latest nba articles from sports sites espn, slam, yahoo, bleacher report and nba
  • Getting latest nba articles by sports sites
  • Getting latest nba articles by player
  • Getting latest nba articles by team

Install

git clone https://github.com/kevinn03/nba_api.git

npm install

npm run dev

localhost:8000

Endpoint Documentation

GET /articles

Returns a list of all the latest nba articles.

Optional params:

  • source returns articles based on chose source

    options: nba-canada, nba, bleacher-report, yahoo, espn, slam

    Example /articles?source=bleacher-report

  • team returns articles based on chosen team

    Example /articles?team=lakers

  • limit returns the maximum number of articles desired

    Example /articles?limit=5

  • player returns articles based on chosen player

    Use dash to seperate names

    Searching by players full name seperated by dash produces best results

    Example /articles?player=kevin-durant&limit=10

Successful Response:

[
{
title: "Heat Sign Mario Chalmers",
url: "https://bleacherreport.com/articles/10022498-mario-chalmers-heat-agree-to-10-day-contract-won-2-championships-with-miami",
source: "bleacherreport"
},
{
title: "raptors-clippers-game-preview-channel-injury-report",
url: "https://ca.nba.com/news/raptors-clippers-game-preview-channel-injury-report/wd09hzt1cqa1160vk9qanglf2",
source: "nba"
},
{
title: "raptors-76ers-game-preview-channel-postponement-news",
url: "https://ca.nba.com/news/raptors-76ers-game-preview-channel-postponement-news/os7dkg8vx7ae1upt6z2w59g3b",
source: "nba"
},
]

To Do:

Dependencies

[axios] (https://www.npmjs.com/package/axios)

[cheerio] (https://www.npmjs.com/package/cheerio) Cheerio parses markup and provides an API for traversing/manipulating the resulting data structure

[express] (https://www.npmjs.com/package/express)
Simple, robust web framework for Node

[nodemon] (https://www.npmjs.com/package/nodemon)
Performs hot reloading of the application

Author

👤 Kevin Nguyen