theditor / soundcloud.ts Goto Github PK

npm install soundcloud.ts

/*Get track v2*/
const track = await soundcloud.tracks.getV2("succducc/azure")
/*Search tracks v2*/
const tracks = await soundcloud.tracks.searchV2({q: "cool track name"})

/*Get user v2*/
const user = await soundcloud.playlists.getV2("someone")
/*Search users v2*/
const users = await soundcloud.users.searchV2({q: "cool username"})

/*Get playlist (web scraping)*/
const playlist = await soundcloud.playlists.getAlt("virtual-riot/sets/throwback-ep")
/*Search playlists v2*/
const playlists = await soundcloud.playlists.searchV2({q: "cool playlist name"})

import Soundcloud from "soundcloud.ts"

async function useAPI() {
  /*Credentials are optional, client id is manually found if omitted.*/
  const soundcloud = new Soundcloud(process.env.SOUNDCLOUD_CLIENT_ID, process.env.SOUNDCLOUD_OAUTH_TOKEN)

  /*You can get tracks by URL or ID (which can only be gotten from the API)*/
  const track = await soundcloud.tracks.get("https://soundcloud.com/imtenpi/snowflake")
  
  /*Worth to mention that you can omit the soundcloud.com part.*/
  const trackShorthand = await soundcloud.tracks.get("imtenpi/snowflake")

  /*To get the ID with the url of a track/playlist/user, you can use the resolve endpoint.*/
  const id = await soundcloud.resolve.get("https://soundcloud.com/imtenpi/snowflake")

  /*You can search for tracks... with nothing?*/
  const randomSearch = await soundcloud.tracks.search()

  /*But more commonly, you will want to add parameters such as the search query.*/
  const search = await soundcloud.tracks.search({q: "virtual riot"})

  /*You can also get the super secret token that is used on private tracks. Authentication required, 
  and only works with your own tracks.*/
  const secretToken = await soundcloud.tracks.secretToken("imtenpi/kudasai")

  /*Playlists are largely the same, you can use the get() and search() methods.*/
  const playlist = await soundcloud.playlists.get("https://soundcloud.com/imtenpi/sets/my-songs")
}

async function useAPI() {
  /*Users also have a get() and search() method.*/
  const user = await soundcloud.users.get("tenpimusic")
  const userSearch = await soundcloud.users.search({q: "some user"})

  /*You can get the followers and following of a user.*/
  const following = await soundcloud.users.following("imtenpi")
  const followers = await soundcloud.users.followers("imtenpi")
  
  /*Favorite tracks too.*/
  const favorites = await soundcloud.users.favorites("imtenpi")

  /*The web profiles are the social links that show on the side of a user's profile*/
  const socialLinks = await soundcloud.users.webProfiles("imtenpi")

  /*It's very easy to get all of the comments on a track, or all of the comments by a user.*/
  const userComments = await soundcloud.users.comments("imtenpi")
  const trackComments = await soundcloud.tracks.comments("imtenpi/moonlight")

  /*And you can get a specific comment from its ID (must make an API call to get it).*/
  const comment = await soundcloud.comments.get(577904916)
}

async function useAPI() {
  /*If downloads aren't enabled, it will download the stream instead of the original file.*/
  await soundcloud.util.downloadTrack("imtenpi/snowflake", "./tracks")

  /*You can download multiple tracks by passing them as an array to downloadTracks(). The third
  parameter is the limit of tracks to download.*/
  const tracks = await soundcloud.tracks.search({q: "cool track"})
  await soundcloud.util.downloadTracks(tracks, "./tracks", 10)

  /*In addition, there are a bunch of utilities that do the above automatically for convenience.*/
  await soundcloud.util.downloadSearch("virtual riot", "./tracks")
  await soundcloud.util.downloadFavorites("imtenpi", "./tracks")
  await soundcloud.util.downloadPlaylist("https://soundcloud.com/imtenpi/sets/my-songs", "./tracks")

  /*streamTrack() will download the track and will return a stream.Readable automatically.*/
  const readableStream = await soundcloud.util.streamTrack("https://soundcloud.com/virtual-riot/emotionalrmx")
}