Playlists

getPlaylist(params, requestInit?)

Get a playlist by id.

Example:

const { data: playlist } = await audiusSdk.playlists.getPlaylist({
  playlistId: 'D7KyD',
})
 
console.log(playlist)

Params

Create an object with the following fields and pass it as the first argument, as shown in the example above.

You can pass an optional RequestInit object as the second argument to customize the underlying fetch request (e.g. set custom headers, abort signal, etc.).

Returns

Returns a Promise containing an object with a data field. data contains a PlaylistResponse object.

getBulkPlaylists(params, requestInit?)

Get a list of playlists by ID, UPC, or permalink.

Example:

const { data: playlists } = await audiusSdk.playlists.getBulkPlaylists({
  id: ['D7KyD', '68yPZb'],
})
 
console.log(playlists)

Params

Create an object with the following fields and pass it as the first argument, as shown in the example above.

You can pass an optional RequestInit object as the second argument to customize the underlying fetch request (e.g. set custom headers, abort signal, etc.).

Returns

Returns a Promise containing an object with a data field. data is an array of PlaylistResponse objects.

getPlaylistTracks(params, requestInit?)

Get the tracks in a playlist.

Example:

const { data: tracks } = await audiusSdk.playlists.getPlaylistTracks({
  playlistId: 'D7KyD',
})
 
console.log(tracks)

Params

Create an object with the following fields and pass it as the first argument, as shown in the example above.

You can pass an optional RequestInit object as the second argument to customize the underlying fetch request (e.g. set custom headers, abort signal, etc.).

Returns

The return type is the same as getBulkTracks

getTrendingPlaylists(params?, requestInit?)

Get the top trending playlists on Audius.

Example:

const { data: playlists } = await audiusSdk.playlists.getTrendingPlaylists()
 
console.log(playlists)

Params

Create an object with the following fields and pass it as the first argument, as shown in the example above.

You can pass an optional RequestInit object as the first argument to customize the underlying fetch request (e.g. set custom headers, abort signal, etc.).

Returns

Returns a Promise containing an object with a data field. data is an array of PlaylistResponse objects.

searchPlaylists(params, requestInit?)

Search for playlists.

Example:

const { data: playlists } = await audiusSdk.playlists.searchPlaylists({
  query: 'skrillex',
})
 
console.log(playlists)

Params

Create an object with the following fields and pass it as the first argument, as shown in the example above.

You can pass an optional RequestInit object as the second argument to customize the underlying fetch request (e.g. set custom headers, abort signal, etc.).

Returns

Returns a Promise containing an object with a data field. data is an array of PlaylistResponse objects.

createPlaylist(params, requestInit?)

Create a new playlist.

To upload a cover image, use the Uploads API. Upload your image first to obtain a CID, then pass it as playlistImageSizesMultihash in the metadata object.

Example:

// Optional: Upload a cover image first
const { start: startImageUpload } = audiusSdk.uploads.createImageUpload({
  file: coverImageFile,
})
const coverArtCid = await startImageUpload()
 
const { data } = await audiusSdk.playlists.createPlaylist({
  userId: '7eP5n',
  metadata: {
    playlistName: 'Summer Vibes 2024',
    description: 'The best summer tracks',
    playlistContents: [
      { trackId: 'ePR5Ll', timestamp: Math.round(Date.now() / 1000) },
      { trackId: 'GManBz', timestamp: Math.round(Date.now() / 1000) },
    ],
    playlistImageSizesMultihash: coverArtCid,
  },
})
 
console.log('New playlist ID:', data.playlistId)

Params

Create an object with the following fields and pass it as the first argument, as shown in the example above.

See CreatePlaylistRequestBody for all available metadata fields.

You can pass an optional RequestInit object as the second argument to customize the underlying fetch request (e.g. set custom headers, abort signal, etc.).

Returns

Returns a Promise resolving to an object with the following fields:

{
  playlistId?: string
  transactionHash?: string
}

updatePlaylist(params, requestInit?)

Update an existing playlist's metadata. If any metadata fields are not provided, their values will be kept the same as before. To replace cover art, upload a new image via the Uploads API and pass the new CID in metadata.

Example:

// Optional: Upload a new cover image
const { start: startImageUpload } = audiusSdk.uploads.createImageUpload({
  file: newCoverImageFile,
})
const coverArtCid = await startImageUpload()
 
const { data } = await audiusSdk.playlists.updatePlaylist({
  playlistId: 'D7KyD',
  userId: '7eP5n',
  metadata: {
    playlistName: 'Summer Vibes 2024 (Updated)',
    description: 'Updated playlist description',
    playlistContents: [
      { trackId: 'ePR5Ll', timestamp: Math.round(Date.now() / 1000) },
      { trackId: 'GManBz', timestamp: Math.round(Date.now() / 1000) },
      { trackId: 'KWJm0x', timestamp: Math.round(Date.now() / 1000) },
    ],
    playlistImageSizesMultihash: coverArtCid,
  },
})
 
console.log('Updated playlist:', data)

Params

Create an object with the following fields and pass it as the first argument, as shown in the example above.

All fields are optional — only include the fields you want to change. See UpdatePlaylistRequestBody for all available fields.

You can pass an optional RequestInit object as the second argument to customize the underlying fetch request (e.g. set custom headers, abort signal, etc.).

Returns

Returns a Promise resolving to an object with the following fields:

{
  transactionHash?: string
}

deletePlaylist(params, requestInit?)

Delete a playlist.

Example:

await audiusSdk.playlists.deletePlaylist({
  playlistId: 'D7KyD',
  userId: '7eP5n',
})

Params

Create an object with the following fields and pass it as the first argument, as shown in the example above.

You can pass an optional RequestInit object as the second argument to customize the underlying fetch request (e.g. set custom headers, abort signal, etc.).

Returns

Returns a Promise resolving to an object with the following fields:

{
  transactionHash?: string
}

favoritePlaylist(params, requestInit?)

Favorite a playlist.

Example:

await audiusSdk.playlists.favoritePlaylist({
  playlistId: 'D7KyD',
  userId: '7eP5n',
})

Params

Create an object with the following fields and pass it as the first argument, as shown in the example above.

You can pass an optional RequestInit object as the second argument to customize the underlying fetch request (e.g. set custom headers, abort signal, etc.).

Returns

Returns a Promise resolving to an object with the following fields:

{
  transactionHash?: string
}

unfavoritePlaylist(params, requestInit?)

Unfavorite a playlist.

Example:

await audiusSdk.playlists.unfavoritePlaylist({
  playlistId: 'D7KyD',
  userId: '7eP5n',
})

Params

Create an object with the following fields and pass it as the first argument, as shown in the example above.

You can pass an optional RequestInit object as the second argument to customize the underlying fetch request (e.g. set custom headers, abort signal, etc.).

Returns

Returns a Promise resolving to an object with the following fields:

{
  transactionHash?: string
}

repostPlaylist(params, requestInit?)

Repost a playlist.

Example:

await audiusSdk.playlists.repostPlaylist({
  playlistId: 'D7KyD',
  userId: '7eP5n',
})

Params

Create an object with the following fields and pass it as the first argument, as shown in the example above.

You can pass an optional RequestInit object as the second argument to customize the underlying fetch request (e.g. set custom headers, abort signal, etc.).

Returns

Returns a Promise resolving to an object with the following fields:

{
  transactionHash?: string
}

unrepostPlaylist(params, requestInit?)

Unrepost a playlist.

Example:

await audiusSdk.playlists.unrepostPlaylist({
  playlistId: 'D7KyD',
  userId: '7eP5n',
})

Params

Create an object with the following fields and pass it as the first argument, as shown in the example above.

You can pass an optional RequestInit object as the second argument to customize the underlying fetch request (e.g. set custom headers, abort signal, etc.).

Returns

Returns a Promise resolving to an object with the following fields:

{
  transactionHash?: string
}

Type Reference

PlaylistResponse

GetTrendingPlaylistsTimeEnum

CreatePlaylistRequestBody

UpdatePlaylistRequestBody

All fields are optional — only include the fields you want to change.

PlaylistAddedTimestamp

Represents a track entry within a playlist.