Skip to content

Latest commit

 

History

History
55 lines (37 loc) · 1.31 KB

README.md

File metadata and controls

55 lines (37 loc) · 1.31 KB
Raw

WNBA and NCAAW Schedule API

image

This project is an simple API for returning WNBA and NCAAW schedules! The API fetches data from external sources and provides access to the processed data.

Built With

Getting Started

Prerequisites

  • Node.js
  • npm

Installing

  1. Clone the repository:
git clone https://github.com/lumamontes/wbb-games-api.git
  1. Navigate into the directory:
cd wbb-games-api
  1. Install the dependencies:
npm install

Usage

Start the local server:

npm run dev

API Endpoints

  • GET /schedule: Fetches the schedule for a given date and league. The league defaults to "ncaaw" and the date for today.

    Query parameters:

    • year: The year of the schedule you want to fetch. Example: 2022.
    • month: The month of the schedule you want to fetch. Example: 07.
    • day: The day of the schedule you want to fetch. Example: 15.
    • league: The league of the schedule you want to fetch. It can be either ncaaw or wnba, defaulting to ncaaw.

    Example: GET /schedule?year=2022&month=07&day=15&league=ncaaw

Any changes/suggestions are welcome :)