PrivateAlbumsAPI

class minim.api.qobuz.PrivateAlbumsAPI(client: APIClient, /)

Bases: PrivateQobuzResourceAPI

Albums API endpoints for the private Qobuz API.

Important

This class is managed by PrivateQobuzAPIClient and should not be instantiated directly.

Parameters:

clientminim.api._shared.APIClient

API client instance used to make HTTP requests.

Methods

get_album	Get Qobuz catalog information for an album.
get_featured_albums	Get Qobuz catalog information for featured albums.
get_my_saved_albums	Get the current user's favorite albums.
is_album_saved	Check whether the current user has an album favorited.
remove_saved_albums	Unfavorite one or more albums.
save_albums	Favorite one or more albums.
search_albums	Search for albums in the Qobuz catalog.
toggle_album_saved	Toggle the favorite status of an album.

get_album(album_id: str, /, *, expand: str | Collection[str] | None = None, limit: int | None = None, offset: int | None = None) → dict[str, Any]

Get Qobuz catalog information for an album.

Parameters:

album_idstr; positional-only

Qobuz ID of the album.

Examples: "0075679933652", "aaxy9wirwgn2a".

expandstr or Collection[str]; keyword-only; optional

Related resources to include metadata for in the response.

Valid values: "albumsFromSameArtist", "focus", "focusAll".

Examples: "albumsFromSameArtist", "focus,focusAll", ["focus", "focusAll"].

limitint; keyword-only; optional

Maximum number of tracks to return.

Valid range: 1 to 500.

API default: 500.

offsetint; keyword-only; optional

Index of the first track to return. Use with limit to get the next batch of tracks.

Minimum value: 0.

API default: 0.

Returns:

albumdict[str, Any]

Qobuz metadata for the album.

Sample response

{
  "albums_same_artist": {
    "items": [
      {
        "articles": [],
        "artist": {
          "albums_count": <int>,
          "id": <int>,
          "image": None,
          "name": <str>,
          "picture": None,
          "slug": <str>
        },
        "artists": [
          {
            "id": <int>,
            "name": <str>,
            "roles": <list[str]>
          }
        ],
        "description": [],
        "displayable": <bool>,
        "downloadable": <bool>,
        "duration": <int>,
        "genre": {
          "color": <str>,
          "id": <int>,
          "name": <str>,
          "path": <list[int]>,
          "slug": <str>
        },
        "hires": <bool>,
        "hires_streamable": <bool>,
        "id": <str>,
        "image": {
          "back": None,
          "large": <str>,
          "small": <str>,
          "thumbnail": <str>
        },
        "label": {
          "albums_count": <int>,
          "id": <int>,
          "name": <str>,
          "slug": <str>,
          "supplier_id": <int>
        },
        "maximum_bit_depth": <int>,
        "maximum_channel_count": <int>,
        "maximum_sampling_rate": <float>,
        "media_count": <int>,
        "parental_warning": <bool>,
        "popularity": <int>,
        "previewable": <bool>,
        "purchasable": <bool>,
        "purchasable_at": <int>,
        "qobuz_id": <int>,
        "release_date_download": <str>,
        "release_date_original": <str>,
        "release_date_stream": <str>,
        "released_at": <int>,
        "sampleable": <bool>,
        "slug": <str>,
        "streamable": <bool>,
        "streamable_at": <int>,
        "title": <str>,
        "tracks_count": <int>,
        "upc": <str>,
        "url": <str>,
        "version": <str>
      }
    ]
  },
  "area": None,
  "articles": [],
  "artist": {
    "albums_count": <int>,
    "id": <int>,
    "image": None,
    "name": <str>,
    "picture": None,
    "slug": <str>
  },
  "artists": [
    {
      "id": <int>,
      "name": <str>,
      "roles": <list[str]>
    }
  ],
  "awards": [],
  "catchline": <str>,
  "copyright": <str>,
  "created_at": <int>,
  "description": <str>,
  "description_language": <str>,
  "displayable": <bool>,
  "downloadable": <bool>,
  "duration": <int>,
  "genre": {
    "color": <str>,
    "id": <int>,
    "name": <str>",
    "path": <list[int]>,
    "slug": <str>
  },
  "genres_list": <list[str]>,
  "goodies": [],
  "hires": <bool>,
  "hires_streamable": <bool>,
  "id": <str>,
  "image": {
    "back": None,
    "large": <str>,
    "small": <str>,
    "thumbnail": <str>
  },
  "is_official": <bool>,
  "items_focus": None,
  "label": {
    "albums_count": <int>,
    "id": <int>,
    "name": <str>,
    "slug": <str>,
    "supplier_id": <int>
  },
  "maximum_bit_depth": <int>,
  "maximum_channel_count": <int>,
  "maximum_sampling_rate": <float>,
  "maximum_technical_specifications": <str>,
  "media_count": <int>,
  "parental_warning": <bool>,
  "period": None,
  "popularity": <int>,
  "previewable": <bool>,
  "product_sales_factors_monthly": <int>,
  "product_sales_factors_weekly": <int>,
  "product_sales_factors_yearly": <int>,
  "product_type": <str>,
  "product_url": <str>,
  "purchasable": <bool>,
  "purchasable_at": <int>,
  "qobuz_id": <int>,
  "recording_information": <str>,
  "relative_url": <str>,
  "release_date_download": <str>,
  "release_date_original": <str>,
  "release_date_stream": <str>,
  "release_tags": [],
  "release_type": <str>,
  "released_at": <int>,
  "sampleable": <bool>,
  "slug": <str>,
  "streamable": <bool>,
  "streamable_at": <int>,
  "subtitle": <str>,
  "title": <str>,
  "tracks": {
    "items": [
      {
        "audio_info": {
          "replaygain_track_gain": <float>,
          "replaygain_track_peak": <float>
        },
        "copyright": <str>,
        "displayable": <bool>,
        "downloadable": <bool>,
        "duration": <int>,
        "hires": <bool>,
        "hires_streamable": <bool>,
        "id": <int>,
        "isrc": <str>,
        "maximum_bit_depth": <int>,
        "maximum_channel_count": <int>,
        "maximum_sampling_rate": <int>,
        "media_number": <int>,
        "parental_warning": <bool>,
        "performer": {
          "id": <int>,
          "name": <str>
        },
        "performers": <str>,
        "previewable": <bool>,
        "purchasable": <bool>,
        "purchasable_at": <int>,
        "release_date_download": <str>,
        "release_date_original": <str>,
        "release_date_purchase": <str>,
        "release_date_stream": <str>,
        "sampleable": <bool>,
        "streamable": <bool>,
        "streamable_at": <int>,
        "title": <str>,
        "track_number": <int>,
        "version": <str>,
        "work": None
      }
    ],
    "limit": <int>,
    "offset": <int>,
    "total": <int>
  },
  "tracks_count": <int>,
  "upc": <str>,
  "url": <str>,
  "version": <str>
}

get_featured_albums(featured_type: str, *, genre_ids: int | str | Collection[int | str] | None = None, limit: int | None = None, offset: int | None = None) → dict[str, Any]

Get Qobuz catalog information for featured albums.

Parameters:

featured_typestr; positional-only

Type of featured albums to return.

Valid values: "most-streamed", "best-sellers", "new-releases", "press-awards", "editors-picks", "most-featured", "harmonia-mundi", "universal-classic", "universal-jazz", "universal-jeunesse", "universal-chanson", "new-releases-full", "recent-releases", "ideal-discography", "qobuzissims", "album-of-the-week", "re-release-of-the-week".

genre_idsint, str, or Collection[int | str]; optional

Qobuz IDs of the genres used to filter the featured albums to return.

Examples: 10, "64", "10,64", [10, "64"].

limitint; keyword-only; optional

Maximum number of albums to return.

Valid range: 1 to 500.

API default: 25.

offsetint; keyword-only; optional

Index of the first album to return. Use with limit to get the next batch of albums.

Minimum value: 0.

API default: 0.

Returns:

albumsdict[str, Any]

Page of Qobuz metadata for the featured albums.

Sample response

{
  "albums": {
    "items": [
      {
        "articles": [],
        "artist": {
          "albums_count": <int>,
          "id": <int>,
          "image": None,
          "name": <str>,
          "picture": None,
          "slug": <str>
        },
        "artists": [
          {
            "id": <int>,
            "name": <str>,
            "roles": <list[str]>
          }
        ],
        "displayable": <bool>,
        "downloadable": <bool>,
        "duration": <int>,
        "genre": {
          "color": <str>,
          "id": <int>,
          "name": <str>,
          "path": <list[int]>,
          "slug": <str>
        },
        "hires": <bool>,
        "hires_streamable": <bool>,
        "id": <str>,
        "image": {
          "back": None,
          "large": <str>,
          "small": <str>,
          "thumbnail": <str>
        },
        "label": {
          "albums_count": <int>,
          "id": <int>,
          "name": <str>,
          "slug": <str>,
          "supplier_id": <int>
        },
        "maximum_bit_depth": <int>,
        "maximum_channel_count": <int>,
        "maximum_sampling_rate": <float>,
        "media_count": <int>,
        "parental_warning": <bool>,
        "popularity": <int>,
        "previewable": <bool>,
        "purchasable": <bool>,
        "purchasable_at": <int>,
        "qobuz_id": <int>,
        "release_date_download": <str>,
        "release_date_original": <str>,
        "release_date_stream": <str>,
        "released_at": <int>,
        "sampleable": <bool>,
        "slug": <str>,
        "streamable": <bool>,
        "streamable_at": <int>,
        "title": <str>,
        "tracks_count": <int>,
        "upc": <str>,
        "url": <str>,
        "version": <str>
      }
    ],
    "limit": <int>,
    "offset": <int>,
    "total": <int>
  }
}

get_my_saved_albums(*, limit: int | None = None, offset: int | None = None) → dict[str, Any]

Get the current user’s favorite albums.

User authentication

Required

User authentication

Access and manage your library.

Parameters:

limitint; keyword-only; optional

Maximum number of artists to return.

Valid range: 1 to 500.

API default: 50.

offsetint; keyword-only; optional

Index of the first artist to return. Use with limit to get the next batch of artists.

Minimum value: 0.

API default: 0.

Returns:

albumsdict[str, Any]

Page of Qobuz metadata for the current user’s favorite albums.

Sample response

{
  "albums": {
    "items": [
      {
        "articles": [],
        "artist": {
          "albums_count": <int>,
          "id": <int>,
          "image": None,
          "name": <str>,
          "picture": None,
          "slug": <str>,
        },
        "artists": [
          {
            "id": <int>,
            "name": <str>,
            "roles": <list[str]>
          }
        ],
        "displayable": <bool>,
        "downloadable": <bool>,
        "duration": <int>,
        "favorited_at": <int>,
        "genre": {
          "color": <str>,
          "id": <int>,
          "name": <str>,
          "path": <list[int]>,
          "slug": <str>
        },
        "hires": <bool>,
        "hires_streamable": <bool>,
        "id": <str>,
        "image": {
          "back": None,
          "large": <str>,
          "small": <str>,
          "thumbnail": <str>,
        },
        "label": {
          "albums_count": <int>,
          "id": <int>,
          "name": <str>,
          "slug": <str>,
          "supplier_id": <int>
        },
        "maximum_bit_depth": <int>,
        "maximum_channel_count": <int>,
        "maximum_sampling_rate": <float>,
        "media_count": <int>,
        "parental_warning": <bool>,
        "popularity": <int>,
        "previewable": <bool>,
        "purchasable": <bool>,
        "purchasable_at": <int>,
        "qobuz_id": <int>,
        "release_date_download": <str>,
        "release_date_original": <str>,
        "release_date_stream": <str>,
        "released_at": <int>,
        "sampleable": <bool>,
        "slug": <str>,
        "streamable": <bool>,
        "streamable_at": <int>,
        "title": <str>,
        "tracks_count": <int>,
        "upc": <str>,
        "url": <str>,
        "version": <str>
      }
    ],
    "limit": <int>,
    "offset": <int>,
    "total": <int>
  },
  "user": {
    "id": <int>,
    "login": <str>
  }
}

is_album_saved(album_id: str, /) → dict[str, bool]

Check whether the current user has an album favorited.

User authentication

Required

User authentication

Access and manage your library.

Parameters:

album_idstr; positional-only

Qobuz ID of the album.

Examples: "0075679933652", "aaxy9wirwgn2a".

Returns:

saveddict[str, bool]

Whether the current user has the album favorited.

Sample response: {"status": <bool>}.

remove_saved_albums(album_ids: str | Collection[str] | None = None, /) → dict[str, str]

Unfavorite one or more albums.

User authentication

Required

User authentication

Access and manage your library.

Parameters:

album_idsstr or Collection[str]; positional-only; optional

Qobuz IDs of the albums.

Examples: "0075679933652", "0075679933652,aaxy9wirwgn2a".

Returns:

statusdict[str, str]

Whether the albums were unfavorited successfully.

Sample response: {"status": "success"}.

save_albums(album_ids: str | Collection[str] | None = None, /) → dict[str, str]

Favorite one or more albums.

User authentication

Required

User authentication

Access and manage your library.

Parameters:

album_idsstr or Collection[str]; positional-only; optional

Qobuz IDs of the albums.

Examples: "0075679933652", "0075679933652,aaxy9wirwgn2a".

Returns:

statusdict[str, str]

Whether the albums were favorited successfully.

Sample response: {"status": "success"}.

search_albums(query: str, /, *, limit: int | None = None, offset: int | None = None) → dict[str, Any]

Search for albums in the Qobuz catalog.

Parameters:

querystr; positional-only

Search query.

Tip

Searches can be narrowed using tags, such as #ByMainArtist, #ByComposer, #ByPerformer, #ByReleaseName, #ByLabel, #NewRelease, and #HiRes.

Use strict matching instead of fuzzy search by wrapping the keyword string in double quotes.

Example: "Galantis" #ByMainArtist #HiRes.

limitint; keyword-only; optional

Maximum number of albums to return.

Valid range: 1 to 500.

API default: 50.

offsetint; keyword-only; optional

Index of the first album to return. Use with limit to get the next batch of albums.

Minimum value: 0.

API default: 0.

Returns:

albumsdict[str, Any]

Page of Qobuz metadata for the matching albums.

Sample response

{
  "albums": {
    "items": [
      {
        "articles": [],
        "artist": {
          "albums_count": <int>,
          "id": <int>,
          "image": None,
          "name": <str>,
          "picture": None,
          "slug": <str>
        },
        "artists": [
          {
            "id": <int>,
            "name": <str>,
            "roles": <list[str]>
          }
        ],
        "displayable": <bool>,
        "downloadable": <bool>,
        "duration": <int>,
        "genre": {
          "color": <str>,
          "id": <int>,
          "name": <str>,
          "path": <list[int]>,
          "slug": <str>
        },
        "hires": <bool>,
        "hires_streamable": <bool>,
        "id": <str>,
        "image": {
          "back": None,
          "large": <str>,
          "small": <str>,
          "thumbnail": <str>
        },
        "label": {
          "albums_count": <int>,
          "id": <int>,
          "name": <str>,
          "slug": <str>,
          "supplier_id": <int>
        },
        "maximum_bit_depth": <int>,
        "maximum_channel_count": <int>,
        "maximum_sampling_rate": <float>,
        "media_count": <int>,
        "parental_warning": <bool>,
        "popularity": <int>,
        "previewable": <bool>,
        "purchasable": <bool>,
        "purchasable_at": <int>,
        "qobuz_id": <int>,
        "release_date_download": <str>,
        "release_date_original": <str>,
        "release_date_stream": <str>,
        "released_at": <int>,
        "sampleable": <bool>,
        "slug": <str>,
        "streamable": <bool>,
        "streamable_at": <int>,
        "title": <str>,
        "tracks_count": <int>,
        "upc": <str>,
        "url": <str>,
        "version": <str>
      }
    ],
    "limit": <int>,
    "offset": <int>,
    "total": <int>
  },
  "query": <str>
}

toggle_album_saved(album_id: str, /) → dict[str, str]

Toggle the favorite status of an album.

User authentication

Required

User authentication

Access and manage your library.

Parameters:

album_idstr; positional-only

Qobuz ID of the album.

Examples: "0075679933652", "aaxy9wirwgn2a".

Returns:

statusdict[str, bool]

Whether the album is now favorited.

Sample response: {"status": <bool>}.