Function createSoundCloudRoutes

Returns {
    getFollowers(
        userId: string | number,
    ): Promise<SoundCloudPaginatedResponse<SoundCloudUser>>;
    getFollowings(
        userId: string | number,
    ): Promise<SoundCloudPaginatedResponse<SoundCloudUser>>;
    getPlaylist(playlistId: string | number): Promise<SoundCloudPlaylist>;
    getPlaylistTracks(
        playlistId: string | number,
    ): Promise<SoundCloudPaginatedResponse<SoundCloudTrack>>;
    getRelatedTracks(trackId: string | number): Promise<SoundCloudTrack[]>;
    getTrack(trackId: string | number): Promise<SoundCloudTrack>;
    getTrackComments(
        trackId: string | number,
    ): Promise<SoundCloudPaginatedResponse<SoundCloudComment>>;
    getTrackLikes(
        trackId: string | number,
    ): Promise<SoundCloudPaginatedResponse<SoundCloudUser>>;
    getTrackStreams(trackId: string | number): Promise<SoundCloudStreams>;
    getUser(userId: string | number): Promise<SoundCloudUser>;
    getUserLikesTracks(
        userId: string | number,
    ): Promise<SoundCloudPaginatedResponse<SoundCloudTrack>>;
    getUserPlaylists(
        userId: string | number,
    ): Promise<SoundCloudPaginatedResponse<SoundCloudPlaylist>>;
    getUserTracks(
        userId: string | number,
        limit?: number,
    ): Promise<SoundCloudPaginatedResponse<SoundCloudTrack>>;
    handler(): (request: Request) => Promise<Response>;
    pagesHandler(): (req: any, res: any) => Promise<void>;
    resolveUrl(url: string): Promise<string>;
    searchPlaylists(
        q: string,
    ): Promise<SoundCloudPaginatedResponse<SoundCloudPlaylist>>;
    searchTracks(
        q: string,
        page?: number,
    ): Promise<SoundCloudPaginatedResponse<SoundCloudTrack>>;
    searchUsers(
        q: string,
    ): Promise<SoundCloudPaginatedResponse<SoundCloudUser>>;
}

An object with route handlers and direct API methods.

• getFollowers: function

  • getFollowers(
        userId: string | number,
    ): Promise<SoundCloudPaginatedResponse<SoundCloudUser>>

    Parameters

    • userId: string | number

    Returns Promise<SoundCloudPaginatedResponse<SoundCloudUser>>

• getFollowings: function

  • getFollowings(
        userId: string | number,
    ): Promise<SoundCloudPaginatedResponse<SoundCloudUser>>

    Parameters

    • userId: string | number

    Returns Promise<SoundCloudPaginatedResponse<SoundCloudUser>>

• getPlaylist: function

  • getPlaylist(playlistId: string | number): Promise<SoundCloudPlaylist>

    Parameters

    • playlistId: string | number

    Returns Promise<SoundCloudPlaylist>

• getPlaylistTracks: function

  • getPlaylistTracks(
        playlistId: string | number,
    ): Promise<SoundCloudPaginatedResponse<SoundCloudTrack>>

    Parameters

    • playlistId: string | number

    Returns Promise<SoundCloudPaginatedResponse<SoundCloudTrack>>

• getRelatedTracks: function

  • getRelatedTracks(trackId: string | number): Promise<SoundCloudTrack[]>

    Parameters

    • trackId: string | number

    Returns Promise<SoundCloudTrack[]>

• getTrack: function

  • getTrack(trackId: string | number): Promise<SoundCloudTrack>

    Parameters

    • trackId: string | number

    Returns Promise<SoundCloudTrack>

• getTrackComments: function

  • getTrackComments(
        trackId: string | number,
    ): Promise<SoundCloudPaginatedResponse<SoundCloudComment>>

    Parameters

    • trackId: string | number

    Returns Promise<SoundCloudPaginatedResponse<SoundCloudComment>>

• getTrackLikes: function

  • getTrackLikes(
        trackId: string | number,
    ): Promise<SoundCloudPaginatedResponse<SoundCloudUser>>

    Parameters

    • trackId: string | number

    Returns Promise<SoundCloudPaginatedResponse<SoundCloudUser>>

• getTrackStreams: function

  • getTrackStreams(trackId: string | number): Promise<SoundCloudStreams>

    Parameters

    • trackId: string | number

    Returns Promise<SoundCloudStreams>

• getUser: function

  • getUser(userId: string | number): Promise<SoundCloudUser>

    Parameters

    • userId: string | number

    Returns Promise<SoundCloudUser>

• getUserLikesTracks: function

  • getUserLikesTracks(
        userId: string | number,
    ): Promise<SoundCloudPaginatedResponse<SoundCloudTrack>>

    Parameters

    • userId: string | number

    Returns Promise<SoundCloudPaginatedResponse<SoundCloudTrack>>

• getUserPlaylists: function

  • getUserPlaylists(
        userId: string | number,
    ): Promise<SoundCloudPaginatedResponse<SoundCloudPlaylist>>

    Parameters

    • userId: string | number

    Returns Promise<SoundCloudPaginatedResponse<SoundCloudPlaylist>>

• getUserTracks: function

  • getUserTracks(
        userId: string | number,
        limit?: number,
    ): Promise<SoundCloudPaginatedResponse<SoundCloudTrack>>

    Parameters

    • userId: string | number
    • Optionallimit: number

    Returns Promise<SoundCloudPaginatedResponse<SoundCloudTrack>>

• handler: function

  • handler(): (request: Request) => Promise<Response>

    App Router catch-all handler. Mount at app/api/soundcloud/[...route]/route.ts

    Returns (request: Request) => Promise<Response>

• pagesHandler: function

  • pagesHandler(): (req: any, res: any) => Promise<void>

    Pages Router catch-all handler. Mount at pages/api/soundcloud/[...route].ts

    Returns (req: any, res: any) => Promise<void>

• resolveUrl: function

  • resolveUrl(url: string): Promise<string>

    Individual route handlers

    Parameters

    • url: string

    Returns Promise<string>

• searchPlaylists: function

  • searchPlaylists(
        q: string,
    ): Promise<SoundCloudPaginatedResponse<SoundCloudPlaylist>>

    Parameters

    • q: string

    Returns Promise<SoundCloudPaginatedResponse<SoundCloudPlaylist>>

• searchTracks: function

  • searchTracks(
        q: string,
        page?: number,
    ): Promise<SoundCloudPaginatedResponse<SoundCloudTrack>>

    Parameters

    • q: string
    • Optionalpage: number

    Returns Promise<SoundCloudPaginatedResponse<SoundCloudTrack>>

• searchUsers: function

  • searchUsers(q: string): Promise<SoundCloudPaginatedResponse<SoundCloudUser>>

    Parameters

    • q: string

    Returns Promise<SoundCloudPaginatedResponse<SoundCloudUser>>

// app/api/soundcloud/[...route]/route.ts
import { createSoundCloudRoutes } from "soundcloud-api-ts-next/server";

const sc = createSoundCloudRoutes({
  clientId: process.env.SC_CLIENT_ID!,
  clientSecret: process.env.SC_CLIENT_SECRET!,
  redirectUri: "http://localhost:3000/api/soundcloud/auth/callback",
});

const handle = sc.handler();
export const GET = handle;
export const POST = handle;
export const DELETE = handle;
Copy