Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

lyricist

Package Overview
Dependencies
Maintainers
1
Versions
9
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

lyricist

Fetches song lyrics using the Genius.com API and website.

  • 2.0.0
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
64
increased by255.56%
Maintainers
1
Weekly downloads
 
Created
Source

Lyricist 🎤

⭐️ Genius.com API client (with lyrics scraper)

v2.0

Version 2.0 is a complete rewrite with promises and async/await.

Installation

yarn add lyricist

or

npm install lyricist --save

API Key

Get an access token at https://genius.com/api-clients.

import Lyricist from 'lyricist';
const lyricist = new Lyricist(accessToken);

Look up a song

Use song() to fetch a song by ID:

const song = await lyricist.song(714198);
console.log(song.title);
// output: Death with Dignity
or with promises:
lyricist.song(714198).then(song => console.log(song.title));

Note: The rest of the examples use async/await for readability.

Get song lyrics

The Genius API doesn't offer lyrics, but Lyricist can scrape Genius.com for you. Simply provide the fetchLyrics option like this:

const lyrics = await lyricist.song(714198, { fetchLyrics: true });

// output: Spirit of my silence I can hear you...

Look up an album

Use album() to look up an album by ID. The Genius API doesn't allow you to search an album by title, but song() will return an album.id:

const album = await lyricist.album(56682);
console.log('%s by %s, album.name, album.artist.name);

// output: Lanterns by Son Lux

Get an album's tracklist

The Genius API doesn't provide tracklists, but Lyricist can scrape Genius.com and return the tracklist for you. Simply provide the fetchTracklist option like this:

const album = await lyricist.album(56682, { fetchTracklist: true });
console.log(album.songs);

// output: [{ id: 502102, title: 'Alternate World' }, { id: 267773, title: 'Lost It To Trying' }, ...]

Look up an artist

Use artist() to look up an artist by ID:

const artist = lyricist.artist(2);
console.log(artist.name);
// output: Jay Z

Get songs by an artist

Use songsByArtist() to list an artist's songs. Example usage:

const songs = lyricist.songsByArtist(2);

songsByArtist() will show 20 results per page by default, and can be as high as 50.

You can provide options as a second parameter. The available options are:

  • perPage: Number (default: 20)
  • page: Number (default: 1)
  • sort String: 'title' or 'popularity' (default: 'title')

Example:

const songs = await lyricist.songsByArtist(2, { page: 2, perPage: 50 });

Warning ⚠️

Take care when fetching lyrics. Use caching and rate-limit your app's requests as much as possible.

Genius API Docs

Check the Genius.com API docs for more info.

Keywords

FAQs

Package last updated on 27 Apr 2017

Did you know?

Socket

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
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc