Home

Info

Welcome to the beatsaver-api-wrapper wiki! Here you can find all the documentation for beatsaver-api-wrapper. If you find something wrong with the documentation or want some more info on methods or other stuff you can open an issue, create a discussion or contact me.

Installation

The package is available on npm. You can install it using this command:

npm install beatsaver-api-wrapper

Example

import BeatSaverAPI from "beatsaver-api-wrapper";

var bsAPI = new BeatSaverAPI("bsAPIExample/1.0");

var response = await bsAPI.getMapInfo("9e11");

console.log(response);

Documentation

For more detailed information see the BeatSaver API documentation.

• Maps API
• Search API
• Users API
• Vote API
• Playlists API
• Responses

API Information

Data is provided by the BeatSaver Public API (api.beatsaver.com).
This API wrapper is based on the BeatSaver API documentation.

The API wrapper only uses axios as a dependency for maximum compatibility with NodeJS or webbrowsers.
Other helper methods will be added later. This is to get data easier instead of the raw API data but raw data will always be an option.
Browser compatibility has not been tested yet but it should work.

Dependencies

Main dependency

• axios - Make HTTP requests

Test dependencies

• mocha - API wrapper tests
• nock - Test network errors

Testing

1. Clone github repository. git clone https://github.com/martin0300/beatsaver-api-wrapper for beta git clone -b beta https://github.com/martin0300/beatsaver-api-wrapper
2. Run npm i to install all dependencies.
3. Run npm test to run all tests. Do not spam this command! You will get rate limited by BeatSaver.
   • If you want to run specific tests open test/test.mjs and put .only after your specific test method. For more info: https://mochajs.org/#exclusive-tests

Contact info

• E-mail: martin0300a@gmail.com
• Website: https://martin0300.github.io
• Github: https://github.com/martin0300