v2.news.details_v3

GET /v2/news/{news}

async Retrieves a single news post based on given parameters.

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)
    });

    const result = await v2.news.details({
      news_id: 1440,
      key: 'id'
    });
    if (result.error != null) {
      console.log(result.error);
      return;
    };

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

main();

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

Response

export interface NewsDetailsResponse {
  id: number
  author: string
  edit_url: string
  first_image: string
  published_at: string
  updated_at: string
  slug: string
  title: string
  content: string
  navigation: Navigation
}

export interface Navigation {
  newer: Newer
  older: Older
}

export interface Newer {
  id: number
  author: string
  edit_url: string
  first_image: string
  published_at: string
  updated_at: string
  slug: string
  title: string
}

export interface Older {
  id: number
  author: string
  edit_url: string
  first_image: string
  published_at: string
  updated_at: string
  slug: string
  title: string
}