Class Search

Search namespace — search for tracks, users, and playlists.

See

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

Index

Constructors

Methods

playlists tracks users

Constructors

constructor

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

Methods

playlists

playlists(
    query: string,
    pageNumber?: number,
    options?: TokenOption,
): Promise<SoundCloudPaginatedResponse<SoundCloudPlaylist>>
Search for playlists by query string.
Parameters
- query: string
  Search query text
- OptionalpageNumber: number
  Zero-based page number (10 results per page)
- Optionaloptions: TokenOption
  Optional token override
Returns Promise<SoundCloudPaginatedResponse<SoundCloudPlaylist>>
Paginated list of matching playlists
Throws
When the API returns an error
Example
```
const results = await sc.search.playlists('chill vibes');
results.collection.forEach(p => console.log(p.title));
```
See
https://developers.soundcloud.com/docs/api/explorer/open-api#/playlists/get_playlists
- Defined in src/client/SoundCloudClient.ts:1164

tracks

tracks(
    query: string,
    pageNumber?: number,
    options?: TokenOption,
): Promise<SoundCloudPaginatedResponse<SoundCloudTrack>>
Search for tracks by query string.
Parameters
- query: string
  Search query text
- OptionalpageNumber: number
  Zero-based page number (10 results per page)
- Optionaloptions: TokenOption
  Optional token override
Returns Promise<SoundCloudPaginatedResponse<SoundCloudTrack>>
Paginated list of matching tracks
Throws
When the API returns an error
Example
```
const results = await sc.search.tracks('lofi hip hop');
results.collection.forEach(t => console.log(t.title));
```
See
https://developers.soundcloud.com/docs/api/explorer/open-api#/tracks/get_tracks
- Defined in src/client/SoundCloudClient.ts:1120

users

users(
    query: string,
    pageNumber?: number,
    options?: TokenOption,
): Promise<SoundCloudPaginatedResponse<SoundCloudUser>>
Search for users by query string.
Parameters
- query: string
  Search query text
- OptionalpageNumber: number
  Zero-based page number (10 results per page)
- Optionaloptions: TokenOption
  Optional token override
Returns Promise<SoundCloudPaginatedResponse<SoundCloudUser>>
Paginated list of matching users
Throws
When the API returns an error
Example
```
const results = await sc.search.users('deadmau5');
results.collection.forEach(u => console.log(u.username));
```
See
https://developers.soundcloud.com/docs/api/explorer/open-api#/users/get_users
- Defined in src/client/SoundCloudClient.ts:1142