Skip to content

Categories

API #

Implementation to make API calls with.

Parameters:

get_several_browse_categories #

get_several_browse_categories(*, country: MissingOr[str] = MISSING, locale: MissingOr[str] = MISSING, limit: MissingOr[int] = MISSING, offset: MissingOr[int] = MISSING) -> Paginator[Category]

Get a list of categories used to tag items in Spotify (on, for example, the Spotify player's 'Browse' tab).

Parameters:

  • country (str, default: MISSING ) –

    Desired country to get content for.

  • locale (str, default: MISSING ) –

    Desired language to get content in. Default: American English

    Note

    Both or neither of the country and locale parameters must be provided.

  • limit (int, default: 20 ) –

    The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50.

  • offset (int, default: 0 ) –

    The index of the first item to return. Default: 0 (the first item).

Returns:

get_single_browse_category #

get_single_browse_category(category_id: str, *, country: MissingOr[str] = MISSING, locale: MissingOr[str] = MISSING) -> Category

Get a single category used to tag items in Spotify (on, for example, the Spotify player's 'Browse' tab).

Parameters:

  • category_id (str) –

    The ID of the category.

  • country (str, default: MISSING ) –

    Desired country to get content for.

  • locale (str, default: MISSING ) –

    Desired language to get content in. Default: American English

    Note

    Both or neither of the country and locale parameters must be provided.

Returns:

Category #

A category.

href #

href: str

A link to the Web API endpoint returning full details of the category.

icons #

icons: list[Image]

The category icon, in various sizes.

id #

id: str

The Spotify category ID of the category.

name #

name: str

The name of the category.