Welcome to tidalapi’s documentation!
tidalapi
Unofficial Python API for TIDAL music streaming service.
0.7.0 Rewrite
The 0.7.0 rewrite is now complete, see the migration guide for dealing with it
Installation
Install from PyPI using pip
:
$ pip install tidalapi
Example usage
import tidalapi
session = tidalapi.Session()
# Will run until you visit the printed url and link your account
session.login_oauth_simple()
album = session.album(66236918)
tracks = album.tracks()
for track in tracks:
print(track.name)
Documentation
Documentation is available at https://tidalapi.netlify.app/
Indices and tables
- Config
- Login
- Pages
- Playlists
- API Reference
- tidalapi.session
Session
Session.access_token
Session.expiry_time
Session.refresh_token
Session.token_type
Session.session_id
Session.country_code
Session.user
Session.convert_type()
Session.load_session()
Session.load_oauth_session()
Session.login()
Session.login_oauth_simple()
Session.login_oauth()
Session.token_refresh()
Session.search()
Session.check_login()
Session.playlist()
Session.track()
Session.video()
Session.artist()
Session.album()
Session.mix()
Session.get_user()
Session.home()
Session.explore()
Session.videos()
Session.genres()
Session.local_genres()
Session.moods()
Session.mixes()
Config
Quality
VideoQuality
LinkLogin
- tidalapi.artist
Artist
Artist.name
Artist.roles
Artist.role
Artist.picture
Artist.user_date_added
Artist.id
Artist.parse_artist()
Artist.parse_artists()
Artist.get_albums()
Artist.get_albums_ep_singles()
Artist.get_albums_other()
Artist.get_top_tracks()
Artist.get_videos()
Artist.get_bio()
Artist.get_similar()
Artist.get_radio()
Artist.image()
Artist.page()
- tidalapi.user
User
FetchedUser
LoggedInUser
LoggedInUser.username
LoggedInUser.email
LoggedInUser.created
LoggedInUser.newsletter
LoggedInUser.accepted_eula
LoggedInUser.gender
LoggedInUser.date_of_birth
LoggedInUser.facebook_uid
LoggedInUser.apple_uid
LoggedInUser.parse()
LoggedInUser.playlists()
LoggedInUser.playlist_and_favorite_playlists()
LoggedInUser.create_playlist()
PlaylistCreator
Favorites
Favorites.add_album()
Favorites.add_artist()
Favorites.add_playlist()
Favorites.add_track()
Favorites.add_video()
Favorites.remove_artist()
Favorites.remove_album()
Favorites.remove_playlist()
Favorites.remove_track()
Favorites.remove_video()
Favorites.artists()
Favorites.albums()
Favorites.playlists()
Favorites.tracks()
Favorites.videos()
- tidalapi.playlist
Playlist
Playlist.name
Playlist.num_tracks
Playlist.num_videos
Playlist.creator
Playlist.description
Playlist.duration
Playlist.last_updated
Playlist.created
Playlist.type
Playlist.public
Playlist.popularity
Playlist.promoted_artists
Playlist.last_item_added_at
Playlist.picture
Playlist.square_picture
Playlist.user_date_added
Playlist.id
Playlist.parse()
Playlist.factory()
Playlist.parse_factory()
Playlist.tracks()
Playlist.items()
Playlist.image()
Playlist.wide_image()
UserPlaylist
- tidalapi.album
Album
Album.name
Album.cover
Album.video_cover
Album.duration
Album.available
Album.num_tracks
Album.num_videos
Album.num_volumes
Album.tidal_release_date
Album.release_date
Album.copyright
Album.version
Album.explicit
Album.universal_product_number
Album.popularity
Album.user_date_added
Album.artists
Album.artist
Album.id
Album.parse()
Album.year
Album.available_release_date
Album.tracks()
Album.items()
Album.image()
Album.video()
Album.page()
Album.similar()
Album.review()
- tidalapi.media
- tidalapi.genre
- tidalapi.page
- tidalapi.mix
- tidalapi.session
- History
- Migration guides
- Index
- Module Index