IEX.js
This library is in early development, so there might be breaking changes
A universal JavaScript client for the IEX Cloud API, therefor usable in both NodeJS and browsers.
Also check out iex-cli to have IEX data straight in your terminal!
Installation
$ npm install iex
Usage
1. IEXClient
Recommended if you use multiple endpoints, multiple times. Exports all endpoints, as well as namespaced by category.
// orconst IEXClient = const iex = IEXClient await iexpriceshistory'AAPL'// orawait iexhistory'AAPL'
When the API returns JSON it will be parsed, otherwise you'll receive a string.
2. Direct imports
Recommended if you only need one or few endpoints and calls
// For quick single calls, initialise and call:await 'aapl' // For multiple calls, initialise once, call multiple times:const fetchHistory = await await
API
IEXClient
Creates a client with pre-initialized enpoint functions (opposite to single imports requiring initialisation).
Determines env from the passed token prefix if not explicitely set, defaults to stable for version
IEXClient instance
prices
history
IEXClient.historysymbol: string, params?: Object, range?: string: Promise<string | Object>
Requests historical prices for symbol
.
params
can be any query parameters the overall API (e.g. format) or the enpoint (e.g. includeLast) supports.
range
can be a range as specified in the docs
intraday
IEXClient.intradaysymbol: string, params?: Object: Promise<string | Object>
Requests intraday prices for symbol
.
params
can be any query parameters the overall API (e.g. format) or the enpoint (e.g. chartIEXOnly) supports.
previous
IEXClient.previoussymbol: string, params?: Object: Promise<string | Object>
Requests closing data of the previous trading day for symbol
.
params
can be any query parameters the overall API (e.g. format) or the enpoint (currently none) supports.
price
IEXClient.pricesymbol: string, params?: Object: Promise<number>
Requests the latest price for symbol
.
params
can be any query parameters the overall API (e.g. format) or the enpoint (currently none) supports.
quote
IEXClient.quotesymbol: string, params?: Object, field?: string: Promise<string | Object>
Requests realtime/delyed quote data (e.g. OHLC, volume, 52 week high, ...) for symbol
.
params
can be any query parameters the overall API (e.g. format) or the enpoint (e.g. displayPercent) supports.
field
can be used to limit data to one attribute of the full response