beatsaver-api - A BeatSaver API Wrapper

Installation

npm install beatsaver-api

Example Usage

const BeatSaverAPI = require('beatsaver-api');

const api = new BeatSaverAPI({
    AppName: 'Application Name',
    Version: '1.0.0'
});

api.getMapByID('ID').then(map => {}).catch(err => {});
api.getMapByHash('hash').then(map => {}).catch(err => {});
api.getMapsByUploader(userID, page?).then(searchResult => {}).catch(err => {});
api.getLatestMaps(automapper, before?).then(searchResult => {}).catch(err => {});

api.searchMaps(searchOptions, page?).then(searchResult => {}).catch(err => {});

You need to make sure that the App Version on the BeatSaverAPI constructor is valid SemVer

Important Notes

While using this library with Node.js, all requests made to BeatSaver are made with the User-Agent AppName/Version (so, in the example case, the User-Agent sent to BeatSaver will be Application Name/1.0.0). However, if you're using this library on a browser, the requests will use your browser's User-Agent.

Help

If you need help using this module or if you found an error with it, you can always contact me on my Discord Server

Search can't find map

I think there is something wrong with using params with axios.

Raw request URL https://api.beatsaver.com/search/text/0?q=Bad%20Romance%20Lady%20Gaga&sortOrder=Relevance

Using

(await axios.get('https://api.beatsaver.com/search/text/0', {
  params: { q: 'Bad%20Romance%20Lady%20Gaga', sortOrder: 'Relevance' },
})).data

yields

{ docs: [] }

Using

(await axios.get(
  'https://api.beatsaver.com/search/text/0?q=Bad%20Romance%20Lady%20Gaga&sortOrder=Relevance'
)).data

yields

{
  docs: [
    {
      id: 'fcad',
      name: 'Lady Gaga - Bad Romance (Short Ver.)',
      description: 'Lady Gaga - Bad Romance (Short Ver.)\n' +
        'Preview : https://www.bilibili.com/video/BV1A541177Qb/',
      uploader: [Object],
      metadata: [Object],
      stats: [Object],
      uploaded: '2020-10-10T06:42:40.442Z',
      automapper: false,
      ranked: false,
      qualified: false,
      versions: [Array],
      createdAt: '2020-10-10T06:42:40.442Z',
      updatedAt: '2020-10-10T06:42:40.442Z',
      lastPublishedAt: '2020-10-10T06:42:40.442Z'
    },
    {
      id: '1f571',
      name: 'Sweet but Bad Romance',
      description: 'Remix of Sweet but Psycho (Ava Max) and Bad Romance (Lady Gaga)\n',
      uploader: [Object],
      metadata: [Object],
      stats: [Object],
      uploaded: '2021-12-29T05:36:10.101380Z',
      automapper: false,
      ranked: false,
      qualified: false,
      versions: [Array],
      createdAt: '2021-12-29T05:34:55.176899Z',
      updatedAt: '2021-12-30T07:00:51.591270Z',
      lastPublishedAt: '2021-12-30T07:00:51.591270Z'
    },
    {
      id: '106b0',
      name: 'Lady Gaga: Bad Romance',
      description: 'Updated (Fixed a few bad beats). This is my first map. Took me about 12 hours. Any feedback I would greatly appreciate or if you want to improve it, message me.',
      uploader: [Object],
      metadata: [Object],
      stats: [Object],
      uploaded: '2020-10-31T02:40:51.745Z',
      automapper: false,
      ranked: false,
      qualified: false,
      versions: [Array],
      createdAt: '2020-10-31T02:40:51.745Z',
      updatedAt: '2020-10-31T02:40:51.745Z',
      lastPublishedAt: '2020-10-31T02:40:51.745Z'
    }
  ]
}

franciscoribeiro03 / beatsaver-api Goto Github PK

beatsaver-api's Introduction

beatsaver-api - A BeatSaver API Wrapper

Installation

Example Usage

Important Notes

Help

beatsaver-api's People

Stargazers

Watchers

Forkers

beatsaver-api's Issues

Search can't find map

Recommend Projects

React

Vue.js

Typescript

TensorFlow

Django

Laravel

D3

Recommend Topics

javascript

web

server

Machine learning

Visualization

Game

Recommend Org

Facebook

Microsoft

Google

Alibaba

D3

Tencent