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

Return user details

Authentication

const { auth } = require('osu-api-extended');
await auth.login(client_id, client_secret);

Function

await v1.user.details()

Parameters

Parameter Type Description
user string id of the user
mode string osu or fruits or mania or taiko
type string u is a user_id or a username. Use string for usernames or id for user_ids
event_days string Max number of days between now and last event date. Range of 1-31. Optional, default value is 1

Response

export interface response {
  id: number;
  name: string;
  pp: number;
  acc: number;
  lvl: number;
  join: string;
  country: {
    flag: string;
    short: string;
    full: string;
  };
  play: {
    count: number;
    time: number;
  };
  hits: {
  50: number;
  100: number;
  300: number;
  };
  score: {
    total: number;
    ranked: number;
  };
  rank: {
    global: number;
    country: number;
  };
  ranks: {
    ssh: number;
    ss: number;
    sh: number;
    s: number;
    a: number;
  };
  events: {
    display: {
      html: string;
      pure: string;
    };
    id: {
      diff: number;
      set: number;
    };
    date: string;
    epicfactor: number;
  }[];
}

[v3.x.x] Documentation


[v2.x.x] Documentation

Clone this wiki locally