Skip to content
owo edited this page May 7, 2022 · 5 revisions

Return match data for specified id

Authentication

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

Function

await v2.matches.details()

Parameters

Parameter Type Description
match number id of the match

Response

export interface response {
  match: {
    id: number;
    start_time: string;
    end_time?: string | null;
    name: string;
  };
  events: {
    id: number;
    detail: {
      type: string;
      text: string;
    };
    timestamp: string;
    user_id: number;
    game: {
      id: number;
      start_time: string;
      end_time: string;
      mode: string;
      mode_int: number;
      scoring_type: string;
      team_type: string;
      mods: string[];
      beatmap: {
        beatmapset_id: number;
        difficulty_rating: number;
        id: number;
        mode: string;
        status: string;
        total_length: number;
        user_id: number;
        version: string;
        beatmapset: {
          artist: string;
          artist_unicode: string;
          covers: {
            cover: string;
            'cover@2x': string;
            card: string;
            'card@2x': string;
            list: string;
            'list@2x': string;
            slimcover: string;
            'slimcover@2x': string;
          };
          creator: string;
          favourite_count: number;
          hype?: null;
          id: number;
          nsfw: boolean;
          offset: number;
          play_count: number;
          preview_url: string;
          source: string;
          status: string;
          title: string;
          title_unicode: string;
          track_id?: null;
          user_id: number;
          video: boolean;
        };
      };
      scores: [];
    };
  }[];
  users: {
    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 | null;
    pm_friends_only: boolean;
    profile_colour?: null;
    username: string;
    country: {
      code: string;
      name: string;
    };
  }[];
  first_event_id: number;
  latest_event_id: number;
  current_game_id?: number | null;
};

[v3.x.x] Documentation


[v2.x.x] Documentation

Clone this wiki locally