The purpose of this library is to make the economic data in the Path of Exile game easily usable. This library is written in typescript.
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.
Permission to access two different services. poe.ninja and poe.watch
Install with npm:
$ npm install poe-api-manager-tsInstall with bun:
$ bun add poe-api-manager-tsconst { NinjaAPI } = require("poe-api-manager-ts");
const ninjaAPI = new NinjaAPI("League-Name");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);
});- getQuickCurrency() => This function returns the chaos value from the currency name. It returns "Divine Orb" chaos as the default value. currencyTypeName default "Divine Orb"
ninjaAPI.currencyView.currency.getQuickCurrency(currencyTypeName).then((data)=> {
console.log(data);
});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
-
Coffins
-
Allflame Embers
-
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);
});const { WatchAPI } = require("poe-api-manager-ts");
const watchAPI = new WatchAPI("League-Name");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 class is a class that contains some auxiliary tools.
const { Utils } = require("poe-api-manager-ts");
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));const { NinjaAPI , WatchAPI } = require("poe-api-manager-ts");
// 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-ts");
// 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);
}
};