{"id":23389001,"url":"https://github.com/ayberkgezer/poe-api-manager-ts","last_synced_at":"2025-07-15T12:11:49.312Z","repository":{"id":230579016,"uuid":"778527222","full_name":"ayberkgezer/poe-api-manager-ts","owner":"ayberkgezer","description":"poe.ninja and poe.watch API (Typescript version)","archived":false,"fork":false,"pushed_at":"2024-04-21T21:31:38.000Z","size":67,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-04-22T12:21:50.938Z","etag":null,"topics":["npm","path-of-exile","pathofexile","poe","typescript","typescript-library"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ayberkgezer.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-03-27T22:12:01.000Z","updated_at":"2024-04-30T18:40:41.414Z","dependencies_parsed_at":"2024-04-30T16:08:58.738Z","dependency_job_id":null,"html_url":"https://github.com/ayberkgezer/poe-api-manager-ts","commit_stats":null,"previous_names":["ayberkgezer/poe-api-manager-ts"],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ayberkgezer%2Fpoe-api-manager-ts","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ayberkgezer%2Fpoe-api-manager-ts/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ayberkgezer%2Fpoe-api-manager-ts/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ayberkgezer%2Fpoe-api-manager-ts/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ayberkgezer","download_url":"https://codeload.github.com/ayberkgezer/poe-api-manager-ts/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247852277,"owners_count":21006918,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["npm","path-of-exile","pathofexile","poe","typescript","typescript-library"],"created_at":"2024-12-22T02:35:59.359Z","updated_at":"2025-04-08T13:34:07.902Z","avatar_url":"https://github.com/ayberkgezer.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# poe-api-manager-ts\n\n[![MIT License](https://img.shields.io/badge/License-MIT-green.svg)](https://choosealicense.com/licenses/mit/)\n![GitHub package.json version](https://img.shields.io/github/package-json/v/ayberkgezer/poe-api-manager-ts)\n![GitHub top language](https://img.shields.io/github/languages/top/ayberkgezer/poe-api-manager-ts?logo=typescript)\n[![ISSUES](https://img.shields.io/github/issues/ayberkgezer/poe-api-manager-ts)](https://github.com/ayberkgezer/poe-api-manager-ts/issues)\n![NPM Downloads](https://img.shields.io/npm/dt/poe-api-manager-ts?logo=npm)\n\n\n- [Introduction](#introduction)\n- [Overview](#overview)\n- [Installation](#installation)\n- [Getting Started](#getting-started)\n  - [poe.ninja](#ninjaapi)\n    - [currencyView](#currencyview)\n    - [itemView](#itemview)\n  - [poe.watch](#watchapi)\n    - [view](#view)\n  - [utils](#utils)\n- [Changelog](https://github.com/ayberkgezer/poe-api-manager/blob/main/Changelog.md)\n- [Examples](#examples)\n\n\n\n## Introduction\nThe purpose of this library is to make the economic data in the Path of Exile game easily usable. This library is written in typescript.\n\n\u003eImportant!: For economy, it is taken from the poe.ninja and poe.watch\n\n\u003e Note: This product is in no way affiliated with or endorsed by Grinding Gear Games, poe.ninja and poe.watch.\n\n## Overview\n\nPermission to access two different services. poe.ninja and poe.watch\n\n## Installation\n**Install with npm:**\n```bash\n$ npm install poe-api-manager-ts\n```\n**Install with bun:**\n```bash\n$ bun add poe-api-manager-ts\n```\n\n## Getting Started\n\n### ninjaAPI\n```javascript\nconst { NinjaAPI } = require(\"poe-api-manager-ts\");\n\nconst ninjaAPI = new NinjaAPI(\"League-Name\");\n```\n\n#### currencyView\nWhat we can get here is as follows.\n- Currency\n- Fragment\n\n- getData() =\u003e function returns data purely.\n```javascript\n//Example Currency\nninjaAPI.currencyView.currency.getData().then((data) =\u003e {\n  console.log(data);\n});\n```\n- getData(requestedProperties) =\u003e The function filters the data as desired.\n\u003eNote: Enter [poe.ninja Document](https://github.com/ayberkgezer/poe.ninja-API-Document?tab=readme-ov-file#poeninja-api) to access the values for the filter.\n```javascript\n//Filtered data is returned\nninjaAPI.currencyView.currency.getData([\"id\", \"name\", \"icon\"]).then((data) =\u003e {\n  console.log(data);\n});\n```\n- getQuickCurrency() =\u003e This function returns the chaos value from the currency name. It returns \"Divine Orb\" chaos as the default value. currencyTypeName default \"Divine Orb\"\n```javascript\nninjaAPI.currencyView.currency.getQuickCurrency(currencyTypeName).then((data)=\u003e {\n  console.log(data);\n});\n```\n\n#### itemView\nWhat we can get here is as follows.\n- BaseType\n- Beast\n- Delirium Orbs\n- Divination Cards\n- Essences\n- Fossils\n- Helment Enchant\n- Incubators\n- Maps\n- Oils\n- Resanators\n- Scarabs\n- Skill Gems\n- Unique Accessories\n- Unique Armours\n- Unique Flask\n- Unique Jewels\n- Unique Maps\n- Unique Weapons\n- Vials\n- Omens\n- Unique Relics\n- Cluster Jewels\n- Blighted Maps\n- Blight Ravaged Maps\n- Invitations\n- Memories\n- Coffins\n- Allflame Embers\n\n- getData() =\u003e function returns data purely.\n```javascript\n//Example BaseType\nninjaAPI.itemView.baseType.getData().then((data) =\u003e {\n  console.log(data);\n});\n```\n- getdata(requestedProperties) =\u003e The function filters the data as desired.\n\u003eNote: Enter [poe.ninja Document](https://github.com/ayberkgezer/poe.ninja-API-Document?tab=readme-ov-file#poeninja-api) to access the values for the filter.\n```javascript\n//Filtered data is returned\nninjaAPI.itemView.baseType.getData([\"id\", \"name\", \"icon\"]).then((data) =\u003e {\n  console.log(data);\n});\n```\n### watchAPI\n```javascript\nconst { WatchAPI } = require(\"poe-api-manager-ts\");\n\nconst watchAPI = new WatchAPI(\"League-Name\");\n```\n#### view\nWhat we can get here is as follows.\n- Currency\n- Essences\n- Fossil\n- Fragment\n- Gem\n- Invitation\n- Jewel\n- Map\n- Oil\n- Scarab\n- Sextant\n- Accessory\n- Armour\n- Weapon\n- Flask\n- Base\n- Beast\n\n- getData() =\u003e function returns data purely.\n```javascript\n//Example Currency\nwatchAPI.view.baseType.getData().then((data) =\u003e {\n  console.log(data);\n});\n```\n\u003e Enter [poe.watch Document](https://docs.poe.watch/#get-all-armours) to access the values for the filter.\n\n- getdata(requestedProperties) =\u003e The function filters the data as desired.\n```javascript\n//Filtered data is returned\nwatchAPI.view.currency.getData([\"id\", \"name\", \"icon\"]).then((data) =\u003e {\n  console.log(data);\n});\n```\n- getCategory(\"categoryName\") =\u003e The function quickly filters through specific categories.\n\n\u003e Note: Used in accessory, armour, base, gem and weapon.\n\n```javascript\n//Returns the chest category in Armor.\nwatchAPI.view.armour.getCategory(\"chest\").then((data) =\u003e {\n  console.log(data);\n});\n```\n## Utils\nUtils class is a class that contains some auxiliary tools.\n```javascript\nconst { Utils } = require(\"poe-api-manager-ts\");\nconst utils = new Utils();\n```\n- getLeagues() =\u003e Returns available league names.\n\n```javascript\nutils.getLeagues().then((data) =\u003e {\n  console.log(data);\n});\n```\n\n- filterProperties(data, properties) =\u003e It is used to filter data.\n\n```javascript\nutils.filterProperties(data, [\"currencyTypeName\", \"chaosEquivalent\"])\n  .then((result) =\u003e console.log(result));\n```\n\n\n## Examples\n```javascript\nconst { NinjaAPI , WatchAPI } = require(\"poe-api-manager-ts\");\n\n// Create NinjaAPI\nconst ninjaAPI = new NinjaAPI(\"Affliction\");\n//Create WatchAPI\nconst watchAPI = new WatchAPI(\"Affliction\")\n\n//We entered the filter data\nconst requestedProperties = [\"id\", \"name\", \"icon\"];\n\n//filtered BaseType data ninjaAPI\nninjaAPI.itemView.baseType.getData(requestedProperties).then((data) =\u003e {\n  console.log(data);\n});\n\n//filtered Currency data ninjaAPI\nninjaAPI.currencyView.currency.getData(requestedProperties).then((data) =\u003e {\n  console.log(data);\n});\n\n// filtered Scarab data watchAPI\nwatchAPI.view.scarab.getData(requestedProperties).then((data) =\u003e {\n  console.log(data);\n});\n```\n\n```javascript\nconst { NinjaAPI , WatchAPI } = require(\"poe-api-manager-ts\");\n\n// Create NinjaAPI\nconst ninjaAPI = new NinjaAPI(\"Affliction\");\n//Create WatchAPI\nconst watchAPI = new WatchAPI(\"Affliction\")\n\nconst requestedProperties = [\"id\", \"name\", \"icon\"];\n\n//Using await in an async function\nconst fetchData = async () =\u003e {\n  try {\n    //Oil Data poe.ninja\n    const oilData = await ninjaAPI.itemView.oil.getData(requestedProperties);\n\n\n    console.log(\"poe.ninja Oil Data:\", oilData);\n\n    //Currency Data poe.ninja\n    const currencyData = await ninjaAPI.currencyView.currency.getData(requestedProperties);\n\n    console.log(\"poe.ninja Currency Data:\", currencyData);\n\n    //Scarab Data poe.watch\n    const scarabData = await watchAPI.view.scarab.getData(requestedProperties)\n\n    console.log(\"poe.watch Scarab Data\", scarabData);\n  } catch (error) {\n    console.error(\"Error fetching data:\", error);\n  }\n};\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fayberkgezer%2Fpoe-api-manager-ts","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fayberkgezer%2Fpoe-api-manager-ts","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fayberkgezer%2Fpoe-api-manager-ts/lists"}