Class Tracks

Track namespace — fetch, update, delete tracks and their metadata.

See

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

Index

Constructors

constructor

Methods

createComment delete getComments getLikes getRelated getReposts getStreams getTrack update

Constructors

constructor

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

Methods

createComment

createComment(
    trackId: string | number,
    body: string,
    timestamp?: number,
    options?: TokenOption,
): Promise<SoundCloudComment>
Post a comment on a track.
Parameters
- trackId: string | number
  The track's numeric ID or URN
- body: string
  The comment text
- Optionaltimestamp: number
  Position in the track in milliseconds where the comment is placed
- Optionaloptions: TokenOption
  Optional token override
Returns Promise<SoundCloudComment>
The created comment object
Throws
When the API returns an error
Example
```
const comment = await sc.tracks.createComment(123456, 'Great track!', 30000);
console.log(comment.id);
```
See
https://developers.soundcloud.com/docs/api/explorer/open-api#/tracks/post_tracks__track_id__comments
- Defined in src/client/SoundCloudClient.ts:860

delete

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

getComments

getComments(
    trackId: string | number,
    limit?: number,
    options?: TokenOption,
): Promise<SoundCloudPaginatedResponse<SoundCloudComment>>
Get comments on a track.
Parameters
- trackId: string | number
  The track's numeric ID or URN
- Optionallimit: number
  Maximum number of comments per page
- Optionaloptions: TokenOption
  Optional token override
Returns Promise<SoundCloudPaginatedResponse<SoundCloudComment>>
Paginated list of comments

Throws
When the API returns an error

See
https://developers.soundcloud.com/docs/api/explorer/open-api#/tracks/get_tracks__track_id__comments
- Defined in src/client/SoundCloudClient.ts:837

getLikes

getLikes(
    trackId: string | number,
    limit?: number,
    options?: TokenOption,
): Promise<SoundCloudPaginatedResponse<SoundCloudUser>>
Get users who have liked (favorited) a track.
Parameters
- trackId: string | number
  The track'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 liked the track

Throws
When the API returns an error

See
https://developers.soundcloud.com/docs/api/explorer/open-api#/tracks/get_tracks__track_id__favoriters
- Defined in src/client/SoundCloudClient.ts:881

getRelated

getRelated(
    trackId: string | number,
    limit?: number,
    options?: TokenOption,
): Promise<SoundCloudTrack[]>
Get tracks related to a given track.
Parameters
- trackId: string | number
  The track's numeric ID or URN
- Optionallimit: number
  Maximum number of related tracks to return
- Optionaloptions: TokenOption
  Optional token override
Returns Promise<SoundCloudTrack[]>
Array of related tracks
Throws
When the API returns an error
Example
```
const related = await sc.tracks.getRelated(123456, 5);
related.forEach(t => console.log(t.title));
```
See
https://developers.soundcloud.com/docs/api/explorer/open-api#/tracks/get_tracks__track_id__related
- Defined in src/client/SoundCloudClient.ts:919

getReposts

getReposts(
    trackId: string | number,
    limit?: number,
    options?: TokenOption,
): Promise<SoundCloudPaginatedResponse<SoundCloudUser>>
Get users who have reposted a track.
Parameters
- trackId: string | number
  The track'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 track

Throws
When the API returns an error

See
https://developers.soundcloud.com/docs/api/explorer/open-api#/tracks/get_tracks__track_id__reposters
- Defined in src/client/SoundCloudClient.ts:897

getStreams

getStreams(
trackId: string | number,
options?: TokenOption,
): Promise<SoundCloudStreams>
Get stream URLs for a track.
Parameters
- trackId: string | number
  The track's numeric ID or URN
- Optionaloptions: TokenOption
  Optional token override
Returns Promise<SoundCloudStreams>
Object containing available stream URLs (HLS, MP3, preview)
Throws
When the track is not found or not streamable
Example
```
const streams = await sc.tracks.getStreams(123456);
console.log(streams.hls_mp3_128_url);
```
See
https://developers.soundcloud.com/docs/api/explorer/open-api#/tracks/get_tracks__track_id__streams
- Defined in src/client/SoundCloudClient.ts:821

getTrack

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

update

update(
    trackId: string | number,
    params: UpdateTrackParams,
    options?: TokenOption,
): Promise<SoundCloudTrack>
Update a track's metadata.
Parameters
- trackId: string | number
  The track's numeric ID or URN
- params: UpdateTrackParams
  Fields to update (title, description, genre, etc.)
- Optionaloptions: TokenOption
  Optional token override
Returns Promise<SoundCloudTrack>
The updated track object
Throws
When the API returns an error
Example
```
const updated = await sc.tracks.update(123456, { title: 'New Title', genre: 'Electronic' });
console.log(updated.title);
```
See
https://developers.soundcloud.com/docs/api/explorer/open-api#/tracks/put_tracks__track_id_
- Defined in src/client/SoundCloudClient.ts:941

Class Tracks

See

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns Tracks

Methods

createComment

Parameters

Returns Promise<SoundCloudComment>

Throws

Example

See

delete

Parameters

Returns Promise<void>

Throws

Example

See

getComments

Parameters

Returns Promise<SoundCloudPaginatedResponse<SoundCloudComment>>

Throws

See

getLikes

Parameters

Returns Promise<SoundCloudPaginatedResponse<SoundCloudUser>>

Throws

See

getRelated

Parameters

Returns Promise<SoundCloudTrack[]>

Throws

Example

See

getReposts

Parameters

Returns Promise<SoundCloudPaginatedResponse<SoundCloudUser>>

Throws

See

getStreams

Parameters

Returns Promise<SoundCloudStreams>

Throws

Example

See

getTrack

Parameters

Returns Promise<SoundCloudTrack>

Throws

Example

See

update

Parameters

Returns Promise<SoundCloudTrack>

Throws

Example

See

Settings

On This Page