warframe-nexus-query Global

Members

<constant> API_BASE_URL

Constants for Warframe Market API v2

Source:

market/v2/constants.js, line 5

Methods

attachmentFromComponents(components, query [, platform])

Build an attachment from the provided components

Parameters:

Name	Type	Argument	Default	Description
`components`	Array.<MarketComponent>			collected array of components with market data
`query`	string			Search query that these components match
`platform`	string	<optional>	'pc'	Platform for the request, defaults to 'pc'

Source:

AttachmentCreator.js, line 149

Returns:

Discord-ready attachment describing the item

Type: Object

calculateMedian(sortedPrices)

Calculate median of sorted array

Parameters:

Name	Type	Description
`sortedPrices`	Array.<number>	Sorted price array

Source:

market/v2/utils/statistics.js, line 76

Returns:

Type: number

calculatePercentile(sortedPrices, percentile)

Calculate percentile of sorted array

Parameters:

Name	Type	Description
`sortedPrices`	Array.<number>	Sorted price array
`percentile`	number	Percentile (0-100)

Source:

market/v2/utils/statistics.js, line 94

Returns:

Type: number

calculateStatistics(orders, options)

Calculate statistics from orders

Parameters:

Name	Type	Description
`orders`	Array.<Order>	Orders array
`options`	Object	Calculation options

Source:

market/v2/MarketFetcherV2.js, line 218

Returns:

Statistics

Type: Object

calculateStatistics(orders, options)

Calculate statistics from order list

Parameters:

Name Type Description

orders Array.<Order> Array of orders

options

Object

Calculation options

Properties

Name	Type	Argument	Default	Description
`type`	string	<optional>	'sell'	Order type ('buy' or 'sell')
`onlineOnly`	boolean	<optional>	true	Only include online users
`includeOutliers`	boolean	<optional>	true	Include price outliers

Source:

market/v2/utils/statistics.js, line 15

Returns:

Statistics object

Type: Object

<async> checkVersions()

Check API versions

Source:

market/v2/MarketFetcherV2.js, line 382

Returns:

Type: Promise.<Object>

<async> checkVersions()

Check versions from server

Source:

market/v2/utils/cache.js, line 217

Returns:

Type: Promise.<Object>

clear()

Clear entire cache

Source:

market/v2/utils/cache.js, line 248

clearCache()

Clear all caches

Source:

market/v2/MarketFetcherV2.js, line 373

delete(key)

Delete specific key from cache

Parameters:

Name	Type	Description
`key`	string	Cache key

Source:

market/v2/utils/cache.js, line 265

extractLocalized(i18n, locale)

Extract localized data from i18n object

Parameters:

Name	Type	Description
`i18n`	Object	i18n object
`locale`	string	Preferred locale

Source:

market/v2/utils/i18n.js, line 24

Returns:

Localized data

Type: Object

<async> fetchWithTimeout(url, options, timeout)

Make HTTP request with timeout

Parameters:

Name	Type	Description
`url`	string	URL to fetch
`options`	Object	Fetch options
`timeout`	number	Timeout in milliseconds

Source:

market/v2/utils/http.js, line 16

Returns:

Type: Promise.<Response>

fieldValue(mComponent)

Build a field from provided nexus & market components (v1)

Parameters:

Name	Type	Description
`mComponent`	MarketComponent	market component

Source:

AttachmentCreator.js, line 54

Returns:

built field

Type: Object

fieldValueV2(mComponent)

Build a field from v2 market component with trader info

Parameters:

Name	Type	Description
`mComponent`	MarketComponent	market component (v2)

Source:

AttachmentCreator.js, line 81

Returns:

built field

Type: Object

formatPriceRange(stats)

Format price range string

Parameters:

Name	Type	Description
`stats`	Object	Statistics object

Source:

market/v2/MarketFetcherV2.js, line 237

Returns:

Type: string

formatPriceRange(stats)

Format price range string

Parameters:

Name	Type	Description
`stats`	Object	Statistics object

Source:

market/v2/utils/statistics.js, line 154

Returns:

Type: string

formatStatistics(stats, type)

Format statistics for display

Parameters:

Name	Type	Description
`stats`	Object	Statistics object
`type`	string	Order type

Source:

market/v2/MarketFetcherV2.js, line 247

Returns:

Type: string

formatStatistics(stats, type)

Format statistics for display

Parameters:

Name	Type	Description
`stats`	Object	Statistics object
`type`	string	Order type ('buy' or 'sell')

Source:

market/v2/utils/statistics.js, line 172

Returns:

Type: string

<async> get(key, collection, fetchFn)

Get item from cache or fetch it

Parameters:

Name	Type	Description
`key`	string	Cache key
`collection`	string	Collection name (items, rivens, etc.)
`fetchFn`	function	Function to fetch data if cache miss

Source:

market/v2/utils/cache.js, line 105

Returns:

Type: Promise.<*>

<async> get(path, options)

Make GET request

Parameters:

Name Type Description

path string API path

options

Object

Request options

Properties

Name	Type	Argument	Description
`platform`	string	<optional>	Platform header
`locale`	string	<optional>	Language header
`query`	Object	<optional>	Query parameters

Source:

market/v2/utils/http.js, line 73

Returns:

Type: Promise.<Object>

getAgeHours()

Get order age in hours

Source:

market/v2/models/Order.js, line 152

Returns:

Type: number

<async> getAllOrders(slug, platform)

Get all orders for an item

Parameters:

Name	Type	Description
`slug`	string	Item slug
`platform`	string	Platform (pc, ps4, xbox, switch)

Source:

market/v2/MarketFetcherV2.js, line 167

Returns:

Type: Promise.<Array.<Order>>

getBestOrders(orders, options)

Get best orders (sorted)

Parameters:

Name	Type	Description
`orders`	Array.<Order>	Orders array
`options`	Object	Options

Source:

market/v2/MarketFetcherV2.js, line 228

Returns:

Type: Object

getBestOrders(orders, options)

Get best orders (lowest sell / highest buy)

Parameters:

Name Type Description

orders Array.<Order> Array of orders

options

Object

Options

Properties

Name	Type	Argument	Default	Description
`limit`	number	<optional>	5	Number of orders to return
`onlineOnly`	boolean	<optional>	true	Only online users

Source:

market/v2/utils/statistics.js, line 129

Returns:

{ buy: Order[], sell: Order[] }

Type: Object

getIconUrl( [baseUrl])

Get full icon URL

Parameters:

Name	Type	Argument	Default	Description
`baseUrl`	string	<optional>	'https://warframe.market/static/assets/'	Base URL for assets

Source:

market/v2/models/Item.js, line 75

Returns:

Type: string

<async> getItemBySlug(slug)

Get item by slug

Parameters:

Name	Type	Description
`slug`	string	Item slug

Source:

market/v2/MarketFetcherV2.js, line 81

Returns:

Type: Promise.<Item>

<async> getItemSet(slug)

Get all items in a set

Parameters:

Name	Type	Description
`slug`	string	Item slug

Source:

market/v2/MarketFetcherV2.js, line 103

Returns:

Type: Promise.<{id: string, items: Array.<Item>}>

<async> getItems()

Get list of all tradable items

Source:

market/v2/MarketFetcherV2.js, line 60

Returns:

Type: Promise.<Array.<Item>>

getLocalized(field [, lang])

Get localized field

Parameters:

Name	Type	Argument	Description
`field`	string		Field name
`lang`	string	<optional>	Language code (defaults to instance locale)

Source:

market/v2/models/Item.js, line 65

Returns:

Localized value

Type: *

getLocalizedField(i18n, field, locale, defaultValue)

Get field from i18n object with fallback

Parameters:

Name	Type	Description
`i18n`	Object	i18n object
`field`	string	Field name
`locale`	string	Preferred locale
`defaultValue`	*	Default value if not found

Source:

market/v2/utils/i18n.js, line 37

Returns:

Type: *

getOnlineBuyers(limit)

Get best online buyers

Parameters:

Name	Type	Default	Description
`limit`	number	5	Number of buyers to return

Source:

market/v2/models/Summary.js, line 84

Returns:

Type: Array.<{ingameName: string, platinum: number, quantity: number, status: string, activity: string}>

getOnlineSellers(limit)

Get best online sellers

Parameters:

Name	Type	Default	Description
`limit`	number	5	Number of sellers to return

Source:

market/v2/models/Summary.js, line 63

Returns:

Type: Array.<{ingameName: string, platinum: number, quantity: number, status: string, activity: string}>

<async> getRecentOrders(platform)

Get recent orders (last 4 hours)

Parameters:

Name	Type	Description
`platform`	string	Platform (pc, ps4, xbox, switch)

Source:

market/v2/MarketFetcherV2.js, line 190

Returns:

Type: Promise.<Array.<Order>>

getThumbUrl( [baseUrl])

Get full thumbnail URL

Parameters:

Name	Type	Argument	Default	Description
`baseUrl`	string	<optional>	'https://warframe.market/static/assets/'	Base URL for assets

Source:

market/v2/models/Item.js, line 84

Returns:

Type: string

<async> getTopOrders(slug, options)

Get top orders for an item (RECOMMENDED for price checks)

Parameters:

Name Type Description

slug string Item slug

options

Object

Options

Properties

Name	Type	Argument	Description
`platform`	string		Platform (pc, ps4, xbox, switch)
`rank`	number	<optional>	Filter by rank
`rankLt`	number	<optional>	Filter by rank less than
`charges`	number	<optional>	Filter by charges
`chargesLt`	number	<optional>	Filter by charges less than
`amberStars`	number	<optional>	Filter by amber stars
`amberStarsLt`	number	<optional>	Filter by amber stars less than
`cyanStars`	number	<optional>	Filter by cyan stars
`cyanStarsLt`	number	<optional>	Filter by cyan stars less than
`subtype`	string	<optional>	Filter by subtype

Source:

market/v2/MarketFetcherV2.js, line 134

Returns:

Type: Promise.<{buy: Array.<Order>, sell: Array.<Order>}>

has(key)

Check if key exists in cache (and is valid)

Parameters:

Name	Type	Description
`key`	string	Cache key

Source:

market/v2/utils/cache.js, line 288

Returns:

Type: boolean

isBuyOrder()

Check if order is buy type

Source:

market/v2/models/Order.js, line 136

Returns:

Type: boolean

isPartOfSet()

Check if item is part of a set

Source:

market/v2/models/Item.js, line 92

Returns:

Type: boolean

isSellOrder()

Check if order is sell type

Source:

market/v2/models/Order.js, line 144

Returns:

Type: boolean

isUserOnline()

Check if order is from an online user

Source:

market/v2/models/Order.js, line 127

Returns:

Type: boolean

isVaulted()

Check if item is vaulted

Source:

market/v2/models/Item.js, line 100

Returns:

Type: boolean

lookupAlias(platformAlias, market)

Look up real platform for platform alias

Parameters:

Name	Type	Default	Description
`platformAlias`	string		Alias of platform
`market`	boolean	false	Whether or not to use market-specific aliases

Source:

Settings.js, line 50

Returns:

Real platform identifier

Type: string

normalizeLanguage(lang)

Normalize language code

Parameters:

Name	Type	Description
`lang`	string	Language code

Source:

market/v2/utils/i18n.js, line 12

Returns:

Normalized language code

Type: string

normalizePlatform(platform)

Normalize platform

Parameters:

Name	Type	Description
`platform`	string	Platform alias

Source:

market/v2/MarketFetcherV2.js, line 420

Returns:

Normalized platform

Type: string

pad(str, length, character)

Padding helper (v1 compatibility)

Parameters:

Name	Type	Default	Description
`str`	string		String to pad
`length`	number	10	Target length
`character`	string		Padding character

Source:

market/v2/models/Summary.js, line 162

Returns:

Type: string

<async> post(path, body, options)

Make POST request

Parameters:

Name	Type	Description
`path`	string	API path
`body`	Object	Request body
`options`	Object	Request options

Source:

market/v2/utils/http.js, line 101

Returns:

Type: Promise.<Object>

<async> priceCheckQuery(query, platform)

Price check query (v1 compatibility method)

Parameters:

Name	Type	Description
`query`	string	Search query
`platform`	string	Platform

Source:

market/v2/MarketFetcherV2.js, line 325

Returns:

Type: Promise.<Object>

<async> queryMarket(query, options)

Query market for item (v1 compatibility method)

Parameters:

Name Type Description

query string Search query

options

Object

Query options

Properties

Name	Type	Argument	Description
`platform`	string		Platform
`successfulQuery`	function	<optional>	Callback on success

Source:

market/v2/MarketFetcherV2.js, line 263

Returns:

Type: Promise.<Array.<Summary>>

<async> refresh(key, collection, fetchFn)

Refresh cache entry

Parameters:

Name	Type	Description
`key`	string	Cache key
`collection`	string	Collection name
`fetchFn`	function	Function to fetch fresh data

Source:

market/v2/utils/cache.js, line 207

Returns:

Type: Promise.<*>

removeOutliers(sortedPrices)

Remove outliers using IQR method

Parameters:

Name	Type	Description
`sortedPrices`	Array.<number>	Sorted price array

Source:

market/v2/utils/statistics.js, line 111

Returns:

Type: Array.<number>

safeRange(value1, value2)

Calculate the safe value for a provided value

Parameters:

Name	Type	Description
`value1`	string	provided minimum value
`value2`	string	provided maximum value

Source:

AttachmentCreator.js, line 45

Returns:

safe value

Type: string

safeValue(value)

Calculate the safe value for a provided value

Parameters:

Name	Type	Description
`value`	string	provided value

Source:

AttachmentCreator.js, line 35

Returns:

safe value

Type: string

set(key, value [, collection])

Set item in cache

Parameters:

Name	Type	Argument	Description
`key`	string		Cache key
`value`	*		Value to cache
`collection`	string	<optional>	Collection name for version tracking

Source:

market/v2/utils/cache.js, line 129

setLocale(locale)

Set locale

Parameters:

Name	Type	Description
`locale`	string	Language code

Source:

market/v2/MarketFetcherV2.js, line 428

setLocale(locale)

Set default locale

Parameters:

Name	Type	Description
`locale`	string	Language code

Source:

market/v2/utils/http.js, line 235

setTimeout(timeout)

Set timeout

Parameters:

Name	Type	Description
`timeout`	number	Timeout in milliseconds

Source:

market/v2/utils/http.js, line 243

<async> shouldRefresh(collection)

Check if collection should be refreshed

Parameters:

Name	Type	Description
`collection`	string	Collection name

Source:

market/v2/utils/cache.js, line 187

Returns:

Type: Promise.<boolean>

size()

Get cache size

Source:

market/v2/utils/cache.js, line 279

Returns:

Type: number

stop()

Stop and cleanup (clears all caches)

Source:

market/v2/MarketFetcherV2.js, line 436

toJSON()

Convert to JSON

Source:

market/v2/models/Item.js, line 108

Returns:

Type: Object

toJSON()

Convert to JSON

Source:

market/v2/models/Order.js, line 161

Returns:

Type: Object

toString()

Convert to string representation

Source:

market/v2/models/Item.js, line 132

Returns:

Type: string

toString()

Convert to string representation

Source:

market/v2/models/Order.js, line 186

Returns:

Type: string

toString(opt)

String representation (v1 compatible)

Parameters:

Name	Type	Default	Description
`opt`	string	item	Option: 'codex', 'item', 'location', 'all'

Source:

market/v2/models/Summary.js, line 105

Returns:

Type: string