musixmatch

0.1.6 • Public • Published

musixmatch

npm version npm downloads License

NodeJS module musixmatch API The simplified NodeJS module for request Musixmatch API support. Inspire by https://github.com/c0b41/musixmatch. Request are pretty awesome, but I found myself using it into NodeJS

Also check out here to using the methods that are very similar to request

📖 Release Notes

Setup

Add musixmatch dependency to your project

npm install musixmatch # or yarn add musixmatch 

Declaring & Creating a Client

You need to setup initial configuration you can use all Musixmatch services then followed by method

const Musixmatch = require("musixmatch");
const init = {
    // Required from Musixmatch.com
    apikey: '<Your Musicmatch API Key>',
 
    // Optional default 'https://api.musixmatch.com/ws/1.1/'
    // baseURL will be prepended to `url` unless `url` is absolute.
    baseURL: 'https://api.musixmatch.com/ws/1.1/',
 
    // Optional if you have problem with CORS, default is 'https://cors-anywhere.herokuapp.com/'
    // if you want remove prefix CORS url set value tobe ''
    corsURL: '<Your cors url>',
 
    // Optional default is 'Json'
    format: 'json'
 
  // More Optional Fetches API request
  options: {
        // `headers` are custom headers to be sent
        headers: {......}
    }
}
 
const msx = Musixmatch(init)
 

Initinal Options

These are the available config options for making requests, for more information https://github.com/axios/axios#request-config

Methods

For more information how to use Methods and Params with example... please refer to https://github.com/c0b41/musixmatch#methods

Example

import Musixmatch from 'musixmatch'
 
const msx = Musixmatch({apikey: '<Api Key>'})
 
msx.chartArtists({ country: 'us', page: 1, page_size: 3 }).then(function (data) {
    console.log(data.artist_list)
}).catch(function (err) {
    console.log(err.stack)
})
 

License

MIT License

Copyright (c) IMAN Thanks to: https://www.axfon.com https://atel.us

Package Sidebar

Install

npm i musixmatch

Homepage

atel.us

Weekly Downloads

5

Version

0.1.6

License

MIT

Unpacked Size

6.62 kB

Total Files

6

Last publish

Collaborators

  • imanullah