Musiclinks

---

Musiclinks is a Node.js client for Music searching. It provides a simple JavaScript API for Music searching programming.

// Import Musiclinks library
const Musiclinks = require("musiclinks");

Prerequisites

---

Node.js

• Node.js version >= 8.19.4

Install Musiclinks

---

Run the following command for the most current version of musiclinks

 npm i musiclinks

Interfaces

interface SearchByUrl {
    title: string,
    id: string,
    image: string,
    links: string[],
    description?: string
}

interface Element {
    name: string,
    id: string,
    image: string,
    url: string
}

interface ArtistAlbum extends Element {
    release_date: string
}

interface QueryOptions {
    q: string,
    type: "artist" | "album" | "track"        
}

Usage

---

Musiclinks is a namespace that contains 3 methods.

Search by url

Musiclinks.search_by_url(spotify_url: string)

Returns a Promise<SearchByUrl>. The spotify_url must be a Spotify URL.

Search by query

Musiclinks.search_by_query(query: QueryOptions)

Returns a Promise<Element[]>. The query is an object with 2 property: q and type. The q is a searching query and the type is the kind of element looking for.

Get artist albums

Musiclinks.search_by_query(spotify_url: string)

Returns a Promise<ArtistAlbum[]>. The spotify_url must be a Spotify URL of an artist.

JavaScript Examples

---

Here are some examples on how to use Musiclinks library.

Search by url

// Get all links of a track, album or artist

await Musiclinks.search_by_url("https://open.spotify.com/artist/4NVhhX3tA4m84EqNNSOJV2");

Search by query

// Search Spotify url of a track, album or artist

await Musiclinks.search_by_query({q:"Leonardo Sartori", type:"artist"})

Get artist albums

// Get all Spotify url of the albums of an artist

await Musiclinks.get_artist_albums("https://open.spotify.com/artist/4NVhhX3tA4m84EqNNSOJV2")