mineget
TypeScript icon, indicating that this package has built-in type declarations

3.1.1 • Public • Published

mineget

CI npm Discord

mineget is a node.js wrapper for a number of Minecraft marketplace APIs to easily fetch aggregated resource statistics, with typing support via Typescript .d.ts.

Queries are cached for 10 minutes to prevent excessive API calls.

Usage

Example querying total downloads across multiple marketplaces.

import mineget from "mineget";

// Getting the total downloads of a resource
// Methods accept an object containing mappings of marketplace IDs
mineget.downloads({ spigot: 97144, polymart: 1634, craftaro: 758 })
.then((res) => {
  console.log(result)
})
const mineget = require('mineget');

// Getting the total downloads of a resource
// Methods accept an object containing mappings of marketplace IDs
mineget.downloads({spigot: 97144, polymart: 1634, craftaro: 758 })
.then((res) => {
    console.log(result);
});

This example will return a json object with following, note that as craftaro doesn't have a 'downloads' endpoint it is omitted from results:

{
  "status": "success",
  "endpoints": { 
    "spigot": { 
      "downloads": 466 
    }, 
    "polymart": { 
      "downloads": 19 
    }
  },
  "total_downloads": 485
}

Methods

  • #downloads(ids) - Get the total downloads of a resource across multiple marketplaces.
  • #rating(ids) - Get the average rating and number of ratings of a resource across multiple marketplaces.
  • #price(ids) - Get the lowest price and lowest price currency of a resource across multiple marketplaces.
  • #latest_version(ids) - Get the latest version name and published timestamp of a resource across multiple marketplaces.
  • #name(ids) - Get the name of a resource as it is listed on different marketplaces.
  • #get(ids) - Returns all available content from the above methods, and the aggregated data points available from each.

Supported Marketplaces

You can query the following marketplaces with this module. Note that not all marketplaces support returning data for every query.

id url name downloads latest_version rating price
spigot Spigot
polymart Polymart
craftaro Craftaro
modrinth Modrinth
hangar Hangar
github Github

Modrinth, GitHub and Hangar IDs are alphanumeric and accept a string.

If you'd like to add support for more marketplaces and additional marketplace API mappings, you can do so by submitting a pull request editing/adding a new marketplace json.

Queries are handled via Spiget.

License

mineget is licensed under Apache-2.0.

Package Sidebar

Install

npm i mineget

Weekly Downloads

5

Version

3.1.1

License

Apache-2.0

Unpacked Size

656 kB

Total Files

13

Last publish

Collaborators

  • william278