PrivateArtistsAPI

class minim.api.tidal.PrivateArtistsAPI(client: APIClient, /)

Bases: PrivateTIDALResourceAPI

Artists API endpoints for the private TIDAL API.

Important

This class is managed by PrivateTIDALAPIClient and should not be instantiated directly.

Parameters:

clientminim.api._shared.APIClient

API client instance used to make HTTP requests.

Methods

block_artist	Block an artist for a user.
follow_artists	Add artists to a user's collection.
get_artist	Get TIDAL catalog information for an artist.
get_artist_albums	Get TIDAL catalog information for albums by an artist.
get_artist_biography	Get an artist's biography.
get_artist_links	Get TIDAL catalog information for links to websites associated with an artist.
get_artist_mix	Get TIDAL catalog information for an artist's mix.
get_artist_mix_id	Get the TIDAL ID of an artist's mix.
get_artist_page	Get the TIDAL page layout for an artist.
get_artist_top_tracks	Get TIDAL catalog information for top tracks by an artist.
get_artist_videos	Get TIDAL catalog information for videos by an artist.
get_similar_artists	Get TIDAL catalog information for similar artists.
get_user_blocked_artists	Get TIDAL catalog information for artists blocked by a user.
get_user_followed_artists	Add artists to a user's collection.
unblock_artist	Unblock an artist for a user.
unfollow_artists	Remove artists from a user's collection.

block_artist(artist_id: int | str, /, user_id: int | str | None = None) → None

Block an artist for a user.

User authentication

Required

User authentication

Access and manage the user’s collection.

Parameters:

artist_idint or str; positional-only

TIDAL ID of the artist.

Examples: 1566, "4676988".

user_idint or str; optional

TIDAL ID of the user. If not specified, the current user’s TIDAL ID is used.

follow_artists(artist_ids: int | str | Collection[int | str], /, user_id: int | str | None = None, country_code: str | None = None, *, missing_ok: bool | None = None) → None

Add artists to a user’s collection.

User authentication

Required

User authentication

Access and manage the user’s collection.

Parameters:

artist_idsint, str, or Collection[int | str]; positional-only

TIDAL IDs of the artists.

Examples: 1566, "4676988", "1566,4676988", [1566, "4676988"].

user_idint or str; optional

TIDAL ID of the user. If not specified, the current user’s TIDAL ID is used.

country_codestr; optional

ISO 3166-1 alpha-2 country code. If not provided, the country associated with the current user account or IP address is used.

Example: "US".

on_missingstr; keyword-only; optional

Behavior when the artists to be favorited cannot be found in the TIDAL catalog.

API default: "FAIL".

get_artist(artist_id: int | str, /, country_code: str | None = None) → dict[str, Any]

Get TIDAL catalog information for an artist.

Parameters:

artist_idint or str; positional-only

TIDAL ID of the artist.

Examples: 1566, "4676988".

country_codestr; optional

ISO 3166-1 alpha-2 country code. If not provided, the country associated with the current user account or IP address is used.

Example: "US".

Returns:

artistdict[str, Any]

TIDAL metadata for the artist.

Sample response

{
  "artistRoles": [
    {
      "category": <str>,
      "categoryId": <int>
    }
  ],
  "artistTypes": <list[str]>,
  "handle": <str>,
  "id": <int>,
  "mixes": {
    "ARTIST_MIX": <str>
  },
  "name": <str>,
  "picture": <str>,
  "popularity": <int>,
  "selectedAlbumCoverFallback": None,
  "spotlighted": <bool>,
  "url": <str>,
  "userId": <int>
}

get_artist_albums(artist_id: int | str, /, country_code: str | None = None, *, album_type: str | None = None, limit: int | None = None, offset: int | None = None) → dict[str, Any]

Get TIDAL catalog information for albums by an artist.

Parameters:

artist_idint or str; positional-only

TIDAL ID of the artist.

Examples: 1566, "4676988".

country_codestr; optional

ISO 3166-1 alpha-2 country code. If not provided, the country associated with the current user account or IP address is used.

Example: "US".

album_typestr; keyword-only; optional

Album type to return.

Valid values: "COMPILATIONS", "EPSANDSINGLES".

limitint; keyword-only; optional

Maximum number of albums to return.

Valid range: 1 to 100.

API default: 10.

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 TIDAL metadata for the artist’s albums.

Sample response

{
  "items": [
    {
      "adSupportedStreamReady": <bool>,
      "allowStreaming": <bool>,
      "artist": {
        "handle": <str>,
        "id": <int>,
        "name": <str>,
        "picture": <str>,
        "type": <str>
      },
      "artists": [
        {
          "handle": <str>,
          "id": <int>,
          "name": <str>,
          "picture": <str>,
          "type": <str>
        }
      ],
      "audioModes": <list[str]>,
      "audioQuality": <str>,
      "copyright": <str>,
      "cover": <str>,
      "djReady": <bool>,
      "duration": <int>,
      "explicit": <bool>,
      "id": <int>,
      "mediaMetadata": {
        "tags": <list[str]>
      },
      "numberOfTracks": <int>,
      "numberOfVideos": <int>,
      "numberOfVolumes": <int>,
      "payToStream": <bool>,
      "popularity": <int>,
      "premiumStreamingOnly": <bool>,
      "releaseDate": <str>,
      "stemReady": <bool>,
      "streamReady": <bool>,
      "streamStartDate": <str>,
      "title": <str>,
      "type": <str>,
      "upc": <str>,
      "upload": <bool>,
      "url": <str>,
      "version": <str>,
      "vibrantColor": <str>,
      "videoCover": <str>
    }
  ],
  "limit": <int>,
  "offset": <int>,
  "totalNumberOfItems": <int>
}

get_artist_biography(artist_id: int | str, /, country_code: str | None = None) → dict[str, Any]

Get an artist’s biography.

Parameters:

artist_idint or str; positional-only

TIDAL ID of the artist.

Examples: 1566, "4676988".

country_codestr; optional

ISO 3166-1 alpha-2 country code. If not provided, the country associated with the current user account or IP address is used.

Example: "US".

Returns:

biographydict[str, Any]

Metadata for the artist’s biography.

Sample response

{
  "lastUpdated": <str>,
  "source": <str>,
  "summary": <str>,
  "text": <str>
}

get_artist_links(artist_id: int | str, /, country_code: str | None = None, *, limit: int | None = None, offset: int | None = None) → dict[str, Any]

Get TIDAL catalog information for links to websites associated with an artist.

Parameters:

artist_idint or str; positional-only

TIDAL ID of the artist.

Examples: 1566, "4676988".

country_codestr; optional

ISO 3166-1 alpha-2 country code. If not provided, the country associated with the current user account or IP address is used.

Example: "US".

limitint; keyword-only; optional

Maximum number of links to return.

Valid range: 1 to 100.

API default: 10.

offsetint; keyword-only; optional

Index of the first link to return. Use with limit to get the next batch of links.

Minimum value: 0.

API default: 0.

Returns:

linksdict[str, Any]

Page of TIDAL metadata for links to the artist’s websites.

Sample response

{
  "items": [
    {
      "siteName": <str>,
      "url": <str>
    }
  ],
  "limit": <int>,
  "offset": <int>,
  "source": <str>,
  "totalNumberOfItems": <int>
}

get_artist_mix(artist_id: int | str, /, country_code: str | None = None, *, limit: int | None = None, offset: int | None = None) → dict[str, Any]

Get TIDAL catalog information for an artist’s mix.

Parameters:

artist_idint or str; positional-only

TIDAL ID of the artist.

Examples: 1566, "4676988".

country_codestr; optional

ISO 3166-1 alpha-2 country code. If not provided, the country associated with the current user account or IP address is used.

Example: "US".

limitint; keyword-only; optional

Maximum number of tracks to return.

Valid range: 1 to 100.

API default: 10.

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:

mixdict[str, Any]

Page of TIDAL metadata for the tracks in the artist’s mix.

Sample response

{
  "items": [
    {
      "accessType": <str>,
      "adSupportedStreamReady": <bool>,
      "album": {
        "cover": <str>,
        "id": <int>,
        "title": <str>,
        "vibrantColor": <str>,
        "videoCover": <str>
      },
      "allowStreaming": <bool>,
      "artist": {
        "handle": <str>,
        "id": <int>,
        "name": <str>,
        "picture": <str>,
        "type": <str>
      },
      "artists": [
        {
          "handle": <str>,
          "id": <int>,
          "name": <str>,
          "picture": <str>,
          "type": <str>
        }
      ],
      "audioModes": <list[str]>,
      "audioQuality": <str>,
      "bpm": <int>,
      "copyright": <str>,
      "djReady": <bool>,
      "duration": <int>,
      "editable": <bool>,
      "explicit": <bool>,
      "id": <int>,
      "isrc": <str>,
      "key": <str>,
      "keyScale": <str>,
      "mediaMetadata": {
        "tags": <list[str]>
      },
      "mixes": {
        "TRACK_MIX": <str>
      },
      "payToStream": <bool>,
      "peak": <float>,
      "popularity": <int>,
      "premiumStreamingOnly": <bool>,
      "replayGain": <float>,
      "spotlighted": <bool>,
      "stemReady": <bool>,
      "streamReady": <bool>,
      "streamStartDate": <str>,
      "title": <str>,
      "trackNumber": <int>,
      "upload": <bool>,
      "url": <str>,
      "version": <str>,
      "volumeNumber": <int>
    }
  ],
  "limit": <int>,
  "offset": <int>,
  "totalNumberOfItems": <int>
}

get_artist_mix_id(artist_id: int | str, /, country_code: str | None = None) → dict[str, str]

Get the TIDAL ID of an artist’s mix.

Parameters:

artist_idint or str; positional-only

TIDAL ID of the artist.

Examples: 1566, "4676988".

country_codestr; optional

ISO 3166-1 alpha-2 country code. If not provided, the country associated with the current user account or IP address is used.

Example: "US".

Returns:

mix_iddict[str, str]

TIDAL ID of the artist’s mix.

Sample response: {"id": <str>}.

get_artist_page(artist_id: int | str, /, country_code: str | None = None, *, device_type: str = 'BROWSER', locale: str | None = None) → dict[str, Any]

Get the TIDAL page layout for an artist.

Parameters:

artist_idint or str; positional-only

TIDAL ID of the artist.

Examples: 1566, "4676988".

country_codestr; optional

ISO 3166-1 alpha-2 country code. If not provided, the country associated with the current user account or IP address is used.

Example: "US".

device_typestr; keyword-only; default: "BROWSER"

Device type.

Valid values:

• "BROWSER" – Web browser.

• "DESKTOP" – Desktop TIDAL application.

• "PHONE" – Mobile TIDAL application.

• "TV" – Smart TV TIDAL application.

localestr; keyword-only; optional

IETF BCP 47 language tag.

API default: "en_US" – English (U.S.).

Returns:

pagedict[str, Any]

Layout for the artist page.

Sample response

{
  "id": <str>,
  "rows": [
    {
      "modules": [
        {
          "artist": {
            "artistTypes": <list[str]>,
            "handle": <str>,
            "id": <int>,
            "mixes": {
              "ARTIST_MIX": <str>
            },
            "name": <str>,
            "picture": <str>,
            "selectedAlbumCoverFallback": None,
            "url": <str>
          },
          "artistMix": {
            "id": <str>
          },
          "bio": {
            "source": <str>,
            "text": <str>
          },
          "description": <str>,
          "id": <str>,
          "mixes": {
            "ARTIST_MIX": <str>
          },
          "playbackControls": [
            {
              "icon": <str>,
              "playbackMode": <str>,
              "shuffle": <bool>,
              "targetModuleId": <str>,
              "title": <str>
            }
          ],
          "preTitle": <str>,
          "roleCategories": <Any>,
          "store": <Any>,
          "title": <str>,
          "type": "ARTIST_HEADER",
          "width": <int>
        }
      ]
    },
    {
      "modules": [
        {
          "description": <str>,
          "id": <str>,
          "layout": <str>,
          "listFormat": <str>,
          "pagedList": {
            "dataApiPath": <str>,
            "items": [
              {
                "accessType": <str>,
                "adSupportedStreamReady": <bool>,
                "album": {
                  "cover": <str>,
                  "id": <int>,
                  "releaseDate": <str>,
                  "title": <str>,
                  "url": <str>,
                  "vibrantColor": <str>,
                  "videoCover": <str>
                },
                "allowStreaming": <bool>,
                "artists": [
                  {
                    "handle": <str>,
                    "id": <int>,
                    "name": <str>,
                    "picture": <str>,
                    "type": <str>,
                    "userId": <int>
                  }
                ],
                "audioModes": <list[str]>,
                "audioQuality": <str>,
                "djReady": <bool>,
                "doublePopularity": <float>,
                "duration": <int>,
                "editable": <bool>,
                "explicit": <bool>,
                "id": <int>,
                "mediaMetadata": {
                  "tags": <list[str]>
                },
                "mixes": {
                  "TRACK_MIX": <str>
                },
                "payToStream": <bool>,
                "popularity": <int>,
                "replayGain": <float>,
                "spotlighted": <bool>,
                "stemReady": <bool>,
                "streamReady": <bool>,
                "streamStartDate": <str>,
                "title": <str>,
                "trackNumber": <int>,
                "upload": <bool>,
                "url": <str>,
                "version": <str>,
                "volumeNumber": <int>
              }
            ],
            "limit": <int>,
            "offset": <int>,
            "totalNumberOfItems": <int>
          },
          "preTitle": <str>,
          "quickPlay": <bool>,
          "scroll": <bool>,
          "showMore": {
            "apiPath": <str>,
            "title": <str>
          },
          "showTableHeaders": <bool>,
          "supportsPaging": <bool>,
          "title": <str>,
          "type": "TRACK_LIST",
          "width": <int>
        }
      ]
    },
    {
      "modules": [
        {
          "description": <str>,
          "header": <str>,
          "id": <str>,
          "layout": <str>,
          "listFormat": <str>,
          "pagedList": {
            "dataApiPath": <str>,
            "items": [
              {
                "allowStreaming": <bool>,
                "artists": [
                  {
                    "contributionLinkUrl": <str>,
                    "handle": <str>,
                    "id": <int>,
                    "name": <str>,
                    "picture": <str>,
                    "type": <str>,
                    "userId": <int>
                  }
                ],
                "audioModes": <list[str]>,
                "audioQuality": <str>,
                "cover": <str>,
                "duration": <int>,
                "explicit": <bool>,
                "id": <int>,
                "mediaMetadata": {
                  "tags": <list[str]>
                },
                "numberOfTracks": <int>,
                "numberOfVideos": <int>,
                "payToStream": <bool>,
                "releaseDate": <str>,
                "streamReady": <bool>,
                "streamStartDate": <str>,
                "title": <str>,
                "upload": <bool>,
                "url":<str>,
                "vibrantColor": <str>,
                "videoCover": <str>
              }
            ],
            "limit": <int>,
            "offset": <int>,
            "totalNumberOfItems": <int>
          },
          "preTitle": <str>,
          "quickPlay": <bool>,
          "scroll": <str>,
          "showMore": {
            "apiPath": <str>,
            "title": <str>
          },
          "supportsPaging": <bool>,
          "title": <str>,
          "type": "ALBUM_LIST",
          "width": <int>
        }
      ]
    },
    {
      "modules": [
        {
          "description": <str>,
          "id": <str>,
          "pagedList": {
            "dataApiPath": <str>,
            "items": [
              {
                "item": {
                  "creators": <list[Any]>,
                  "description": <str>,
                  "duration": <int>,
                  "image": <str>,
                  "lastItemAddedAt": <str>,
                  "numberOfTracks": <int>,
                  "numberOfVideos": <int>,
                  "promotedArtists": [
                    {
                      "contributionLinkUrl": <str>,
                      "handle": <str>,
                      "id": <int>,
                      "name": <str>,
                      "picture": <str>,
                      "type": <str>,
                      "userId": <int>
                    }
                  ],
                  "squareImage": <str>,
                  "title": <str>,
                  "type": "EDITORIAL",
                  "url": <str>,
                  "uuid": <str>
                },
                "type": "PLAYLIST"
              }
            ],
            "limit": <int>,
            "offset": <int>,
            "totalNumberOfItems": <int>
          },
          "preTitle": <str>,
          "quickPlay": <bool>,
          "scroll": <str>,
          "showMore": {
            "apiPath": <str>,
            "title": <str>
          },
          "supportsPaging": <bool>,
          "title": <str>,
          "type": "MIXED_TYPES_LIST",
          "width": <int>
        }
      ]
    },
    {
      "modules": [
        {
          "description": <str>,
          "id": <str>,
          "layout": <str>,
          "listFormat": <str>,
          "pagedList": {
            "dataApiPath": <str>,
            "items": [
              {
                "adSupportedStreamReady": <bool>,
                "adsPrePaywallOnly": <bool>,
                "adsUrl": <str>,
                "album": {
                  "cover": <str>,
                  "id": <int>,
                  "title": <str>,
                  "vibrantColor": <str>,
                  "videoCover": <str>
                },
                "allowStreaming": <bool>,
                "artists": [
                  {
                    "handle": <str>,
                    "id": <int>,
                    "name": <str>,
                    "picture": <str>,
                    "type": <str>,
                    "userId": <int>
                  }
                ],
                "djReady": <bool>,
                "doublePopularity": <float>,
                "duration": <int>,
                "explicit": <bool>,
                "id": <int>,
                "imageId": <str>,
                "popularity": <int>,
                "releaseDate": <str>,
                "stemReady": <bool>,
                "streamReady": <bool>,
                "streamStartDate": <str>,
                "title": <str>,
                "trackNumber": <int>,
                "type": "Music Video",
                "url": <str>,
                "version": <str>,
                "vibrantColor": <str>,
                "volumeNumber": <int>
              }
            ],
            "limit": <int>,
            "offset": <int>,
            "totalNumberOfItems": <int>
          },
          "preTitle": <str>,
          "quickPlay": <bool>,
          "scroll": <str>,
          "showMore": {
            "apiPath": <str>,
            "title": <str>
          },
          "showTableHeaders": <bool>,
          "supportsPaging": <bool>,
          "title": <str>,
          "type": "VIDEO_LIST",
          "width": <int>
        }
      ]
    },
    {
      "modules": [
        {
          "description": <str>,
          "header": <str>,
          "id": <str>,
          "layout": <str>,
          "pagedList": {
            "dataApiPath": <str>,
            "items": [
              {
                "artistRoles": [
                  {
                    "category": <str>,
                    "categoryId": <int>
                  }
                ],
                "artistTypes": <list[str]>,
                "id": <int>,
                "mixes": {
                  "ARTIST_MIX": <str>
                },
                "name": <str>,
                "picture": <str>,
                "selectedAlbumCoverFallback": None
              }
            ],
            "limit": <int>,
            "offset": <int>,
            "totalNumberOfItems": <int>
          },
          "preTitle": <str>,
          "quickPlay": <bool>,
          "scroll": <str>,
          "showMore": {
            "apiPath": <str>,
            "title": <str>
          },
          "supportsPaging": <bool>,
          "title": <str>,
          "type": "ARTIST_LIST",
          "width": <int>
        }
      ]
    }
  ],
  "selfLink": <str>,
  "title": <str>
}

get_artist_top_tracks(artist_id: int | str, /, country_code: str | None = None, *, limit: int | None = None, offset: int | None = None) → dict[str, Any]

Get TIDAL catalog information for top tracks by an artist.

Parameters:

artist_idint or str; positional-only

TIDAL ID of the artist.

Examples: 1566, "4676988".

country_codestr; optional

ISO 3166-1 alpha-2 country code. If not provided, the country associated with the current user account or IP address is used.

Example: "US".

limitint; keyword-only; optional

Maximum number of tracks to return.

Valid range: 1 to 100.

API default: 10.

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:

top_tracksdict[str, Any]

Page of TIDAL metadata for the artist’s top tracks.

Sample response

{
  "items": [
    {
      "accessType": <str>,
      "adSupportedStreamReady": <bool>,
      "album": {
        "cover": <str>,
        "id": <int>,
        "title": <str>,
        "vibrantColor": <str>,
        "videoCover": <str>
      },
      "allowStreaming": <bool>,
      "artist": {
        "handle": <str>,
        "id": <int>,
        "name": <str>,
        "picture": <str>,
        "type": <str>
      },
      "artists": [
        {
          "handle": <str>,
          "id": <int>,
          "name": <str>,
          "picture": <str>,
          "type": <str>
        }
      ],
      "audioModes": <list[str]>,
      "audioQuality": <str>,
      "bpm": <int>,
      "copyright": <str>,
      "djReady": <bool>,
      "duration": <int>,
      "editable": <bool>,
      "explicit": <bool>,
      "id": <int>,
      "isrc": <str>,
      "key": <str>,
      "keyScale": <str>,
      "mediaMetadata": {
        "tags": <list[str]>
      },
      "mixes": {
        "TRACK_MIX": <str>
      },
      "payToStream": <bool>,
      "peak": <float>,
      "popularity": <int>,
      "premiumStreamingOnly": <bool>,
      "replayGain": <float>,
      "spotlighted": <bool>,
      "stemReady": <bool>,
      "streamReady": <bool>,
      "streamStartDate": <str>,
      "title": <str>,
      "trackNumber": <int>,
      "upload": <bool>,
      "url": <str>,
      "version": <str>,
      "volumeNumber": <int>
    }
  ],
  "limit": <int>,
  "offset": <int>,
  "totalNumberOfItems": <int>
}

get_artist_videos(artist_id: int | str, /, country_code: str | None = None, *, limit: int | None = None, offset: int | None = None) → dict[str, Any]

Get TIDAL catalog information for videos by an artist.

Parameters:

artist_idint or str; positional-only

TIDAL ID of the artist.

Examples: 1566, "4676988".

country_codestr; optional

ISO 3166-1 alpha-2 country code. If not provided, the country associated with the current user account or IP address is used.

Example: "US".

limitint; keyword-only; optional

Maximum number of videos to return.

Valid range: 1 to 100.

API default: 10.

offsetint; keyword-only; optional

Index of the first video to return. Use with limit to get the next batch of videos.

Minimum value: 0.

API default: 0.

Returns:

videosdict[str, Any]

Page of TIDAL metadata for the artist’s videos.

Sample response

{
  "items": [
    {
      "adSupportedStreamReady": <bool>,
      "adsPrePaywallOnly": <bool>,
      "adsUrl": <str>,
      "album": {
        "cover": <str>,
        "id": <int>,
        "title": <str>,
        "vibrantColor": <str>,
        "videoCover": <str>
      },
      "allowStreaming": <bool>,
      "artist": {
        "handle": <str>,
        "id": <int>,
        "name": <str>,
        "picture": <str>,
        "type": <str>
      },
      "artists": [
        {
          "handle": <str>,
          "id": <int>,
          "name": <str>,
          "picture": <str>,
          "type": <str>
        }
      ],
      "djReady": <bool>,
      "duration": <int>,
      "explicit": <bool>,
      "id": <int>,
      "imageId": <str>,
      "imagePath": <str>,
      "popularity": <int>,
      "quality": <str>,
      "releaseDate": <str>,
      "stemReady": <bool>,
      "streamReady": <bool>,
      "streamStartDate": <str>,
      "title": <str>,
      "trackNumber": <int>,
      "type": <str>,
      "vibrantColor": <str>,
      "volumeNumber": <int>
    }
  ],
  "limit": <int>,
  "offset": <int>,
  "totalNumberOfItems": <int>
}

get_similar_artists(artist_id: int | str, /, country_code: str | None = None, *, limit: int | None = None, offset: int | None = None) → dict[str, Any]

Get TIDAL catalog information for similar artists.

Parameters:

artist_idint or str; positional-only

TIDAL ID of the artist.

Examples: 1566, "4676988".

country_codestr; optional

ISO 3166-1 alpha-2 country code. If not provided, the country associated with the user account is used.

Example: "US".

limitint; keyword-only; optional

Maximum number of artists to return.

Valid range: 1 to 100.

API default: 10.

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:

similar_artistsdict[str, Any]

Page of TIDAL metadata for the similar artists.

Sample response

{
  "items": [
    {
      "artistRoles": <list[str]>,
      "artistTypes": <list[str]>,
      "banner": <str>,
      "handle": <str>,
      "id": <int>,
      "mixes": {
        "ARTIST_MIX": <str>
      },
      "name": <str>,
      "picture": <str>,
      "popularity": <int>,
      "relationType": <str>,
      "selectedAlbumCoverFallback": None,
      "spotlighted": <bool>,
      "type": <str>,
      "url": <str>,
      "userId": <int>
    }
  ],
  "limit": <int>,
  "offset": <int>,
  "source": <str>,
  "totalNumberOfItems": <int>
}

get_user_blocked_artists(user_id: int | str | None = None, /, *, limit: int | None = None, offset: int | None = None) → dict[str, Any]

Get TIDAL catalog information for artists blocked by a user.

User authentication

Required

User authentication

Access and manage the user’s collection.

Parameters:

user_idint or str; positional-only; optional

TIDAL ID of the user. If not specified, the current user’s TIDAL ID is used.

limitint; keyword-only; optional

Maximum number of artists to return.

Valid range: 1 to 100.

API default: 10.

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 TIDAL metadata for artists blocked by the user.

Sample response

{
  "items": [
    {
      "created": <str>,
      "item": {
        "artistRoles": [
          {
            "category": <str>,
            "categoryId": <int>
          }
        ],
        "artistTypes": <list[str]>,
        "banner": <str>,
        "handle": <str>,
        "id": <int>,
        "mixes": {
          "ARTIST_MIX": <str>
        },
        "name": <str>,
        "picture": <str>,
        "popularity": <int>,
        "selectedAlbumCoverFallback": None,
        "spotlighted": <bool>,
        "type": <str>,
        "url": <str>,
        "userId": <int>
      },
      "type": "ARTIST"
    }
  ],
  "limit": <int>,
  "offset": <int>,
  "totalNumberOfItems": <int>
}

get_user_followed_artists(user_id: int | str | None = None, /, country_code: str | None = None, *, limit: int | None = None, offset: int | None = None, sort_by: str | None = None, descending: bool | None = None) → dict[str, Any]

Add artists to a user’s collection.

User authentication

Required

User authentication

Access and manage the user’s collection.

Parameters:

artist_idsint, str, or Collection[int | str]; positional-only

TIDAL IDs of the artists.

Examples: 1566, "4676988", "1566,4676988", [1566, "4676988"].

user_idint or str; optional

TIDAL ID of the user. If not specified, the current user’s TIDAL ID is used.

country_codestr; optional

ISO 3166-1 alpha-2 country code. If not provided, the country associated with the current user account or IP address is used.

Example: "US".

on_missingstr; keyword-only; optional

Behavior when the artists to be favorited cannot be found in the TIDAL catalog.

API default: "FAIL".

unblock_artist(artist_id: int | str, /, user_id: int | str | None = None) → None

Unblock an artist for a user.

User authentication

Required

User authentication

Access and manage the user’s collection.

Parameters:

artist_idint or str; positional-only

TIDAL ID of the artist.

Examples: 1566, "4676988".

user_idint or str; optional

TIDAL ID of the user. If not specified, the current user’s TIDAL ID is used.

unfollow_artists(artist_ids: int | str | Collection[int | str], /, user_id: int | str | None = None) → None

Remove artists from a user’s collection.

User authentication

Required

User authentication

Access and manage the user’s collection.

Parameters:

artist_idsint, str, or Collection[int | str]; positional-only

TIDAL IDs of the artists.

Examples: 1566, "4676988", "1566,4676988", [1566, "4676988"].

user_idint or str; optional

TIDAL ID of the user. If not specified, the current user’s TIDAL ID is used.