Class Users

User profile namespace — fetch public user data.

See

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

Index

Constructors

constructor

Methods

getFollowers getFollowings getLikesPlaylists getLikesTracks getPlaylists getTracks getUser getWebProfiles

Constructors

constructor

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

Methods

getFollowers

getFollowers(
    userId: string | number,
    limit?: number,
    options?: TokenOption,
): Promise<SoundCloudPaginatedResponse<SoundCloudUser>>
Get a user's followers.
Parameters
- userId: string | number
  The user's numeric ID or URN
- Optionallimit: number
  Maximum number of followers 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#/users/get_users__user_id__followers
- Defined in src/client/SoundCloudClient.ts:667

getFollowings

getFollowings(
    userId: string | number,
    limit?: number,
    options?: TokenOption,
): Promise<SoundCloudPaginatedResponse<SoundCloudUser>>
Get users that a user is following.
Parameters
- userId: string | number
  The user'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 followed users

Throws
When the API returns an error

See
https://developers.soundcloud.com/docs/api/explorer/open-api#/users/get_users__user_id__followings
- Defined in src/client/SoundCloudClient.ts:683

getLikesPlaylists

getLikesPlaylists(
    userId: string | number,
    limit?: number,
    options?: TokenOption,
): Promise<SoundCloudPaginatedResponse<SoundCloudPlaylist>>
Get playlists liked by a user.
Parameters
- userId: string | number
  The user's numeric ID or URN
- 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#/users/get_users__user_id__likes_playlists
- Defined in src/client/SoundCloudClient.ts:748

getLikesTracks

getLikesTracks(
    userId: string | number,
    limit?: number,
    cursor?: string,
    options?: TokenOption,
): Promise<SoundCloudPaginatedResponse<SoundCloudTrack>>
Get tracks liked by a user.
Parameters
- userId: string | number
  The user's numeric ID or URN
- Optionallimit: number
  Maximum number of tracks per page
- Optionalcursor: string
  Pagination cursor from a previous response's next_href
- Optionaloptions: TokenOption
  Optional token override
Returns Promise<SoundCloudPaginatedResponse<SoundCloudTrack>>
Paginated list of liked tracks

Throws
When the API returns an error

See
https://developers.soundcloud.com/docs/api/explorer/open-api#/users/get_users__user_id__likes_tracks
- Defined in src/client/SoundCloudClient.ts:732

getPlaylists

getPlaylists(
    userId: string | number,
    limit?: number,
    options?: TokenOption,
): Promise<SoundCloudPaginatedResponse<SoundCloudPlaylist>>
Get a user's public playlists.
Parameters
- userId: string | number
  The user's numeric ID or URN
- Optionallimit: number
  Maximum number of playlists per page
- Optionaloptions: TokenOption
  Optional token override
Returns Promise<SoundCloudPaginatedResponse<SoundCloudPlaylist>>
Paginated list of playlists (without full track data)

Throws
When the API returns an error

See
https://developers.soundcloud.com/docs/api/explorer/open-api#/users/get_users__user_id__playlists
- Defined in src/client/SoundCloudClient.ts:715

getTracks

getTracks(
    userId: string | number,
    limit?: number,
    options?: TokenOption,
): Promise<SoundCloudPaginatedResponse<SoundCloudTrack>>
Get a user's public tracks.
Parameters
- userId: string | number
  The user's numeric ID or URN
- 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#/users/get_users__user_id__tracks
- Defined in src/client/SoundCloudClient.ts:699

getUser

getUser(userId: string | number, options?: TokenOption): Promise<SoundCloudUser>
Get a user's profile by ID.
Parameters
- userId: string | number
  The user's numeric ID or URN
- Optionaloptions: TokenOption
  Optional token override
Returns Promise<SoundCloudUser>
The user's public profile
Throws
When the user is not found or the API returns an error
Example
```
const user = await sc.users.getUser(123456);
console.log(user.username, user.followers_count);
```
See
https://developers.soundcloud.com/docs/api/explorer/open-api#/users/get_users__user_id_
- Defined in src/client/SoundCloudClient.ts:651

getWebProfiles

getWebProfiles(
userId: string | number,
options?: TokenOption,
): Promise<SoundCloudWebProfile[]>
Get a user's external web profile links (Twitter, Instagram, etc.).
Parameters
- userId: string | number
  The user's numeric ID or URN
- Optionaloptions: TokenOption
  Optional token override
Returns Promise<SoundCloudWebProfile[]>
Array of web profile objects
Throws
When the API returns an error
Example
```
const profiles = await sc.users.getWebProfiles(123456);
profiles.forEach(p => console.log(p.service, p.url));
```
See
https://developers.soundcloud.com/docs/api/explorer/open-api#/users/get_users__user_id__web_profiles
- Defined in src/client/SoundCloudClient.ts:769

Class Users

See

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns Users

Methods

getFollowers

Parameters

Returns Promise<SoundCloudPaginatedResponse<SoundCloudUser>>

Throws

See

getFollowings

Parameters

Returns Promise<SoundCloudPaginatedResponse<SoundCloudUser>>

Throws

See

getLikesPlaylists

Parameters

Returns Promise<SoundCloudPaginatedResponse<SoundCloudPlaylist>>

Throws

See

getLikesTracks

Parameters

Returns Promise<SoundCloudPaginatedResponse<SoundCloudTrack>>

Throws

See

getPlaylists

Parameters

Returns Promise<SoundCloudPaginatedResponse<SoundCloudPlaylist>>

Throws

See

getTracks

Parameters

Returns Promise<SoundCloudPaginatedResponse<SoundCloudTrack>>

Throws

See

getUser

Parameters

Returns Promise<SoundCloudUser>

Throws

Example

See

getWebProfiles

Parameters

Returns Promise<SoundCloudWebProfile[]>

Throws

Example

See

Settings

On This Page