v2.rooms.details_v3

GET /v2/rooms/{room}

async Retrieve a room by given parameters.

Usage example

const { auth, v2 } = require('osu-api-extended');

async function main() {
  try {
    await auth.login({
      type: 'lazer',
      login,
      password,
      cachedTokenPath: './test.json' // path to the file your auth token will be saved (to prevent osu!api spam)
    });

    const result = await v2.rooms.details({
      id: 582709,
    });
    if (result.error != null) {
      console.log(result.error);
      return;
    };

    console.log(result);
  } catch (error) {
    console.log(error);
  };
};

main();

Parameter	Type	Description
params.id	number	'latest'
addons.legacy_only?	boolean
addons.apiVersion?	'20240130'	'99999999'
addons.authKey?	string
addons.timeout_ms?	number
addons.ignoreSessionRefresh?	boolean

Response

import { Mod } from "../mods"

export interface RoomsDetailsResponse {
  id: number
  name: string
  category: string
  type: string
  user_id: number
  starts_at: string
  ends_at: any
  max_attempts: any
  participant_count: number
  channel_id: number
  active: boolean
  has_password: boolean
  queue_mode: string
  auto_skip: boolean
  current_user_score: CurrentUserScore
  host: Host
  playlist: Playlist[]
  recent_participants: RecentParticipant[]
}

export interface CurrentUserScore {
  accuracy: number
  attempts: number
  completed: number
  pp: number
  room_id: number
  total_score: number
  user_id: number
  playlist_item_attempts: any[]
}

export interface Host {
  avatar_url: string
  country_code: string
  default_group: string
  id: number
  is_active: boolean
  is_bot: boolean
  is_deleted: boolean
  is_online: boolean
  is_supporter: boolean
  last_visit: string
  pm_friends_only: boolean
  profile_colour: any
  username: string
  country: Country
}

export interface Country {
  code: string
  name: string
}

export interface Playlist {
  id: number
  room_id: number
  beatmap_id: number
  ruleset_id: number
  allowed_mods: Mod[]
  required_mods: Mod[]
  expired: boolean
  owner_id: number
  playlist_order?: number
  played_at?: string
  beatmap: Beatmap
}

export interface Settings { }

export interface Beatmap {
  beatmapset_id: number
  difficulty_rating: number
  id: number
  mode: string
  status: string
  total_length: number
  user_id: number
  version: string
  beatmapset: Beatmapset
  checksum: string
  max_combo: number
}

export interface Beatmapset {
  artist: string
  artist_unicode: string
  covers: Covers
  creator: string
  favourite_count: number
  hype: any
  id: number
  nsfw: boolean
  offset: number
  play_count: number
  preview_url: string
  source: string
  spotlight: boolean
  status: string
  title: string
  title_unicode: string
  track_id?: number
  user_id: number
  video: boolean
}

export interface Covers {
  cover: string
  "cover@2x": string
  card: string
  "card@2x": string
  list: string
  "list@2x": string
  slimcover: string
  "slimcover@2x": string
}

export interface RecentParticipant {
  avatar_url: string
  country_code: string
  default_group: string
  id: number
  is_active: boolean
  is_bot: boolean
  is_deleted: boolean
  is_online: boolean
  is_supporter: boolean
  last_visit: string
  pm_friends_only: boolean
  profile_colour: any
  username: string
}