Skip to content

sok.apis.music.deezer_api

Deezer API Implementation Support for music search and metadata.

DeezerApi

class DeezerApi(api_key: str = '')

Bases: BaseAPI

Deezer API for music. No API key required for public search.

Initialize Deezer API.

Parameters

NameTypeDefaultDescription
api_keystr''Not used but required by BaseAPI signature
Source

Attributes

NameType
BASE_URL
sessionOptional[aiohttp.ClientSession]

supported_content_typesproperty

List[ContentType]

Get supported content types.

supported_media_typesproperty

List[MediaType]

Get supported media types.

get_album_detailsasync

async def get_album_details(album_id: str) -> Dict[str, Any]:

Get detailed album information.

Parameters

NameTypeDescription
album_idstrDeezer album ID.

Returns

  • Dict[str, Any]Dictionary containing album details with tracks.
Source

get_artist_detailsasync

async def get_artist_details(artist_id: str) -> Dict[str, Any]:

Get detailed artist information.

Parameters

NameTypeDescription
artist_idstrDeezer artist ID.

Returns

  • Dict[str, Any]Dictionary containing artist details.
Source

get_detailsasync

async def get_details(
item_id: str,
content_type: ContentType,
**kwargs,
) -> Dict[str, Any]:

Get detailed information for an item.

Parameters

NameTypeDescription
item_idstrDeezer item ID.
content_typeContentTypeType of content (ALBUM, ARTIST).
**kwargsAdditional parameters.

Returns

  • Dict[str, Any]Dictionary containing item details.
Source
async def get_related_items(
item_id: str,
content_type: ContentType,
**kwargs,
) -> List[Dict[str, Any]]:

Get related items (tracks for an album).

Parameters

NameTypeDescription
item_idstrDeezer item ID.
content_typeContentTypeType of content.
**kwargsAdditional parameters.

Returns

  • List[Dict[str, Any]]List of tracks for albums, empty list otherwise.
Source
async def search(
query: str,
content_type: ContentType,
**kwargs,
) -> Dict[str, Any]:

Search for music on Deezer.

Parameters

NameTypeDescription
querystrSearch query string.
content_typeContentTypeType of content (ALBUM, ARTIST, TRACK).
**kwargsAdditional parameters (limit).

Returns

  • Dict[str, Any]Dictionary containing search results.
Source

search_albumasync

async def search_album(query: str, limit: int = 20) -> List[Dict[str, Any]]:

Search for albums on Deezer.

Parameters

NameTypeDefaultDescription
querystrAlbum search query.
limitint20Maximum number of results.

Returns

  • List[Dict[str, Any]]List of album dictionaries.
Source

search_artistasync

async def search_artist(query: str, limit: int = 20) -> List[Dict[str, Any]]:

Search for artists on Deezer.

Parameters

NameTypeDefaultDescription
querystrArtist search query.
limitint20Maximum number of results.

Returns

  • List[Dict[str, Any]]List of artist dictionaries.
Source

search_trackasync

async def search_track(
query: str,
limit: int = 20,
title: Optional[str] = None,
artist: Optional[str] = None,
) -> List[Dict[str, Any]]:

Search for tracks on Deezer.

Parameters

NameTypeDefaultDescription
querystrFree search text, used without title and artist.
limitint20Maximum number of results.
titleOptional[str]NoneTrack title, for a precise search.
artistOptional[str]NoneArtist name, for a precise search.

Returns

  • List[Dict[str, Any]]List of track dictionaries, with their album.
Source
Built with Kiln