API Reference

tidalapi

class tidalapi.Session(config=<tidalapi.Config object>)[source]
check_login()[source]

Returns true if current session is valid, false otherwise.

get_album(album_id)[source]
get_album_items(album_id)[source]
get_album_tracks(album_id)[source]
get_album_videos(album_id)[source]
get_artist(artist_id)[source]
get_artist_albums(artist_id)[source]
get_artist_albums_ep_singles(artist_id)[source]
get_artist_albums_other(artist_id)[source]
get_artist_bio(artist_id)[source]
get_artist_radio(artist_id)[source]
get_artist_similar(artist_id)[source]
get_artist_top_tracks(artist_id)[source]
get_artist_videos(artist_id)[source]
get_genre_items(genre_id, content_type)[source]
get_genres()[source]
get_media_url(track_id)[source]
get_mood_playlists(mood_id)[source]
get_moods()[source]
get_playlist(playlist_id)[source]
get_playlist_items(playlist_id)[source]
get_playlist_tracks(playlist_id)[source]
get_playlist_videos(playlist_id)[source]
get_track(track_id)[source]
get_track_radio(track_id)[source]
get_track_url(track_id)[source]
get_user(user_id)[source]
get_user_playlists(user_id)[source]
get_video(video_id)[source]
get_video_url(video_id)[source]
load_session(session_id, country_code, user_id)[source]
login(username, password)[source]
request(method, path, params=None, data=None)[source]
search(field, value)[source]
class tidalapi.User(session, id)[source]
favorites = None
playlists()[source]
class tidalapi.Favorites(session, user_id)[source]
add_album(album_id)[source]
add_artist(artist_id)[source]
add_track(track_id)[source]
albums()[source]
artists()[source]
playlists()[source]
remove_album(album_id)[source]
remove_artist(artist_id)[source]
remove_track(track_id)[source]
tracks()[source]

tidalapi.models

class tidalapi.models.Artist(**kwargs)[source]
image
picture(width, height)[source]

A url to an artist picture

Parameters:
  • width (int) – pixel width, maximum 2000
  • height (int) – pixel height, maximum 2000

Original sizes: 80x80, 160x160, 320x320, 480x480, 640x640, 1280x1280

role = None
roles = []
class tidalapi.models.Album(**kwargs)[source]
artist = None
artists = []
duration = -1
image
num_tracks = -1
picture(width, height)[source]

A url to an album picture

Parameters:
  • width (int) – pixel width, maximum 2000
  • height (int) – pixel height, maximum 2000

Original sizes: 80x80, 160x160, 320x320, 640x640 and 1280x1280

release_date = None
class tidalapi.models.Media(**kwargs)[source]
album = None
artist = None
artists = []
available = True
disc_num = 1
duration = -1
popularity = -1
track_num = -1
class tidalapi.models.Track(**kwargs)[source]

Bases: tidalapi.models.Media

class tidalapi.models.Video(**kwargs)[source]

Bases: tidalapi.models.Media

type = None
class tidalapi.models.Playlist(**kwargs)[source]
created = None
creator = None
description = None
duration = -1
image
is_public = None
last_updated = None
num_tracks = -1
picture(width, height)[source]

A url to a playlist picture

Parameters:
  • width (int) – pixel width, maximum 2000
  • height (int) – pixel height, maximum 2000

Original sizes: 160x160, 320x320, 480x480, 640x640, 750x750, 1080x1080

type = None
class tidalapi.models.SearchResult(**kwargs)[source]
albums = []
artists = []
playlists = []
tracks = []