v2.groups.history_v3

GET /groups/history

async Retrieves a groups history

Usage example

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

async function main() {
  try {
    const result = await v2.groups.history();
    if (result.error != null) {
      console.log(result.error);
      return;
    };

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

main();

Parameter	Type	Description
params.user?	string	number
params.group?	'gmt'	'nat'
params.sort?	'id_desc'	'id_asc'
params.max_date?	string
params.min_date?	string
addons.legacy_only?	boolean
addons.apiVersion?	'20240130'	'99999999'
addons.authKey?	string
addons.timeout_ms?	number
addons.ignoreSessionRefresh?	boolean

Response

export interface GroupsHistoryResponse {
  events: Event[]
  cursor: Cursor
  cursor_string: string
}

export interface Event {
  created_at: string
  group_id: number
  hidden: boolean
  id: number
  type: string
  user_id: number
  user_name: string
  group_name: string
  playmodes?: string[]
}

export interface Cursor {
  id: number
}