Class Playlists

Playlist namespace — fetch, create, update, and delete playlists.

See

https://developers.soundcloud.com/docs/api/explorer/open-api#/playlists

Index

Constructors

constructor

Methods

create delete getPlaylist getReposts getTracks update

Constructors

constructor

new Playlists(getToken: TokenGetter, refreshCtx?: AutoRefreshContext): Playlists
Parameters
- getToken: TokenGetter
- OptionalrefreshCtx: AutoRefreshContext
Returns Playlists
- Defined in src/client/SoundCloudClient.ts:972

Methods

create

create(
params: CreatePlaylistParams,
options?: TokenOption,
): Promise<SoundCloudPlaylist>
Create a new playlist.
Parameters
- params: CreatePlaylistParams
  Playlist creation parameters (title is required)
- Optionaloptions: TokenOption
  Optional token override
Returns Promise<SoundCloudPlaylist>
The created playlist object
Throws
When the API returns an error
Example
```
const playlist = await sc.playlists.create({
  title: 'My Favorites',
  sharing: 'public',
  tracks: [{ urn: 'soundcloud:tracks:123' }],
});
```
See
https://developers.soundcloud.com/docs/api/explorer/open-api#/playlists/post_playlists
- Defined in src/client/SoundCloudClient.ts:1048

delete

delete(playlistId: string | number, options?: TokenOption): Promise<void>
Delete a playlist.
Parameters
- playlistId: string | number
  The playlist's numeric ID or URN
- Optionaloptions: TokenOption
  Optional token override
Returns Promise<void>
Throws
When the API returns an error
Example
```
await sc.playlists.delete(123456);
```
See
https://developers.soundcloud.com/docs/api/explorer/open-api#/playlists/delete_playlists__playlist_id_
- Defined in src/client/SoundCloudClient.ts:1088

getPlaylist

getPlaylist(
playlistId: string | number,
options?: TokenOption,
): Promise<SoundCloudPlaylist>
Get a playlist by ID.
Parameters
- playlistId: string | number
  The playlist's numeric ID or URN
- Optionaloptions: TokenOption
  Optional token override
Returns Promise<SoundCloudPlaylist>
The playlist object with track data
Throws
When the playlist is not found or the API returns an error
Example
```
const playlist = await sc.playlists.getPlaylist(123456);
console.log(playlist.title, playlist.track_count);
```
See
https://developers.soundcloud.com/docs/api/explorer/open-api#/playlists/get_playlists__playlist_id_
- Defined in src/client/SoundCloudClient.ts:991

getReposts

getReposts(
    playlistId: string | number,
    limit?: number,
    options?: TokenOption,
): Promise<SoundCloudPaginatedResponse<SoundCloudUser>>
Get users who have reposted a playlist.
Parameters
- playlistId: string | number
  The playlist's numeric ID or URN
- Optionallimit: number
  Maximum number of users per page
- Optionaloptions: TokenOption
  Optional token override
Returns Promise<SoundCloudPaginatedResponse<SoundCloudUser>>
Paginated list of users who reposted the playlist

Throws
When the API returns an error

See
https://developers.soundcloud.com/docs/api/explorer/open-api#/playlists/get_playlists__playlist_id__reposters
- Defined in src/client/SoundCloudClient.ts:1024

getTracks

getTracks(
    playlistId: string | number,
    limit?: number,
    offset?: number,
    options?: TokenOption,
): Promise<SoundCloudPaginatedResponse<SoundCloudTrack>>
Get tracks in a playlist.
Parameters
- playlistId: string | number
  The playlist's numeric ID or URN
- Optionallimit: number
  Maximum number of tracks per page
- Optionaloffset: number
  Number of tracks to skip (for offset-based pagination)
- Optionaloptions: TokenOption
  Optional token override
Returns Promise<SoundCloudPaginatedResponse<SoundCloudTrack>>
Paginated list of tracks

Throws
When the API returns an error

See
https://developers.soundcloud.com/docs/api/explorer/open-api#/playlists/get_playlists__playlist_id__tracks
- Defined in src/client/SoundCloudClient.ts:1008

update

update(
    playlistId: string | number,
    params: UpdatePlaylistParams,
    options?: TokenOption,
): Promise<SoundCloudPlaylist>
Update a playlist's metadata or track list.
Parameters
- playlistId: string | number
  The playlist's numeric ID or URN
- params: UpdatePlaylistParams
  Fields to update
- Optionaloptions: TokenOption
  Optional token override
Returns Promise<SoundCloudPlaylist>
The updated playlist object
Throws
When the API returns an error
Example
```
const updated = await sc.playlists.update(123456, { title: 'Updated Title' });
```
See
https://developers.soundcloud.com/docs/api/explorer/open-api#/playlists/put_playlists__playlist_id_
- Defined in src/client/SoundCloudClient.ts:1069

Class Playlists

See

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns Playlists

Methods

create

Parameters

Returns Promise<SoundCloudPlaylist>

Throws

Example

See

delete

Parameters

Returns Promise<void>

Throws

Example

See

getPlaylist

Parameters

Returns Promise<SoundCloudPlaylist>

Throws

Example

See

getReposts

Parameters

Returns Promise<SoundCloudPaginatedResponse<SoundCloudUser>>

Throws

See

getTracks

Parameters

Returns Promise<SoundCloudPaginatedResponse<SoundCloudTrack>>

Throws

See

update

Parameters

Returns Promise<SoundCloudPlaylist>

Throws

Example

See

Settings

On This Page