ksoft.js
  • KSoft.js
  • Response Types
  • Endpoints
    • Images
    • Bans
    • Kumo
    • Music
Powered by GitBook
On this page
  • Get Lyrics for a song
  • Search lyrics
  • Get Artist/Track/Album by ID
  • Get Music Recommendations (paid)
  1. Endpoints

Music

This API provides deep and powerful tools for searching lyrics, artists or albums. Unlike other APIs it can also search by lyrics and does not need separate artist and song name entries.

Get Lyrics for a song

ksoft.lyrics.get(song, options);

Parameter

Type

song

String

options.textOnly

Boolean

Success: Returns Track

Not Found: Throws Error

ksoft.lyrics.get('Billie Eyelash - Bald Guy');
ksoft.lyrics.get('Is this the real life? Is this just fantasy?',
    { textOnly: true });

Search lyrics

ksoft.lyrics.search(query, options);

Parameter

Type

query

String

options.limit

Number

options.textOnly

Boolean

Success: Returns Array<Track>

Not Found: Throws Error

ksoft.lyrics.search('Billie Eyelash', { limit: 5 })
    .catch(err => console.log(err.message));
ksoft.lyrics.search("I'm the baaaaaad guyyyy (duh)", { textOnly: true });

Get Artist/Track/Album by ID

ksoft.music.artist(id);
ksoft.music.track(id);
ksoft.music.album(id);

Parameter

Type

id

String

Success: Returns Artist/Track/Album

Not Found: Throws Error

ksoft.music.artist('28333');
ksoft.music.track('628942');
ksoft.music.album('88287');

Get Music Recommendations (paid)

ksoft.music.recommendations(provider, tracks, token, options);

Parameter

Type

provider

String: 'spotify' | 'youtube' | 'youtube_ids' | 'youtube_titles'

tracks

Array<String> (track IDs or titles depending on provider)

token

String (YouTube API token)

options.limit

Number

Success: Returns Array<Suggestion>

ksoft.music.recommendations('youtube_titles', [
    'Luis - Des',
    'Luis - Pa',
    'Fonsi - Ci',
    'Fonsi - To'
], 'you-wish-i-put-one-here', { limit: 3 });
PreviousKumo

Last updated 5 years ago