Logo

Docs

Info

Info Models

Object models returned by the info endpoint.

Branding

User-facing metadata for the OpenMusic service.

interface Branding {
  name: string;
  email: string;
  logo: string | null;
  short_name: string | null;
  theme: string | null;
  homepage: string | null;
}

OpenMusicInfo

Describes the implemented OpenMusic version and capability flags.

interface OpenMusicInfo {
  version: string;
  capabilities: {
    info: true;
    search: true;
    song: true;
    download: true;
    stream: boolean;
    albums: boolean;
    artists: boolean;
    playlists: boolean;
    stations: boolean;
    sort: boolean;
    lyrics: boolean;
  };
}

Info

Top-level info object returned inside data.

type Info = {
  branding: Branding;
  openmusic: OpenMusicInfo;
};

On this page