Albums

Module with the albums endpoint

Albums (Endpoint)

Wraps the spotify album endpoint

Source code in async_spotify/api/_endpoints/albums.py

class Albums(Endpoint):
    """
    Wraps the spotify album endpoint
    """

    async def get_one(self, album_id: str, auth_token: SpotifyAuthorisationToken = None, **kwargs) -> dict:
        """
        Get the album with the specific spotify album id

        Args:
            album_id: The album id of the album you want to get
            auth_token: The auth token if you set the api class not to keep the token in memory
            kwargs: Optional arguments as keyword args

        Notes:
            [https://developer.spotify.com/documentation/web-api/reference/albums/get-album/](https://developer.spotify.com/documentation/web-api/reference/albums/get-album/)

        Returns:
            The album json
        """

        required_args = {"id": album_id}
        args = {**required_args, **kwargs}

        url, args = self._add_url_params(URLS.ALBUM.ONE, args)
        response = await self.api_request_handler.make_request('GET', url, args, auth_token)

        return response

    async def get_tracks(self, album_id: str, auth_token: SpotifyAuthorisationToken = None, **kwargs) -> dict:
        """
        Get the tracks of an album

        Args:
            album_id: The id of the album
            auth_token: The auth token if you set the api class not to keep the token in memory
            kwargs: Optional arguments as keyword args

        Notes:
            [https://developer.spotify.com/documentation/web-api/reference/albums/get-albums-tracks/](https://developer.spotify.com/documentation/web-api/reference/albums/get-albums-tracks/)

        Returns:
            The tracks of an album
        """

        required_args = {"id": album_id}
        args = {**required_args, **kwargs}

        url, args = self._add_url_params(URLS.ALBUM.TRACKS, args)
        response = await self.api_request_handler.make_request('GET', url, args, auth_token)

        return response

    async def get_multiple(self, album_id_list: List[str], auth_token: SpotifyAuthorisationToken = None,
                           **kwargs) -> dict:
        """
        Get All the albums specified in the album_id_list

        Args:
            album_id_list: The list of the spotify album ids
            auth_token: The auth token if you set the api class not to keep the token in memory
            kwargs: Optional arguments as keyword args

        Notes:
            [https://developer.spotify.com/documentation/web-api/reference/albums/get-several-albums/](https://developer.spotify.com/documentation/web-api/reference/albums/get-several-albums/)

        Returns:
            All the albums you queried
        """

        required_args = {"ids": album_id_list}
        args = {**required_args, **kwargs}

        url, args = self._add_url_params(URLS.ALBUM.MULTIPLE, args)
        response = await self.api_request_handler.make_request('GET', url, args, auth_token)

        return response

get_multiple(self, album_id_list, auth_token=None, **kwargs) async

Get All the albums specified in the album_id_list

Parameters:

Name	Type	Description	Default
album_id_list	List[str]	The list of the spotify album ids	required
auth_token	SpotifyAuthorisationToken	The auth token if you set the api class not to keep the token in memory	None
kwargs		Optional arguments as keyword args	{}

Notes

https://developer.spotify.com/documentation/web-api/reference/albums/get-several-albums/

Returns:

Type	Description
dict	All the albums you queried

Source code in async_spotify/api/_endpoints/albums.py

async def get_multiple(self, album_id_list: List[str], auth_token: SpotifyAuthorisationToken = None,
                       **kwargs) -> dict:
    """
    Get All the albums specified in the album_id_list

    Args:
        album_id_list: The list of the spotify album ids
        auth_token: The auth token if you set the api class not to keep the token in memory
        kwargs: Optional arguments as keyword args

    Notes:
        [https://developer.spotify.com/documentation/web-api/reference/albums/get-several-albums/](https://developer.spotify.com/documentation/web-api/reference/albums/get-several-albums/)

    Returns:
        All the albums you queried
    """

    required_args = {"ids": album_id_list}
    args = {**required_args, **kwargs}

    url, args = self._add_url_params(URLS.ALBUM.MULTIPLE, args)
    response = await self.api_request_handler.make_request('GET', url, args, auth_token)

    return response

get_one(self, album_id, auth_token=None, **kwargs) async

Get the album with the specific spotify album id

Parameters:

Name	Type	Description	Default
album_id	str	The album id of the album you want to get	required
auth_token	SpotifyAuthorisationToken	The auth token if you set the api class not to keep the token in memory	None
kwargs		Optional arguments as keyword args	{}

Notes

https://developer.spotify.com/documentation/web-api/reference/albums/get-album/

Returns:

Type	Description
dict	The album json

Source code in async_spotify/api/_endpoints/albums.py

async def get_one(self, album_id: str, auth_token: SpotifyAuthorisationToken = None, **kwargs) -> dict:
    """
    Get the album with the specific spotify album id

    Args:
        album_id: The album id of the album you want to get
        auth_token: The auth token if you set the api class not to keep the token in memory
        kwargs: Optional arguments as keyword args

    Notes:
        [https://developer.spotify.com/documentation/web-api/reference/albums/get-album/](https://developer.spotify.com/documentation/web-api/reference/albums/get-album/)

    Returns:
        The album json
    """

    required_args = {"id": album_id}
    args = {**required_args, **kwargs}

    url, args = self._add_url_params(URLS.ALBUM.ONE, args)
    response = await self.api_request_handler.make_request('GET', url, args, auth_token)

    return response

get_tracks(self, album_id, auth_token=None, **kwargs) async

Get the tracks of an album

Parameters:

Name	Type	Description	Default
album_id	str	The id of the album	required
auth_token	SpotifyAuthorisationToken	The auth token if you set the api class not to keep the token in memory	None
kwargs		Optional arguments as keyword args	{}

Notes

https://developer.spotify.com/documentation/web-api/reference/albums/get-albums-tracks/

Returns:

Type	Description
dict	The tracks of an album

Source code in async_spotify/api/_endpoints/albums.py

async def get_tracks(self, album_id: str, auth_token: SpotifyAuthorisationToken = None, **kwargs) -> dict:
    """
    Get the tracks of an album

    Args:
        album_id: The id of the album
        auth_token: The auth token if you set the api class not to keep the token in memory
        kwargs: Optional arguments as keyword args

    Notes:
        [https://developer.spotify.com/documentation/web-api/reference/albums/get-albums-tracks/](https://developer.spotify.com/documentation/web-api/reference/albums/get-albums-tracks/)

    Returns:
        The tracks of an album
    """

    required_args = {"id": album_id}
    args = {**required_args, **kwargs}

    url, args = self._add_url_params(URLS.ALBUM.TRACKS, args)
    response = await self.api_request_handler.make_request('GET', url, args, auth_token)

    return response

---

Last update: April 27, 2020