Class API

constructor

• new API(clientId?, oauthToken?, proxy?): API

• Parameters

  • Optional clientId: string

  • Optional oauthToken: string

  • Optional proxy: string

  Returns API

api

apiV2

Optional clientId

Optional oauthToken

Optional proxy

web

Static headers

headers

• get headers(): Record<string, any>

• Returns Record<string, any>

get

• get(endpoint, params?): Promise<any>

• Gets an endpoint from the Soundcloud API.

  Parameters

  • endpoint: string

  • Optional params: Record<string, any>

  Returns Promise<any>

getClientId

• getClientId(reset?): Promise<string>

• Parameters

  • Optional reset: boolean

  Returns Promise<string>

getClientIdMobile

• getClientIdMobile(): Promise<string>

• Returns Promise<string>

getClientIdWeb

• getClientIdWeb(): Promise<string>

• Returns Promise<string>

getURL

• getURL(URI, params?): Promise<any>

• Gets a URL, such as download, stream, attachment, etc.

  Parameters

  • URI: string

  • Optional params: Record<string, any>

  Returns Promise<any>

getV2

• getV2(endpoint, params?): Promise<any>

• Gets an endpoint from the Soundcloud V2 API.

  Parameters

  • endpoint: string

  • Optional params: Record<string, any>

  Returns Promise<any>

getWebsite

• getWebsite(endpoint, params?): Promise<any>

• Some endpoints use the main website as the URL.

  Parameters

  • endpoint: string

  • Optional params: Record<string, any>

  Returns Promise<any>

post

• post(endpoint, params?): Promise<any>

• Parameters

  • endpoint: string

  • Optional params: Record<string, any>

  Returns Promise<any>