Skip to content
This repository has been archived by the owner on May 22, 2020. It is now read-only.

Latest commit

 

History

History
29 lines (19 loc) · 885 Bytes

README.md

File metadata and controls

29 lines (19 loc) · 885 Bytes

Welcome to the Listen.moe v3 Documentation

v4 is out. See the main documentation site

The list of public endpoints include:

  • POST /api/authenticate

Once authenticated, the following endpoints are available:

  • GET /api/user
  • GET /api/user/favorites
  • POST /api/songs/favorite
  • POST /api/songs/request

Every request that completes succesfully will return a json with the parameter success: true and different extra parameters depending on the endpoint.

If the request fails due to bad credentials, wrong song id, or any other reason then the parameter success will return false and a descriptive message indicating what went wrong.

Example:

{
	"success": false,
	"message": "invalid-password"
}

Note that all the POST requests need to be either json or application/x-www-form-urlencoded