Skip to content

album.md

Latest commit

 

History

History
59 lines (40 loc) · 1.86 KB

album.md

File metadata and controls

59 lines (40 loc) · 1.86 KB

PublicAlbum Class

The PublicAlbum class allows you to access public information about a Spotify album without requiring user login.

Parameters

  • album: str
    The Spotify URI of the album, it is used to initialize the album.

  • client: TLSClient
    An instance of TLSClient used for making HTTP requests. Defaults to a new instance with specified parameters.

  • language: str, optional
    The language for API responses using ISO 639-1 language codes (e.g., 'ko', 'ja', 'zh', 'en'). Default is 'en'.

Methods

__init__(self, album: str, /, *, client: TLSClient = TLSClient("chrome_120", "", auto_retries=3), language: str = "en") -> None

Initializes the PublicAlbum class with an optional album URI and a TLSClient instance.

Language Support Examples

from spotapi import PublicAlbum

# Initialize with Korean language
album = PublicAlbum("4m2880jivSbbyEGAKfITCa", language="ko")

# Get album info with Korean language responses
info = album.get_album_info()

# Change language at runtime
album.base.set_language("zh")  # Switch to Chinese

get_album_info(self, limit: int = 25, *, offset: int = 0) -> Mapping[str, Any]

Fetches public information about the album.

  • Args:

    • limit: int
      The maximum number of results to return. Default is 25.
    • offset: int
      The offset for pagination. Default is 0.

  • Returns:
    Mapping[str, Any]
    The album information.

  • Raises:
    AlbumError if there is an issue retrieving the album information or if the response is invalid.

paginate_album(self) -> Generator[Mapping[str, Any], None, None]

Generator that fetches album information in chunks.

  • Returns:
    Generator[Mapping[str, Any], None, None]
    A generator yielding album information in chunks.

  • Note: If the total number of tracks is 343 or fewer, pagination is not required.