Learn about our RFC process, Open RFC meetings & more.Join in the discussion! »

iex

0.4.1 • Public • Published

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.

import IEXClient from 'iex'
// or
const IEXClient = require('iex')
 
const iex = IEXClient.create({ token: 'pk_youriextoken' })
 
await iex.prices.history('AAPL')
// or
await iex.history('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

import { history } from 'iex/prices'
 
// For quick single calls, initialise and call:
await history({ token: 'pk_youriextoken' })('aapl')
 
// For multiple calls, initialise once, call multiple times:
const fetchHistory = history({ token: 'pk_youriextoken' })
await fetchHistory('aapl')
await fetchHistory('msft')

API

IEXClient

class IEXClient({ token, env?, version? = 'stable' })
IEXClient.create({ token, env?, version? = 'stable' }): 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.history(symbolstring, 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.intraday(symbolstring, 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.previous(symbolstring, 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.price(symbolstring, 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.quote(symbolstring, 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

Install

npm i iex

DownloadsWeekly Downloads

12

Version

0.4.1

License

MIT

Unpacked Size

23.6 kB

Total Files

21

Last publish

Collaborators

  • avatar