Class Me

Authenticated user namespace — endpoints for the currently logged-in user (/me).

See

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

Index

Constructors

Methods

follow getActivities getActivitiesOwn getActivitiesTracks getFollowers getFollowings getFollowingsTracks getLikesPlaylists getLikesTracks getMe getPlaylists getTracks unfollow

Constructors

constructor

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

Methods

follow

follow(userUrn: string | number, options?: TokenOption): Promise<void>
Follow a user.
Parameters
- userUrn: string | number
  The user's ID or URN to follow
- Optionaloptions: TokenOption
  Optional token override
Returns Promise<void>
Throws
When the API returns an error
Example
```
await sc.me.follow(123456);
```
See
https://developers.soundcloud.com/docs/api/explorer/open-api#/me/put_me_followings__user_id_
- Defined in src/client/SoundCloudClient.ts:556

getActivities

getActivities(
limit?: number,
options?: TokenOption,
): Promise<SoundCloudActivitiesResponse>
Get the authenticated user's activity feed.
Parameters
- Optionallimit: number
  Maximum number of activities per page
- Optionaloptions: TokenOption
  Optional token override
Returns Promise<SoundCloudActivitiesResponse>
Paginated activities response with future_href for polling
Throws
When the API returns an error
Example
```
const activities = await sc.me.getActivities(25);
activities.collection.forEach(a => console.log(a.type, a.created_at));
```
See
https://developers.soundcloud.com/docs/api/explorer/open-api#/me/get_me_activities
- Defined in src/client/SoundCloudClient.ts:441

getActivitiesOwn

getActivitiesOwn(
limit?: number,
options?: TokenOption,
): Promise<SoundCloudActivitiesResponse>
Get the authenticated user's own activities (uploads, reposts).
Parameters
- Optionallimit: number
  Maximum number of activities per page
- Optionaloptions: TokenOption
  Optional token override
Returns Promise<SoundCloudActivitiesResponse>
Paginated activities response

Throws
When the API returns an error

See
https://developers.soundcloud.com/docs/api/explorer/open-api#/me/get_me_activities_all_own
- Defined in src/client/SoundCloudClient.ts:456

getActivitiesTracks

getActivitiesTracks(
limit?: number,
options?: TokenOption,
): Promise<SoundCloudActivitiesResponse>
Get track-related activities in the authenticated user's feed.
Parameters
- Optionallimit: number
  Maximum number of activities per page
- Optionaloptions: TokenOption
  Optional token override
Returns Promise<SoundCloudActivitiesResponse>
Paginated activities response filtered to track activities

Throws
When the API returns an error

See
https://developers.soundcloud.com/docs/api/explorer/open-api#/me/get_me_activities_tracks
- Defined in src/client/SoundCloudClient.ts:471

getFollowers

getFollowers(
limit?: number,
options?: TokenOption,
): Promise<SoundCloudPaginatedResponse<SoundCloudUser>>
Get the authenticated user's followers.
Parameters
- Optionallimit: number
  Maximum number of users per page
- Optionaloptions: TokenOption
  Optional token override
Returns Promise<SoundCloudPaginatedResponse<SoundCloudUser>>
Paginated list of follower users

Throws
When the API returns an error

See
https://developers.soundcloud.com/docs/api/explorer/open-api#/me/get_me_followers
- Defined in src/client/SoundCloudClient.ts:590

getFollowings

getFollowings(
limit?: number,
options?: TokenOption,
): Promise<SoundCloudPaginatedResponse<SoundCloudUser>>
Get users the authenticated user is following.
Parameters
- Optionallimit: number
  Maximum number of users per page
- Optionaloptions: TokenOption
  Optional token override
Returns Promise<SoundCloudPaginatedResponse<SoundCloudUser>>
Paginated list of followed users

Throws
When the API returns an error

See
https://developers.soundcloud.com/docs/api/explorer/open-api#/me/get_me_followings
- Defined in src/client/SoundCloudClient.ts:522

getFollowingsTracks

getFollowingsTracks(
limit?: number,
options?: TokenOption,
): Promise<SoundCloudPaginatedResponse<SoundCloudTrack>>
Get recent tracks from users the authenticated user is following.
Parameters
- Optionallimit: number
  Maximum number of tracks per page
- Optionaloptions: TokenOption
  Optional token override
Returns Promise<SoundCloudPaginatedResponse<SoundCloudTrack>>
Paginated list of tracks from followed users

Throws
When the API returns an error

See
https://developers.soundcloud.com/docs/api/explorer/open-api#/me/get_me_followings_tracks
- Defined in src/client/SoundCloudClient.ts:537

getLikesPlaylists

getLikesPlaylists(
limit?: number,
options?: TokenOption,
): Promise<SoundCloudPaginatedResponse<SoundCloudPlaylist>>
Get playlists liked by the authenticated user.
Parameters
- Optionallimit: number
  Maximum number of playlists per page
- Optionaloptions: TokenOption
  Optional token override
Returns Promise<SoundCloudPaginatedResponse<SoundCloudPlaylist>>
Paginated list of liked playlists

Throws
When the API returns an error

See
https://developers.soundcloud.com/docs/api/explorer/open-api#/me/get_me_likes_playlists
- Defined in src/client/SoundCloudClient.ts:507

getLikesTracks

getLikesTracks(
limit?: number,
options?: TokenOption,
): Promise<SoundCloudPaginatedResponse<SoundCloudTrack>>
Get tracks liked by the authenticated user.
Parameters
- Optionallimit: number
  Maximum number of tracks per page
- Optionaloptions: TokenOption
  Optional token override
Returns Promise<SoundCloudPaginatedResponse<SoundCloudTrack>>
Paginated list of liked tracks
Throws
When the API returns an error
Example
```
const likes = await sc.me.getLikesTracks(50);
likes.collection.forEach(t => console.log(t.title));
```
See
https://developers.soundcloud.com/docs/api/explorer/open-api#/me/get_me_likes_tracks
- Defined in src/client/SoundCloudClient.ts:492

getMe

getMe(options?: TokenOption): Promise<SoundCloudMe>
Get the authenticated user's profile.
Parameters
- Optionaloptions: TokenOption
  Optional token override
Returns Promise<SoundCloudMe>
The authenticated user's full profile
Throws
When the API returns an error
Example
```
const me = await sc.me.getMe();
console.log(me.username, me.followers_count);
```
See
https://developers.soundcloud.com/docs/api/explorer/open-api#/me/get_me
- Defined in src/client/SoundCloudClient.ts:420

getPlaylists

getPlaylists(
limit?: number,
options?: TokenOption,
): Promise<SoundCloudPaginatedResponse<SoundCloudPlaylist>>
Get the authenticated user's playlists.
Parameters
- Optionallimit: number
  Maximum number of playlists per page
- Optionaloptions: TokenOption
  Optional token override
Returns Promise<SoundCloudPaginatedResponse<SoundCloudPlaylist>>
Paginated list of playlists

Throws
When the API returns an error

See
https://developers.soundcloud.com/docs/api/explorer/open-api#/me/get_me_playlists
- Defined in src/client/SoundCloudClient.ts:605

getTracks

getTracks(
limit?: number,
options?: TokenOption,
): Promise<SoundCloudPaginatedResponse<SoundCloudTrack>>
Get the authenticated user's tracks.
Parameters
- Optionallimit: number
  Maximum number of tracks per page
- 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#/me/get_me_tracks
- Defined in src/client/SoundCloudClient.ts:620

unfollow

unfollow(userUrn: string | number, options?: TokenOption): Promise<void>
Unfollow a user.
Parameters
- userUrn: string | number
  The user's ID or URN to unfollow
- Optionaloptions: TokenOption
  Optional token override
Returns Promise<void>
Throws
When the API returns an error
Example
```
await sc.me.unfollow(123456);
```
See
https://developers.soundcloud.com/docs/api/explorer/open-api#/me/delete_me_followings__user_id_
- Defined in src/client/SoundCloudClient.ts:575

Class Me

See

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns Me

Methods

follow

Parameters

Returns Promise<void>

Throws

Example

See

getActivities

Parameters

Returns Promise<SoundCloudActivitiesResponse>

Throws

Example

See

getActivitiesOwn

Parameters

Returns Promise<SoundCloudActivitiesResponse>

Throws

See

getActivitiesTracks

Parameters

Returns Promise<SoundCloudActivitiesResponse>

Throws

See

getFollowers

Parameters

Returns Promise<SoundCloudPaginatedResponse<SoundCloudUser>>

Throws

See

getFollowings

Parameters

Returns Promise<SoundCloudPaginatedResponse<SoundCloudUser>>

Throws

See

getFollowingsTracks

Parameters

Returns Promise<SoundCloudPaginatedResponse<SoundCloudTrack>>

Throws

See

getLikesPlaylists

Parameters

Returns Promise<SoundCloudPaginatedResponse<SoundCloudPlaylist>>

Throws

See

getLikesTracks

Parameters

Returns Promise<SoundCloudPaginatedResponse<SoundCloudTrack>>

Throws

Example

See

getMe

Parameters

Returns Promise<SoundCloudMe>

Throws

Example

See

getPlaylists

Parameters

Returns Promise<SoundCloudPaginatedResponse<SoundCloudPlaylist>>

Throws

See

getTracks

Parameters

Returns Promise<SoundCloudPaginatedResponse<SoundCloudTrack>>

Throws

See

unfollow

Parameters

Returns Promise<void>

Throws

Example

See