TIDAL
App · 20 actions
Browse TIDAL albums, artists, tracks, playlists, artwork and related catalog resources.
Actions
| Action | What it does |
|---|---|
| Get album | Get album. |
| Get artist | Get artist. |
| Get playlist | Get playlist. |
| Get track | Get track. |
| Get track artists | Get track artists. |
| List album artists | List album artists. |
| List album items | List album items. |
| List albums | List albums. |
| List artist albums | List artist albums. |
| List artist tracks | List artist tracks. |
| List artists | List artists. |
| List playlist items | List playlist items. |
| List playlists | List playlists. |
| List similar albums | List similar albums. |
| List similar artists | List similar artists. |
| List tracks | List tracks. |
| Search albums | Search albums. |
| Search artists | Search artists. |
| Search playlists | Search playlists. |
| Search tracks | Search tracks. |
Get album
Get album.
Inputs
- Resource ID
idtextRequired - Album id
- Country code
country_codetext - ISO 3166-1 alpha-2 country codeOne of:
AD(Andorra),AE(United Arab Emirates),AF(Afghanistan),AG(Antigua & Barbuda),AI(Anguilla),AL(Albania),AM(Armenia),AO(Angola),AQ(Antarctica),AR(Argentina), and 240 more. - Include
includelist - Include related resources. Available relationships: albumStatistics, artists, coverArt, genres, items, owners, priceConfig, providers, replacement, shares, similarAlbums, suggestedCoverArts, usageRules
Outputs
dataobject- The service response, including pagination metadata when present.
Example output
{
"data": {
"data": {
"attributes": {
"accessType": "PUBLIC",
"ai": false,
"albumType": "ALBUM",
"availability": [],
"barcodeId": "example",
"copyright": {
"text": {}
},
"createdAt": "example",
"duration": "example",
"explicit": false,
"externalLinks": [],
"mediaTags": [],
"numberOfItems": 1,
"numberOfVolumes": 1,
"popularity": 1.0,
"published": false,
"releaseDate": "example",
"title": "example",
"type": "ALBUM",
"version": "example"
},
"id": "example",
"relationships": {
"albumStatistics": {
"data": {},
"included": {},
"links": {}
},
"artists": {
"data": {},
"included": {},
"links": {}
},
"coverArt": {
"data": {},
"included": {},
"links": {}
},
"genres": {
"data": {},
"included": {},
"links": {}
},
"items": {
"data": {},
"included": {},
"links": {}
},
"owners": {
"data": {},
"included": {},
"links": {}
},
"priceConfig": {
"data": {},
"included": {},
"links": {}
},
"providers": {
"data": {},
"included": {},
"links": {}
},
"replacement": {
"data": {},
"included": {},
"links": {}
},
"shares": {
"data": {},
"included": {},
"links": {}
},
"similarAlbums": {
"data": {},
"included": {},
"links": {}
},
"suggestedCoverArts": {
"data": {},
"included": {},
"links": {},
"meta": {}
},
"usageRules": {
"data": {},
"included": {},
"links": {}
}
},
"type": "example"
},
"included": [],
"links": {
"meta": {
"nextCursor": "example"
},
"next": "example",
"self": "example"
}
}
}Get artist
Get artist.
Inputs
- Resource ID
idtextRequired - Artist id
- Country code
country_codetext - ISO 3166-1 alpha-2 country codeOne of:
AD(Andorra),AE(United Arab Emirates),AF(Afghanistan),AG(Antigua & Barbuda),AI(Anguilla),AL(Albania),AM(Armenia),AO(Angola),AQ(Antarctica),AR(Argentina), and 240 more. - Include
includelist - Include related resources. Available relationships: albums, bannerArt, biography, claimStatus, followers, following, logoArt, owners, profileArt, radio, roles, similarArtists, trackProviders, tracks, videos
Outputs
dataobject- The service response, including pagination metadata when present.
Example output
{
"data": {
"data": {
"attributes": {
"backgroundColor": "example",
"contributionsEnabled": false,
"contributionsSalesPitch": "example",
"externalLinks": [],
"foregroundColor": "example",
"handle": "example",
"name": "example",
"numberOfFollowers": 1,
"ownerType": "LABEL",
"popularity": 1.0,
"spotlighted": false
},
"id": "example",
"relationships": {
"albums": {
"data": {},
"included": {},
"links": {}
},
"bannerArt": {
"data": {},
"included": {},
"links": {}
},
"biography": {
"data": {},
"included": {},
"links": {}
},
"claimStatus": {
"data": {},
"included": {},
"links": {}
},
"followers": {
"data": {},
"included": {},
"links": {}
},
"following": {
"data": {},
"included": {},
"links": {}
},
"logoArt": {
"data": {},
"included": {},
"links": {}
},
"owners": {
"data": {},
"included": {},
"links": {}
},
"profileArt": {
"data": {},
"included": {},
"links": {}
},
"radio": {
"data": {},
"included": {},
"links": {}
},
"roles": {
"data": {},
"included": {},
"links": {}
},
"similarArtists": {
"data": {},
"included": {},
"links": {}
},
"trackProviders": {
"data": {},
"included": {},
"links": {}
},
"tracks": {
"data": {},
"included": {},
"links": {}
},
"videos": {
"data": {},
"included": {},
"links": {}
}
},
"type": "example"
},
"included": [],
"links": {
"meta": {
"nextCursor": "example"
},
"next": "example",
"self": "example"
}
}
}Get playlist
Get playlist.
Inputs
- Resource ID
idtextRequired - Playlist id
- Country code
country_codetext - ISO 3166-1 alpha-2 country codeOne of:
AD(Andorra),AE(United Arab Emirates),AF(Afghanistan),AG(Antigua & Barbuda),AI(Anguilla),AL(Albania),AM(Armenia),AO(Angola),AQ(Antarctica),AR(Argentina), and 240 more. - Include
includelist - Include related resources. Available relationships: collaboratorProfiles, collaborators, coverArt, curators, items, ownerProfiles, owners, suggestedCoverArts
Outputs
dataobject- The service response, including pagination metadata when present.
Example output
{
"data": {
"data": {
"attributes": {
"accessType": "PUBLIC",
"bounded": false,
"createdAt": "example",
"description": "example",
"duration": "example",
"externalLinks": [],
"hasGenerations": false,
"lastModifiedAt": "example",
"name": "example",
"numberOfFollowers": 1,
"numberOfItems": 1,
"numberOfTrackItems": 1,
"numberOfVideoItems": 1,
"playlistType": "EDITORIAL"
},
"id": "example",
"relationships": {
"collaboratorProfiles": {},
"collaborators": {
"data": {},
"included": {},
"links": {}
},
"coverArt": {
"data": {},
"included": {},
"links": {}
},
"curators": {
"data": {},
"included": {},
"links": {}
},
"items": {
"data": {},
"included": {},
"links": {}
},
"ownerProfiles": {},
"owners": {
"data": {},
"included": {},
"links": {}
},
"suggestedCoverArts": {
"data": {},
"included": {},
"links": {}
}
},
"type": "example"
},
"included": [],
"links": {
"meta": {
"nextCursor": "example"
},
"next": "example",
"self": "example"
}
}
}Get track
Get track.
Inputs
- Resource ID
idtextRequired - Track id
- Country code
country_codetext - ISO 3166-1 alpha-2 country codeOne of:
AD(Andorra),AE(United Arab Emirates),AF(Afghanistan),AG(Antigua & Barbuda),AI(Anguilla),AL(Albania),AM(Armenia),AO(Angola),AQ(Antarctica),AR(Argentina), and 240 more. - Include
includelist - Include related resources. Available relationships: albums, artists, credits, download, genres, lyrics, metadataStatus, owners, priceConfig, providers, radio, replacement, shares, similarTracks, sourceFile, suggestedTracks, trackStatistics, usageRules
Outputs
dataobject- The service response, including pagination metadata when present.
Example output
{
"data": {
"data": {
"attributes": {
"accessType": "PUBLIC",
"ai": false,
"availability": [],
"bpm": 1.0,
"copyright": {
"text": {}
},
"createdAt": "example",
"duration": "example",
"explicit": false,
"externalLinks": [],
"isrc": "example",
"key": "UNKNOWN",
"keyScale": "UNKNOWN",
"mediaTags": [],
"popularity": 1.0,
"spotlighted": false,
"title": "example",
"toneTags": [],
"version": "example"
},
"id": "example",
"relationships": {
"albums": {
"data": {},
"included": {},
"links": {}
},
"artists": {
"data": {},
"included": {},
"links": {}
},
"credits": {
"data": {},
"included": {},
"links": {}
},
"download": {
"data": {},
"included": {},
"links": {}
},
"genres": {
"data": {},
"included": {},
"links": {}
},
"lyrics": {
"data": {},
"included": {},
"links": {}
},
"metadataStatus": {
"data": {},
"included": {},
"links": {}
},
"owners": {
"data": {},
"included": {},
"links": {}
},
"priceConfig": {
"data": {},
"included": {},
"links": {}
},
"providers": {
"data": {},
"included": {},
"links": {}
},
"radio": {
"data": {},
"included": {},
"links": {}
},
"replacement": {
"data": {},
"included": {},
"links": {}
},
"shares": {
"data": {},
"included": {},
"links": {}
},
"similarTracks": {
"data": {},
"included": {},
"links": {}
},
"sourceFile": {
"data": {},
"included": {},
"links": {}
},
"suggestedTracks": {
"data": {},
"included": {},
"links": {}
},
"trackStatistics": {
"data": {},
"included": {},
"links": {}
},
"usageRules": {
"data": {},
"included": {},
"links": {}
}
},
"type": "example"
},
"included": [],
"links": {
"meta": {
"nextCursor": "example"
},
"next": "example",
"self": "example"
}
}
}Get track artists
Get track artists.
Inputs
- Resource ID
idtextRequired - Track id
- Country code
country_codetext - ISO 3166-1 alpha-2 country codeOne of:
AD(Andorra),AE(United Arab Emirates),AF(Afghanistan),AG(Antigua & Barbuda),AI(Anguilla),AL(Albania),AM(Armenia),AO(Angola),AQ(Antarctica),AR(Argentina), and 240 more. - Include
includelist - Include related resources. Available relationships: artists
- Page cursor
page_cursortext - Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified
Outputs
dataobject- The service response, including pagination metadata when present.
Example output
{
"data": {
"data": [],
"included": [],
"links": {
"meta": {
"nextCursor": "example"
},
"next": "example",
"self": "example"
}
}
}List album artists
List album artists.
Inputs
- Resource ID
idtextRequired - Album id
- Country code
country_codetext - ISO 3166-1 alpha-2 country codeOne of:
AD(Andorra),AE(United Arab Emirates),AF(Afghanistan),AG(Antigua & Barbuda),AI(Anguilla),AL(Albania),AM(Armenia),AO(Angola),AQ(Antarctica),AR(Argentina), and 240 more. - Include
includelist - Include related resources. Available relationships: artists
- Page cursor
page_cursortext - Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified
Outputs
dataobject- The service response, including pagination metadata when present.
Example output
{
"data": {
"data": [],
"included": [],
"links": {
"meta": {
"nextCursor": "example"
},
"next": "example",
"self": "example"
}
}
}List album items
List album items.
Inputs
- Resource ID
idtextRequired - Album id
- Country code
country_codetext - ISO 3166-1 alpha-2 country codeOne of:
AD(Andorra),AE(United Arab Emirates),AF(Afghanistan),AG(Antigua & Barbuda),AI(Anguilla),AL(Albania),AM(Armenia),AO(Angola),AQ(Antarctica),AR(Argentina), and 240 more. - Include
includelist - Include related resources. Available relationships: items
- Page cursor
page_cursortext - Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified
Outputs
dataobject- The service response, including pagination metadata when present.
Example output
{
"data": {
"data": [],
"included": [],
"links": {
"meta": {
"nextCursor": "example"
},
"next": "example",
"self": "example"
}
}
}List albums
List albums.
Inputs
- Country code
country_codetext - ISO 3166-1 alpha-2 country codeOne of:
AD(Andorra),AE(United Arab Emirates),AF(Afghanistan),AG(Antigua & Barbuda),AI(Anguilla),AL(Albania),AM(Armenia),AO(Angola),AQ(Antarctica),AR(Argentina), and 240 more. - Barcode id
filter_barcode_idlist - List of barcode IDs (EAN-13 or UPC-A). NOTE: Supplying more than one barcode ID will currently only return one album per barcode ID. (e.g. `196589525444`)
- Id
filter_idlist - List of album IDs (e.g. `251380836`)
- Owners id
filter_owners_idlist - User id. Also accepts `me`.
- Include
includelist - Include related resources. Available relationships: albumStatistics, artists, coverArt, genres, items, owners, priceConfig, providers, replacement, shares, similarAlbums, suggestedCoverArts, usageRules
- Page cursor
page_cursortext - Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified
Outputs
dataobject- The service response, including pagination metadata when present.
Example output
{
"data": {
"data": [],
"included": [],
"links": {
"meta": {
"nextCursor": "example"
},
"next": "example",
"self": "example"
}
}
}List artist albums
List artist albums.
Inputs
- Resource ID
idtextRequired - Artist id
- Country code
country_codetext - ISO 3166-1 alpha-2 country codeOne of:
AD(Andorra),AE(United Arab Emirates),AF(Afghanistan),AG(Antigua & Barbuda),AI(Anguilla),AL(Albania),AM(Armenia),AO(Angola),AQ(Antarctica),AR(Argentina), and 240 more. - Include
includelist - Include related resources. Available relationships: albums
- Page cursor
page_cursortext - Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified
Outputs
dataobject- The service response, including pagination metadata when present.
Example output
{
"data": {
"data": [],
"included": [],
"links": {
"meta": {
"nextCursor": "example"
},
"next": "example",
"self": "example"
}
}
}List artist tracks
List artist tracks.
Inputs
- Collapse by
collapse_bytextRequired - Collapse by options for getting artist tracks. Available options: FINGERPRINT, ID. FINGERPRINT option might collapse similar tracks based entry fingerprints while collapsing by ID always returns all available items.One of:
FINGERPRINT,NONE. - Resource ID
idtextRequired - Artist id
- Country code
country_codetext - ISO 3166-1 alpha-2 country codeOne of:
AD(Andorra),AE(United Arab Emirates),AF(Afghanistan),AG(Antigua & Barbuda),AI(Anguilla),AL(Albania),AM(Armenia),AO(Angola),AQ(Antarctica),AR(Argentina), and 240 more. - Include
includelist - Include related resources. Available relationships: tracks
- Page cursor
page_cursortext - Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified
Outputs
dataobject- The service response, including pagination metadata when present.
Example output
{
"data": {
"data": [],
"included": [],
"links": {
"meta": {
"nextCursor": "example"
},
"next": "example",
"self": "example"
}
}
}List artists
List artists.
Inputs
- Country code
country_codetext - ISO 3166-1 alpha-2 country codeOne of:
AD(Andorra),AE(United Arab Emirates),AF(Afghanistan),AG(Antigua & Barbuda),AI(Anguilla),AL(Albania),AM(Armenia),AO(Angola),AQ(Antarctica),AR(Argentina), and 240 more. - Id
filter_idlist - List of artist IDs (e.g. `1566`)
- Owners id
filter_owners_idlist - User id. Also accepts `me`.
- Include
includelist - Include related resources. Available relationships: albums, bannerArt, biography, claimStatus, followers, following, logoArt, owners, profileArt, radio, roles, similarArtists, trackProviders, tracks, videos
Outputs
dataobject- The service response, including pagination metadata when present.
Example output
{
"data": {
"data": [],
"included": [],
"links": {
"meta": {
"nextCursor": "example"
},
"next": "example",
"self": "example"
}
}
}List playlist items
List playlist items.
Inputs
- Resource ID
idtextRequired - Playlist id
- Country code
country_codetext - ISO 3166-1 alpha-2 country codeOne of:
AD(Andorra),AE(United Arab Emirates),AF(Afghanistan),AG(Antigua & Barbuda),AI(Anguilla),AL(Albania),AM(Armenia),AO(Angola),AQ(Antarctica),AR(Argentina), and 240 more. - Include
includelist - Include related resources. Available relationships: items
- Page cursor
page_cursortext - Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified
Outputs
dataobject- The service response, including pagination metadata when present.
Example output
{
"data": {
"data": [],
"included": [],
"links": {
"meta": {
"nextCursor": "example"
},
"next": "example",
"self": "example"
}
}
}List playlists
List playlists.
Inputs
- Country code
country_codetext - ISO 3166-1 alpha-2 country codeOne of:
AD(Andorra),AE(United Arab Emirates),AF(Afghanistan),AG(Antigua & Barbuda),AI(Anguilla),AL(Albania),AM(Armenia),AO(Angola),AQ(Antarctica),AR(Argentina), and 240 more. - Id
filter_idlist - List of playlist IDs (e.g. `550e8400-e29b-41d4-a716-446655440000`)
- Owners id
filter_owners_idlist - User id. Also accepts `me`.
- Include
includelist - Include related resources. Available relationships: collaboratorProfiles, collaborators, coverArt, curators, items, ownerProfiles, owners, suggestedCoverArts
- Page cursor
page_cursortext - Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified
Outputs
dataobject- The service response, including pagination metadata when present.
Example output
{
"data": {
"data": [],
"included": [],
"links": {
"meta": {
"nextCursor": "example"
},
"next": "example",
"self": "example"
}
}
}List similar albums
List similar albums.
Inputs
- Resource ID
idtextRequired - Album id
- Country code
country_codetext - ISO 3166-1 alpha-2 country codeOne of:
AD(Andorra),AE(United Arab Emirates),AF(Afghanistan),AG(Antigua & Barbuda),AI(Anguilla),AL(Albania),AM(Armenia),AO(Angola),AQ(Antarctica),AR(Argentina), and 240 more. - Include
includelist - Include related resources. Available relationships: similarAlbums
- Page cursor
page_cursortext - Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified
Outputs
dataobject- The service response, including pagination metadata when present.
Example output
{
"data": {
"data": [],
"included": [],
"links": {
"meta": {
"nextCursor": "example"
},
"next": "example",
"self": "example"
}
}
}List similar artists
List similar artists.
Inputs
- Resource ID
idtextRequired - Artist id
- Country code
country_codetext - ISO 3166-1 alpha-2 country codeOne of:
AD(Andorra),AE(United Arab Emirates),AF(Afghanistan),AG(Antigua & Barbuda),AI(Anguilla),AL(Albania),AM(Armenia),AO(Angola),AQ(Antarctica),AR(Argentina), and 240 more. - Include
includelist - Include related resources. Available relationships: similarArtists
- Page cursor
page_cursortext - Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified
Outputs
dataobject- The service response, including pagination metadata when present.
Example output
{
"data": {
"data": [],
"included": [],
"links": {
"meta": {
"nextCursor": "example"
},
"next": "example",
"self": "example"
}
}
}List tracks
List tracks.
Inputs
- Country code
country_codetext - ISO 3166-1 alpha-2 country codeOne of:
AD(Andorra),AE(United Arab Emirates),AF(Afghanistan),AG(Antigua & Barbuda),AI(Anguilla),AL(Albania),AM(Armenia),AO(Angola),AQ(Antarctica),AR(Argentina), and 240 more. - Id
filter_idlist - List of track IDs (e.g. `75413016`)
- Owners id
filter_owners_idlist - User id. Also accepts `me`.
- Include
includelist - Include related resources. Available relationships: albums, artists, credits, download, genres, lyrics, metadataStatus, owners, priceConfig, providers, radio, replacement, shares, similarTracks, sourceFile, suggestedTracks, trackStatistics, usageRules
- Page cursor
page_cursortext - Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified
Outputs
dataobject- The service response, including pagination metadata when present.
Example output
{
"data": {
"data": [],
"included": [],
"links": {
"meta": {
"nextCursor": "example"
},
"next": "example",
"self": "example"
}
}
}Search albums
Search albums.
Inputs
- Search text
idtextRequired - An opaque search results identifier
- Country code
country_codetext - ISO 3166-1 alpha-2 country codeOne of:
AD(Andorra),AE(United Arab Emirates),AF(Afghanistan),AG(Antigua & Barbuda),AI(Anguilla),AL(Albania),AM(Armenia),AO(Angola),AQ(Antarctica),AR(Argentina), and 240 more. - Include
includelist - Include related resources. Available relationships: albums
- Page cursor
page_cursortext - Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified
Outputs
dataobject- The service response, including pagination metadata when present.
Example output
{
"data": {
"data": [],
"included": [],
"links": {
"meta": {
"nextCursor": "example"
},
"next": "example",
"self": "example"
}
}
}Search artists
Search artists.
Inputs
- Search text
idtextRequired - An opaque search results identifier
- Country code
country_codetext - ISO 3166-1 alpha-2 country codeOne of:
AD(Andorra),AE(United Arab Emirates),AF(Afghanistan),AG(Antigua & Barbuda),AI(Anguilla),AL(Albania),AM(Armenia),AO(Angola),AQ(Antarctica),AR(Argentina), and 240 more. - Include
includelist - Include related resources. Available relationships: artists
- Page cursor
page_cursortext - Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified
Outputs
dataobject- The service response, including pagination metadata when present.
Example output
{
"data": {
"data": [],
"included": [],
"links": {
"meta": {
"nextCursor": "example"
},
"next": "example",
"self": "example"
}
}
}Search playlists
Search playlists.
Inputs
- Search text
idtextRequired - An opaque search results identifier
- Country code
country_codetext - ISO 3166-1 alpha-2 country codeOne of:
AD(Andorra),AE(United Arab Emirates),AF(Afghanistan),AG(Antigua & Barbuda),AI(Anguilla),AL(Albania),AM(Armenia),AO(Angola),AQ(Antarctica),AR(Argentina), and 240 more. - Include
includelist - Include related resources. Available relationships: playlists
- Page cursor
page_cursortext - Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified
Outputs
dataobject- The service response, including pagination metadata when present.
Example output
{
"data": {
"data": [],
"included": [],
"links": {
"meta": {
"nextCursor": "example"
},
"next": "example",
"self": "example"
}
}
}Search tracks
Search tracks.
Inputs
- Search text
idtextRequired - An opaque search results identifier
- Country code
country_codetext - ISO 3166-1 alpha-2 country codeOne of:
AD(Andorra),AE(United Arab Emirates),AF(Afghanistan),AG(Antigua & Barbuda),AI(Anguilla),AL(Albania),AM(Armenia),AO(Angola),AQ(Antarctica),AR(Argentina), and 240 more. - Include
includelist - Include related resources. Available relationships: tracks
- Page cursor
page_cursortext - Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified
Outputs
dataobject- The service response, including pagination metadata when present.
Example output
{
"data": {
"data": [],
"included": [],
"links": {
"meta": {
"nextCursor": "example"
},
"next": "example",
"self": "example"
}
}
}