Skip to content
cyperdark edited this page May 9, 2022 · 1 revision

Return list of beatmaps for specified user

Authentication

const { auth } = require('osu-api-extended')
auth.set_v1(api_key)

Function

await v1.beatmap.creator()

Parameters

Parameter Type Description
id number id of the user
mode string osu or fruits or mania or taiko
converted string 0 or 1
hash string beatmap file hash
limit string Maximum number of results
mods string/number Name of the mods HDDT or mods number 72
since string Return all beatmaps ranked or loved since this date. Must be a MySQL date. In UTC

Response

export interface response {
  id: {
    set: number
    diff: number
  }
  date: {
    submit: string
    approved: string
    update: string
  }
  metadata: {
    artist: {
      original: string
      unicode: string
    }
    title: {
      original: string
      unicode: string
    }
    creator: {
      id: number
      name: string
    }
    favs: number
    rating: number
    source: string
    genre_id: {
      id: number
      name: string
    }
    language_id: {
      id: number
      name: string
    }
    tags: string
  }
  status: {
    id: number
    name: string
  }
  difficulties: {
    id: number
    diff: string
    mode: {
      id: number
      name: string
    }
    file_md5: string
    stats: {
      star: {
        pure: number
        aim: number
        speed: number
      }
      ar: number
      od: number
      cs: number
      hp: number
      bpm: {
        avg: number
      }
      combo: number
      time: {
        full: number
        drain: number
      }
      objects: {
        all: number
        circles: number
        sliders: number
        spinners: number
      }
    }
    plays: number
    pass: number
  }
  misc: {
    download_unavailable: boolean
    audio_unavailable: boolean
    storyboard: boolean
    video: boolean
    packs: string
    bg: {
      full: string
      raw: string
      slim: {
        1: string
        2: string
      }
      cover: {
        1: string
        2: string
      }
      card: {
        1: string
        2: string
      }
      list: {
        1: string
        2: string
      }
    }
  }
}

[v3.x.x] Documentation


[v2.x.x] Documentation

Clone this wiki locally