Giter VIP home page Giter VIP logo

poe-api-manager's Introduction

poe-api-manager

MIT License GitHub package.json version GitHub top language ISSUES NPM Downloads

Introduction

The purpose of this library is to make the economic data in the Path of Exile game easily usable.

Important!: For economy, it is taken from the poe.ninja and poe.watch

Note: This product is in no way affiliated with or endorsed by Grinding Gear Games, poe.ninja and poe.watch.

Overwiev

Permission to access two different services. poe.ninja and poe.watch

Installation

Install with npm:

$ npm install poe-api-manager

Getting Started

ninjaAPI

const { NinjaAPI } = require("poe-api-manager");

const ninjaAPI = new NinjaAPI("League-Name");

currencyView

What we can get here is as follows.

  • Currency

  • Fragment

  • getData() => function returns data purely.

//Example Currency
ninjaAPI.currencyView.currency.getData().then((data) => {
  console.log(data);
});
  • getdata(requestedProperties) => The function filters the data as desired.

Note: Enter poe.ninja Document to access the values for the filter.

//Filtered data is returned
ninjaAPI.currencyView.currency.getData(["id", "name", "icon"]).then((data) => {
  console.log(data);
});

itemView

What we can get here is as follows.

  • BaseType

  • Beast

  • Delirium Orbs

  • Divination Cards

  • Essences

  • Fossils

  • Helment Enchant

  • Incubators

  • Maps

  • Oils

  • Resanators

  • Scarabs

  • Skill Gems

  • Unique Accessories

  • Unique Armours

  • Unique Flask

  • Unique Jewels

  • Unique Maps

  • Unique Weapons

  • Vials

  • Omens

  • Unique Relics

  • Cluster Jewels

  • Blighted Maps

  • Blight Ravaged Maps

  • Invitations

  • Memories

  • getData() => function returns data purely.

//Example BaseType
ninjaAPI.itemView.baseType.getData().then((data) => {
  console.log(data);
});
  • getdata(requestedProperties) => The function filters the data as desired.

Note: Enter poe.ninja Document to access the values for the filter.

//Filtered data is returned
ninjaAPI.itemView.baseType.getData(["id", "name", "icon"]).then((data) => {
  console.log(data);
});

watchAPI

const { WatchAPI } = require("poe-api-manager");

const watchAPI = new WatchAPI("League-Name");

view

What we can get here is as follows.

  • Currency

  • Essences

  • Fossil

  • Fragment

  • Gem

  • Invitation

  • Jewel

  • Map

  • Oil

  • Scarab

  • Sextant

  • Accessory

  • Armour

  • Weapon

  • Flask

  • Base

  • Beast

  • getData() => function returns data purely.

//Example Currency
watchAPI.view.baseType.getData().then((data) => {
  console.log(data);
});

Enter poe.watch Document to access the values for the filter.

  • getdata(requestedProperties) => The function filters the data as desired.
//Filtered data is returned
watchAPI.view.currency.getData(["id", "name", "icon"]).then((data) => {
  console.log(data);
});
  • getCategory("categoryName") => The function quickly filters through specific categories.

Note: Used in accessory, armour, base, gem and weapon.

//Returns the chest category in Armor.
watchAPI.view.armour.getCategory("chest").then((data) => {
  console.log(data);
});

Utils

Utils class is a class that contains some auxiliary tools.

const { Utils } = require("poe-api-manager");
const utils = new Utils();
  • getLeagues() => Returns available league names.
utils.getLeagues().then((data) => {
  console.log(data);
});
  • filterProperties(data, properties) => It is used to filter data.
utils.filterProperties(data, ["currencyTypeName", "chaosEquivalent"])
  .then((result) => console.log(result));

Examples

const { NinjaAPI , WatchAPI } = require("poe-api-manager");

// Create NinjaAPI
const ninjaAPI = new NinjaAPI("Affliction");
//Create WatchAPI
const watchAPI = new WatchAPI("Affliction")

//We entered the filter data
const requestedProperties = ["id", "name", "icon"];

//filtered BaseType data ninjaAPI
ninjaAPI.itemView.baseType.getData(requestedProperties).then((data) => {
  console.log(data);
});

//filtered Currency data ninjaAPI
ninjaAPI.currencyView.currency.getData(requestedProperties).then((data) => {
  console.log(data);
});

// filtered Scarab data watchAPI
watchAPI.view.scarab.getData(requestedProperties).then((data) => {
  console.log(data);
});
const { NinjaAPI , WatchAPI } = require("poe-api-manager");

// Create NinjaAPI
const ninjaAPI = new NinjaAPI("Affliction");
//Create WatchAPI
const watchAPI = new WatchAPI("Affliction")

const requestedProperties = ["id", "name", "icon"];

//Using await in an async function
const fetchData = async () => {
  try {
    //Oil Data poe.ninja
    const oilData = await ninjaAPI.itemView.oil.getData(requestedProperties);


    console.log("poe.ninja Oil Data:", oilData);

    //Currency Data poe.ninja
    const currencyData = await ninjaAPI.currencyView.currency.getData(requestedProperties);

    console.log("poe.ninja Currency Data:", currencyData);

    //Scarab Data poe.watch
    const scarabData = await watchAPI.view.scarab.getData(requestedProperties)

    console.log("poe.watch Scarab Data", scarabData);
  } catch (error) {
    console.error("Error fetching data:", error);
  }
};

poe-api-manager's People

Contributors

ayberkgezer avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.