Beatsify

An API wrapper for Beatsify (Mino)

How to use it

Import

//Common
const mino = require("beatsify")

//Module
import mino from "beatsify"

Search

You can search beatmaps based on title, artist, rank and more!

/* 
    Optional
    query: artist, title, creator or tags - default: Newest
    mode: filter result by mode - default: -1 (All modes)
    ranked: filter result by rank status - default: [-3] (All statuses)
    filter: add custom filters - default: ""
    limit: limit result by x amount - default: 101
    offset: offset result by x amount - default: 0

    Bonus
    query: Newest | Get newest maps
    query: Top Rated | Get most favourited maps
    query: Most Played | Get most played maps
*/

Beatmaps

You can select single or multiple beatmaps with ease!

const beatmap = await mino.map(75)
const beatmaps = await mino.maps(75, 53)
const beatmapset = await mino.set(1)
const beatmapsets = await mino.sets(1, 3)

Download

You can also download beatmaps and osu files with pretty much no effort!

//returns either true or false depending on the success of the download
const mapDownload = await mino.download(1, "./downloads/maps") 
const osuDownload = await mino.osu(75, "./downloads/osu")

Status & Audio Preview

Check our status or let a preview url be generated for you

const status = await mino.status() //<- Receive information of Version and Location
const previewSetURL = mino.preview(1, true) //<- Receives preview of set (https://catboy.best/preview/audio/1?set=1)
const previewURL = mino.preview(75) //<- Receives preview of map (https://catboy.best/preview/audio/75)

Contribute

We would love to extend our functionality with you as contributer. If you got any ideas open a pull request and we see how we can implement it!