iex.js (iexjs) is a client library for querying IEX Cloud data and operating on Apperate resources, such as data, datasets, data sources, and more. The easy-to-use JavaScript methods wrap requests to Apperate endpoints and IEX Cloud legacy endpoints, so you can tap into Core Data and permissioned datasets, and operate on Apperate resources.

Referral

Please subscribe to IEX Cloud using this referral code.

Install

Use npm to install iexjs.

npm i @apperate/iexjs

iexjs can also run in the browser via native fetch and eventsource, or from node via cross-fetch and eventsource.

Apperate Examples

The iexjs Client object stores your API token (API key) and IEX Cloud API version (e.g., v1) for convenience.

Tip: The iexjs client automatically picks up tokens from the environment variable IEX_TOKEN.

Here are some examples.

Get a real-time stock quote:

const {Client} = require("@apperate/iexjs")
const client = new Client({api_token: "TOKEN", version: "VERSION"});
client.quote({symbol: "AAPL"}).then((res) => {
    console.log(res);
});

The code above calls the quote method to get a real-time price on the AAPL stock.

iex.js Core Data Methods has information on all the methods.

Get cash flow details:

const {Client} = require("@apperate/iexjs")
const client = new Client({api_token: "TOKEN", version: "VERSION"});
client.apperate.queryData({key: "AAPL", workspace: "CORE", id: "CASH_FLOW"}).then((res) => {
    console.log(res);
});

The apperate methods wrap calls to Apperate APIs, including the Data API. The queryData method retrieves data from the dataset specified by the id parameter. You can retrieve data from any dataset you have access to, including CORE datasets.

Querying Datasets with iex.js provides details on searching datasets.

IEX Cloud Legacy Examples

iexjs provides wrappers for static data and SSE streaming data. The library supports the IEX Cloud legacy API through two interfaces. The first is a simple function call, passing in the API version and token as arguments

const {chart} = require("iexjs");
chart({symbol: "AAPL", range: "1m"}, {token, version}).then((res) => {
    console.log(res);
});

Since the token rarely changes, we have a Client object for convenience:

const {Client} = require("iexjs");
const client = new Client({api_token: "YOUR_TOKEN_HERE", version: "v1"});
client.chart({symbol: "AAPL", range: "1m"}).then((res) => {
    console.log(res);
});

The client will automatically pick up the API key from the environment variable IEX_TOKEN, or it can be passed as an argument.

CATALOG.md lists the methods for the IEX Cloud Legacy API.

License

This software is licensed under the Apache 2.0 license. See the LICENSE and AUTHORS files for details.