Playlists

Methods

getPlaylist

getPlaylist(requestParameters): Promise<Playlist[]>

Get a playlist by ID

Example:

const playlist = await audiusSdk.playlists.getPlaylist({
    playlistId: "AxRP0",
});

Parameters

Name	Type
requestParameters	GetPlaylistRequest

Returns

Promise<Playlist[]>

---

getPlaylistTracks

getPlaylistTracks(requestParameters): Promise<Track[]>

Fetch tracks within a playlist.

Example:

const tracks = await audiusSdk.playlists.getPlaylistTracks({
    playlistId: "AxRP0",
});

Parameters

Name	Type
requestParameters	GetPlaylistTracksRequest

Returns

Promise<Track[]>

---

getTrendingPlaylists

getTrendingPlaylists(requestParameters?): Promise<Playlist[]>

Gets trending playlists for a time period

Example:

const playlists = await audiusSdk.playlists.getTrendingPlaylists();

Parameters

Name	Type
requestParameters	GetTrendingPlaylistsRequest

Returns

Promise<Playlist[]>

---

searchPlaylists

searchPlaylists(requestParameters): Promise<Playlist[]>

Search for a playlist

Example:

const playlists = await audiusSdk.playlists.searchPlaylists({
    query: 'lo-fi',
});

Parameters

Name	Type
requestParameters	SearchPlaylistsRequest

Returns

Promise<Playlist[]>