Market | N|Steam Market-Pricing

Market Class.

Hierarchy

Market

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Market(options: MarketOptions): Market

- Defined in index.ts:322
Create the API

Parameters
- options: MarketOptions
  
  Options
Returns Market

Properties

Optional address

address: undefined | string

Local interface to bind for network connections

appid

appid: number

Application ID of the game you want to query skin/s for

Optional base

base: undefined | string

Base domain for the HTTP request

Optional country

country: undefined | string

Optional ISO-3166 country code

Optional currency

currency: undefined | number

Optional currency integer

Optional gzip

gzip: undefined | false | true

Use GZIP compression for the HTTP request

Optional path

path: undefined | string

Base path for the HTTP request

Optional raw

raw: undefined | false | true

Request the raw object

Optional strictSSL

strictSSL: undefined | false | true

Force strict SSL for the HTTP request

Optional timeout

timeout: undefined | number

Number of milliseconds to wait for a server to send response headers

Optional timings

timings: undefined | false | true

Whether to return request timings

Optional useragent

useragent: undefined | string

Custom user agent for the HTTP request

Methods

getPrice

getPrice(name: string, options: OverwriteMarketOptionsWithRaw): Promise<RawItem>
getPrice(name: string, options: OverwriteMarketOptionsWithRaw, callback: Callback<RawItem>): void
getPrice(name: string, callback: Callback<CleanItem>): void
getPrice(name: string, options: OverwriteMarketOptions, callback: Callback<CleanItem>): void
getPrice(name: string, options?: OverwriteMarketOptions): Promise<CleanItem>

- Defined in index.ts:373
Get a item

Parameters
- name: string
  
  The name of the skin
- options: OverwriteMarketOptionsWithRaw
Returns Promise<RawItem>
- Defined in index.ts:374
Parameters
- name: string
- options: OverwriteMarketOptionsWithRaw
- callback: Callback<RawItem>
Returns void
- Defined in index.ts:376
Parameters
- name: string
- callback: Callback<CleanItem>
Returns void
- Defined in index.ts:377
Parameters
- name: string
- options: OverwriteMarketOptions
- callback: Callback<CleanItem>
Returns void
- Defined in index.ts:379
Parameters
- name: string
- Optional options: OverwriteMarketOptions
Returns Promise<CleanItem>

getPrices

getPrices(names: string[], options: OverwriteMarketOptionsWithRaw): Promise<RawItemArray>
getPrices(names: string[], options: OverwriteMarketOptionsWithRaw, callback: Callback<RawItemArray>): void
getPrices(names: string[], callback: Callback<ItemArray>): void
getPrices(names: string[], options: OverwriteMarketOptions, callback: Callback<ItemArray>): void
getPrices(names: string[], options?: OverwriteMarketOptions): Promise<ItemArray>

- Defined in index.ts:407
Get a array of items

Parameters
- names: string[]
  
  Array with the names of the skins
- options: OverwriteMarketOptionsWithRaw
Returns Promise<RawItemArray>
- Defined in index.ts:408
Parameters
- names: string[]
- options: OverwriteMarketOptionsWithRaw
- callback: Callback<RawItemArray>
Returns void
- Defined in index.ts:410
Parameters
- names: string[]
- callback: Callback<ItemArray>
Returns void
- Defined in index.ts:411
Parameters
- names: string[]
- options: OverwriteMarketOptions
- callback: Callback<ItemArray>
Returns void
- Defined in index.ts:413
Parameters
- names: string[]
- Optional options: OverwriteMarketOptions
Returns Promise<ItemArray>

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

options: MarketOptions

Returns Market

Properties

Optional address

appid

Optional base

Optional country

Optional currency

Optional gzip

Optional path

Optional raw

Optional strictSSL

Optional timeout

Optional timings

Optional useragent

Methods

getPrice

Parameters

name: string

options: OverwriteMarketOptionsWithRaw

Returns Promise<RawItem>

Parameters

name: string

options: OverwriteMarketOptionsWithRaw

callback: Callback<RawItem>

Returns void

Parameters

name: string

callback: Callback<CleanItem>

Returns void

Parameters

name: string

options: OverwriteMarketOptions

callback: Callback<CleanItem>

Returns void

Parameters

name: string

Optional options: OverwriteMarketOptions

Returns Promise<CleanItem>

getPrices

Parameters

names: string[]

options: OverwriteMarketOptionsWithRaw

Returns Promise<RawItemArray>

Parameters

names: string[]

options: OverwriteMarketOptionsWithRaw

callback: Callback<RawItemArray>

Returns void

Parameters

names: string[]

callback: Callback<ItemArray>

Returns void

Parameters

names: string[]

options: OverwriteMarketOptions

callback: Callback<ItemArray>

Returns void

Parameters

names: string[]

Optional options: OverwriteMarketOptions

Returns Promise<ItemArray>