Socket
Socket
Sign inDemoInstall

musixmatch

Package Overview
Dependencies
9
Maintainers
1
Versions
7
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    musixmatch

Fetches Lyrics from Musixmatch API


Version published
Weekly downloads
4
increased by33.33%
Maintainers
1
Install size
776 kB
Created
Weekly downloads
 

Readme

Source

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

Keywords

FAQs

Last updated on 05 Dec 2019

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc