warframe-nexus-query
Version:
Query prices form nexus-stats.com and warframe.market.
48 lines (33 loc) • 4.01 kB
Markdown
# warframe-nexus-query
[](https://github.com/WFCD/banner/blob/master/PROJECTS.md)
[](https://discord.gg/jGZxH9f)
A node project for allowing simple summary of the [Warframe.Market](https://warframe.market) pricing API.
## Installation
```
npm install --save warframe-nexus-query
```
## Usage
| Require | Module File | Accessor | Description | parameters |
|------------------------|-------------|--------------------------|---------------------------------------------------------|---------------------|
| `warframe-nexus-query` | `index.js` | `.priceCheckQueryString` | Get Query result string | `query`, `callback` |
| `warframe-nexus-query` | `index.js` | `.priceCheckQuery` | Get Query result objects, has more parameters available | `query`, `callback` |
## Environment variables
| Variable | example | default |
|------------------------------|---------------------------------|-------------------------------|
| `NEXUSSTATS_MAX_CACHED_TIME` | `600000` | `30000` |
| `NEXUSSTATS_URL_OVERRIDE` | `'https://nexus-stats.com/api'` | `https://nexus-stats.com/api` |
## Objects
Item
* `components` - List of component objects
* `id` - Unique identifier for the Item object
* `title` - Title of the item
* `type` - Type of the item
* `supplyPercent` - Of the total amount of item listings for this object, this is the percent for sale
* `demandPercent` - Of the total amount of item listings for this object, this is t looking to be bought
* `supplyAmount` - Of the total amount of item listings for this object, this is the number for sale
* `demandAmount` - Of the total amount of item listings for this object, this is the number looking to be bought
Component
* `name` - Name of the component
* `avgPrice` - Average platinum price
* `rawAverage` - Raw average (non-rounded) price of the component
* `data` - Array of Miscellaneous data