Skip to content

README.md

Latest commit

 

History

History
52 lines (35 loc) · 1.47 KB

README.md

File metadata and controls

52 lines (35 loc) · 1.47 KB

Forked Version of the Unofficial API for Backloggd written in Typescript.

Original at Qewertyy/Backloggd-API

This version adds a "currently playing" object to the API response.

Deploy Locally

To use this API, you will need Node.js and npm installed on your machine. You can install the necessary dependencies by running:

git clone https://github.com/bobmatyas/Backloggd-API && cd Backloggd-API && npm i && npm start

Usage

Endpoint

for now only this endpoint has been added

  • GET /user/:username

    • Retrieves information for the specified user.

  • POST /user/:username

    • Retrieves information for the specified user.

Request Parameters

  • username: The username of the user to retrieve information for.

Response

The API returns a JSON response with the following structure:

{
  "message": "success",
  "code": 2,
  "content": {
    // User information object
  }
}

In case of an error, the response will include an appropriate error message along with the HTTP status code.

Error Handling

If the username is not provided or if there's an error retrieving the user information, the API will respond with an error message and an appropriate HTTP status code.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Disclaimer

This API is unofficial and is not affiliated with the official web service.