PrivatePurchasesAPI

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

Bases: PrivateQobuzResourceAPI

Purchases 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_my_purchased_item_ids	Get Qobuz IDs of albums and tracks purchased by the current user.
get_my_purchases	Get Qobuz catalog information for albums and tracks purchased by the current user.

get_my_purchased_item_ids() → dict[str, Any]

Get Qobuz IDs of albums and tracks purchased by the current user.

User authentication

Required

User authentication

Access personal collection and favorites.

Returns:

item_idsdict[str, Any]

Qobuz IDs of the current user’s purchased albums and tracks.

Sample response

{
  "albums": {
    "items": [
      {
        "id": <str>
      }
    ],
    "total": <int>
  },
  "tracks": {
    "items": [
      {
        "bought": <bool>,
        "id": <int>
      }
    ],
    "total": <int>
  },
  "user": {
    "id": <int>,
    "login": <str>
  }
}

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

Get Qobuz catalog information for albums and tracks purchased by the current user.

User authentication

Required

User authentication

Access personal collection and favorites.

Parameters:

limitint; keyword-only; optional

Maximum number of items to return.

Valid range: 1 to 500.

API default: 50.

offsetint; keyword-only; optional

Index of the first item to return. Use with limit to get the next batch of items.

Minimum value: 0.

API default: 0.

Returns:

purchasesdict[str, Any]

Page of Qobuz metadata for the current user’s purchased albums and tracks.

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>,
        "downloadable_format_ids": <list[str]>,
        "duration": <int>,
        "genre": {
          "color": <int>,
          "id": <int>,
          "name": <int>,
          "path": <list[int]>,
          "slug": <str>
        },
        "hires": <bool>,
        "hires_purchased": <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": <int>,
        "media_count": <int>,
        "order_id": <int>,
        "order_line_id": <int>,
        "parental_warning": <bool>,
        "popularity": <int>,
        "previewable": <bool>,
        "purchasable": <bool>,
        "purchasable_at": <int>,
        "purchased_at": <int>,
        "qobuz_id": <int>,
        "release_date_download": <str>,
        "release_date_original": <str>,
        "release_date_stream": <str>,
        "released_at": <int>,
        "sampleable": <bool>,
        "streamable": <bool>,
        "streamable_at": <int>,
        "title": <str>,
        "tracks_count": <int>,
        "upc": <str>,
        "url": <str>,
        "version": <str>
      }
    ],
    "limit": <int>,
    "offset": <int>,
    "total": <int>
  },
  "tracks": {
    "items": [
      {
        "album": {
          "artist": {
            "albums_count": <int>,
            "id": <int>,
            "image": None,
            "name": <str>,
            "picture": None,
            "slug": <str>
          },
          "displayable": <bool>,
          "downloadable": <bool>,
          "duration": <int>,
          "genre": {
            "color": <int>,
            "id": <int>,
            "name": <int>,
            "path": <list[int]>,
            "slug": <str>
          },
          "hires": <bool>,
          "hires_streamable": <bool>,
          "id": <str>,
          "image": {
            "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": <int>,
          "maximum_technical_specifications": <str>,
          "media_count": <int>,
          "parental_warning": <bool>,
          "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>,
          "streamable": <bool>,
          "streamable_at": <int>,
          "title": <str>,
          "tracks_count": <int>,
          "upc": <str>,
          "version": <str>
        },
        "audio_info": {
          "replaygain_track_gain": <float>,
          "replaygain_track_peak": <float>
        },
        "composer": {
          "id": <int>,
          "name": <str>
        },
        "copyright": <str>,
        "displayable": <bool>,
        "downloadable": <bool>,
        "downloadable_format_ids": <list[int]>,
        "duration": <int>,
        "hires": <bool>,
        "hires_purchased": <bool>,
        "hires_streamable": <bool>,
        "id": <int>,
        "isrc": <str>,
        "maximum_bit_depth": <int>,
        "maximum_channel_count": <int>,
        "maximum_sampling_rate": <float>,
        "media_number": <int>,
        "order_id": <int>,
        "order_line_id": <int>,
        "parental_warning": <bool>,
        "performer": {
          "id": <int>,
          "name": <str>
        },
        "performers": <str>,
        "previewable": <bool>,
        "purchasable": <bool>,
        "purchasable_at": <int>,
        "purchased_at": <int>,
        "release_date_download": <str>,
        "release_date_original": <str>,
        "release_date_stream": <str>,
        "sampleable": <bool>,
        "streamable": <bool>,
        "streamable_at": <int>,
        "title": <str>,
        "track_number": <int>,
        "type": <str>,
        "version": <str>,
        "work": None
      }
    ],
    "limit": <int>,
    "offset": <int>,
    "total": <int>
  },
  "user": {"id": <int>, "login": <str>}
}