iex-cloud-wrapper v1.0.6

Information

• Get an API key
• Pricing
• Documentation
• Attribution
• Disclaimers

Installation

$npm i iex-cloud-wrapper

Setup

const iexCloud = require('iex-cloud-wrapper');

const IEX = new iexCloud.Client({
  API_KEY: 'API_KEY',
  version: 'stable', //You can iterate API versions using this (stable, v1, beta)
  sandbox: false //If you are using a sanbox API key you will need to enable this
});

Stocks

IEX.advancedstats("AAPL").then(data => {
    console.log(data)
});

IEX.fundamentals("AAPL", period).then(data => { //The period paramters are "annual", "quarterly", "ttm"
    console.log(data)
});

IEX.balancesheet("AAPL").then(data => {
    console.log(data)
});

IEX.book("AAPL").then(data => {
    console.log(data)
});

IEX.cashflow("AAPL").then(data => {
    console.log(data)
});

IEX.company("AAPL").then(data => {
    console.log(data)
});

IEX.dividends("AAPL", range).then(data => { //The range parameter can equal 5y, 2y, 1y, ytd, 6m, 3m, 1m, next
    console.log(data)
});

IEX.financials("AAPL").then(data => {
    console.log(data)
});

IEX.fundownership("AAPL").then(data => {
    console.log(data)
});

IEX.historicalprices("AAPL", "1d").then(data => { 
    console.log(data)
});

IEX.income("AAPL").then(data => {
    console.log(data)
});

IEX.insiderroster("AAPL").then(data => {
    console.log(data)
});

IEX.insidersummary("AAPL").then(data => {
    console.log(data)
});

IEX.insidertransactions("AAPL").then(data => {
    console.log(data)
});

IEX.institutionalownership("AAPL").then(data => {
    console.log(data)
});

IEX.intradayprices("AAPL").then(data => {
    console.log(data)
});

IEX.stats("AAPL").then(data => {
    console.log(data)
});

IEX.largesttrades("AAPL").then(data => {
    console.log(data)
});

IEX.logo("AAPL").then(data => {
    console.log(data)
});

IEX.ohlc("AAPL").then(data => {
    console.log(data)
});

IEX.peers("AAPL").then(data => {
    console.log(data)
});

IEX.previous("AAPL").then(data => {
    console.log(data)
});

IEX.price("AAPL").then(data => {
    console.log(data)
});

IEX.quote("AAPL").then(data => {
    console.log(data)
});

IEX.splits("AAPL", range).then(data => { //The range parameter can equal 5y, 2y, 1y, ytd, 6m, 3m, 1m, next
    console.log(data)
});

IEX.volumebyvenue("AAPL").then(data => {
    console.log(data)
});

News

IEX.news("AAPL").then(data => {
    console.log(data)
});

Cryptocurrency

IEX.cryptobook("BTCUSDT").then(data => {
    console.log(data)
});

IEX.cryptoprice("BTCUSD").then(data => {
    console.log(data)
});

IEX.cryptoquote("BTCUSDT").then(data => {
    console.log(data)
});

Options

IEX.optiondates("AAPL").then(data => {
    console.log(data)
});

IEX.options("AAPL", "20210415").then(data => {
    console.log(data)
});

Ceo Compensation

IEX.ceocompensation("AAPL").then(data => {
    console.log(data)
});

Treasuries

IEX.treasury().then(data => {
    console.log(data)
});

Commodities

IEX.oilprice(ticker).then(data => { //The ticker parameter must be 'DCOILWTICO' or 'DCOILBRENTEU'
    console.log(data)
});

IEX.naturalgasprice().then(data => {
    console.log(data)
});

IEX.heatingoilprices().then(data => {
    console.log(data)
});

IEX.jetfuelprices().then(data => {
    console.log(data)
});

IEX.dieselprice().then(data => {
    console.log(data)
});

IEX.gasprices(ticker).then(data => { //The ticker parameter must be 'GASREGCOVW', 'GASMIDCOVW', or 'GASPRMCOVW'
    console.log(data)
});

IEX.propaneprices().then(data => {
    console.log(data)
});

Economic Data

IEX.cdrates(ticker).then(data => { //The ticker parameter must be 'MMNRNJ' or 'MMNRJD'
    console.log(data)
});

IEX.consumerpriceindex().then(data => {
    console.log(data)
});

IEX.creditcardinterestrate().then(data => {
    console.log(data)
});

IEX.federalfundrates().then(data => {
    console.log(data)
});

IEX.realgdp().then(data => {
    console.log(data)
});

IEX.institutionalmoneyfunds().then(data => {
    console.log(data)
});

IEX.initialclaims().then(data => {
    console.log(data)
});

IEX.industrialproductionindex().then(data => {
    console.log(data)
});

IEX.mortgagerates(ticker).then(data => { //The ticker parameter must be 'MORTGAGE30US', 'MORTGAGE15US', or 'MORTGAGE5US'
    console.log(data)
});

IEX.totalhousingstarts().then(data => {
    console.log(data)
});

IEX.totalpayrolls().then(data => {
    console.log(data)
});

IEX.totalvehiclesales().then(data => {
    console.log(data)
});

IEX.retailmoneyfunds().then(data => {
    console.log(data)
});

IEX.unemploymentrate().then(data => {
    console.log(data)
});

IEX.usrecessionprobabilities().then(data => {
    console.log(data)
});

Reference Data

IEX.search(`AAPL`).then(data => {
    console.log(data)
});

IEX.symbols().then(data => {
    console.log(data)
});

IEX.iexsymbols().then(data => {
    console.log(data)
});

IEX.optionssymbols(ticker).then(data => { //The ticker parameter is optional
    console.log(data)
});

IEX.holidays(type, direction).then(data => { //The type parameter must be trade or holiday and the direction parameter must be next or last
    console.log(data)
});