Progarchives-client NPM

🎼 Fetch data easily from ProgArchives.com - using this npm package.

Description

Unfortunately, ProgArchives.com does not provide an API for developers.

However, with this npm package, you can easily fetch data and use it in your own program. 😁

Features

🔎 Name correction
💾 Information about an album
✅ Tested
⛏ Maintained

Installation

npm

$ npm i --save progarchives-client

yarn

$ yarn add progarchives-client

API

getAlbumInfo(albumName)

Note: This function is an async function.

Returns information about an album - including artist name, album name, average rating, number of ratings and distribution of ratings.

albumName

Type: string

Note: You do not need to enter the name correctly, the search engine will try to correct it.

Example

const ProgArchivesClient = require('progarchives-client');

(async () => {
  const albumInfo = await ProgArchivesClient.getAlbumInfo('King Crimson - In The Court');
  console.log(albumInfo);

  // {
  //   artistName: 'King Crimson',
  //   albumName: 'In The Court Of The Crimson King',
  //   fullAlbumName: 'King Crimson - In The Court Of The Crimson King',
  //   avgRating: '4.63',
  //   ratings: 4133,
  //   distribution: [ '78%', '16%', '4%', '1%', '0%' ]
  // }
})();