O S R S - R E L D O - A P I

Backend API for use with os-league-tools.

Development

1. Install packages:

   • npm install

2. Set up .env file:

   • Make a copy of /.env.example and rename it to /.env.development
   • Any fields with the value "example" will need to be replaced with valid values in order to function correctly. Not all routes need env vars.
     • /hiscores routes do not require any env vars
     • /feedback routes require all HEIGHT_* vars to be correctly filled out. See Height API documentation for more info on the keys and IDs used in task creation.

3. Start app:

   • npm run dev

4. API will be running at http://localhost:8080/

Usage

/hiscores

GET /hiscores/:rsn

Returns leagues hiscores for the given RSN, formatted as JSON using osrs-json-hiscores.

Use query param mode to get hiscores for a different gamemode. Valid options:

• seasonal (default)
• main
• ironman
• hardcore
• ultimate

/feedback

POST /feedback

Sends general feedback to Height #feedback list.

Request body:

{
  "description": string,
}

POST /feedback/suggestion

Sends a suggestion to Height #suggestions list.

Request body:

{
  "description": string,
}

POST /feedback/bug

Sends a bug report to Height #bugs list.

Request body:

{
  // Required
  "description": string,

  // Optional
  "reproSteps": string,
  "device": string,
  "client": string,
  "debugInfo": string,
}