PrivateLabelsAPI¶

class minim.api.qobuz.PrivateLabelsAPI(client: APIClient, /)[source]¶

Bases: PrivateQobuzResourceAPI

Labels 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_label`	Get Qobuz catalog information for a label.
`get_labels`	Get Qobuz catalog information for available labels.

Get Qobuz catalog information for a label.

Parameters:

label_idint or str; positional-only

Qobuz ID of the label.

Examples: 1385, "8355112".

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

Related resources to include metadata for in the response.

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

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

limitint; keyword-only; optional

Maximum number of albums to return when "albums" is included in the expand parameter.

Valid range: 1 to 500.

API default: 25.

offsetint; keyword-only; optional

Index of the first album to return when "albums" is included in the expand parameter. Use with limit to get the next batch of albums.

Minimum value: 0.

API default: 0.

Returns:

labeldict[str, Any]

Qobuz metadata for the label.

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": <int>
        },
        "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": <int>,
        "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>
  }
  "albums_count": <int>,
  "description": None,
  "id": <int>,
  "image": None,
  "items_focus": None,
  "name": <str>,
  "slug": <str>,
  "supplier_id": <int>
}

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

Get Qobuz catalog information for available labels.

Parameters:

limitint; keyword-only; optional

Maximum number of labels to return.

Valid range: 1 to 500.

API default: 25.

offsetint; keyword-only; optional

Index of the first label to return. Use with limit to get the next batch of labels.

Minimum value: 0.

API default: 0.

Returns:

labelsdict[str, Any]

Page of Qobuz metadata for the labels.

Sample response

{
  "labels": {
    "items": [
      {
        "albums_count": <int>,
        "id": <int>,
        "name": <str>,
        "slug": <str>,
        "supplier_id": <int>,
      }
    ],
    "limit": <int>,
    "offset": <int>,
    "total": <int>
  }
}