PrivateGenresAPI¶

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

Bases: PrivateQobuzResourceAPI

Genres 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

`available_genres`	Available genres.
`get_genre`	Get Qobuz catalog information for a genre.
`get_genres`	Get Qobuz catalog information for available top-level genres or the subgenres of a specific top-level genre.

available_genres() → dict[str, dict[str, Any]][source]¶: Available genres.

Note

Accessing this property may call get_genres() and make multiple requests to the Qobuz API.

get_genre(genre_id: int | str, /) → dict[str, Any][source]¶

Get Qobuz catalog information for a genre.

Parameters:

genre_idint or str; positional-only

Qobuz ID of the genre.

Examples: 10, "64".

Returns:

genredict[str, Any]

Qobuz metadata for the genre.

Sample response

{
  "color": <str>,
  "id": <int>,
  "name": <str>,
  "path": <list[int]>,
  "slug": <str>
}

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

Get Qobuz catalog information for available top-level genres or the subgenres of a specific top-level genre.

Parameters:

genre_idint or str; positional-only; optional

Qobuz ID of the top-level genre. If not provided, all top-level genres are returned.

Examples: 10, "64".

limitint; keyword-only; optional

Maximum number of genres to return.

Valid range: 1 to 500.

API default: 25.

offsetint; keyword-only; optional

Index of the first genre to return. Use with limit to get the next batch of genres.

Minimum value: 0.

API default: 0.

Returns:

genresdict[str, Any]

Page of Qobuz metadata for the genres.

Sample response

{
  "genres": {
    "items": [
      {
        "color": <str>,
        "id": <int>,
        "name": <str>,
        "path": <list[int]>,
        "slug": <str>
      }
    ],
    "limit": <int>,
    "offset": <int>,
    "total": <int>
  },
  "parent": {
    "color": <str>,
    "id": <int>,
    "name": <str>,
    "path": <list[int]>,
    "slug": <str>
  }
}