v2.matches.details_v3

GET /v2/matches/{match}

async Get a match by certain criteria.

Usage example

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

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

    await v2.matches.details({ match_id: 16155689 });
    if (result.error != null) {
      console.log(result.error);
      return;
    };

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

main();

Parameter	Type	Description
params.match_id	number
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 MatchesDetailsResponse {
  match: Match
  events: Event[]
  users: User[]
  first_event_id: number
  latest_event_id: number
  current_game_id: any
}

export interface Match {
  id: number
  start_time: string
  end_time: string
  name: string
}

export interface Event {
  id: number
  detail: Detail
  timestamp: string
  user_id?: number
  game?: Game
}

export interface Detail {
  type: string
  text?: string
}

export interface Game {
  beatmap_id: number
  id: number
  start_time: string
  end_time: string
  mode: string
  mode_int: number
  scoring_type: string
  team_type: string
  mods: Mod[]
  beatmap?: Beatmap
  scores: Score[]
}

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
}

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: any
  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 Score {
  accuracy: number
  best_id: any
  created_at: string
  id: any
  max_combo: number
  mode: string
  mode_int: number
  mods: Mod[]
  passed: boolean
  perfect: number
  pp: any
  rank: string
  replay: boolean
  score: number
  statistics: Statistics
  type: string
  user_id: number
  current_user_attributes: CurrentUserAttributes
  match: Match2
}

export interface Statistics {
  count_100: number
  count_300: number
  count_50: number
  count_geki: number
  count_katu: number
  count_miss: number
}

export interface CurrentUserAttributes {
  pin: any
}

export interface Match2 {
  slot: number
  team: string
  pass: boolean
}

export interface User {
  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?: string
  username: string
  country: Country
}

export interface Country {
  code: string
  name: string
}