PrivateSearchAPI

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

Bases: PrivateQobuzResourceAPI

Search-related endpoints for the private Qobuz API.

Note

This class groups search-related endpoints for convenience. Qobuz does not provide a dedicated Search 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

search

Search for albums, artists, playlists, stories, and/or tracks in the Qobuz catalog.

search_albums

Search for albums in the Qobuz catalog.

search_artists

Search for artists in the Qobuz catalog.

search_most_popular

Get Qobuz catalog information for the 30 most popular albums, artists, and tracks that match a keyword string.

search_playlists

Search for playlists in the Qobuz catalog.

search_stories

Search for stories in the Qobuz catalog.

search_tracks

Search for tracks in the Qobuz catalog.

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

Search for albums, artists, playlists, stories, and/or tracks 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 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:
itemsdict[str, Any]

Page of Qobuz metadata for the matching catalog items.

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

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.

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

Search for artists 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 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:
artistsdict[str, Any]

Page of Qobuz metadata for the matching artists.

Get Qobuz catalog information for the 30 most popular albums, artists, and tracks that match a keyword string.

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.

offsetint; keyword-only; optional

Index of the first item to return.

Minimum value: 0.

API default: 0.

Returns:
itemsdict[str, Any]

Page of Qobuz metadata for the most popular items.

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

Search for playlists 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 playlists to return.

Valid range: 1 to 500.

API default: 50.

offsetint; keyword-only; optional

Index of the first playlist to return. Use with limit to get the next batch of playlists.

Minimum value: 0.

API default: 0.

Returns:
playlistsdict[str, Any]

Page of Qobuz metadata for the matching playlists.

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

Search for stories 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 stories to return.

Valid range: 1 to 500.

API default: 50.

offsetint; keyword-only; optional

Index of the first story to return. Use with limit to get the next batch of stories.

Minimum value: 0.

API default: 0.

Returns:
storiesdict[str, Any]

Page of Qobuz metadata for the matching stories.

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

Search for tracks 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 tracks to return.

Valid range: 1 to 500.

API default: 50.

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:
tracksdict[str, Any]

Page of Qobuz metadata for the matching tracks.