Introduction

IEX Cloud is a platform that makes financial data and services accessible to everyone.

API Reference

The IEX Cloud API is based on REST, has resource-oriented URLs, returns JSON-encoded responses, and returns standard HTTP response codes.

API Versioning

IEX Cloud will release new versions when we make backwards-incompatible changes to the API. We plan to support up to three active versions and will give advanced notice before releasing a new version or retiring an old version.

Backwards compatible changes:

Versions are added to the base url:

Current Version is v1 https://cloud.iexapis.com/v1/

Naming convention

stable can be used to access the latest stable API version. For example, https://cloud.iexapis.com/stable/

latest can be used to access the latest API version which may be in beta. For example, https://cloud.iexapis.com/latest/

Beta versions will include a -beta, for example, https://cloud.iexapis.com/v2-beta/

Attribution

Attribution is required for all users. It is as simple as putting “Data provided by IEX Cloud” somewhere on your site or app and linking that text to https://iexcloud.io. In case of limited screen space, or design constraints, the attribution link can be included in your terms of service.

<a href="https://iexcloud.io">Data provided by IEX Cloud</a>

When displaying a real-time price, you must display and link to IEX Cloud as the source near the price. The link is commonly placed below the price.

<a href="https://iexcloud.io">IEX Cloud</a>

Authentication

API Tokens

IEX Cloud authenticates your API requests using your account’s API tokens. To use any IEX Cloud API, you must pass an API token with each request. If you do not include your API token when making an API request, or use one that is incorrect or disabled, IEX Cloud returns an error.

IEX Cloud provides two types of API tokens: publishable and secret.

Protecting your API tokens

Batch Requests

HTTP request

GET /stock/{symbol}/batch

JSON response

// .../symbol
{
  "quote": {...},
  "news": [...],
  "chart": [...]
}

// .../market
{
  "AAPL" : {
    "quote": {...},
    "news": [...],
    "chart": [...]
  },
  "FB" : {
    "quote": {...},
    "news": [...],
    "chart": [...]
  },
  // { ... }
}

Data Weighting

Based on each type of call

Examples

Path Parameters

Option Description
symbol Use market to query multiple symbols (i.e. .../market/batch?...)

Query String Parameters

Option Details
types Required.
• Comma delimited list of endpoints to call. The names should match the individual endpoint names. Limited to 10 endpoints.
symbols Optional.
• Comma delimited list of symbols limited to 100. This parameter is used only if market option is used.
range Optional.
• Used to specify a chart range if chart is used in types parameter.
* Optional.
• Parameters that are sent to individual endpoints can be specified in batch calls and will be applied to each supporting endpoint. For example, last can be used for the news endpoint to specify the number of articles

Response Attributes

Responses will vary based on types requested. Refer to each endpoint for details.

Data Formats

Most endpoints support a format parameter to return data in a format other than the default JSON.

Supported formats

Format Content Type Example
json application/json ?format=json or by not passing the format parameter.
csv text/csv ?format=csv
psv text/plain ?format=psv

Disclaimers

Error Codes

IEX Cloud uses HTTP response codes to indicate the success or failure of an API request.

General HTML status codes

2xx Success.

4xx Errors based on information provided in the request

5xx Errors on IEX Cloud servers

IEX Cloud HTTP status codes

HTTP Code Type Description
400 Incorrect Values Invalid values were supplied for the API request
400 No Symbol No symbol provided
400 Type Required Batch request types parameter requires a valid value
401 Authorization Restricted Hashed token authorization is restricted
401 Authorization Required Hashed token authorization is required
401 Restricted The requested data is marked restricted and the account does not have access.
401 No Key An API key is required to access the requested endpoint.
401 Secret Key Required The secret key is required to access to requested endpoint.
401 Denied Referer The referer in the request header is not allowed due to API token domain restrictions.
402 Over Limit You have exceeded your allotted message quota and pay-as-you-go is not enabled.
402 Free tier not allowed The requested endpoint is not available to free accounts.
402 Tier not allowed The requested data is not available to your current tier.
403 Authorization Invalid Hashed token authorization is invalid.
403 Disabled Key The provided API token has been disabled
403 Invalid Key The provided API token is not valid.
403 Test token in production A test token was used for a production endpoint.
403 Production token in sandbox A production token was used for a sandbox endpoint.
403 Circuit Breaker Your pay-as-you-go circuit breaker has been engaged and further requests are not allowed.
403 Inactive Your account is currently inactive.
404 Unknown Symbol Unknown symbol provided
404 Not Found Resource not found
413 Max Types Maximum number of types values provided in a batch request.
429 Too many requests Too many requests hit the API too quickly. An exponential backoff of your requests is recommended.
451 Enterprise Permission Required The requested data requires additional permission to access.
500 System Error Something went wrong on an IEX Cloud server.

Filter results

Most endpoints support a filter parameter to return a subset of data. Pass a comma-delimited list of response attributes to filter. Response attributes are case-sensitive and are found in the Response Attributes section of each endpoint.

Example: ?filter=symbol,volume,lastSalePrice will return only the three attributes specified.

How Messages Work

Certain products, such as the Core Financial API, measure usage in message counts. We calculate message counts by multiplying the type of data object by that data object’s weight. Data objects are commonly understood units, such as a single stock quote, company fundamentals, or news headline. Weights are determined by taking two factors into consideration: frequency of distribution and acquisition costs. Weighting can be found in the Data Weighting section of each API endpoint.

We built a pricing calculator to help you estimate how many messages you can expect to use based on your app and number of users. You should consider the following inputs that will impact your final cost:

API calls will return iexcloud-messages-used in the header to indicate the total number of messages consumed for the call, as well as an iexcloud-premium-messages-used to indicate the total number of premium messages consumed for the call.

Query Parameters

Request Limits

IEX Cloud only applies request limits per IP address to ensure system stability. We limit requests to 100 per second per IP measured in milliseconds, so no more than 1 request per 10 milliseconds. We do allow bursts, but this should be sufficient for almost all use cases. Note that Sandbox Testing has a request limit of 10 requests per second measured in milliseconds.

SSE endpoints are limited to 50 symbols per connection. You can make multiple connections if you need to consume more than 50 symbols.

Security

We provide a valid, signed certificate for our API methods. Be sure your connection library supports HTTPS with the SNI extension.

SSE Streaming

NOTE: Only included with paid subscription plans

We support Server-sent Events (SSE Streaming) for streaming data as an alternative to WebSockets. You will need to decide whether SSE streaming is more efficient for your workflow than REST calls. In many cases streaming is more efficient since you will only receive the latest available data. If you need to control how often you receive updates, then you may use REST to set a timed interval.

Snapshots

When you connect to an SSE endpoint, you should receive a snapshot of the latest message, then updates as they are available. You can disable this feature by passing a url parameter of nosnapshot=true

You can also specify a starting point for a snapshot by passing a url parameter of snapshotAsOf=EPOCH_TIMESTAMP where the value is an epoch timestamp

Curl Example

curl --header 'Accept: text/event-stream' https://cloud-sse.iexapis.com/stable/stocksUS\?symbols\=spy\&token\=YOUR_TOKEN

Curl Firehose Example

curl --header 'Accept: text/event-stream' https://cloud-sse.iexapis.com/stable/stocksUS\?token\=YOUR_TOKEN

Curl Example (Not authorized by UTP)

curl --header 'Accept: text/event-stream' https://cloud-sse.iexapis.com/stable/stocksUSNoUTP\?symbols\=spy\&token\=YOUR_TOKEN

Curl Firehose Example (Not authorized by UTP)

curl --header 'Accept: text/event-stream' https://cloud-sse.iexapis.com/stable/stocksUSNoUTP\?token\=YOUR_TOKEN

How messages are counted

We use a reserve system for streaming endpoints due to high data rates. This is similar to how a credit card puts a hold on an account and reconciles the amount at a later time.

When you connect to an SSE endpoint, we will validate your API token, then attempt to reserve an amount of messages from your account. For example, 1000 messages.

If you have enough messages in your quota, or you have pay-as-you-go enabled, we will allow data to start streaming.

We keep track of the number of messages streamed to your account during our reserve interval.

Once our reserve interval expires, we will reconcile usage. This means we will compare how many messages were sent versus the number of messages we reserved. For example, if we delivered 1200 messages, you would have used 200 more than we reserved, so we will apply 200 additional messages to your account. If we only delivered 100 messages, we would credit the 900 unused messages back to your account.

After we reconcile the messages, we will attempt another reserve.

The reserve and reconcile process is seamless and does not impact your data stream. If we attempt to reserve messages and your account does not have enough quota and pay-as-you-go disabled, then we will disconnect your connection. You can avoid service disruptions by enabling pay-as-you-go in the Console.

When you disconnect from an endpoint, we will reconcile your message usage immediately.

SSE

Firehose

Scale users can firehose stream all symbols (excluding DEEP endpoints) by leaving off the symbols parameter.

Interval Streaming

Some SSE endpoints are offered on set intervals such as 1 second, 5 seconds, or 1 minute. This means we will send out messages no more than the interval subscribed to. This helps make message delivery more predictable.

Supported Endpoints

# Stock Quotes no UTP
# Firehose can be about 100 million messages per day
curl --header 'Accept: text/event-stream' 'https://cloud-sse.iexapis.com/stable/stocksUSNoUTP?token=YOUR_TOKEN&symbols=spy'

# Stock Quotes
# Firehose can be about 100 million messages per day
curl --header 'Accept: text/event-stream' 'https://cloud-sse.iexapis.com/stable/stocksUS?token=YOUR_TOKEN&symbols=spy'

# Stock Quotes every 1 second
# Can be up to 54,000 messages per symbol per day
curl --header 'Accept: text/event-stream' 'https://cloud-sse.iexapis.com/stable/stocksUS1Second?token=YOUR_TOKEN&symbols=spy'

# Stock Quotes every 5 seconds
# Can be up to 10,800 messages per symbol per day
curl --header 'Accept: text/event-stream' 'https://cloud-sse.iexapis.com/stable/stocksUS5Second?token=YOUR_TOKEN&symbols=spy'

# Stock Quotes every 1 minute
# Can be up to 900 messages per symbol per day
curl --header 'Accept: text/event-stream' 'https://cloud-sse.iexapis.com/stable/stocksUS1Minute?token=YOUR_TOKEN&symbols=spy'

# Cryptocurrency Quote
curl --header 'Accept: text/event-stream' 'https://cloud-sse.iexapis.com/stable/cryptoQuotes?token=YOUR_TOKEN&symbols=btcusd'

# Cryptocurrency Book
curl --header 'Accept: text/event-stream' 'https://cloud-sse.iexapis.com/stable/cryptoBook?token=YOUR_TOKEN&symbols=btcusd'

# Cryptocurrency Events
curl --header 'Accept: text/event-stream' 'https://cloud-sse.iexapis.com/stable/cryptoEvents?token=YOUR_TOKEN&symbols=btcusd'

# Social Sentiment
curl --header 'Accept: text/event-stream' 'https://cloud-sse.iexapis.com/stable/sentiment?token=YOUR_TOKEN&symbols=spy'

# Forex / Currencies
curl --header 'Accept: text/event-stream' 'https://cloud-sse.iexapis.com/stable/forex?token=YOUR_TOKEN&symbols=USDCAD'

# News
curl --header 'Accept: text/event-stream' 'https://cloud-sse.iexapis.com/stable/news-stream?token=YOUR_TOKEN&symbols=spy'

# IEX TOPS
curl --header 'Accept: text/event-stream' 'https://cloud-sse.iexapis.com/stable/tops?token=YOUR_TOKEN&symbols=spy'

# IEX LAST
curl --header 'Accept: text/event-stream' 'https://cloud-sse.iexapis.com/stable/last?token=YOUR_TOKEN&symbols=spy,aapl,tsla'

# IEX DEEP
curl --header 'Accept: text/event-stream' 'https://cloud-sse.iexapis.com/stable/deep?token=YOUR_TOKEN&symbols=spy&channels=deep'

# IEX DEEP by channel
curl --header 'Accept: text/event-stream' 'https://cloud-sse.iexapis.com/stable/deep?token=YOUR_TOKEN&symbols=spy&channels=auction'

curl --header 'Accept: text/event-stream' 'https://cloud-sse.iexapis.com/stable/deep?token=YOUR_TOKEN&symbols=spy&channels=book'

curl --header 'Accept: text/event-stream' 'https://cloud-sse.iexapis.com/stable/deep?token=YOUR_TOKEN&symbols=spy&channels=op-halt-status'

curl --header 'Accept: text/event-stream' 'https://cloud-sse.iexapis.com/stable/deep?token=YOUR_TOKEN&symbols=spy&channels=official-price'

curl --header 'Accept: text/event-stream' 'https://cloud-sse.iexapis.com/stable/deep?token=YOUR_TOKEN&symbols=spy&channels=security-event'

curl --header 'Accept: text/event-stream' 'https://cloud-sse.iexapis.com/stable/deep?token=YOUR_TOKEN&symbols=spy&channels=trades'

curl --header 'Accept: text/event-stream' 'https://cloud-sse.iexapis.com/stable/deep?token=YOUR_TOKEN&symbols=spy&channels=trade-breaks'

curl --header 'Accept: text/event-stream' 'https://cloud-sse.iexapis.com/stable/deep?token=YOUR_TOKEN&symbols=spy&channels=trading-status'

Node.js SSE client example

'use strict';
const request = require('request');
var stream;
var partialMessage;

function connect() {
    stream = request({
        url: 'https://cloud-sse.iexapis.com/stable/stocksUSNoUTP?token=YOUR_TOKEN&symbols=spy,ibm,twtr',
        headers: {
            'Content-Type': 'text/event-stream'
        }
    })
}
connect();

stream.on('socket', () => {
    console.log("Connected");
});

stream.on('end', () => {
    console.log("Reconnecting");
    connect();
});

stream.on('complete', () => {
    console.log("Reconnecting");
    connect();
});

stream.on('error', (err) => {
    console.log("Error", err);
    connect();
});

stream.on('data', (response) => {
    var chunk = response.toString();
    var cleanedChunk = chunk.replace(/data: /g, '');

    if (partialMessage) {
        cleanedChunk = partialMessage + cleanedChunk;
        partialMessage = "";
    }

    var chunkArray = cleanedChunk.split('\r\n\r\n');

    chunkArray.forEach(function (message) {
        if (message) {
            try {   
                var quote = JSON.parse(message)[0];
                console.log(quote);
            } catch (error) {
                partialMessage = message;
            }
        }
    });
});

function wait () {
    setTimeout(wait, 1000);
};

wait();

Support

If you find any issues with our API or have any questions, please file an issue at Github. If your account includes support, you’ll find additional support options when logged into your Console.

Developer Tools

Client and server libraries

Below is a list of known unofficial 3rd party libraries and integrations.
If you’d like to have your library, integration, or app added, email us at support@iexcloud.io.

Client and server libraries that support IEX Cloud

Language URL
C# IEXCloudDotNet
IEXSharp
Excel IEX-Excel-Sharp
Stock Connector by Michael Saunders
Go goinvest
Google Sheets 2Investing
Haskell iexcloud
Hubot hubot-stock-checker
KDB iex_cloud_q
Java IEXTrading4j
NodeJS iexcloud-api-wrapper
iexcli
Outlook IEX-Outlook-Sharp
PHP iex-cloud-sdk
PowerPoint IEX-PowerPoint-Sharp
Python pyEX
iexfinance
FinMesh
R iexcloudR
Riex
Ruby iex-ruby-client
TypeScript IEX Cloud API TypeScript Client
Word IEX-Word-Sharp

Applications that support IEX Cloud

Application Description URL
Perspective Streaming pivot visualization via WebAssembly GitHub
Postman Collections Interface implementation of the IEX Cloud API in Postman GitHub
Stock Analysis Engine Build and tune investment algorithms for use with artificial intelligence (deep neural networks) with a distributed stack for running backtests using live pricing data on publicly traded companies GitHub
Docs
TOP an HTML5 Trading Terminal from SoftCapital Top - By SoftCapital
AlphaPy Automated Machine Learning [AutoML] with Python, scikit-learn, and Keras GitHub
Cryptosheets IEX Cloud API integration for Excel and Google Sheets Tutorial
Website

Libraries that support the deprecated IEX API

Reach out to the developer and ask about supporting IEX Cloud.

Language URL
C++ IEX_CPP_API
C# IEXTrading API
IEXDotNetWrapper
Go go-iex
Haskell stocks
HTML Stocks!
Perl Finance::Quote::IEX
Python iex-api-python
iex_data
pandas-datareader
PyPI IEX
IEX with Bokeh
.NET IEXTradingApi
NodeJS iex-api
PHP iex-trading
R IEX API for R
React ticker-react
iex-api
Rust iex-rs

Testing Sandbox

IEX Cloud provides all accounts a free, unlimited use sandbox for testing. Every account will be assigned two test tokens available via the Console. All sandbox endpoints function the same as production, so you will only need to change the base url and token.

We’ve also updated the Usage Report to allow you to view the number of test messages the same way as production message usage.

How to use

Test tokens look like Tpk_ and Tsk_.

To make a call for test data, use the same url, but pass your test token.

Guides

Excel How-To

IEX Cloud supports Excel and Google Sheets data import methods.

Excel

Excel provides the Webservice function to import data into a cell. We support this in endpoints like quote, stats, financials, cash-flow, balance-sheet, income, and dividends.

Example:

This will pull just the latest price for Apple
=WEBSERVICE("https://cloud.iexapis.com/stable/stock/aapl/quote/latestPrice?token=YOUR_TOKEN_HERE")

IEX Cloud provides an example Excel file that can be used to see how the Webservice function works. Download it here - the Excel webservice function only works on Excel for Windows.

Please note, the highlighted column for latestUpdate is a formula that converts the Unix timestamp into an excel date/time. To get this to work you’ll have to put your token in column B1. And don’t forget that you need to refresh the workbook to update (CTRL + ALT + F9)

Google Sheets

Google Sheets provides IMPORT functions to populate cells with data.

This will pull just the latest price for Apple
=IMPORTDATA("https://cloud.iexapis.com/stable/stock/aapl/quote/latestPrice?token=YOUR_TOKEN_HERE")

Next earnings report date for Apple
=IMPORTDATA("https://cloud.iexapis.com/stable/stock/aapl/estimates/1/reportDate?token=YOUR_TOKEN_HERE")

CSV Files

You can also return most endpoints as CSV by passing a query parameter of format=csv.
https://cloud.iexapis.com/stable/stock/aapl/quote?token=YOUR_TOKEN_HERE&format=csv

REST How-To

Making your first REST API call is easy and can be done from your browser.

You will need:

REST calls are made up of:

Free IEX price for Apple

https://cloud.iexapis.com/stable/tops?token=YOUR_TOKEN_HERE&symbols=aapl

Stock quote for Apple

https://cloud.iexapis.com/stable/stock/aapl/quote?token=YOUR_TOKEN_HERE

Curl quote for Apple from the command line

curl -k 'https://cloud.iexapis.com/stable/stock/aapl/quote?token=YOUR_TOKEN_HERE'

Time Series

Time series is the most common type of data available, and consists of a collection of data points over a period of time. Time series data is indexed by a single date field, and can be retrieved by any portion of time.

To use this endpoint, you’ll first make a free call to get an inventory of available time series data.

HTTP request

# List all available time series data
GET /time-series

JSON response

{
  "id": "REPORTED_FINANCIALS",
  "description": "Reported financials",
  "key": "a valid symbol",
  "subkey": "10-K,10-Q",    
  "schema": {
    "type": "object",
    "properties": {
      "formFiscalYear": {
        "type": "number"
      },
      "formFiscalQuarter": {
        "type": "number"
      },
      "version": {
        "type": "string"
      },
      "periodStart": {
        "type": "string"
      },
      "periodEnd": {
        "type": "string"
      },
      "dateFiled": {
        "type": "string"
      },
      "reportLink": {
        "type": "string"
      },
      "adsh": {
        "type": "string"
      },
      "stat": {
        "type": "object"
      }
    }
  },
  "weight": 5000,
  "created": "2019-06-04 21:32:20",
  "lastUpdated": "2019-06-04 21:32:20"
}

A full inventory of time series data is returned by calling /time-series without a data id. The data structure returned is an array of available data sets that includes the data set id, a description of the data set, the data weight, a data schema, date created, and last updated date. The schema defines the minimum data properties for the data set, but note that additional properties can be returned. This is possible when data varies between keys of a given data set.

Each inventory entry may include a key and subkey which describes what can be used for the key or subkey parameter.

Once you find the data set you want, use the id to query the time series data.

HTTP request

# Get time series data
GET /time-series/{id}/{key?}/{subkey?}

Time series data is queried by a required data set id. For example, “REPORTED_FINANCIALS”. Some time series data sets are broken down further by a data set key. This may commonly be a symbol. For example, REPORTED_FINANCIALS accepts a symbol such as “AAPL” as a key. Data sets can be even further broken down by sub key. For example, REPORTED_FINANCIALS data set with the key “AAPL” can have a sub key of “10-Q” or “10-K”.

Keys and sub keys will be defined in the data set inventory.

Data Weighting

The time series inventory call is Free
Time series data weight is specified in the inventory call and applied per array item (row) returned.

Data Timing

Varies

Data Schedule

Varies

Data Source(s)

Varies

Notes

Access to each data point will be based on the source Stocks endpoint

Available Methods

GET /time-series
GET /time-series/{id}/{key?}/{subkey}

Examples

Path Parameters

Parameter Details
id Required.
• ID used to identify a time series dataset.
key Required.
• Key used to identify data within a dataset. A common example is a symbol such as AAPL.
subkey Optional.
• The optional subkey can used to further refine data for a particular key if available.

Query String Parameters

Parameter Details
range Optional.
Returns data for a given range. Supported ranges described below.
calendar Optional.
Boolean. Used in conjunction with range to return data in the future.
limit Optional.
Limits the number of results returned. Defaults to 1 when no date or range {subkey} is specified
subattribute Optional.
Allows you to query time series by any field in the result set. All time series data is stored by ID, then key, then subkey. If you want to query by any other field in the data, you can use subattribute.
For example, news may be stored as /news/{symbol}/{newsId}, and the result data returns the keys id, symbol, date, sector, hasPaywall
By default you can only query by symbol or id. Maybe you want to query all news where the sector is Technology.

Your query would be: /time-series/news?subattribute=source|WSJ
The syntax is subattribute={keyName}|{value}

Both the key name and the value are case sensitive. A pipe symbol is used to represent ‘equal to’.
dateField Optional.
All time series data is stored by a single date field, and that field is used for any range or date parameters. You may want to query time series data by a different date in the result set. To change the date field used by range queries, pass the case sensitive field name with this parameter.
For example, corporate buy back data may be stored by announce date, but also contains an end date which you’d rather query by. To query by end date you would use dateField=endDate&range=last-week
from Optional.
Returns data on or after the given from date. Format YYYY-MM-DD
to Optional.
Returns data on or before the given to date. Format YYYY-MM-DD
on Optional.
Returns data on the given date. Format YYYY-MM-DD
last Optional.
Returns the latest n number of records in the series
first Optional.
Returns the first n number of records in the series
filter Optional.
The standard filter parameter. Filters return data to the specified comma delimited list of keys (case-sensitive)
format Optional.
The standard format parameter. Returns data as JSON by default. See the data format section for supported types.

Supported Ranges

Parameter Details
today Returns data for today
yesterday Returns data for yesterday
ytd Returns data for the current year
last-week Returns data for Sunday-Saturday last week
last-month Returns data for the last month
last-quarter Returns data for the last quarter
d Use the short hand d to return a number of days. Example: 2d returns 2 days.
If calendar=true, data is returned from today forward.
w Use the short hand w to return a number of weeks. Example: 2w returns 2 weeks.
If calendar=true, data is returned from today forward.
m Use the short hand m to return a number of months. Example: 2m returns 2 months.
If calendar=true, data is returned from today forward.
q Use the short hand q to return a number of quarters. Example: 2q returns 2 quarters.
If calendar=true, data is returned from today forward.
y Use the short hand y to return a number of years. Example: 2y returns 2 years.
If calendar=true, data is returned from today forward.
tomorrow Calendar data for tomorrow. Requires calendar=true
this-week Calendar data for Sunday-Saturday this week. Requires calendar=true
this-month Calendar data for current month. Requires calendar=true
this-quarter Calendar data for current quarter. Requires calendar=true
next-week Calendar data for Sunday-Saturday next week. Requires calendar=true
next-month Calendar data for next month. Requires calendar=true
next-quarter Calendar data for next quarter. Requires calendar=true

Response Attributes

Time series call returns an array of objects. The data returned varies by dataset ID, but each will contain common attributes.

Name Type Description
id string The dataset ID
source string Source of the data if available
key string The requested dataset key
subkey string The requested dataset subkey
date number The date field of the time series as epoch timestamp
updated number The time data was last updated as epoch timestamp

Time series inventory call returns:

Name Type Description
id string Dataset ID
description string Description of the dataset
key string Dataset key
subkey string Dataset subkey
schema object Data weight to call the individual data point in number of messages.
weight number Data weight to call the time series in number of messages per array item (row) returned.
created string ISO 8601 formatted date time the time series dataset was created.
lastUpdated string ISO 8601 formatted date time the time series dataset was last updated.

Calendar

Using the time series `calendar` parameter, you can use short-hand codes to pull future event data such as tomorrow, next-week, this-month, next-month, and more.

Subset of time series parameters used for calendar

Parameter Details
range Optional.
• Returns data for a given range. Supported ranges described below.
calendar Optional.
• boolean. Used in conjunction with range to return data in the future.
Plus all supported time series parameters

Supported calendar ranges

Parameter Details
d Use the short hand d to return a number of days. Example: 2d returns 2 days.
If calendar=true, data is returned from today forward.
w Use the short hand w to return a number of weeks. Example: 2w returns 2 weeks.
If calendar=true, data is returned from today forward.
m Use the short hand m to return a number of months. Example: 2m returns 2 months.
If calendar=true, data is returned from today forward.
q Use the short hand q to return a number of quarters. Example: 2q returns 2 quarters.
If calendar=true, data is returned from today forward.
y Use the short hand y to return a number of years. Example: 2y returns 2 years.
If calendar=true, data is returned from today forward.
tomorrow Calendar data for tomorrow. Requires calendar=true
this-week Calendar data for Sunday-Saturday this week. Requires calendar=true
this-month Calendar data for current month. Requires calendar=true
this-quarter Calendar data for current quarter. Requires calendar=true
next-week Calendar data for Sunday-Saturday next week. Requires calendar=true
next-month Calendar data for next month. Requires calendar=true
next-quarter Calendar data for next quarter. Requires calendar=true

Data Points

Data points are available per symbol and return individual plain text values. Retrieving individual data points is useful for Excel and Google Sheet users, and applications where a single, lightweight value is needed. We also provide update times for some endpoints which allow you to call an endpoint only once it has new data.

To use this endpoint, you’ll first make a free call to list all available data points for your desired symbol, which can be a security or data category.

HTTP request

# List available data keys
GET /data-points/{symbol}

JSON request

[
  {
    "key": "QUOTE-LATESTPRICE",
    "weight": 1,
    "description": "Quote: latestPrice",
    "lastUpdated": "2019-04-15T13:56:39+00:00"
  },
  {
    "key": "LATEST-FINANCIAL-REPORT-DATE",
    "weight": 0,
    "description": "Latest financials report date available",
    "lastUpdated": "2019-04-15T08:08:10+00:00"
  },
  {
    "key": "LATEST-NEWS",
    "weight": 0,
    "description": "Timestamp of the latest available news item",
    "lastUpdated": "2019-04-15T13:50:11+00:00"
  },
  {
    "key": "PRICE-TARGET",
    "weight": 500,
    "description": "Price target average",
    "lastUpdated": "2019-04-15T12:00:08+00:00"
  },
]

Once you find the data point you want, use the key to fetch the individual data point.

HTTP request

# Get a data point
GET /data-points/{symbol}/{key}

Data Weighting

List available data keys Free
Get a data point: The weight specified in the data list.

Data Timing

Varies

Data Schedule

Varies

Data Source(s)

Varies

Notes

Access to each data point will be based on the source Stocks endpoint

Available Methods

Examples

Response Attributes

Data point call returns a single plain text value Available data keys call returns:

Name Type Description
key string Data key used to call a specific data point
weight number Data weight to call the individual data point in number of messages.
description string Description of the data point
lastUpdated string ISO 8601 formatted date time the data point was last updated.

Files

The Files API allows users to download bulk data files, PDFs, etc.

Lookup Available Files

HTTP request

# List all available file types
GET /files

JSON response

[
  {
    "id": "VALUENGINE_REPORT",
    "metadata": {
    "weight": "PREMIUM_VALUENGINE_REPORT",
    "bySymbol": true,
    "byDate": true,
    "numberOfDownloads": 3,
    "source": "ValueEngine",
    "contentType": "text/pdf",
    "extension": "pdf",
    "tags": [ ],
    "categories": [ ]
  },
    "lastUpdated": "2020-03-20T15:15:03+00:00"
  },

]


Lookup avilable symbols and/or dates for file types

For files that have bySymbol = true or byDate = true, this call will show what symbols and dates are available.

HTTP request

# List all available file types
GET /files/info/:id

JSON response

{
  "symbols": [],
  "dates": []
}


Download a file

This call returns an HTTP redirect to a one time secure URL. The URL expires after 1 minute.

HTTP request

# List all available file types
GET /files/download/:id?symbol={symbol}&date={date}

HTTP Redirect response

If the file schema specifies bySymbol = true, then pass a {symbol} query parameter.
If the file schema specifies byDate = true, then pass a {date} query parameter the format "YYYYMMDD".

Rules Engine Beta

Evaluate thousands of data points per second and build event-driven, automated alerts using Rules Engine. You can access Rules Engine through the IEX Console or through our API using the guidelines below.

Your Secret API Token (sk_) should be used to interact with Rules Engine API endpoints. Make sure to not expose your secret token publicly. All interactions should be from a secure server. Find and manage your API Tokens through the console.

To create a rule:

Rules Schema

Pull the latest schema for data points, notification types, and operators used to construct rules.

HTTP Request

GET /stable/rules/schema

JSON Response

{
  "schema": [
    {
      "label": "Symbol: Change %",
      "value": "changePercent",
      "type": "number",
      "scope": "state",
      "isLookup": false,
      "weight": 1,
      "weightKey": "STOCK_QUOTE",
    },
    {
      "label": "Symbol: Latest Price",
      "value": "latestPrice",
      "type": "number",
      "scope": "state",
      "isLookup": false,
      "weight": 1,
      "weightKey": "STOCK_QUOTE",
    },
    // { ... }
  ],
  "notificationTypes": [
    {
      "label": "Webhook",
      "value": "webhook",
      "weight": 100,
      "enabled": true,
    },
    {
      "label": "Google Cloud Function",
      "value": "googlefunctions",
      "weight": 1000,
      "enabled": true,
    },
    {
      "label": "Email",
      "value": "email",
      "weight": 20000,
      "enabled": true,
    },
    // { ... }
  ],
  "operators": {
    "number": [
      {
        "label": "is above",
        "value": ">",
      },
      {
        "label": "is above or equal to",
        "value": ">=",
      },
      {
        "label": "is below",
        "value": "<",
      },
      // { ... }
    ],
    "string": [
      {
        "label": "is",
        "value": "==",
      }
    ],
    "boolean": [
      {
        "label": "True",
        "value": "true",
      },
      {
        "label": "False",
        "value": "false",
      },
    ],
    "time": [
      {
        "label": "is within",
        "value": "within",
      }
    ],
  }
}

Available Methods

GET /stable/rules/schema

Examples

Notes

If a schema object has “isLookup”: true, pass the value key to /stable/rules/lookup/{value}. This returns all valid values for the rightValue of a condition.

Response Attributes

Key Type Description
label string Data label
value string Data value
type string Data type
scope string Scope of data
isLookup boolean
weight number Data weight
weightKey string Data weight key

Lookup Values

HTTP Request

GET /stable/rules/lookup/{value}

JSON Response

// sector
[
  {
    "value": "Basic Materials",
    "label": "Basic Materials",
    "type": "string",
    "formula": "",
    "scope": "lookup",
  },
  {
    "value": "Communication Services",
    "label": "Communication Services",
    "type": "string",
    "formula": "",
    "scope": "lookup",
  },
  // { ... }
]

Available Methods

GET /stable/rules/lookup/{value}

Examples

Path Parameters

If a schema object has isLookup:true, then use the value (ex: changePercent, latestPrice, etc) as the {value} path parameter.

Response Attributes

Key Type Description
value string The actual lookup value that should be used in the right condition
label string Label of the lookup
type string Data type
formula string
scope string


Creating a Rule

This endpoint is used to both create and edit rules. Note that rules run be default after being created.

HTTP Request

POST /stable/rules/create

JSON Response

{
  "id": "f759e05a-7cda-44cc-9579-41178249be4a",
  "weight": 20001
}

Data Weighting

0

Available Methods

POST /stable/rules/create

Example

JavaScript Example

'use strict';
const Request = require('request-promise-native');
function connect() {
    Request({
        method: 'POST',
        url: 'https://cloud.iexapis.com/stable/rules/create',
        json: {
            token: '{YOUR_API_TOKEN}',
            ruleSet: 'AAPL',
            type: 'any',
            ruleName: 'My Rule',
            conditions: [
                ['changePercent','>',5],
                ['latestPrice','<',100]
            ],
            outputs: [
                {
                    frequency: 60,
                    method: 'email',
                    to: 'your_email@domain'
                }
            ]
        },
    }).then((body) => {
        console.log(body);
    }).catch((err) => {
        console.log("Error in request", err);
    });
}

connect();

Post Parameters

Option Type Description
token string Required. Your sk API token
ruleSet string Required. Valid US symbol or the string ANYEVENT. If the string ANYEVENT is passed, the rule will be triggered for any symbol in the system. The cool down period for alerts (frequency) is applied on a per symbol basis.
type string Required. Specify either any, where if any condition is true you get an alert, or all, where all conditions must be true to trigger an alert. any is the default value
ruleName string Required. Your name for the rule
conditions array Required. An array of arrays. Each condition array will consist of three values; left condition, operator, right condition.
Ex: [ ['latestPrice', '>', 200.25], ['peRatio', '<', 20] ]
outputs array Required. An array of one object. The object’s schema is defined for each notification type, and is returned by the notificationTypes array in the /rules/schema endpoint.
Every output object will contain method (which should match the value key of the notificationType, and frequency which is the number of seconds to wait between alerts.
Ex: [ { method: 'webhook', url: 'https://myserver.com/iexcloud-webhook', frequency: 60 } ]
id string Optional. The id of an existing rule only if you are editing the existing rule
additionalKeys array Optional. An array of schema data values to be included in alert message in addition to the data values in the conditions.
Ex: ['latestPrice', 'peRatio', 'nextEarningsDate']

Response Attributes

Key Type Description
id string Rule id
weight number Total message weight that will be charged per alert sent


Pause and Resume

You can control the output of rules by pausing and resume per rule id.

HTTP Request

POST /stable/rules/pause
POST /stable/rules/resume

JSON Response

true

Available Methods

POST /stable/rules/pause POST /stable/rules/resume

Post Parameters

Option Type Description
token string Required.
• Your sk API token
ruleId string Required.
• Rule ID of rule you want to pause or resume.

Response Attributes

Response Type Description
true / false boolean Returns true if action was successful or false if action was unsuccessful

Edit an existing rule

To edit an existing rule, use the same process as creating a rule, but include the rule id in the POST object.

Example

JavaScript Example

'use strict';
const Request = require('request-promise-native');
function connect() {
  Request({
    method: 'POST',
    url: 'https://cloud.iexapis.com/stable/rules/create',
    json: {
      token: {YOUR_API_TOKEN},
      id: "f759e05a-7cda-44cc-9579-41178249be4a",
      ruleSet: "AAPL",
      type: "any",
      ruleName: "My Rule",
      conditions: [
        ['changePercent','>',2],
        ['latestPrice','<',200]
      ],
      outputs: [
        {
          frequency: 60*60,
          method: 'email',
          to: '{Your Email}'
        }
      ]
    },
  }).then((body) => {
    console.log(body);
  });
}

connect();


Delete a rule

You can delete a rule by using an __HTTP DELETE__ request. This will stop rule executions and delete the rule from your dashboard. If you only want to temporarily stop a rule, use the pause/resume functionality instead.

HTTP Request

DELETE /stable/rules/:id

JSON Response

true

Available Methods

DELETE /stable/rules/:id

Path Parameters

Option Details
id Required.
• Rule ID of rule you want to delete.

Response Attributes

Response Type Description
true / false boolean Returns true if action was successful or false if action was unsuccessful


Get Rule Info

Rule information such as the current rule status and execution statistics.

HTTP Request

GET /stable/rules/info/{id}

JSON Response

[
  {
    "id": "f759e05a-7cda-44cc-9579-41178249be4a",
    "name": "My Apple Rule",
    "event": "AAPL",
    "dateCreated": "2020-02-25",
    "dateUpdated": "2020-02-25",
    "isActive": true,
    "ran": 157,
    "passed": 2,
    "sent": 2
  }
]

Available Methods

GET /stable/rules/info/{id}

Path Parameters

Option Details
id Required.
• Rule ID of rule you want to delete.

Response Attributes

Key Type Description
id string Rule ID
name string Name of rule
event string Symbol or event attached to rule
dateCreated string Date the rule was created
dateUpdated string Date the rule was last updated
isActive boolean Returns true if rule is running or false if rule is paused
ran number Number of times rule has been triggered
passed number Number of times the rule passed conditions
sent number Number of alerts sent from Rules Engine

List all rules

List all rules that are currently on your account. Each rule object returned will include the current rule status and execution statistics.

HTTP Request

GET /stable/rules

JSON Response

[
  {
    "id": "f759e05a-7cda-44cc-9579-41178249be4a",
    "name": "My Apple Rule",
    "event": "AAPL",
    "dateCreated": "2020-02-25",
    "dateUpdated": "2020-02-25",
    "isActive": true,
    "ran": 157,
    "passed": 2,
    "sent": 2
  },
  {
    "id": "436a3520-5ae5-4497-b116-0152664bd1a8",
    "name": "My Tesla Rule",
    "event": "TSLA",
    "dateCreated": "2020-02-21",
    "dateUpdated": "2020-02-23",
    "isActive": false,
    "ran": 23,
    "passed": 0,
    "sent": 0
  },
  // { ... }
]

Available Methods

GET /stable/rules

Response Attributes

Key Type Description
id string Rule ID
name string Name of rule
event string Symbol attached to rule
dateCreated string Date rule was created
dateUpdated string Date rule was last changed
isActive boolean Returns true if rule is active or false if rule is paused
ran number Number of times rule was ran
passed number Number of times the rule passed conditions
sent number Number of alerts sent from Rules Engine


Get Log Output

If you choose `logs` as your rule output method, IEX Cloud will save the output objects on our server. You can use this method to retrieve those data objects.

HTTP Request

GET /stable/rules/output/{id}

JSON Response

Available Methods

GET /stable/rules/output/{id}

Path Parameters

Option Details
id Required.
• Rule ID of rule you want output info for.

Response Attributes

The response will be an array of objects. Each object will contain data defined by the keys in each rule.


Webhooks

If you choose `webhooks` as your rule output method, IEX Cloud will HTTP POST to a URL with your data object.

The POST is sent with Content-Type header as `application/json`. Default timeout for a response is 10 seconds

If you use an HTTPS URL for your webhook endpoint, your server must be correctly configured to support HTTPS with a valid server certificate.

HTTP POST JSON Example

{
  "data": {
    "id": "2342-12342ssd-2323xs23-asdfs",
    "event": "AAPL",
    "name": "My Rule",
    "data": {
      "latestPrice": 100.10
    },
    "timestamp": 1505779200000
  }
}

Response Attributes

Key Type Description
id string Rule ID
event string Symbol attached to rule
name string Name of the rule
ruleEvent object Object containing key value pairs as defined by the rule
timestamp number Refers to the machine readable epoch timestamp of when the rule triggered. Represented in milliseconds since midnight Jan 1, 1970.

Account

Message Budget

Used to set an upper limit, “message budget”, on pay as you go messages where you want to make sure not to go above a certain amount. Set the total messages you wish to consume for the month, and once that limit is reached, all API calls will stop until the limit is removed or increased.

HTTP Request

POST /account/messagebudget

Data Weighting

Free

Notes

Requires SK token to access

Available Methods

POST /account/messagebudget

Query Parameters

Option Description
token Required.
• boolean. Your SK API token.
totalMessages Required.
• number. The total messages your account is allowed to consume for the current month above your quota. For example: If your account is allowed 5 million messages, and you do not want to exceed 10 million for the month, then you will pass 10000000 as total messages.

Metadata

Used to retrieve account details such as current tier, payment status, message quote usage, etc.

HTTP Request

GET /account/metadata

JSON Response

{
    "payAsYouGoEnabled": true,
    "effectiveDate": 1547590582000,
    "endDateEffective": 1547830921000,
    "subscriptionTermType": "monthly",
    "tierName": "launch",
    "messageLimit": 1000000000,
    "messagesUsed": 215141655,
    "circuitBreaker": 3000000000
}

Data Weighting

Free

Data Timing

Start users End of day
Launch, Grow, and Scale users Real-time

Notes

Requires SK token to access

Available Methods

GET /account/metadata

Pay as you go

Used to toggle Pay-as-you-go on your account.

HTTP Request

POST /account/payasyougo

Data Weighting

Free

Notes

Requires SK token to access

Available Methods

POST /account/payasyougo

Query Parameters

Option Description
token Required.
• (boolean) Your SK API token.
allow Required.
• (boolean) Pass true to enable Pay-as-you-go, or false to disable.

Signed Requests

Making your first Signed REST API requires a little more effort. This approach has been heavily based on Amazon’s V4 signing approach. The basic idea is to take your secret key, and use that to generate a cryptographic fingerprint of all aspects of your request, so they can be verified by the server, so the interception of the data over the network does not compromise your account. However, you must take care that your secret key for your publishable key is not compromised!

You will need:

Signed REST calls are made up of:

Setting up signed token

Signs a token, so it will require signed headers when a request is made using this token.

HTTP request

POST content-type:application/json { "token" : "SK_TOKEN", "tokenToSign" : "PK/SK_TOKEN_TO_BE_SIGNED", ("unsign" : true) } /account/signed

JSON response

{
    "secret" : "e2700e6b-3be0-4f31-a408-61365caa263a",
    "signedToken" : "pk_6b95e1fac3114f0392a5becd4d8f08e1"
}

Data Weighting

Free

Notes

Examples

See below

Response Attributes

Key Type Description
secret string The secret key for the token
signedToken string The token that has just been signed

Getting the secret for a signed token

Returns the secret for a token, thus making it “signed”.

HTTP request

GET /account/signed?token=SK_TOKEN&signedToken=TOKEN

JSON example

{
     "secret" : "e2700e6b-3be0-4f31-a408-61365caa263a",
}

Data Weighting

Free

Notes

Examples

See below

Response Attributes

Key Type Description
secret string The secret key for the token

Examples on how to make a signed request:

Node.js Example

#!/usr/bin/env node

/*
Copyright 2019-2020 iexcloud. or its affiliates. All Rights Reserved.

This file is licensed under the Apache License, Version 2.0 (the "License").
You may not use this file except in compliance with the License. A copy of the
License is located at

https://www.apache.org/licenses/LICENSE-2.0

This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS
OF ANY KIND, either express or implied. See the License for the specific
language governing permissions and limitations under the License.
*/

const moment = require('moment');
const crypto = require('crypto');
const https  = require('https');

const method = 'GET'
const host = 'cloud.iexapis.com'

const access_key = process.env.IEX_PUBLIC_KEY // public key
const secret_key = process.env.IEX_SECRET_KEY // secret key for public key

const canonical_querystring = 'token=' + access_key ;
const canonical_uri = '/v1/stock/aapl/company'

var ts = moment.utc();
const iexdate = ts.format("YYYYMMDDTHHmmss") + 'Z';
const datestamp = ts.format("YYYYMMDD");

function sign(secret, data) {
    return crypto.createHmac('sha256', secret).update(data, "utf8").digest('hex');
};

function getSignatureKey(key, datestamp) {
    const signedDate = sign(key, datestamp);
    return sign(signedDate, 'iex_request');
}

if ( ! access_key || ! secret_key ) {
    console.warn('No access key is available.')
    process.exit(1);
}

const canonical_headers = 'host:' + host + '\n' + 'x-iex-date:' + iexdate + '\n';
const signed_headers = 'host;x-iex-date'
const payload = '';
const payload_hash = crypto.createHash('sha256').update(payload).digest('hex');
const canonical_request = method + '\n' + canonical_uri + '\n' + canonical_querystring + '\n' + canonical_headers + '\n' + signed_headers + '\n' + payload_hash;
const algorithm = 'IEX-HMAC-SHA256';
const credential_scope = datestamp + '/' + 'iex_request';
const string_to_sign = algorithm + '\n' +  iexdate + '\n' +  credential_scope + '\n' + crypto.createHash('sha256').update(canonical_request, "utf8").digest('hex');
const signing_key = getSignatureKey(secret_key, datestamp)
const signature = crypto.createHmac('sha256', signing_key).update(string_to_sign, "utf8").digest('hex');
const authorization_header = algorithm + ' ' + 'Credential=' + access_key + '/' + credential_scope + ', ' +  'SignedHeaders=' + signed_headers + ', ' + 'Signature=' + signature
const headers = {'x-iex-date':iexdate, 'Authorization':authorization_header}

const options = {
    host: host,
    port: 443,
    path: canonical_uri + "?" + canonical_querystring,
    method: 'GET',
    headers: headers
};

const req = https.request(options, function(res) {
    res.setEncoding('utf8');
    res.on('data', function(chunk) {
        var parsed = JSON.parse(chunk);
        console.log(parsed);
    });
});
req.end();

Python Example

#!/usr/bin/env python

# Copyright 2019-2020 iexcloud. or its affiliates. All Rights Reserved.
#
# This file is licensed under the Apache License, Version 2.0 (the "License").
# You may not use this file except in compliance with the License. A copy of the
# License is located at
#
# https://www.apache.org/licenses/LICENSE-2.0
#
# This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS
# OF ANY KIND, either express or implied. See the License for the specific
# language governing permissions and limitations under the License.

import sys, os, base64, datetime, hashlib, hmac
import requests # pip install requests

# ************* REQUEST VALUES *************
method = 'GET'
host = 'cloud.iexapis.com'

access_key = os.environ.get('IEX_PUBLIC_KEY')
secret_key = os.environ.get('IEX_SECRET_KEY')

canonical_querystring = 'token=' + access_key
canonical_uri = '/v1/stock/aapl/company'
endpoint = "https://" + host + canonical_uri

def sign(key, msg):
    return hmac.new(key, msg.encode('utf-8'), hashlib.sha256).hexdigest()

def getSignatureKey(key, dateStamp):
    kDate = sign(key, dateStamp)
    return sign(kDate, 'iex_request')

if access_key is None or secret_key is None:
    print('No access key is available.')
    sys.exit()

t = datetime.datetime.utcnow()
iexdate = t.strftime('%Y%m%dT%H%M%SZ')
datestamp = t.strftime('%Y%m%d') # Date w/o time, used in credential scope
canonical_headers = 'host:' + host + '\n' + 'x-iex-date:' + iexdate + '\n'
signed_headers = 'host;x-iex-date'
payload_hash = hashlib.sha256(('').encode('utf-8')).hexdigest()
canonical_request = method + '\n' + canonical_uri + '\n' + canonical_querystring + '\n' + canonical_headers + '\n' + signed_headers + '\n' + payload_hash
algorithm = 'IEX-HMAC-SHA256'
credential_scope = datestamp + '/' + 'iex_request'
string_to_sign = algorithm + '\n' +  iexdate + '\n' +  credential_scope + '\n' +  hashlib.sha256(canonical_request.encode('utf-8')).hexdigest()
signing_key = getSignatureKey(secret_key, datestamp)
signature = hmac.new(signing_key, (string_to_sign).encode('utf-8'), hashlib.sha256).hexdigest()
authorization_header = algorithm + ' ' + 'Credential=' + access_key + '/' + credential_scope + ', ' +  'SignedHeaders=' + signed_headers + ', ' + 'Signature=' + signature

headers = {'x-iex-date':iexdate, 'Authorization':authorization_header}

# ************* SEND THE REQUEST *************
request_url = endpoint + '?' + canonical_querystring

print('\nBEGIN REQUEST++++++++++++++++++++++++++++++++++++')
print('Request URL = ' + request_url)
r = requests.get(request_url, headers=headers)

print('\nRESPONSE++++++++++++++++++++++++++++++++++++')
print('Response code: %d\n' % r.status_code)
print(r.text)

Usage

Used to retrieve current month usage for your account.

HTTP Request

GET /account/usage/{type}

JSON Response

{
    "monthlyUsage": 215200,
    "monthlyPayAsYouGo": 0,
    "dailyUsage": {
        "20190120": 115200, 
        "20190121": 100000
    },
    "tokenUsage": {
        "pk_123": 215200
    },
    "keyUsage": {
        "IEX_STATS": 0, 
        "EARNINGS": 115200, 
        "STOCK_QUOTES": 100000
    }
}

Data Weighting

Free

Data Timing

Real-time

Notes

Available Methods

GET /account/usage/{type}

Path Parameters

Option Description
type Optional.
• Used to specify which quota to return. Ex: messages, rules, rule-records, alerts, alert-records

API System Metadata

Status

Used to retrieve current system status.

HTTP Request

GET /status

JSON response

{
    "status": "up",
    "version": "1.32",
    "time": 1607979129127,
    "currentMonthAPICalls": 14225180421
}

Data Weighting

Free

Data Timing

Real-time

Available Methods

GET /status

Notes

No token required

Changelog

The following is a list of running updates to the IEX API.

v1

2021-01-27

2021-01-25

2020-08-10

2020-06-22

2020-06-01

2020-04-07

2020-03-20

2020-03-18

2020-03-17

2020-03-16

2020-03-13

2020-03-12

2020-03-04

2020-03-03

2020-02-28

2020-02-27

2020-02-07

2020-02-03

2020-01-17

2019-12-09

2019-12-05

2019-11-26

2019-11-25

2019-11-20

2019-11-15

2019-11-14

2019-11-12

2019-11-08

2019-11-07

2019-11-01

2019-10-29

2019-10-23

2019-10-14

2019-10-11

2019-10-10

2019-10-01

2019-09-20

2019-09-09

2019-08-15

2019-08-10

2019-07-31

2019-07-18

2019-07-15

2019-07-01

2019-06-14

2019-06-03

2019-05-28

2019-05-16

2019-05-15

2019-05-10

2019-04-30

2019-04-26

2019-04-18

Beta

2019-04-15

2019-04-10

2019-04-09

2019-03-22

2019-03-21

2019-03-20

2019-03-18

2019-03-14

2019-03-13

2019-03-12

2019-03-08

2019-03-07

2019-03-06

2019-02-28

2019-02-27

2019-02-26

2019-02-21

2019-02-20

2019-02-19

2019-02-14

2019-02-12

2019-02-07

2019-02-01

Core Data

Stocks / Equities

Advanced Fundamentals

The New Constructs Reported Fundamentals Data dataset provides immediate access to the data points in our models for 2850+ companies. Models are updated daily. Reported Fundamentals includes data as reported by the company from their financial statements - the income statement, balance sheet, and cash flow statement.

HTTP request

GET /time-series/fundamentals/{symbol}/{period}

JSON response

[
  {
    "accountsPayable": 20673000000,
    "accountsPayableTurnover": 8,
    "accountsReceivable": 9237000000,
    "accountsReceivableTurnover": 17,
    "asOfDate": "2020-02-05",
    "assetsCurrentCash": 22288000000,
    "assetsCurrentCashRestricted": 0,
    "assetsCurrentDeferredCompensation": 0,
    "assetsCurrentDeferredTax": 0,
    "assetsCurrentDiscontinuedOperations": 2383000000,
    "assetsCurrentInvestments": 3296000000,
    "assetsCurrentLeasesOperating": 0,
    "assetsCurrentLoansNet": 53651000000,
    "assetsCurrentOther": 3339000000,
    "assetsCurrentSeparateAccounts": 0,
    "assetsCurrentUnadjusted": 114047000000,
    "assetsFixed": 144490000000,
    "assetsFixedDeferredCompensation": 0,
    "assetsFixedDeferredTax": 11863000000,
    "assetsFixedDiscontinuedOperations": 0,
    "assetsFixedLeasesOperating": 0,
    "assetsFixedOperatingDiscontinuedOperations": 0,
    "assetsFixedOperatingSubsidiaryUnconsolidated": 2519000000,
    "assetsFixedOreo": 0,
    "assetsFixedOther": 93639000000,
    "assetsFixedUnconsolidated": 0,
    "assetsUnadjusted": 258537000000,
    "capex": -7632000000,
    "capexAcquisition": -55576000000,
    "capexMaintenance": 0,
    "cashConversionCycle": -6,
    "cashFlowFinancing": -3129000000,
    "cashFlowInvesting": -13721000000,
    "cashFlowOperating": 17639000000,
    "cashFlowShareRepurchase": -237000000,
    "cashLongTerm": 0,
    "cashOperating": 9067000000,
    "cashPaidForIncomeTaxes": 0,
    "cashPaidForInterest": 0,
    "cashRestricted": 0,
    "chargeAfterTax": 37000000,
    "chargeAfterTaxDiscontinuedOperations": 0,
    "chargesAfterTaxOther": 0,
    "cik": "37996",
    "creditLossProvision": 0,
    "dataGenerationDate": "2020-02-05",
    "daysInAccountsPayable": 48,
    "daysInInventory": 25,
    "daysInRevenueDeferred": 5,
    "daysRevenueOutstanding": 22,
    "debtFinancial": 140029000000,
    "debtShortTerm": 1575000000,
    "depreciationAndAmortizationAccumulated": 31020000000,
    "depreciationAndAmortizationCashFlow": 10888000000,
    "dividendsPreferred": 0,
    "dividendsPreferredRedeemableMandatorily": 0,
    "earningsRetained": 20320000000,
    "ebitReported": 1796000000,
    "ebitdaReported": 12684000000,
    "equityShareholder": 33185000000,
    "equityShareholderOther": 0,
    "equityShareholderOtherDeferredCompensation": 0,
    "equityShareholderOtherEquity": 0,
    "equityShareholderOtherMezzanine": 0,
    "expenses": 157762000000,
    "expensesAcquisitionMerger": 0,
    "expensesCompensation": 0,
    "expensesDepreciationAndAmortization": 0,
    "expensesDerivative": 0,
    "expensesDiscontinuedOperations": 0,
    "expensesDiscontinuedOperationsReits": 0,
    "expensesEnergy": 0,
    "expensesForeignCurrency": 0,
    "expensesInterest": 1049000000,
    "expensesInterestFinancials": 0,
    "expensesInterestMinority": 37000000,
    "expensesLegalRegulatoryInsurance": 0,
    "expensesNonOperatingCompanyDefinedOther": -106000000,
    "expensesNonOperatingOther": 1602000000,
    "expensesNonOperatingSubsidiaryUnconsolidated": 0,
    "expensesNonRecurringOther": -89000000,
    "expensesOperating": 155326000000,
    "expensesOperatingOther": 9472000000,
    "expensesOperatingSubsidiaryUnconsolidated": 0,
    "expensesOreo": 0,
    "expensesOreoReits": 0,
    "expensesOtherFinancing": 0,
    "expensesRestructuring": -20000000,
    "expensesSga": 11161000000,
    "expensesStockCompensation": 0,
    "expensesWriteDown": 0,
    "ffo": 0,
    "figi": "BBG000BQPC32",
    "filingDate": "2020-02-05",
    "filingType": "10-K",
    "fiscalQuarter": 3,
    "fiscalYear": 2019,
    "goodwillAmortizationCashFlow": 0,
    "goodwillAmortizationIncomeStatement": 0,
    "goodwillAndIntangiblesNetOther": 0,
    "goodwillNet": 0,
    "incomeFromOperations": 0,
    "incomeNet": 47000000,
    "incomeNetPerRevenue": 0,
    "incomeNetPerWabso": 0,
    "incomeNetPerWabsoSplitAdjusted": 0,
    "incomeNetPerWabsoSplitAdjustedYoyDeltaPercent": -1,
    "incomeNetPerWadso": 0,
    "incomeNetPerWadsoSplitAdjusted": 0,
    "incomeNetPerWadsoSplitAdjustedYoyDeltaPercent": -1,
    "incomeNetPreTax": -640000000,
    "incomeNetYoyDelta": -3630000000,
    "incomeOperating": 1222000000,
    "incomeOperatingDiscontinuedOperations": 0,
    "incomeOperatingOther": 1190000000,
    "incomeOperatingSubsidiaryUnconsolidated": 32000000,
    "incomeOperatingSubsidiaryUnconsolidatedAfterTax": 0,
    "incomeTax": -724000000,
    "incomeTaxCurrent": 670000000,
    "incomeTaxDeferred": -1394000000,
    "incomeTaxDiscontinuedOperations": 0,
    "incomeTaxOther": 0,
    "incomeTaxRate": 1,
    "interestMinority": 45000000,
    "inventory": 10786000000,
    "inventoryTurnover": 14,
    "liabilities": 258537000000,
    "liabilitiesCurrent": 185790000000,
    "liabilitiesNonCurrentAndInterestMinorityTotal": 39562000000,
    "liabilitiesNonCurrentDebt": 13703000000,
    "liabilitiesNonCurrentDeferredCompensation": 0,
    "liabilitiesNonCurrentDeferredTax": 490000000,
    "liabilitiesNonCurrentDiscontinuedOperations": 0,
    "liabilitiesNonCurrentLeasesOperating": 1047000000,
    "liabilitiesNonCurrentLongTerm": 24322000000,
    "liabilitiesNonCurrentOperatingDiscontinuedOperations": 0,
    "liabilitiesNonCurrentOther": 24277000000,
    "nibclDeferredCompensation": 0,
    "nibclDeferredTax": 0,
    "nibclDiscontinuedOperations": 526000000,
    "nibclLeasesOperating": 367000000,
    "nibclOther": 20529000000,
    "nibclRestructuring": 0,
    "nibclRevenueDeferred": 2091000000,
    "nibclRevenueDeferredTurnover": 75,
    "nibclSeparateAccounts": 0,
    "oci": -7728000000,
    "periodEndDate": "2020-02-05",
    "ppAndENet": 36469000000,
    "pricePerEarnings": 792,
    "pricePerEarningsPerRevenueYoyDeltaPercent": -286,
    "profitGross": 21207000000,
    "profitGrossPerRevenue": 0,
    "researchAndDevelopmentExpense": 0,
    "reserves": 975000000,
    "reservesInventory": 462000000,
    "reservesLifo": 0,
    "reservesLoanLoss": 513000000,
    "revenue": 155900000000,
    "revenueCostOther": 134693000000,
    "revenueIncomeInterest": 0,
    "revenueOther": 155900000000,
    "revenueSubsidiaryUnconsolidated": 0,
    "salesCost": 134693000000,
    "sharesIssued": 4082000000,
    "sharesOutstandingPeDateBs": 0,
    "sharesTreasury": 0,
    "stockCommon": 22206000000,
    "stockPreferred": 0,
    "stockPreferredEquity": 0,
    "stockPreferredMezzanine": 0,
    "stockTreasury": -1613000000,
    "symbol": "F",
    "wabso": 3972000000,
    "wabsoSplitAdjusted": 3972000000,
    "wadso": 4004000000,
    "wadsoSplitAdjusted": 4004000000,
    "id": "FUNDAMENTALS",
    "key": "F",
    "subkey": "quarterly",
    "date": 1605360441000,
    "updated": 1635419177511
  }
]

Data Weighting

75,000 per record

Data Timing

Real-time Historical

Data Schedule

daily

Data Source(s)

Copyright: Data provided by New Constructs, LLC © All rights reserved.

Notes

Only included with paid subscription plans

Available Methods

GET /time-series/fundamentals/{symbol}/{period}

Examples

Pull the last 4 annual reports (10-K) for Ford. - /time-series/fundamentals/F/annual

Pull the lastest quarterly report (10-Q) for Apple. - /time-series/fundamentals/F/annual

Pull the last 2 reported quarters for Tesla. - /time-series/fundamentals/F/annual

Pull the last 2 reported quarters for Tesla. - /time-series/fundamentals/F/annual

Path Parameters

Option Details
symbol Primary security symbol
period Either annual, quarterly, or ttm

Query Parameters

This end point uses all standard time-series query parameters.

Response Attributes

This endpoint inherits common keys from Time Series.

Key Type Description
asOfDate string Date last updated
accountsPayable number Accounts Payable
Accounts payable, a current liability on the balance sheet.
accountsPayableTurnover number Accounts Payable Turnover
The accounts payable turnover ratio shows how many times a company pays off its accounts payable during the period.
accountsReceivable number Accounts Receivable
Accounts receivable, a current asset on the balance sheet.
accountsReceivableTurnover number Accounts Receivable Turnover
The accounts receivable turnover ratio shows how quickly the company is paid for the credit it extends to customers.
assetsUnadjusted number Total Assets (unadjusted)
Total Assets (unadjusted) as reported on the balance sheet.
assetsCurrentUnadjusted number Total Current/Investment Assets (unadjusted)
Total Current/Investment Assets (unadjusted) as reported on the balance sheet.
assetsCurrentCash number Cash and Equivalents (Non-Operating)
Cash and cash equivalents, a current asset on the balance sheet. This data point collects cash for non-financial companies.
assetsCurrentCashRestricted number Current Restricted Cash
Restricted cash, a current asset on the balance sheet.
assetsCurrentDeferredCompensation number Reported Current Deferred Compensation Assets
Current deferred compensation assets, a current asset on the balance sheet.
assetsCurrentDeferredTax number Reported Current Deferred Tax Assets
Current deferred tax assets, a current asset on the balance sheet.
assetsCurrentDiscontinuedOperations number Current Discontinued Operations (Non-Operating)
Current assets from discontinued operations, a current asset on the balance sheet.
assetsCurrentInvestments number Other Investment Securities (Operating)
Investment securities, a current asset on the balance sheet for financial companies or financial segments.
assetsCurrentLeasesOperating number Reported Current Operating Lease Assets
Current operating lease assets, a current asset on the balance sheet.
assetsCurrentLoansNet number Net Loans
Net loans, a current asset on the balance sheet for finanial companies or financial segments
assetsCurrentOther number Other Current or Investment Assets
Other current assets on the balance sheet.
assetsCurrentSeparateAccounts number Separate Accounts
Separate accounts, a current asset on the balance sheet.
assetsFixed number Total Fixed Assets
Total fixed assets from the balance sheet.
assetsFixedDeferredCompensation number Reported Deferred Compensation Assets
Fixed deferred compensation assets, a fixed asset on the balance sheet.
assetsFixedDeferredTax number Reported Deferred Tax Assets
Fixed deferred tax assets, a fixed asset on the balance sheet.
assetsFixedDiscontinuedOperations number Discontinued Operations (Non-Operating)
Fixed assets from discontinued operations, a fixed asset on the balance sheet.
assetsFixedLeasesOperating number Reported Non-Current Operating Lease Assets
Fixed operating lease assets, a fixed asset on the balance sheet.
assetsFixedOperatingDiscontinuedOperations number Discontinued Operations (Operating)
Fixed assets from discontinued operations, a fixed asset on the balance sheet for REITs.
assetsFixedOperatingSubsidiaryUnconsolidated number Unconsolidated Subsidiary Assets (Operating)
Investment in unconsolidated subsidiaries that are part of operations. A fixed asset on the balance sheet.
assetsFixedOreo number Other Real Estate Owned
Other Real Estate Owned (OREO) assets, a fixed asset on the balance sheet for financial companies or segments.
assetsFixedOther number Other Fixed Assets
Other fixed assets on the balance sheet.
assetsFixedUnconsolidated number Unconsolidated Subsidiary Assets (non-operating)
Investment in unconsolidated subsidiaries that are not part of operations. A fixed asset on the balance sheet.
capex number Capital Expenditures
Capital expenditures, from cash flows from investing section of the cash flow statement.
capexAcquisition number Acquisition Capital Expenditures
Acquisition expenditures, from cash flows from investing section of the cash flow statement.
capexMaintenance number Maintenance Capital Expenditures
Capital expenditures, as reported on the cash flow statement, that are necessary for the company to continue operating in its current form.
cashConversionCycle number Cash Conversion Cycle
The cash conversion cycle show the number of days it takes for a company to convert its inventory and other resources into revenue.
cashFlowFinancing number Cash Flow from Financing Activities
Total cash flow from financing activities.
cashFlowInvesting number Cash Flow from Investing Activities
Total cash flow from investing activities.
cashFlowOperating number Cash Flow from Operations
Total cash flow from operations.
cashFlowShareRepurchase number Cash Paid for Share Repurchases
Total cash flow from share repurchases.
cashLongTerm number Long-Term Investments (Non-Operating)
Long-term investments, a long-term asset on the balance sheet.
cashOperating number Cash and Equivalents (Operating)
Cash and cash equivalents, a current asset on the balance sheet. This data point collects cash for financial companies or segments.
cashPaidForIncomeTaxes number Cash Paid for Income Taxes
Cash paid for income taxes, a data point disclosed on the cash flow statement or in the notes.
cashPaidForInterest number Cash Paid for Interest
Cash paid for interest, a data point disclosed on the cash flow statement or in the notes.
cashRestricted number Long-term Restricted Cash
Restricted cash, a long-term asset on the balance sheet.
chargesAfterTaxOther number Reported Other After-Tax Charges, Net
HBS & MIT Sloan Data. Reported Other After-tax Charges, net are other non-operating expenses and income that appear directly on the income statement after tax.
chargeAfterTax number Reported After-Tax Non-Operating Expense/(Income), Net
Net After-Tax Non-Operating Expense/(Income) are the net of non-operating expenses and income that appear directly on the income statement after tax. We classify Non-Operating After-Tax Expenses into the following types:__
chargeAfterTaxDiscontinuedOperations number Reported Loss/(Gain) from Discontinued Operations After-Tax, Net
HBS & MIT Sloan Data. Reported Loss/(Gain) from Discontinued Operations, net is the after-tax expense from assets or subsidiaries that are held for sale.
cik string The unique identifier for this data set, the Central Index Key (“CIK”) is used to identify entities that are regulated by the Securities and Exchange Commission (“SEC”).
creditLossProvision number Credit Loss Provision
Credit loss provision, an expense on the income statement recognized by financial companies or segments.
dataGenerationDate string Date data was generated, formatted YYYY-MM-DD
daysInAccountsPayable number Days in Accounts Payable
Days in accounts payable shows the average number of days it takes a company to pay its bills.
daysInInventory number Days in Inventory
The days in inventory ratio shows how quickly, in days, a company is converting its inventory into revenue.
daysInRevenueDeferred number Days in Deferred Revenue
Days in deferred revenue shows the average number of days it takes a company to collect on deferred revenue.
daysRevenueOutstanding number Days Revenue Outstanding
Days in revenue outstanding shows the average number of days it takes a compnay to collect payment after a sale has been made.
debtFinancial number Investment Liabilities - Debt
Short-term and long-term debt for financial companies or segments.
debtShortTerm number Short-Term Debt
Short-term debt, a current liability on the balance sheet.
depreciationAndAmortizationAccumulated number Accumulated Depreciation and Amortization
Accumulated depreciation and amortization, a data point collected from the balance sheet or notes.
depreciationAndAmortizationCashFlow number Depreciation and Amortization (Cash Flow)
Depreciation and amortization from cash flows from operations section of the cash flow statement.
dividendsPreferred number Reported Preferred Dividends, Net
Reported Preferred Stock Dividends, net are the dividends that must be paid out to preferred equity owners before common stock owners can receive any money.
dividendsPreferredRedeemableMandatorily number Reported Dividends on Redeemable Preferred Stock, Net
Reported Redeemable Preferred Stock Dividends, net are the dividends that must be paid out to redeemable preferred equity owners before common stock owners can receive any money.
earningsRetained number Retained Earnings
Retained earnings, from the shareholders’ equity section of the balance sheet.
ebitdaReported number Reported EBITDA
Reported operating earnings before interest, taxes, depreciation and amortization. This version of EBITDA uses only reported data from the income statment and is not adjusted for unusual gains/losses found only in the footnotes or MD&A.
ebitReported number Reported EBIT
Reported operating earnings before interest and taxes. This version of EBIT uses only reported data from the income statment and is not adjusted for unusual gains/losses found only in the footnotes or MD&A.
equityShareholder number Total Shareholders’ Equity
Total shareholders’ equity, from the shareholders’ equity section of the balance sheet.
equityShareholderOther number Other Shareholders’ Equity
Other shareholders’ equity, from the shareholders’ equity section of the balance sheet.
equityShareholderOtherDeferredCompensation number Deferred Compensation Shareholders’ Equity
Deferred compensation shareholder’s equity, from the shareholders’ equity section of the balance sheet.
equityShareholderOtherEquity number Other Shareholders’ Equity
Other shareholders’ equity, from the shareholders’ equity section of the balance sheet.
equityShareholderOtherMezzanine number Mezzanine Shareholders’ Equity
Mezzanine shareholders’ equity, from the shareholders’ equity section of the balance sheet.
expenses number Total Expenses
expensesAcquisitionMerger number Reported Acquisition and Merger Expenses, Net
HBS & MIT Sloan Data. Reported Acquisition and Merger Expenses, net are the net of non-operating expenses related to an acquisition or merger that appear directly on the income statement.
expensesCompensation number Other Compensation
Other compensation, an expense on the income statement.
expensesDepreciationAndAmortization number Depreciation and Amortization
Depreciation and amortization, an expense on the income statement.
expensesDerivative number Reported Derivate Related Expenses, Net
HBS & MIT Sloan Data. Reported Derivative Related Expenses, net are the net of non-operating expenses related to derivatives that appear directly on the income statement.
expensesDiscontinuedOperations number Reported Expenses/(Income) from Discontinued Operations, Net
HBS & MIT Sloan Data. Reported Expenses/(Income) from Discontinued Operations, net are non-operating expenses associated with businesses or subsidiaries that are held for sale. These expenses appear directly on the income statement.
expensesDiscontinuedOperationsReits number Losses from Discontinued Operations (Operating)
Losses from discontinued operations for REITs.
expensesEnergy number Energy Operating Expense
Energy expense, an expense on the income statement for energy companies.
expensesForeignCurrency number Reported Foreign Currency Expenses, Net
HBS & MIT Sloan Data. Reported Foreign Currency Loss/(Gain), net is a non-operating expense related to the changes in the value of foreign currency that appears directly on the income statement.
expensesInterest number Reported Interest Expense/(Income), Net
Reported Interest Expense/(Income), net is a non-operating expense related to the cost of financing that appears directly on the income statement.
expensesInterestFinancials number Interest Expense (Operating)
Interest expense, an exense on the income statement for financial companies or financial segments.
expensesInterestMinority number Reported Minority Interest Expense, Net
Reported Minority Interest Expenses, net are the net of non-operating expenses associated with significant but non-controlling ownership of a company’s voting shares. The portion of the parent company’s income attributed to minority interest is subtracted from reported profits.
expensesLegalRegulatoryInsurance number Reported Legal, Regulatory, and Insurance Related Expenses, Net
HBS & MIT Sloan Data. Reported Legal, Regulatory, and Insurance Related Expenses, net are the net of non-operating expenses related to legal, regulatory, and insurance costs that appear directly on the income statement.
expensesNonOperatingCompanyDefinedOther number Reported Company Defined Other Non-Operating Expenses, Net
HBS & MIT Sloan Data. Reported Company Defined Other Non-Operating Expenses, net are the net of non-operating expenses for costs specifically defined as other that appear directly on the income statement.
expensesNonOperatingOther number Reported Other Non-Operating Expense/(Income), Net
HBS & MIT Sloan Data. Reported Other Non-Operating Expenses/(Income), net are non-operating expenses for other costs that appear directly on the income statement.
expensesNonOperatingSubsidiaryUnconsolidated number Reported Losses/(Income) from Unconsolidated Subsidiaries, Net
Reported Losses/(Income) from Unconsolidated Subsidiaries, net are non-operating expenses associated with subsidiaries that are not consolidated within the parent company’s financial statements. These expenses appear directly on the income statement.
expensesNonRecurringOther number Reported Other Non-Recurring Expense/(Income), Net
HBS & MIT Sloan Data. Reported Other Non-Recurring Expenses/(Income), net are non-operating expenses for other costs that appear directly on the income statement. These costs should not recur in the future.
expensesOperating number Total Operating Expense
Total operating expenses disclosed on the income statement.
expensesOperatingOther number Other Operating Expense
Other operating expense, an expense on the income statement.
expensesOperatingSubsidiaryUnconsolidated number Losses from Unconsolidated Subsidiaries (Operating)
Losses from unconsolidated subsidiaries, treated as operating if the corresponding asset is operating.
expensesOreo number Reported Non-Operating Other Real Estate Owned Expense/(Income), Net
HBS & MIT Sloan Data. Reported Non-Operating Other Real Estate Owned Expenses/(Income), net are non-operating expenses associated with foreclosed assets owned or controlled by a bank. These expenses appear directly on the income statement.
expensesOreoReits number Operating Other Real Estate Owned Expense
Other real estate owned (OREO) expense, an expense on the income statement.
expensesOtherFinancing number Reported Other Financing Expenses, Net
HBS & MIT Sloan Data. Reported Other Financing Expenses, net are the net of non-operating expenses related to the cost of financing that appear directly on the income statement.
expensesRestructuring number Reported Restructuring Expenses, Net
HBS & MIT Sloan Data. Reported Restructuring Expenses, net are the net of non-operating expenses related to the reorganization of a business that appear directly on the income statement.
expensesSga number Selling, General, and Administrative Expense
Selling, general, and administrative, an expense on the income statement.
expensesStockCompensation number Stock Compensation
Stock compensation, an expense on the income statement.
expensesWriteDown number Reported Write-Downs (Non-Operating), Net
HBS & MIT Sloan Data. Reported Write-Downs, net are non-operating expenses related to the impairment in value of a company’s assets. These expenses appear directly on the income statement.
ffo number Funds from Operations
figi string Financial Instrument Global Identifier for the symbol if available
filingDate string Formatted YYYY-MM-DD
filingType string Filing type
fiscalQuarter number Associated fiscal quarter
fiscalYear number Associated fiscal year
goodwillAmortizationCashFlow number Goodwill Amortization (Cash Flow Statement)
Goodwill amortization, from cash flows from operations section of the cash flow statement, collected prior to 2001 when companies where permitted to amortize goodwill.
goodwillAmortizationIncomeStatement number Goodwill Amortization
Goodwill amortization, a data point on the income statement collected prior to 2001 when companies where permitted to amortize goodwill.
goodwillAndIntangiblesNetOther number Other Intangibles
Goodwill and intangible assets, net, a long-term asset reported on the balance sheet.
goodwillNet number Goodwill, net
Goodwill, net, a long-term asset reported on the balance sheet.
incomeFromOperations number Reported Income from Operations
Reported income from operations, an item on the income statement.
incomeNet number GAAP Net Income
GAAP net income.
incomeNetPerRevenue number GAAP Net Income Margin
GAAP net income margin.
incomeNetPerWabso number Basic EPS (Not Split-Adjusted)
Basic earnings per share (not split-adjusted).
incomeNetPerWabsoSplitAdjusted number Basic EPS
Basic earnings per share.
incomeNetPerWabsoSplitAdjustedYoyDeltaPercent number Basic EPS Annual Growth
Percent growth in basic earnings per share year over year.
incomeNetPerWadso number Diluted GAAP EPS (Not Split-Adjusted)
Diluted earnings per share (not split-adjusted).
incomeNetPerWadsoSplitAdjusted number Diluted GAAP EPS
Diluted earnings per share.
incomeNetPerWadsoSplitAdjustedYoyDeltaPercent number Diluted GAAP EPS Annual Growth
Percent growth in diluted earnings per share year over year.
incomeNetPreTax number Pre-Tax Income
Pre-tax income.
incomeNetYoyDelta number Annual Change in Net Income
The change in Net Income year over year.
incomeOperating number Total Operating Income
Sum of a company’s operating income derived outside of revenues.
incomeOperatingDiscontinuedOperations number Income from Discontinued Operations (Operating)
Income from discontinued operations, an item on the income statement for REITs.
incomeOperatingOther number Other Operating Income
Other operating income.
incomeOperatingSubsidiaryUnconsolidated number Income from Unconsolidated Subsidiaries (Operating)
Income from unconsolidated subsidiaries, an operating item on the income statement.
incomeOperatingSubsidiaryUnconsolidatedAfterTax number Income from Unconsolidated Subsidiaries After-tax (Operating)
Income from unconsolidated subsidiaries after-tax, an operating item on the income statement.
incomeTax number Income Tax Provision
A line item on a company’s income statement representing its estimated tax liability or benefit for the current year.
incomeTaxCurrent number Total Current Income Taxes
Current income taxes payable.
incomeTaxDeferred number Total Deferred Income Taxes
Deferred income taxes.
incomeTaxDiscontinuedOperations number Income Tax Expense/(Benefit) - Discontinued Operations
Income tax expense/(benefit) from discontinued operations.
incomeTaxOther number Income Tax Expense/(Benefit) - Other
Other income tax expense/(benefit).
incomeTaxRate number Effective Income Tax Rate
The reported, effective income tax rate.
interestMinority number Minority Interests
Minority interests, a component of shareholder’s equity representing a significant but non-controlling ownership of a company’s voting shares by either an investor or another company.
inventory number Inventory
Inventory, a current asset on the balance sheet.
inventoryTurnover number Inventory Turnover
Inventory turnover shows how many times a company has sold and replaced inventory during the period.
liabilities number Total Liabilities and Shareholders’ Equity
Total liabilities and shareholders’ equity.
liabilitiesCurrent number Total Current/Investment Liabilities
Total current/investment liabilities.
liabilitiesNonCurrentAndInterestMinorityTotal number Total Long-term Liabilities and Minority Interest
Total Long-term Liabilities and Minority Interest
liabilitiesNonCurrentDebt number Long-Term Debt
Long-term debt, a long-term, liability on the balance sheet.
liabilitiesNonCurrentDeferredCompensation number Reported Deferred Compensation Liability
Long-term deferred compensation liability, a long-term liability on the balance sheet.
liabilitiesNonCurrentDeferredTax number Reported Deferred Tax Liability
Long-term deferred tax liabilities, a long-term liability on the balance sheet.
liabilitiesNonCurrentDiscontinuedOperations number Discontinued Operations (Non-Operating)
Long-term discontinued operations, a long-term liability on the balance sheet.
liabilitiesNonCurrentLeasesOperating number Reported Non-Current Operating Lease Liabilities
Long-term operating lease liability, a long-term liability on the balance sheet.
liabilitiesNonCurrentLongTerm number Discontinued Long-term Liabilities
Long-term discontinued liabilities.
liabilitiesNonCurrentOperatingDiscontinuedOperations number Discontinued Operations (Operating)
Long-term discontinued operations, a long-term liability on the balance sheet for REITs.
liabilitiesNonCurrentOther number Other Long-term Liabilities
Other long-term liabilities, a long-term liability on the balance sheet.
nibclDeferredCompensation number Reported Current Deferred Compensation Liability
Current deferred compensation liability, a current liability on the balance sheet.
nibclDeferredTax number Reported Current Deferred Tax Liability
Current deferred tax liability, a current liability on the balance sheet.
nibclDiscontinuedOperations number Current Discontinued Operations (Non-Operating)
Current liability for discontinued operations, a current liability on the balance sheet.
nibclLeasesOperating number Reported Current Operating Lease Liabilities
Current operating lease liabilities, a current liability on the balance sheet.
nibclOther number Other NIBCL or Investment Liabilities
Other non-interest bearing current liabilities or investment liabilities, a current liability on the balance sheet.
nibclRestructuring number Accrued Restructuring Charges
Current liability for restructuring charges, a current liability on the balance sheet.
nibclRevenueDeferred number Current Deferred Revenue
Current deferred revenue, a current liability on the balance sheet.
nibclRevenueDeferredTurnover number Deferred Revenue Turnover
Deferred revenue turnover
nibclSeparateAccounts number Separate Accounts
Separate accounts, a current liability on the balance sheet.
oci number Accumulated OCI (Other Comprehensive Income)
Accumulated Other Comprehensive Income, from the shareholders’ equity section of the balance sheet.
periodEndDate string Formatted YYYY-MM-DD
ppAndENet number Net Property, Plant, and Equipment
Property, plant, and equipment, net, a fixed asset on the balance sheet.
pricePerEarnings number P/E (Price/Earnings Multiple)
Traditional P/E multiple
pricePerEarningsPerRevenueYoyDeltaPercent number P/E Per Revenue Growth
Traditional P/E multiple divided by the annual percent change in revenue.
profitGross number Gross Profit
Gross Profit
profitGrossPerRevenue number Gross Margin
Gross Profit Margin
researchAndDevelopmentExpense number Research and Development Expense
Research and development expense, an expense on the income statement.
reserves number Total Reserves
Sum of the current ending reserve balances for LIFO, inventory, and loan loss reserves.
reservesInventory number Inventory Reserves
Inventory reserve from the current year.
reservesLifo number LIFO Reserves
LIFO reserve from the current year.
reservesLoanLoss number Loan Loss Reserves
Loan loss reserve from the current year.
revenue number Total Revenue
Total revenue as reported on the income statement.
revenueCostOther number Cost of Sales
Cost of sales, an expense on the income statement.
revenueIncomeInterest number Interest Income
Interest income for financials, an item on the income statement.
revenueOther number Operating Revenue
Revenue, an item on the income statement.
revenueSubsidiaryUnconsolidated number Unconsolidated Subsidiary Revenue
Unconsolidated subsidiary revenue, an item on the income statement.
salesCost number Total Cost of Sales
Total cost of sales, an expense on the income statement.
sharesIssued number Shares Issued (Not Split-Adjusted)
Shares issued (not split-adjusted).
sharesOutstandingPeDateBs number Shares Outstanding on the PE Date (Not Split-Adjusted)
Shares outstanding on the period end date (not split-adjusted).
sharesTreasury number Treasury Shares (not split-adjusted)
Treasury shares (not split-adjusted).
stockCommon number Common Stock
Common stock, from the shareholders’ equity section of the balance sheet.
stockPreferred number Preferred Capital
Total preferred stock from the Shareholder’s Equity section of the balance sheet and the Mezzanine section of the balance sheet.
stockPreferredEquity number Preferred Stock
Preferred stock, from the shareholders’ equity section of the balance sheet.
stockPreferredMezzanine number Preferred Stock - Mezzanine
Preferred stock - mezzanine, from the mezzanine section of the balance sheet.
stockTreasury number Treasury Stock
Treasury stock, from the shareholders’ equity section of the balance sheet.
symbol string Associated symbol or ticker
wabso number Basic Weighted Avg. Shares (Not Split-Adjusted)
Basic weighted average shares (not split-adjusted).
wabsoSplitAdjusted number Basic Weighted Avg. Shares
Weighted average basic shares oustanding as reported on the income statment, adjusted for stock splits.
wadso number Diluted Weighted Avg. Shares (Not Split-Adjusted)
Diluted weighted average shares (not split-adjusted).
wadsoSplitAdjusted number Weighted Average Diluted Shares Outstanding (Split Adjusted)
Weighted average diluted shares oustanding as reported on the income statment, adjusted for stock splits.
id string The dataset ID.
Inherited from time-series common.
source string Source of the data if available.
Inherited from time-series common.
key string The requested dataset key.
Inherited from time-series common.
subkey string The requested dataset subkey.
Inherited from time-series common.
date number The date field of the time series as epoch timestamp.
Inherited from time-series common.
updated number The time data was last updated as epoch timestamp.
Inherited from time-series common.

Advanced Stats

Returns everything in key stats plus additional advanced stats such as EBITDA, ratios, key financial data, and more.

HTTP request

GET /stock/{symbol}/advanced-stats

JSON response

{
    // ...key stats
    "beta": 1.4661365583766115,
    "totalCash": 66301000000,
    "currentDebt": 20748000000,
    "revenue": 265809000000,
    "grossProfit": 101983000000,
    "totalRevenue": 265809000000,
    "EBITDA": 80342000000,
    "revenuePerShare": 0.02,
    "revenuePerEmployee": 2013704.55,
    "debtToEquity": 1.07,
    "profitMargin": 22.396157,
    "enterpriseValue": 1022460690000,
    "enterpriseValueToRevenue": 3.85,
    "priceToSales": 3.49,
    "priceToBook": 8.805916432564608,
    "forwardPERatio": 18.14,
    "pegRatio": 2.19,
    "peHigh": 22.61,
    "peLow": 11.98,
    "week52highDate": "2019-11-19",
    "week52lowDate": "2019-01-03",
    "putCallRatio": .7611902044412406,
}

Data Weighting

3,000 per symbol + Key Stats weight

Data Timing

End of day

Data Schedule

4am, 5am ET

Data Source(s)

IEX Cloud

Notes

Only included with paid subscription plans

Available Methods

GET /stock/{symbol}/advanced-stats/

Examples

Response Attributes

Key Type Description
Inherited stats See key stats
totalCash number Cash on hand
currentDebt number The current debt
revenue number In accounting, revenue is the income that a business has from its normal business activities, usually from the sale of goods and services to customers
grossProfit number Gross profit is the profit a company makes after deducting the costs associated with making and selling its products, or the costs associated with providing its services
totalRevenue number Calculated as the sum of gross income (the difference between sales or revenues and cost of goods sold and depreciation) and cost of goods sold for the period
EBITDA number Earnings before interest, tax, depreciation and amortization from the most recent quarterly financial report.
revenuePerShare number Amount of revenue over common shares outstanding
revenuePerEmployee number Net Income per employee (NIPE) is a company’s net income divided by the number of employees
debtToEquity number The debt-to-equity (D/E) ratio is calculated by dividing a company’s total liabilities by its shareholder equity
profitMargin number A measure of profitability by finding the net profit as a percentage of the revenue
enterpriseValue number Enterprise value (EV) is a measure of a company’s total value, often used as a more comprehensive alternative to equity market capitalization
enterpriseValueToRevenue number The enterprise value-to-revenue multiple (EV/R) is a measure of the value of a stock that compares a company’s enterprise value to its revenue
priceToSales number Price–sales ratio, P/S ratio, or PSR, is a valuation metric for stocks. It is calculated by dividing the company’s market capitalization by the revenue in the most recent year; or, equivalently, divide the per-share stock price by the per-share revenue
priceToBook number The price-to-book ratio, or P/B ratio, is a financial ratio used to compare a company’s current market price to its book value
forwardPERatio number Forward price-to-earnings (forward P/E) is a version of the ratio of price-to-earnings (P/E) that uses forecasted earnings for the P/E calculation
pegRatio number The PEG ratio is calculated easily and represents the ratio of the P/E to the trailing twelve month (ttm) earnings per share (EPS) growth rate of a company
beta number Beta is a measure used in fundamental analysis to determine the volatility of an asset or portfolio in relation to the overall market. Levered beta calculated with 1 year historical data and compared to SPY.
peHigh string 52 week high of the symbol’s PE Ratio.
peLow string 52 week low of the symbol’s PE Ratio.
week52highDate string Date of 52 week high
week52lowDate string Date of 52 week low
putCallRatio number The security’s total put volume relative to its total call volume over all available option contract dates. Investopedia

Balance Sheet

Pulls balance sheet data. Available quarterly or annually with the default being the last available quarter. This data is currently only available for U.S. symbols.

HTTP request

GET /stock/{symbol}/balance-sheet

JSON response

{
  "symbol": "AAPL",
  "balancesheet": [
    {
      "reportDate": "2020-10-17",
      "filingType": "10-K",
      "fiscalDate": "2020-09-13",
      "fiscalQuarter": 4,
      "fiscalYear": 2010,
      "currency": "USD",
      "currentCash": 25913000000,
      "shortTermInvestments": null,
      "receivables": 23186000000,
      "inventory": 3956000000,
      "otherCurrentAssets": 12087000000,
      "currentAssets": 131339000000,
      "longTermInvestments": 170799000000,
      "propertyPlantEquipment": 41304000000,
      "goodwill": null,
      "intangibleAssets": null,
      "otherAssets": 22283000000,
      "totalAssets": 365725000000,
      "accountsPayable": 55888000000,
      "currentLongTermDebt": null,
      "otherCurrentLiabilities": null,
      "totalCurrentLiabilities": 116866000000,
      "longTermDebt": 93735000000,
      "otherLiabilities": null,
      "minorityInterest": 0,
      "totalLiabilities": 258578000000,
      "commonStock": 40201000000,
      "retainedEarnings": 70400000000,
      "treasuryStock": null,
      "capitalSurplus": null,
      "shareholderEquity": 107147000000,
      "netTangibleAssets": 107147000000,
      "id": "BALANCE_SHEET",
      "key": "AAPL",
      "subkey": "quarterly",
      "date": 1635273127391,
      "updated": 1635273127391
    },
    // { ... }
  ]
}

Data Weighting

3000 per symbol per period

Data Timing

End of day

Data Schedule

Updates at 8am, 9am UTC daily

Data Source(s)

Copyright: Data provided by New Constructs, LLC © All rights reserved.

Notes

Examples

Query String Parameters

Option Details
period Optional.
• string. Allows you to specify annual or quarterly balance sheet. Defaults to quarter. Values should be annual or quarter
last Optional.
• number. Specify the number of quarters or years to return. One quarter is returned by default. You can specify up to 12 quarters with quarter, or up to 4 years with annual.

Response Attributes

This endpoint inherits common keys from Time Series.

Key Type Description
reportDate string Date financials were reported
filingType string Filing type
fiscalDate string The last day of the relevant fiscal period, formatted YYYY-MM-DD
fiscalQuarter number Associated fiscal quarter
fiscalYear number Associated fiscal year
currency string Currency code for reported financials.
currentCash number Represents current cash excluding short-term investments. Current cash excludes commercial paper issued by unconsolidated subsidiaries to the parent company, amount due from sale of debentures, checks written by the company but not yet deposited and charged to the company’s bank account, and promissory notes.
shortTermInvestments number Returns null as of December 1, 2020. Total short-term investments.
receivables number Represents net claims against customers for merchandise sold or services performed in the ordinary course of business. Investopedia
inventory number Represents tangible items or merchandise net of advances and obsolescence acquired for either resale directly or included in the production of finished goods manufactured for sale in the normal course of operation. Excludes tools that are listed in current assets, supplies and prepaid expenses for companies that lump these items together, advances from customers, and contract billings. For non-U.S. companies, if negative inventories arise from advances from customers greater than costs on long-term contracts, it is reclassified to current liabilities.
otherCurrentAssets number Represents other current assets for the period. Investopedia
currentAssets number Represents cash and other assets that are reasonably expected to be realized in cash, sold or consumed within one year or one operating cycle. Generally, the sum of cash and equivalents, receivables, inventories, prepaid expenses, and other current assets. For non-U.S. companies, long term receivables are excluded from current assets even though included in net receivables. Investopedia
longTermInvestments number Represents total investments and advances for the period. Calculated as long term investment minus affiliate companies and other long term investments. Investopedia
propertyPlantEquipment number Represents gross property, plant, and equipment less accumulated reserves for depreciation, depletion, and ammortization. Investopedia
goodwill number Represents the excess cost over the fair market value of the net assets purchased. Is excluded from other intangible assets. Investopedia
intangibleAssets number Represents other assets not having a physical existence. The value of these assets lie in their expected future return. This excludes goodwill. Investopedia
otherAssets number Returns other assets for the period calculated as other assets including intangibles minus intangible other assets.
totalAssets number Represents the sum of total current assets, long-term receivables, investment in unconsolidated subsidiaries, other investments, net property plant and equipment, deferred tax assets, and other assets.
accountsPayable number Represents the claims of trade creditors for unpaid goods and services that are due within the normal operating cycle of the company. Investopedia
currentLongTermDebt number Returns null as of December 1, 2020. Represents the amount of long term debt due within the next twelve months. Excludes notes payable arising from short term borrowings, current maturities of participation and entertainment obligation, contracts payable for broadcast rights, current portion of advances and production payments Bank overdrafts, advances from subsidiaries/associated companies, and current portion of preferred stock of a subsidiary. Investopedia
otherCurrentLiabilities number Returns null as of December 1, 2020. Represents other current liabilities and calculated as the sum of misc current liabilities, dividends payable, and accrued payroll.
totalCurrentLiabilities number Represents debt or other obligations that the company expects to satisfy within one year.
longTermDebt number Represents all interest-bearing financial obligations, excluding amounts due within one year, net of premium or discount. Excludes current portion of long-term debt, pensions, deferred taxes, and minority interest. Investopedia
otherLiabilities number Returns null as of December 1, 2020. Returns other liabilities for the period calculated as the sum of other liabilities excluding deferred revenue, deferred income, and deferred tax liability in untaxed reserves.
minorityInterest number Represents the portion of earnings/losses of a subsidiary pertaining to common stock not owned by the controlling company or other members of the consolidated group. Minority Interest is subtracted from consolidated net income to arrive at the company’s net income.
totalLiabilities number Represents all short and long term obligations expected to be satisfied by the company. Excludes minority interest preferred stock equity, preferred stock equity, common stock equity, and non-equity reserves.
commonStock number Number of shares outstanding as the difference between issued shares and treasury shares. Investopedia
retainedEarnings number Represents the accumulated after tax earnings of the company which have not been distributed as dividends to shareholders or allocated to a reserve amount. Excess involuntary liquidation value over stated value of preferred stock is deducted if there is an insufficient amount in the capital surplus account. Investopedia
treasuryStock number Represents the acquisition cost of shares held by the company. For non-U.S. companies treasury stock may be carried at par value. This stock is not entitled to dividends, has no voting rights, and does not share in the profits in the event of liquidation. Investopedia
capitalSurplus number Returns null as of December 1, 2020. Represents the amount received in excess of par value from the sale of common stock. Along with common stock it is the equity capital received from parties outside the company.
shareholderEquity number Total shareholders’ equity for the period calculated as the sum of total common equity and preferred stock carrying value.
netTangibleAssets number Calculated as shareholder equity less goodwill and less
id string The dataset ID.
Inherited from time-series common.
source string Source of the data if available.
Inherited from time-series common.
key string The requested dataset key.
Inherited from time-series common.
subkey string The requested dataset subkey.
Inherited from time-series common.
date number The date field of the time series as epoch timestamp.
Inherited from time-series common.
updated number The time data was last updated as epoch timestamp.
Inherited from time-series common.

Book

HTTP request

GET /stock/{symbol}/book

JSON response

{
  "quote": {...},
  "bids": [...],
  "asks": [...],
  "trades": [...],
  "systemEvent": {...},
}

Data Weighting

1 per quote returned

Data Timing

Real-time + 15min delayed

Data Schedule

Real-time during Investors Exchange market hours

Data Source(s)

Investors Exchange IEX Cloud Consolidated Tape

Available Methods

GET /stock/{symbol}/book

Examples

Response Attributes

Response includes data from deep and quote. Refer to each endpoint for details.

Cash Flow

Pulls cash flow data. Available quarterly or annually, with the default being the last available quarter. This data is currently only available for U.S. symbols.

HTTP request

GET /stock/{symbol}/cash-flow

JSON response

{
  "symbol": "AAPL",
  "cashflow": [
    {
      "capitalExpenditures": -3742080084,
      "cashChange": null,
      "cashFlow": 38385893986,
      "cashFlowFinancing": -28735881222,
      "changesInInventories": null,
      "changesInReceivables": null,
      "currency": "USD",
      "depreciation": 31163596487,
      "dividendsPaid": null,
      "exchangeRateEffect": null,
      "filingType": "10-K",
      "fiscalDate": "2020-10-23",
      "fiscalQuarter": 4,
      "fiscalYear": 2020,
      "investingActivityOther": null,
      "investments": null,
      "netBorrowings": null,
      "netIncome": 13197898763,
      "otherFinancingCashFlows": null,
      "reportDate": "2020-10-27",
      "symbol": "AAPL",
      "totalInvestingCashFlows": -3480671359,
      "id": "CASH_FLOW",
      "key": "AAPL",
      "subkey": "quarterly",
      "date": 1612403165595,
      "updated": 1612403165595
    }
  ]
}

Data Weighting

1000 per symbol per period

Data Timing

End of day

Data Schedule

Updates at 8am, 9am UTC daily

Data Source(s)

Copyright: Data provided by New Constructs, LLC © All rights reserved.

Notes

Examples

Query String Parameters

Option Details
period Optional.
• string. Allows you to specify annual or quarterly cash flow. Defaults to quarter. Values should be annual or quarter
last Optional.
• number. Specify the number of quarters or years to return. One quarter is returned by default. You can specify up to 12 quarters with quarter, or up to 4 years with annual.

Response Attributes

This endpoint inherits common keys from Time Series.

Key Type Description
reportDate string Date financials were reported.
filingType string Filing type
fiscalDate string The last day of the relevant fiscal period, formatted YYYY-MM-DD
fiscalQuarter number Associated fiscal quarter
fiscalYear number Associated fiscal year
currency string Currency code for reported financials.
netIncome number Represents income before extraordinary items and preferred and common dividends, but after operating and non-operating income and expenses, minority interest and equity in earnings.
depreciation number Depreciation represents the process of allocating the cost of a depreciable asset to the accounting periods covered during its expected useful life to a business. Depletion refers to cost allocation for natural resources such as oil and mineral deposits. Amortization relates to cost allocation for intangible assets such as patents and leasehold improvements, trademarks, book plates, tools & film costs. This item includes dry-hole expense, abandonments and oil and gas property valuation provision for extractive companies. This item excludes amortization of discounts or premiums on financial instruments owned or outstanding and depreciation on discontinued operations.
changesInReceivables number Returns null as of December 1, 2020. Represents the change in the amount of inventories from one year to the next as reported in the cash flow statement.
changesInInventories number Returns null as of December 1, 2020. Represents the change in the amount of inventories from one year to the next as reported in the cash flow statement.
cashChange number Returns null as of December 1, 2020. Represents the change in cash and short term investments from one year to the next. This item is available only when the Statement of Changes in Financial Position is based on cash and short term investments.
cashFlow number Returns net cash from operating activities for the period calculated as the sum of funds from operations, extraordinary items, and funds from other operating activities.
capitalExpenditures number Returns total capital expenditures for the period calculated as the sum of capital expenditures additions to fixed assets, and additions to other assets.
investments number Returns null as of December 1, 2020. Returns purchase/sale of investments for the period calculated as the sum of the negative of increase in investments, and decrease in investments
investingActivityOther number Returns null as of December 1, 2020. Represents any other funds employed in investing activities and not included in capital expenditures, net assets from acquisitions, increase in investments, decrease in investments or additions to property.
dividendsPaid number Returns null as of December 1, 2020. Represents the total common and preferred dividends paid to shareholders of the company. Excludes dividends paid to minority shareholders.
netBorrowings number Returns null as of December 1, 2020. Returns net issuance/reduction of debt for the period calculated as (increase/decrease in short term borrowings) + (long term borrowings - reduction in long term debt)
otherFinancingCashFlows number Returns null as of December 1, 2020. Returns other financing activities for the period.
cashFlowFinancing number Returns net cash from financing activities for the period.
exchangeRateEffect number Returns null as of December 1, 2020. Represents the effect of translating from one currency to another on the cash flow of the company.
symbol string Associated symbol or ticker
totalInvestingCashFlows number Returns net cash from investing activities for the period calculated as (Cash Flow from Investing Activity) - Net. If this is not available, then it is calculated as (Other Uses/(Sources) Investing) + (Disposal of fixed assets) + (decrease in investments) - (net assets from acquisitions) - (capital expenditures other assets) - (increase in investments) - (capital expenditures additions to fixed assets)
id string The dataset ID.
Inherited from time-series common.
source string Source of the data if available.
Inherited from time-series common.
key string The requested dataset key.
Inherited from time-series common.
subkey string The requested dataset subkey.
Inherited from time-series common.
date number The date field of the time series as epoch timestamp.
Inherited from time-series common.
updated number The time data was last updated as epoch timestamp.
Inherited from time-series common.

Charts

Price charts can be built using the historical or intraday price endpoints

Company

HTTP request

GET /stock/{symbol}/company

JSON response

{
  "symbol": "AAPL",
  "companyName": "Apple Inc.",
  "exchange": "NASDAQ",
  "industry": "Telecommunications Equipment",
  "website": "http://www.apple.com",
  "description": "Apple, Inc. engages in the design, manufacture, and marketing of mobile communication, media devices, personal computers, and portable digital music players. It operates through the following geographical segments: Americas, Europe, Greater China, Japan, and Rest of Asia Pacific. The Americas segment includes North and South America. The Europe segment consists of European countries, as well as India, the Middle East, and Africa. The Greater China segment comprises of China, Hong Kong, and Taiwan. The Rest of Asia Pacific segment includes Australia and Asian countries. The company was founded by Steven Paul Jobs, Ronald Gerald Wayne, and Stephen G. Wozniak on April 1, 1976 and is headquartered in Cupertino, CA.",
  "CEO": "Timothy Donald Cook",
  "securityName": "Apple Inc.",
  "issueType": "cs",
  "sector": "Electronic Technology",
  "primarySicCode": 3663,
  "employees": 132000,
  "tags": [
    "Electronic Technology",
    "Telecommunications Equipment"
  ],
  "address": "One Apple Park Way",
  "address2": null,
  "state": "CA",
  "city": "Cupertino",
  "zip": "95014-2083",
  "country": "US",
  "phone": "1.408.974.3123"
}

Data Weighting

1 per symbol

Data Timing

End of Day

Data Schedule

Updates at 4am and 5am UTC every day

Data Source(s)

IEX Cloud

Examples

Response Attributes

Key Type Description
symbol string Ticker of the company
companyName string Name of the company
employees number Number of employees
exchange string Refers to Exchange using IEX Supported Exchanges list
industry string Refers to the industry the company belongs to
website string Website of the company
description string Description for the company
CEO string Name of the CEO of the company
securityName string Name of the security
issueType string Refers to the common issue type of the stock.
ad – American Depository Receipt (ADR’s)
re – Real Estate Investment Trust (REIT’s)
ce – Closed end fund (Stock and Bond Fund)
si – Secondary Issue
lp – Limited Partnerships
cs – Common Stock
et – Exchange Traded Fund (ETF)
wt – Warrant
rt – Right
(blank) – Not Available, i.e., Note, or (non-filing) Closed Ended Funds
ut - Unit
temp - Temporary
sector string Refers to the sector the company belongs to.
primarySicCode string Primary SIC Code for the symbol (if available)
tags array An array of strings used to classify the company.
address string Street address of the company if available
address2 string Street address of the company if available
state string State of the company if available
city string City of the company if available
zip string Zip code of the company if available
country string Country of the company if available
phone string Phone number of the company if available

Delayed Quote

This returns the 15 minute delayed market quote.

HTTP request

GET /stock/{symbol}/delayed-quote

JSON response

{
  "symbol": "AAPL",
  "delayedPrice": 143.08,
  "delayedSize": 200,
  "delayedPriceTime": 1498762739791,
  "high": 143.90,
  "low": 142.26,
  "totalVolume": 33547893,
  "processedTime": 1498763640156
}

Data Weighting

1 per symbol per quote

Data Timing

15min delayed

Data Schedule

4:30am - 8pm ET M-F when market is open

Data Source(s)

IEX Cloud

Notes

Available Methods

GET /stock/{symbol}/delayed-quote

Examples

Query Parameters

Option Details
oddLot Optional.
• true or false. True returns latest 15 minute delayed odd Lot trade data

Response Attributes

Key Type Description
symbol string Refers to the stock ticker.
delayedPrice number Refers to the 15 minute delayed market price.
high number Refers to the 15 minute delayed high price.
low number Refers to the 15 minute delayed low price.
delayedSize number Refers to the 15 minute delayed last trade size.
delayedPriceTime number Refers to the time of the delayed market price.
totalVolume number Refers to the 15 minute delayed total volume.
processedTime number Refers to when IEX processed the SIP price.

Dividends (Basic)

Provides basic dividend data for US equities, ETFs, and Mutual Funds for the last 5 years. For 13+ years of history, comprehensive data, and international dividends, use the Advanced Dividends endpoint.

HTTP request

GET /stock/{symbol}/dividends/{range}

JSON response

[
    {
        "amount": 0.70919585493507512,
        "currency": "USD",
        "declaredDate": "2020-10-19",
        "description": "Ordinary Shares",
        "exDate": "2020-10-28",
        "flag": "Cash",
        "frequency": "quarterly",
        "paymentDate": "2020-11-06",
        "recordDate": "2020-10-28",
        "refid": 2096218,
        "symbol": "AAPL",
        "id": "DIVIDENDS",
        "key": "AAPL",
        "subkey": "2053393",
        "date": 1612392166191,
        "updated": 1612392166191
    },
    // { ... }
]

Data Weighting

10 per symbol per period returned

Data Timing

End of day

Data Schedule

Updated at 9am UTC every day

Data Source(s)

IEX Cloud

Notes

Dividends prior to last reported are only included with paid subscription plans

Available Methods

GET /stock/{symbol}/dividends/{range}

Examples

Path Parameters

Range Description Source
5y Five years Historical market data
2y Two years Historical market data
1y One year Historical market data
ytd Year-to-date Historical market data
6m Six months Historical market data
3m Three months Historical market data
1m One month (default) Historical market data
next The next upcoming dividend Historical market data

Response Attributes

This endpoint inherits common keys from Time Series.

Key Type Description
amount number Refers to the payment amount
currency string Currency of the dividend
declaredDate string Refers to the dividend declaration date
description string Description of the dividend event
exDate string Refers to the dividend ex-date
flag string Type of dividend event
frequency string Frequency of the dividend
paymentDate string Refers to the payment date
recordDate string Refers to the dividend record date
symbol string Associated symbol or ticker
id string The dataset ID.
Inherited from time-series common.
source string Source of the data if available.
Inherited from time-series common.
key string The requested dataset key.
Inherited from time-series common.
subkey string The requested dataset subkey.
Inherited from time-series common.
date number The date field of the time series as epoch timestamp.
Inherited from time-series common.
updated number The time data was last updated as epoch timestamp.
Inherited from time-series common.

Extended Hours Quote

Financials

Pulls income statement, balance sheet, and cash flow data from the most recent reported quarter.

HTTP request

GET /stock/{symbol}/financials/

JSON response

{
  "symbol": "AAPL",
  "financials": [
    {
      "EBITDA": 17719601200,
      "accountsPayable": 42998973564,
      "capitalSurplus": null,
      "cashChange": null,
      "cashFlow": 82243225634,
      "cashFlowFinancing": -90480740851,
      "changesInInventories": null,
      "changesInReceivables": null,
      "commonStock": 52683500776,
      "costOfRevenue": 41281698523,
      "currency": "USD",
      "currentAssets": 147408209562,
      "currentCash": 92433115477,
      "currentDebt": 14042702867,
      "currentLongTermDebt": null,
      "depreciation": 11091337897,
      "dividendsPaid": null,
      "ebit": 15229091974,
      "exchangeRateEffect": null,
      "filingType": "10-K",
      "fiscalDate": "2020-10-17",
      "fiscalQuarter": 4,
      "fiscalYear": 2020,
      "goodwill": 0,
      "grossProfit": 25476146025,
      "incomeTax": 2237447945,
      "intangibleAssets": 0,
      "interestIncome": 653431048,
      "inventory": 4110848973,
      "investingActivityOther": null,
      "investments": null,
      "longTermDebt": 90201000000,
      "longTermInvestments": 103250878098,
      "minorityInterest": 0,
      "netBorrowings": null,
      "netIncome": 13007112349,
      "netIncomeBasic": 13211528403,
      "netTangibleAssets": null,
      "operatingExpense": 51023064506,
      "operatingIncome": 14873382386,
      "operatingRevenue": null,
      "otherAssets": 43334740957,
      "otherCurrentAssets": 11337007423,
      "otherCurrentLiabilities": null,
      "otherIncomeExpenseNet": 45025988542,
      "otherLiabilities": null,
      "pretaxIncome": 15342982672,
      "propertyPlantEquipment": 37297136451,
      "receivables": 37549658022,
      "reportDate": "2020-10-18",
      "researchAndDevelopment": 5221387455,
      "retainedEarnings": 15481666532,
      "revenue": 64962762222,
      "sellingGeneralAndAdmin": 5160667378,
      "shareholderEquity": 65804482428,
      "shortTermDebt": 14085341819,
      "shortTermInvestments": null,
      "symbol": "AAPL",
      "totalAssets": 337635772114,
      "totalCash": 80433000000,
      "totalDebt": 112630000000,
      "totalInvestingCashFlows": -4319108499,
      "totalLiabilities": 260962428116,
      "totalRevenue": 65427328464,
      "treasuryStock": 0,
      "id": "FINANCIALS",
      "key": "AAPL",
      "subkey": "quarterly",
      "updated": 1671015835008
    }
  ]
}

Data Weighting

5000 per symbol per period

Data Timing

End of day

Data Schedule

Updates at 8am, 9am UTC daily

Data Source(s)

Copyright: Data provided by New Constructs, LLC © All rights reserved.

Notes

Examples

Query String Parameters

Option Details
period Optional.
• string. Allows you to specify annual or quarterly financials. Defaults to quarter. Values should be annual or quarter

Response Attributes

This endpoint inherits common keys from Time Series.

Key Type Description
EBITDA number Reported Earnings Before Interest, Tax, Depreciation and Amortization
accountsPayable number Accounts Payable
capitalSurplus number Returns null as of December 1, 2020.
cashChange number Returns null as of December 1, 2020. Cash in Cash from last period
cashFlow number Cash Flow from Operations
cashFlowFinancing number Cash Flow from Financing Activities
changesInInventories number Returns null as of December 1, 2020. Changes in Inventories
changesInReceivables number Returns null as of December 1, 2020. Changes in Receivables
commonStock number Common stock
costOfRevenue number Total Cost of Sales
currency string Reporting Currency
currentAssets number Total Current/Investment Assets (Unadjusted)
currentCash number Cash and Equivalents (Non-Operating)
currentDebt number Short-Term Debt
currentLongTermDebt number Short Term Debt and Investment Liabilities
depreciation number Depreciation and Amortization (Cash Flow)
dividendsPaid number Returns null as of December 1, 2020.
ebit number Reported earnings before interest and tax
exchangeRateEffect number Returns null as of December 1, 2020.
filingType string Filing type
fiscalDate string The last day of the relevant fiscal period, formatted YYYY-MM-DD
fiscalQuarter number Associated fiscal quarter
fiscalYear number Associated fiscal year
goodwill number Good Will Net
grossProfit number Gross Profit
incomeTax number Income Tax Provision
intangibleAssets number Other Intangibles
interestIncome number Reported Interest Expense/(Income), Net
inventory number Inventory
investingActivityOther number Returns null as of December 1, 2020.
investments number Returns null as of December 1, 2020.
longTermDebt number Long-Term Debt
longTermInvestments number Total Fixed Assets
minorityInterest number Minority Interests
netBorrowings number Net Borrowings
netIncome number GAAP Net Income
netIncomeBasic number GAAP Net Income
netTangibleAssets number Net Tangible Assets
operatingExpense number Total Expenses
operatingIncome number Operating Income (Revenues-Total Expenses)
operatingRevenue number Operating Revenue
otherAssets number Other Fixed Assets
otherCurrentAssets number Other Current or Investment Assets
otherCurrentLiabilities number Other Current Liabilities
otherIncomeExpenseNet number Other Operating Income
otherLiabilities number Other Long-term Liabilities
pretaxIncome number Pre-Tax Income
propertyPlantEquipment number Net Property, Plant, and Equipment
receivables number Accounts Receivable
reportDate string Date financials were reported.
researchAndDevelopment number Research and Development Expense
retainedEarnings number Retained Earnings
revenue number Total Revenue
sellingGeneralAndAdmin number Selling, General, and Administrative Expense
shareholderEquity number Selling, General, and Administrative Expense
shortTermDebt number Short-Term Debt
shortTermInvestments number Short Term Investments
symbol string Associated symbol or ticker
totalAssets number Total Assets (Unadjusted)
totalCash number Current and Operating Cash
totalDebt number Total Debt
totalInvestingCashFlows number Cash Flow from Investing Activities
totalLiabilities number Total Liabilities (including Minorities)
totalRevenue number Total Revenue
treasuryStock number Treasury Stock
id string The dataset ID.
Inherited from time-series common.
source string Source of the data if available.
Inherited from time-series common.
key string The requested dataset key.
Inherited from time-series common.
subkey string The requested dataset subkey.
Inherited from time-series common.
date number The date field of the time series as epoch timestamp.
Inherited from time-series common.
updated number The time data was last updated as epoch timestamp.
Inherited from time-series common.

Financials As Reported

As reported financials are pulled directly from the raw SEC filings. Returns raw financial data reported in 10-K and 10-Q filings.
History available as far back as 2009.

HTTP request

GET /time-series/reported_financials/{symbol?}/{filing?}

JSON response

[
  {
    "id": "REPORTED_FINANCIALS",
    "source": "SEC",
    "key": "GOOGL",
    "subkey": "10-K",
    "date": 1549324800,
    "updated": 1560349214,
    "DecreaseInUnrecognizedTaxBenefitsIsReasonablyPossible": 600000000,
    "formFiscalYear": 2018,
    "version": "us-gaap",
    "periodStart": 1514764800000,
    "periodEnd": 1546214400000,
    "dateFiled": 1549324800000,
    "formFiscalQuarter": null,
    "reportLink": "",
    "OtherAccruedLiabilitiesCurrent": 7394000000,
    "OtherAssetsCurrent": 4236000000,
    "DeferredFederalStateAndLocalTaxExpenseBenefit": 907000000,
    "OtherAssetsNoncurrent": 2693000000,
    "DeferredForeignIncomeTaxExpenseBenefit": -134000000,
    "DeferredIncomeTaxAssetsNet": 737000000,
    "DeferredIncomeTaxesAndTaxCredits": 778000000,
    "DeferredIncomeTaxExpenseBenefit": 773000000,
    "DeferredIncomeTaxLiabilities": 3491000000,
    "DeferredIncomeTaxLiabilitiesNet": 1264000000,
    "OtherComprehensiveIncomeLossAvailableForSaleSecuritiesAdjustmentNetOfTax": -823000000,
    "OtherComprehensiveIncomeLossAvailableForSaleSecuritiesTax": -156000000,
    "OtherComprehensiveIncomeLossCashFlowHedgeGainLossAfterReclassificationAndTax": 388000000,
    "OtherComprehensiveIncomeLossCashFlowHedgeGainLossAfterReclassificationTax": 103000000,
    "OtherComprehensiveIncomeLossCashFlowHedgeGainLossBeforeReclassificationAfterTax": 290000000,
    "OtherComprehensiveIncomeLossCashFlowHedgeGainLossReclassificationAfterTax": -98000000,
    "DeferredTaxAssetsGross": 5781000000,
    "DeferredTaxAssetsLiabilitiesNet": 250000000,
    "DeferredTaxAssetsNet": 2964000000,
    "DeferredTaxAssetsOperatingLossCarryforwards": 557000000,
    "DeferredTaxAssetsOther": 251000000,
    "OtherComprehensiveIncomeLossForeignCurrencyTransactionAndTranslationAdjustmentNetOfTax": -781000000,
    "OtherComprehensiveIncomeLossNetOfTax": -1216000000,
    "OtherComprehensiveIncomeLossNetOfTaxPortionAttributableToParent": -1314000000,
    "OtherComprehensiveIncomeLossReclassificationAdjustmentFromAOCIForSaleOfSecuritiesNetOfTax": 911000000,
    "DeferredTaxAssetsTaxCreditCarryforwardsOther": 1979000000,
    "DeferredTaxAssetsTaxDeferredExpenseCompensationAndBenefitsEmployeeBenefits": 387000000,
    "DeferredTaxAssetsTaxDeferredExpenseCompensationAndBenefitsShareBasedCompensationCost": 291000000,
    "DeferredTaxAssetsTaxDeferredExpenseReservesAndAccrualsOther": 1062000000,
    "DeferredTaxAssetsValuationAllowance": 2817000000,
    "DeferredTaxLiabilities": 527000000,
    "DeferredTaxLiabilitiesGoodwillAndIntangibleAssetsIntangibleAssets": 229000000,
    "DeferredTaxLiabilitiesInvestments": 1143000000,
    "DeferredTaxLiabilitiesOther": 237000000,
    "DeferredTaxLiabilitiesPropertyPlantAndEquipment": 1382000000,
    "LossContingencyAccrualCarryingValueCurrent": 7754000000,
    "DefinedContributionPlanCostRecognized": 691000000,
    "InventoryNet": 1107000000,
    "EmployeeRelatedLiabilitiesCurrent": 6839000000,
    "LossContingencyLossInPeriod": 5071000000,
    "IncreaseDecreaseInIncomeTaxes": -2251000000,
    "ForeignCurrencyCashFlowHedgeGainLossToBeReclassifiedDuringNext12Months": 247000000,
    "AccountsPayableCurrent": 4378000000,
    "IncreaseDecreaseInOtherOperatingAssets": 1207000000,
    "OtherComprehensiveIncomeUnrealizedHoldingGainLossOnSecuritiesArisingDuringPeriodNetOfTax": 88000000,
    "EmployeeServiceShareBasedCompensationTaxBenefitFromCompensationExpense": 1500000000,
    "ForeignCurrencyTransactionGainLossBeforeTax": -80000000,
    "ForeignCurrencyTransactionLossBeforeTax": 195000000,
    "AccountsReceivableNetCurrent": 20838000000,
    "ContractWithCustomerLiabilityCurrent": 1784000000,
    "ContractWithCustomerLiabilityNoncurrent": 396000000,
    "ContractWithCustomerLiabilityRevenueRecognized": 1500000000,
    "Assets": 232792000000,
    "AssetsCurrent": 135676000000,
    "ImpairmentOfInvestments": 0,
    "IncomeLossFromContinuingOperationsBeforeIncomeTaxesDomestic": 15800000000,
    "IncomeLossFromContinuingOperationsBeforeIncomeTaxesForeign": 19100000000,
    "IncomeLossFromContinuingOperationsBeforeIncomeTaxesMinorityInterestAndIncomeLossFromEquityMethodInvestments": 34913000000,
    "IncomeTaxesPaidNet": 5671000000,
    "IncomeTaxesReceivable": 355000000,
    "IncomeTaxExpenseBenefit": 4177000000,
    "CommercialPaper": 0,
    "CommitmentsAndContingencies": 0,
    "MarketableSecuritiesCurrent": 92439000000,
    "CommonStockCapitalSharesReservedForFutureIssuance": 31848134,
    "MarketingAndAdvertisingExpense": 6400000000,
    "PreferredStockParOrStatedValuePerShare": 0.001,
    "PreferredStockSharesAuthorized": 100000000,
    "PreferredStockSharesIssued": 0,
    "PreferredStockSharesOutstanding": 0,
    "DerivativeAssetFairValueGrossLiability": 56000000,
    "DerivativeAssetFairValueOffsetAgainstCollateralNetOfNotSubjectToMasterNettingArrangementPolicyElection": 102000000,
    "AssetsNoncurrent": 97116000000,
    "CommonStockParOrStatedValuePerShare": 0.001,
    "CommonStockSharesAuthorized": 15000000000,
    "CommonStockSharesIssued": 695556000,
    "CommonStockSharesOutstanding": 695556000,
    "CommonStocksIncludingAdditionalPaidInCapital": 45049000000,
    "AccruedIncomeTaxesCurrent": 69000000,
    "AccruedIncomeTaxesNoncurrent": 11327000000,
    "AccruedLiabilitiesCurrent": 16958000000,
    "IncreaseDecreaseInAccountsPayable": 1067000000,
    "IncreaseDecreaseInAccountsReceivable": 2169000000,
    "IncreaseDecreaseInAccruedLiabilities": 8614000000,
    "ConvertiblePreferredStockNonredeemableOrRedeemableIssuerOptionValue": 0,
    "LongTermDebt": 4062000000,
    "LongTermDebtAndCapitalLeaseObligations": 4012000000,
    "ComprehensiveIncomeNetOfTax": 29520000000,
    "LongTermDebtFairValue": 3900000000,
    "LongTermDebtMaturitiesRepaymentsOfPrincipalAfterYearFive": 3039000000,
    "LongTermDebtMaturitiesRepaymentsOfPrincipalInNextTwelveMonths": 0,
    "NetCashProvidedByUsedInFinancingActivities": -13179000000,
    "NetCashProvidedByUsedInInvestingActivities": -28504000000,
    "NetCashProvidedByUsedInOperatingActivities": 47971000000,
    "DerivativeAssetNotOffsetPolicyElectionDeduction": 90000000,
    "DerivativeAssets": 513000000,
    "EntityPublicFloat": 680000000000,
    "NetIncomeLoss": 30736000000,
    "IncreaseDecreaseInCollateralHeldUnderSecuritiesLending": 0,
    "IncreaseDecreaseInContractWithCustomerLiability": 371000000,
    "DerivativeCollateralObligationToReturnCash": 307000000,
    "DerivativeCollateralObligationToReturnSecurities": 14000000,
    "DerivativeCollateralRightToReclaimCash": 0,
    "DerivativeCollateralRightToReclaimSecurities": 0,
    "AccumulatedDepreciationDepletionAndAmortizationPropertyPlantAndEquipment": 22788000000,
    "PaymentsForRepurchaseOfCommonStock": 9075000000,
    "LeaseAndRentalExpense": 1300000000,
    "LongTermDebtMaturitiesRepaymentsOfPrincipalInYearFive": 3000000,
    "LongTermDebtMaturitiesRepaymentsOfPrincipalInYearFour": 3000000,
    "LongTermDebtMaturitiesRepaymentsOfPrincipalInYearThree": 1003000000,
    "LongTermDebtMaturitiesRepaymentsOfPrincipalInYearTwo": 14000000,
    "LongTermDebtNoncurrent": 3950000000,
    "DerivativeFairValueOfDerivativeAsset": 569000000,
    "DerivativeFairValueOfDerivativeLiability": 289000000,
    "AvailableForSaleDebtSecuritiesAccumulatedGrossUnrealizedGainBeforeTax": 213000000,
    "AvailableForSaleDebtSecuritiesAccumulatedGrossUnrealizedLossBeforeTax": 1054000000,
    "AccumulatedOtherComprehensiveIncomeLossNetOfTax": -2306000000,
    "ProceedsFromCollectionOfNotesReceivable": 0,
    "ProceedsFromDebtNetOfIssuanceCosts": 6766000000,
    "IntangibleAssetsNetExcludingGoodwill": 2220000000,
    "UnrecognizedTaxBenefits": 4652000000,
    "UnrecognizedTaxBenefitsDecreasesResultingFromPriorPeriodTaxPositions": 623000000,
    "UnrecognizedTaxBenefitsDecreasesResultingFromSettlementsWithTaxingAuthorities": 191000000,
    "UnrecognizedTaxBenefitsIncomeTaxPenaltiesAndInterestAccrued": 490000000,
    "UnrecognizedTaxBenefitsIncreasesResultingFromCurrentPeriodTaxPositions": 449000000,
    "UnrecognizedTaxBenefitsIncreasesResultingFromPriorPeriodTaxPositions": 321000000,
    "AvailableForSaleSecuritiesDebtMaturitiesAfterFiveThroughTenYearsFairValue": 2236000000,
    "AvailableForSaleSecuritiesDebtMaturitiesAfterOneThroughFiveYearsFairValue": 54504000000,
    "AvailableForSaleSecuritiesDebtMaturitiesAfterTenYearsFairValue": 10808000000,
    "EquityMethodInvestments": 1300000000,
    "CapitalLeasedAssetsGross": 648000000,
    "CapitalLeaseObligationsNoncurrent": 62000000,
    "ProceedsFromMinorityShareholders": 950000000,
    "ProceedsFromPaymentsForSecuritiesPurchasedUnderAgreementsToResell": 0,
    "DerivativeLiabilities": 233000000,
    "DerivativeLiabilityFairValueGrossAsset": 56000000,
    "DerivativeLiabilityFairValueOffsetAgainstCollateralNetOfNotSubjectToMasterNettingArrangementPolicyElection": 143000000,
    "DerivativeLiabilityNotOffsetPolicyElectionDeduction": 90000000,
    "EquitySecuritiesFvNiGainLoss": 5460000000,
    "EquitySecuritiesFvNiRealizedGainLoss": 1458000000,
    "EquitySecuritiesFvNiUnrealizedGainLoss": 4002000000,
    "AvailableForSaleSecuritiesDebtMaturitiesWithinOneYearFairValue": 23669000000,
    "AvailableForSaleSecuritiesDebtSecurities": 91217000000,
    "ProceedsFromSaleAndMaturityOfMarketableSecurities": 48507000000,
    "ProceedsFromSaleAndMaturityOfOtherInvestments": 1752000000,
    "PaymentsToAcquireMarketableSecurities": 50158000000,
    "PaymentsToAcquireOtherInvestments": 2073000000,
    "PaymentsToAcquirePropertyPlantAndEquipment": 25139000000,
    "EquitySecuritiesWithoutReadilyDeterminableFairValueAmount": 12275000000,
    "EquitySecuritiesWithoutReadilyDeterminableFairValueDownwardPriceAdjustmentAnnualAmount": 178000000,
    "EquitySecuritiesWithoutReadilyDeterminableFairValueDownwardPriceAdjustmentCumulativeAmount": -178000000,
    "EquitySecuritiesWithoutReadilyDeterminableFairValueUpwardPriceAdjustmentAnnualAmount": 4285000000,
    "EquitySecuritiesWithoutReadilyDeterminableFairValueUpwardPriceAdjustmentCumulativeAmount": -4285000000,
    "CashAndCashEquivalentsAtCarryingValue": 16701000000,
    "CashAndCashEquivalentsFairValueDisclosure": 3493000000,
    "CashAndCashEquivalentsPeriodIncreaseDecrease": 5986000000,
    "CashCashEquivalentsAndShortTermInvestments": 109140000000,
    "PurchaseObligation": 7400000000,
    "AdjustmentsToAdditionalPaidInCapitalSharebasedCompensationRequisiteServicePeriodRecognitionValue": 9353000000,
    "NoncontrollingInterestIncreaseFromSaleOfParentEquityInterest": 659000000,
    "Liabilities": 55164000000,
    "LiabilitiesAndStockholdersEquity": 232792000000,
    "LiabilitiesCurrent": 34620000000,
    "ProceedsFromSaleOfPropertyPlantAndEquipment": 98000000,
    "InterestCostsCapitalized": 92000000,
    "InterestExpense": 114000000,
    "GeneralAndAdministrativeExpense": 8126000000,
    "PropertyPlantAndEquipmentGross": 82507000000,
    "PropertyPlantAndEquipmentNet": 59719000000,
    "AllocatedShareBasedCompensationExpense": 10000000000,
    "CostMethodInvestments": 4500000000,
    "CostMethodInvestmentsFairValueDisclosure": 8800000000,
    "InterestIncomeOther": 1878000000,
    "InterestPaidNet": 69000000,
    "SellingAndMarketingExpense": 16333000000,
    "Goodwill": 17888000000,
    "GoodwillAcquiredDuringPeriod": 1227000000,
    "AllowanceForDoubtfulAccountsReceivableCurrent": 729000000,
    "NonoperatingIncomeExpense": 8592000000,
    "StockholdersEquity": 177628000000,
    "GoodwillImpairmentLoss": 0,
    "GoodwillTransfers": 0,
    "GoodwillTranslationAndPurchaseAccountingAdjustments": -86000000,
    "FiniteLivedIntangibleAssetsAccumulatedAmortization": 3957000000,
    "FiniteLivedIntangibleAssetsAmortizationExpenseAfterYearFive": 182000000,
    "FiniteLivedIntangibleAssetsAmortizationExpenseNextTwelveMonths": 712000000,
    "FiniteLivedIntangibleAssetsAmortizationExpenseYearFive": 7000000,
    "FiniteLivedIntangibleAssetsAmortizationExpenseYearFour": 201000000,
    "FiniteLivedIntangibleAssetsAmortizationExpenseYearThree": 533000000,
    "FiniteLivedIntangibleAssetsAmortizationExpenseYearTwo": 585000000,
    "FiniteLivedIntangibleAssetsGross": 6177000000,
    "FiniteLivedIntangibleAssetsNet": 2220000000,
    "EarningsPerShareBasic": 44.22,
    "EarningsPerShareDiluted": 43.7,
    "RevenueFromContractWithCustomerExcludingAssessedTax": 136819000000,
    "OciBeforeReclassificationsNetOfTaxAttributableToParent": -527000000,
    "EffectiveIncomeTaxRateContinuingOperations": 0.12,
    "EffectiveIncomeTaxRateReconciliationAtFederalStatutoryIncomeTaxRate": 0.21,
    "EffectiveIncomeTaxRateReconciliationChangeInDeferredTaxAssetsValuationAllowance": -0.02,
    "EffectiveIncomeTaxRateReconciliationChangeInEnactedTaxRate": -0.012,
    "EffectiveIncomeTaxRateReconciliationForeignIncomeTaxRateDifferential": -0.049,
    "CostOfRevenue": 59549000000,
    "EffectiveIncomeTaxRateReconciliationNondeductibleExpenseShareBasedCompensationCost": 0.022,
    "EffectiveIncomeTaxRateReconciliationOtherAdjustments": 0.007,
    "EffectiveIncomeTaxRateReconciliationTaxCreditsResearch": 0.024,
    "RetainedEarningsAccumulatedDeficit": 134885000000,
    "CostsAndExpenses": 110498000000,
    "RepaymentsOfDebtAndCapitalLeaseObligations": 6827000000,
    "EffectOfExchangeRateOnCashAndCashEquivalents": -302000000,
    "CumulativeEffectOfNewAccountingPrincipleInPeriodOfAdoption": -697000000,
    "CurrentFederalStateAndLocalTaxExpenseBenefit": 2153000000,
    "OperatingIncomeLoss": 26321000000,
    "UnrecognizedTaxBenefitsThatWouldImpactEffectiveTaxRate": 2900000000,
    "StockIssuedDuringPeriodValueNewIssues": 148000000,
    "StockRepurchasedAndRetiredDuringPeriodValue": 9075000000,
    "CurrentForeignTaxExpenseBenefit": 1251000000,
    "CurrentIncomeTaxExpenseBenefit": 3404000000,
    "OperatingLeasesFutureMinimumPaymentsDue": 10102000000,
    "OperatingLeasesFutureMinimumPaymentsDueCurrent": 1319000000,
    "OperatingLeasesFutureMinimumPaymentsDueInFiveYears": 980000000,
    "OperatingLeasesFutureMinimumPaymentsDueInFourYears": 1153000000,
    "OperatingLeasesFutureMinimumPaymentsDueInThreeYears": 1337000000,
    "OperatingLeasesFutureMinimumPaymentsDueInTwoYears": 1397000000,
    "OperatingLeasesFutureMinimumPaymentsDueThereafter": 3916000000,
    "OperatingLeasesFutureMinimumPaymentsReceivable": 55000000,
    "OperatingLeasesFutureMinimumPaymentsReceivableCurrent": 16000000,
    "OperatingLeasesFutureMinimumPaymentsReceivableInFiveYears": 3000000,
    "OperatingLeasesFutureMinimumPaymentsReceivableInFourYears": 8000000,
    "OperatingLeasesFutureMinimumPaymentsReceivableInThreeYears": 10000000,
    "OperatingLeasesFutureMinimumPaymentsReceivableInTwoYears": 13000000,
    "OperatingLeasesFutureMinimumPaymentsReceivableThereafter": 5000000,
    "DebtAndEquitySecuritiesGainLoss": 6650000000,
    "VariableInterestEntityConsolidatedAssetsPledged": 2400000000,
    "VariableInterestEntityConsolidatedLiabilitiesNoRecourse": 909000000,
    "ResearchAndDevelopmentExpense": 21419000000,
    "DebtInstrumentUnamortizedDiscount": 50000000,
    "DebtSecuritiesAvailableForSaleRealizedLoss": 143000000,
    "DebtSecuritiesAvailableForSaleUnrealizedLossPosition": 71665000000,
    "DebtSecuritiesAvailableForSaleUnrealizedLossPositionAccumulatedLoss": 1054000000,
    "DebtSecuritiesAvailableForSaleContinuousUnrealizedLossPositionLessThan12MonthsAccumulatedLoss": 267000000,
    "DebtSecuritiesAvailableForSaleContinuousUnrealizedLossPositionLessThan12Months": 27724000000,
    "DebtSecuritiesAvailableForSaleContinuousUnrealizedLossPosition12MonthsOrLongerAccumulatedLoss": 787000000,
    "DebtSecuritiesAvailableForSaleContinuousUnrealizedLossPosition12MonthsOrLonger": 43941000000,
    "DebtSecuritiesAvailableForSaleRealizedGain": 1300000000,
    "DebtSecuritiesRealizedGainLoss": 1190000000,
    "ShareBasedCompensation": 9353000000,
    "TaxCreditCarryforwardAmount": 2400000000,
    "OtherLiabilitiesNoncurrent": 3545000000,
    "OtherLongTermInvestments": 13859000000,
    "OtherNoncashIncomeExpense": 189000000,
    "OtherNonoperatingIncomeExpense": 378000000,
    "ReclassificationFromAociCurrentPeriodNetOfTaxAttributableToParent": 813000000
  }
]

Data Weighting

5000 per filing per date returned

Data Timing

Quarterly

Data Source(s)

IEX Cloud SEC Filings

Notes

Available to paid plans only. Data may not be available back to 2009 for all symbols.

This is a time series endpoint, and supports all common time series features.

Available Methods

GET /time-series/reported_financials/{symbol?}/{filing?}

Examples

Path Parameters

Option Value Description
symbol A valid stock symbol
filing 10-K Annual report
10-Q Quarterly report

Fund Ownership

Returns the top 10 fund holders, meaning any firm not defined as buy-side or sell-side such as mutual funds, pension funds, endowments, investment firms, and other large entities that manage funds on behalf of others.

HTTP request

GET /stock/{symbol}/fund-ownership

JSON response

[
  {
    "symbol": "AAPL",
    "id": "MUTUAL_FUND_HOLDERS",
    "adjHolding": 177998597,
    "adjMv": 20036225482,
    "entityProperName": "PARNASSUS INCOME FUNDS",
    "report_date": 1676849549242,
    "reportedHolding": 174277099,
    "reportedMv": 19808288329,
    "updated": 1615663857444
  },
  {
    "symbol": "AAPL",
    "id": "MUTUAL_FUND_HOLDERS",
    "adjHolding": 157069011,
    "adjMv": 13938361025,
    "entityProperName": "INVESCO QQQ TRUST",
    "report_date": 1607991008468,
    "reportedHolding": 39517849,
    "reportedMv": 14310176930,
    "updated": 1650595136026
  },
  // { ... }
]

Data Weighting

10000 per symbol per period

Data Timing

End of day

Data Schedule

Updates at 5am, 6am ET every day

Data Source(s)

IEX Cloud

Notes

Only included with paid subscription plans

Available Methods

GET /stock/{symbol}/fund-ownership

Examples

Response Attributes

This endpoint inherits common keys from Time Series.

Key Type Description
symbol string Associated symbol or ticker
adjHolding number Share amount held by the fund as of the report date, adjusted for corporate actions
adjMv number Total share amount multiplied by the latest month-end share price, adjusted for corporate actions in USD
entityProperName string Name of the entity
report_date number Refers to the update time of report_date as epoch timestamp
reportedHolding number Share amount held by the fund as reported in the source
reportedMv number Market value held by the fund as reported in the source, represented in USD.
id string The dataset ID.
Inherited from time-series common.
source string Source of the data if available.
Inherited from time-series common.
key string The requested dataset key.
Inherited from time-series common.
subkey string The requested dataset subkey.
Inherited from time-series common.
date number The date field of the time series as epoch timestamp.
Inherited from time-series common.
updated number The time data was last updated as epoch timestamp.
Inherited from time-series common.

Historical Prices

Returns adjusted and unadjusted historical data for up to 15 years, and historical minute-by-minute intraday prices for the last 30 trailing calendar days. Useful for building charts.

Learn more about how to get historical prices using this endpoint in our help center.

HTTP request

GET /stock/{symbol}/chart/{range}/{date}

JSON response

// .../3m
[
    {
    "close": 116.59,
    "high": 117.49,
    "low": 116.22,
    "open": 116.57,
    "symbol": "AAPL",
    "volume": 46691331,
    "id": "HISTORICAL_PRICES",
    "key": "AAPL",
    "subkey": "",
    "date": "2020-11-27",
    "updated": 1606746790000,
    "changeOverTime": 0,
    "marketChangeOverTime": 0,
    "uOpen": 116.57,
    "uClose": 116.59,
    "uHigh": 117.49,
    "uLow": 116.22,
    "uVolume": 46691331,
    "fOpen": 116.57,
    "fClose": 116.59,
    "fHigh": 117.49,
    "fLow": 116.22,
    "fVolume": 46691331,
    "label": "Nov 27, 20",
    "change": 0,
    "changePercent": 0
  },
  // { ... }
]

Data Weighting

Adjusted + Unadjusted
10 per symbol per time interval returned (Excluding 1d)
Example: If you query for AAPL 5 day, it will return 5 days of prices for AAPL for a total of 50.

Adjusted close only
2 per symbol per time interval returned (Excluding 1d)
use chartCloseOnly param

NOTE: For minute-bar historical prices when a specific date is used in the range parameter, the weight is 50 messages
Example: If you query for AAPL minute-bar for 20190610, it will return 390 minutes of data at a cost of 50 messages.

Data Timing

End of Day

Data Schedule

Prior trading day adjusted data available after 4am ET Tue-Sat

Data Source(s)

IEX Cloud Investors Exchange

Notes

Access to Historical Prices from more than 5 years ago is only included with paid subscriptions

Available Methods

GET /stock/{symbol}/chart/{range}/{date}

Examples

Path Parameters

Option Description
symbol Valid symbol
range See below
Range Description Source
max All available data up to 15 years Historically adjusted market-wide data
5y Five years Historically adjusted market-wide data
2y Two years Historically adjusted market-wide data
1y One year Historically adjusted market-wide data
ytd Year-to-date Historically adjusted market-wide data
6m Six months Historically adjusted market-wide data
3m Three months Historically adjusted market-wide data
1m One month (default) Historically adjusted market-wide data
1mm One month Historically adjusted market-wide data in 30 minute intervals
5d Five Days Historically adjusted market-wide data by day.
5dm Five Days Historically adjusted market-wide data in 10 minute intervals
date Specific date If used with the query parameter chartByDay, then this returns historical OHLCV data for that date. Otherwise, it returns data by minute for a specified date, if available. Date format YYYYMMDD. Currently supporting trailing 30 calendar days of minute bar data.
dynamic One day Will return 1d or 1m data depending on the day or week and time of day. Intraday per minute data is only returned during market hours.

Query String Parameters

Option Details
chartCloseOnly Optional.
• boolean. Will return adjusted data only with keys date, close, and volume.
chartByDay Optional.
• boolean. Used only when range is date to return OHLCV data instead of minute bar data.
chartSimplify Optional.
• boolean. If true, runs a polyline simplification using the Douglas-Peucker algorithm. This is useful if plotting sparkline charts.
chartInterval Optional.
• number. If passed, chart data will return every Nth element as defined by chartInterval
changeFromClose Optional.
• boolean. If true, changeOverTime and marketChangeOverTime will be relative to previous day close instead of the first value.
chartLast Optional.
• number. If passed, chart data will return the last N elements from the time period defined by the range parameter
displayPercent Optional.
• If set to true, all percentage values will be multiplied by a factor of 100 (Ex: /stock/twtr/chart?displayPercent=true)
range Optional.
• string. Same format as the path parameter. This can be used for batch calls.
exactDate Optional.
• string. Formatted as YYYYMMDD. This can be used for batch calls when range is 1d or date.
sort Optional.
• string. Can be asc or desc to sort results by date. Defaults to desc
includeToday Optional.
• boolean. If true, current trading day data is appended

Response Attributes

This endpoint inherits common keys from Time Series.

Key Type Description
close number Adjusted data for historical dates. Split adjusted only.
high number Adjusted data for historical dates. Split adjusted only.
low number Adjusted data for historical dates. Split adjusted only.
open number Adjusted data for historical dates. Split adjusted only.
symbol string Associated symbol or ticker
volume number Adjusted data for historical dates. Split adjusted only.
id string The dataset ID.
Inherited from time-series common.
source string Source of the data if available.
Inherited from time-series common.
key string The requested dataset key.
Inherited from time-series common.
subkey string The requested dataset subkey.
Inherited from time-series common.
date number The date field of the time series as epoch timestamp.
Inherited from time-series common.
updated number The time data was last updated as epoch timestamp.
Inherited from time-series common.
changeOverTime number Percent change of each interval relative to first value. Useful for comparing multiple stocks.
marketChangeOverTime number Percent change of each interval relative to first value. 15 minute delayed consolidated data.
uOpen number Unadjusted data for historical dates.
uClose number Unadjusted data for historical dates.
uHigh number Unadjusted data for historical dates.
uLow number Unadjusted data for historical dates.
uVolume number Unadjusted data for historical dates.
fOpen number Fully adjusted for historical dates.
fClose number Fully adjusted for historical dates.
fHigh number Fully adjusted for historical dates.
fLow number Fully adjusted for historical dates.
fVolume number Fully adjusted for historical dates.
label number A human readable format of the date depending on the range.
change number Change from previous trading day.
changePercent number Change percent from previous trading day.

Income Statement

Pulls income statement data. Available quarterly or annually with the default being the last available quarter. This data is currently only available for U.S. symbols.

HTTP request

GET /stock/{symbol}/income

JSON response

{
  "symbol": "AAPL",
  "income": [
    {
      "reportDate": "2020-10-21",
      "filingType": "10-K",
      "fiscalDate": "2020-09-13",
      "fiscalQuarter": 4,
      "fiscalYear": 2010,
      "currency": "USD",
      "totalRevenue": 62681000000,
      "costOfRevenue": 39086000000,
      "grossProfit": 23595000000,
      "researchAndDevelopment": 3750000000,
      "sellingGeneralAndAdmin": 4216000000,
      "operatingExpense": 47052000000,
      "operatingIncome": 15629000000,
      "otherIncomeExpenseNet": 792000000,
      "ebit": 15629000000,
      "interestIncome": 868000000,
      "pretaxIncome": 16421000000,
      "incomeTax": 2296000000,
      "minorityInterest": 0,
      "netIncome": 14125000000,
      "netIncomeBasic": 14125000000
    },
    // { ... }
  ]
}

Data Weighting

1000 per symbol per period

Data Timing

End of day

Data Schedule

Updates at 8am, 9am UTC daily

Data Source(s)

Copyright: Data provided by New Constructs, LLC © All rights reserved.

Notes

Examples

Query String Parameters

Option Details
period Optional.
• string. Allows you to specify annual or quarterly income statement. Defaults to quarter. Values should be annual or quarter
last Optional.
• number. Specify the number of quarters or years to return. One quarter is returned by default. You can specify up to 12 quarters with quarter, or up to 4 years with annual.

Response Attributes

This endpoint inherits common keys from Time Series.

Key Type Description
reportDate string Date financials were reported.
filingType string Filing type
fiscalDate string The last day of the relevant fiscal period, formatted YYYY-MM-DD
fiscalQuarter number Associated fiscal quarter
fiscalYear number Associated fiscal year
currency string Currency code for reported financials.
totalRevenue number Refers to the sum of both operating and non-operating revenues . Investopedia
costOfRevenue number Represents the cost of goods sold for the period including depletion and amortization. Investopedia
grossProfit number Represents the difference between sales or revenues and cost of goods sold and depreciation. Investopedia
researchAndDevelopment number Represents all direct and indirect costs related to the creation and development of new processes, techniques, applications and products with commercial possibilities. Excludes customer or government sponsored research, purchase of mineral rights (for oil, gas, coal, drilling and mining companies), engineering expense, and contributions by government, customers, partnerships or other corporations to the company’s research and development expense
sellingGeneralAndAdmin number Represents expenses not directly attributable to the production process but relating to selling, general and administrative functions. Excludes research and development.
operatingExpense number Calculated as cost of revenue minus selling, general & administrative expense. Investopedia
operatingIncome number Represents operating income for the period calculated as (net sales or revenue) - (cost of goods sold) - (selling, general & administrative expenses) - (other operating expenses). This will only return for industrial companies.
otherIncomeExpenseNet number Calculated as income before tax minus operating income.
ebit number Represents operating income for the period calculated as (net sales or revenue) - (cost of goods sold) - (selling, general & administrative expenses) - (other operating expenses). This will only return for industrial companies. Investopedia
interestIncome number Represents interest expense, net of interest capitalized for the period calculated as (interest expense on debt) - (interest capitalized) Investopedia
pretaxIncome number Represents all income/loss before any federal, state or local taxes. Extraordinary items reported net of taxes are excluded.
incomeTax number Represents all income taxes levied on the income of a company by federal, state and foreign governments. Excludes domestic international sales corporation taxes, ad valorem taxes, excise taxes, windfall profit taxes, taxes other than income, and general and services taxes.
minorityInterest number Represents the portion of earnings/losses of a subsidiary pertaining to common stock not owned by the controlling company or other members of the consolidated group.
netIncome number Represents income before extraordinary items and preferred and common dividends, but after operating and non-operating income and expenses, minority interest and equity in earnings. Investopedia
netIncomeBasic number Represents net income available to common basic EPS before extraordinaries for the period calculated as (net income after preferred dividends) - (discontinued operations)
id string The dataset ID.
Inherited from time-series common.
source string Source of the data if available.
Inherited from time-series common.
key string The requested dataset key.
Inherited from time-series common.
subkey string The requested dataset subkey.
Inherited from time-series common.
date number The date field of the time series as epoch timestamp.
Inherited from time-series common.
updated number The time data was last updated as epoch timestamp.
Inherited from time-series common.

Insider Roster

Returns the top 10 insiders, with the most recent information.

HTTP request

GET /stock/{symbol}/insider-roster

JSON response

[
    {
        entityName : "Random insider",
        position : 12345,
        reportDate : 1546387200000
    }
]

Data Weighting

5000 per symbol

Data Timing

End of day

Data Schedule

Updates at 5am, 6am ET every day

Data Source(s)

IEX Cloud

Notes

Only included with paid subscription plans

Available Methods

GET /stock/{symbol}/insider-roster

Examples

Response Attributes

Key Type Description
entityName string Name of the entity
reportDate number Refers to the update time of report_date in milliseconds since midnight Jan 1, 1970.
position number Number of shares held, adjusted for corporate actions

Insider Summary

Returns aggregated insiders summary data for the last 6 months.

HTTP request

GET /stock/{symbol}/insider-summary

JSON response

[
  {
    "fullName": "John Appleseed",
    "netTransacted": 1307282,
    "reportedTitle": "General Counsel",
    "symbol": "AAPL",
    "totalBought": 2433589,
    "totalSold": -1178724,
    "id": "INSIDER_SUMMARY",
    "key": "AAPL",
    "subkey": "335777",
    "updated": 1683414527684
  }
]

Data Weighting

5000 per symbol

Data Timing

End of day

Data Schedule

Updates at 5am, 6am ET every day

Data Source(s)

IEX Cloud

Notes

Only included with paid subscription plans

Available Methods

GET /stock/{symbol}/insider-summary

Examples

Response Attributes

This endpoint inherits common keys from Time Series.

Key Type Description
fullName string Full name of the individual. This field concatenates the individuals First Name, Middle Name, Last Name and Suffix.
netTransacted number As-reported (unadjusted) number of shares acquired or disposed
reportedTitle string Insiders job title per the sourced filing
totalBought number Total shares purchased
totalSold number Total shares sold
id string The dataset ID.
Inherited from time-series common.
source string Source of the data if available.
Inherited from time-series common.
key string The requested dataset key.
Inherited from time-series common.
subkey string The requested dataset subkey.
Inherited from time-series common.
date number The date field of the time series as epoch timestamp.
Inherited from time-series common.
updated number The time data was last updated as epoch timestamp.
Inherited from time-series common.

Insider Transactions

Returns insider transactions.

HTTP request

GET /stock/{symbol}/insider-transactions

JSON response

[
  {
    "conversionOrExercisePrice": null,
    "directIndirect": "D",
    "effectiveDate": 1592507189879,
    "filingDate": "2020-02-04",
    "fullName": "WAGNER SUSAN",
    "is10b51": false,
    "postShares": 886126,
    "reportedTitle": null,
    "symbol": "AAPL",
    "transactionCode": "M",
    "transactionDate": "2020-02-01",
    "transactionPrice": null,
    "transactionShares": 1429,
    "transactionValue": null,
    "id": "INSIDER_TRANSACTIONS",
    "key": "AAPL",
    "subkey": "0000320193-20-000023",
    "date": 1592507189879,
    "updated": 1606805326000,
    "tranPrice": null,
    "tranShares": 1429,
    "tranValue": null
  },
  // { ... }
]

Data Weighting

50 per transaction

Data Timing

End of day

Data Schedule

Updates at UTC every day

Data Source(s)

IEX Cloud

Notes

Available Methods

GET /stock/{symbol}/insider-transactions

Examples

Response Attributes

This endpoint inherits common keys from Time Series.

Key Type Description
conversionOrExercisePrice number The conversion or exercise price of the transaction, if available
directIndirect letter (D)irect or (I)ndirect
effectiveDate number Effective date of the transaction.
filingDate string Date the transaction was filed with the SEC.
fullName string Full name of the individual. This field concatenates the individuals First Name, Middle Name, Last Name and Suffix.
is10b51 boolean Whether the transaction was executed under Rule 10b5-1. Rule 10b5-1 allows company insiders to make predetermined trades while following insider trading laws and avoiding insider trading accusations. Learn more.
postShares number The reported number of shares held after the transaction.
reportedTitle string Insiders job title per the sourced filing if available
symbol string Associated ticker or symbol
transactionCode letter Transaction Codes
transactionDate string Date the transaction was executed
transactionPrice number As-reported (unadjusted) unit price at which shares were acquired or disposed, represented in USD.
transactionShares number As-reported (unadjusted) number of shares acquired or disposedValue of the transaction, calculated as Tran_Shares * Tran_Price, represented in USD. This value is not adjusted for corporate actions.
transactionValue number Value of the transaction, calculated as Tran_Shares * Tran_Price, represented in USD. This value is not adjusted for corporate actions.
tranPrice number As-reported (unadjusted) unit price at which shares were acquired or disposed, represented in USD.
tranShares number As-reported (unadjusted) number of shares acquired or disposedValue of the transaction, calculated as Tran_Shares * Tran_Price, represented in USD. This value is not adjusted for corporate actions.
tranValue number Value of the transaction, calculated as Tran_Shares * Tran_Price, represented in USD. This value is not adjusted for corporate actions.
id string The dataset ID.
Inherited from time-series common.
source string Source of the data if available.
Inherited from time-series common.
key string The requested dataset key.
Inherited from time-series common.
subkey string The requested dataset subkey.
Inherited from time-series common.
date number The date field of the time series as epoch timestamp.
Inherited from time-series common.
updated number The time data was last updated as epoch timestamp.
Inherited from time-series common.

Institutional Ownership

Returns the top 10 institutional holders, defined as buy-side or sell-side firms.

HTTP request

GET /stock/{symbol}/institutional-ownership

JSON response

[
  {
    "symbol": "AAPL",
    "id": "0001104659-20-095098",
    "adjHolding": 1315961000,
    "adjMv": 120015645,
    "entityProperName": "VANGUARD GROUP INC",
    "reportDate": 1593475200000,
    "filingDate": "2020-06-30",
    "reportedHolding": 328990250,
    "date": 1606608000000,
    "updated": 1606622415000
  },
  // { ... }
]

Data Weighting

10000 per symbol per period

Data Timing

End of day

Data Schedule

Updates at 5am, 6am ET every day

Data Source(s)

IEX Cloud

Notes

Only included with paid subscription plans

Available Methods

GET /stock/{symbol}/institutional-ownership

Examples

Response Attributes

This endpoint inherits common keys from Time Series.

Key Type Description
adjHolding number Share amount held by the fund as of the report date, adjusted for corporate actions
adjMv number Total share amount multiplied by the latest month-end share price, adjusted for corporate actions in USD
entityProperName string Name of the entity
reportDate number Refers to the update time of report_date in milliseconds since midnight Jan 1, 1970.
reportedHolding number Share amount held by the institution as reported in the source
id string The dataset ID.
Inherited from time-series common.
source string Source of the data if available.
Inherited from time-series common.
key string The requested dataset key.
Inherited from time-series common.
subkey string The requested dataset subkey.
Inherited from time-series common.
date number The date field of the time series as epoch timestamp.
Inherited from time-series common.
updated number The time data was last updated as epoch timestamp.
Inherited from time-series common.

Intraday Prices

This endpoint will return aggregated intraday prices in one-minute buckets for the current day. For historical intraday data, use our Historical Prices endpoint.

Learn more about how to get real-time stock prices using in our help center.

HTTP request

GET /stock/{symbol}/intraday-prices

JSON response

[
  {
    "date": "2017-12-15",
    "minute": "09:30",
    "label": "09:30 AM",
    "marketOpen": 143.98,
    "marketClose": 143.775,
    "marketHigh": 143.98,
    "marketLow": 143.775,
    "marketAverage": 143.889,
    "marketVolume": 3070,
    "marketNotional": 441740.275,
    "marketNumberOfTrades": 20,
    "marketChangeOverTime": -0.004,
    "high": 143.98,
    "low": 143.775,
    "open": 143.98,
    "close": 143.775,
    "average": 143.889,
    "volume": 3070,
    "notional": 441740.275,
    "numberOfTrades": 20,
    "changeOverTime": -0.0039,
  },
  // { ... }
]

Data Weighting

1 per symbol per time interval up to a max use of 50 messages
Example: If you query for twtr 1d at 11:00am, it will return 90 minutes of data for a total of 50.

IEX Only intraday minute bar
Free This will only return IEX data with keys minute, high, low, average, volume, notional, and numberOfTrades
Use the chartIEXOnly param

Data Timing

No delay for IEX data
15 minutes delayed for market data

Data Schedule

9:30-4pm ET Mon-Fri on regular market trading days
9:30-1pm ET on early close trading days

Data Source(s)

IEX Cloud Investors Exchange

Notes

All response attributes related to 15 minute delayed market-wide price data are only available to paid subscribers

Available Methods

GET /stock/{symbol}/intraday-prices

Examples

Path Parameters

Option Details
symbol Valid symbol

Query String Parameters

Option Details
chartIEXOnly Optional.
• boolean. Limits the return of intraday prices to IEX only data.
chartReset Optional.
• boolean. If true, chart will reset at midnight instead of the default behavior of 9:30am ET.
chartSimplify Optional.
• boolean. If true, runs a polyline simplification using the Douglas-Peucker algorithm. This is useful if plotting sparkline charts.
chartInterval Optional.
• number. If passed, chart data will return every Nth element as defined by chartInterval
changeFromClose Optional.
• boolean. If true, changeOverTime and marketChangeOverTime will be relative to previous day close instead of the first value.
chartLast Optional.
• number. If passed, chart data will return the last N elements
exactDate Optional.
• string. Formatted as YYYYMMDD. This can be used for batch calls when range is 1d or date. Currently supporting trailing 30 calendar days of minute bar data.
chartIEXWhenNull Optional.
• boolean. By default, all market prefixed fields are 15 minute delayed, meaning the most recent 15 objects will be null. If this parameter is passed as true, all market prefixed fields that are null will be populated with IEX data if available.

Response Attributes

Key Type Description
date string
minute string Formatted as HHmm
marketAverage number 15 minute delayed data. Average price during the minute across all markets. This represents data from all markets. If the value is null, then the market did not trade during the minute.
marketNotional number 15 minute delayed data. Total notional value during the minute for trades across all markets. This represents data from all markets. If the value is null, then the market did not trade during the minute.
marketNumberOfTrades number 15 minute delayed data. Number of trades during the minute across all markets. This represents data from all markets. If the value is null, then the market did not trade during the minute.
marketOpen number 15 minute delayed data. First price during the minute across all markets. This represents data from all markets. If the value is null, then the market did not trade during the minute.
marketClose number 15 minute delayed data. Last price during the minute across all markets. This represents data from all markets. If the value is null, then the market did not trade during the minute.
marketHigh number 15 minute delayed data. Highest price during the minute across all markets. This represents data from all markets. If the value is null, then the market did not trade during the minute.
marketLow number 15 minute delayed data. Lowest price during the minute across all markets. This represents data from all markets. If the value is null, then the market did not trade during the minute.
marketVolume number 15 minute delayed data. Total volume of trades during the minute across all markets. This represents data from all markets. If the value is null, then the market did not trade during the minute.
marketChangeOverTime number Percent change of each interval relative to first value. 15 minute delayed consolidated data.
simplifyFactor array Only when chartSimplify is true. The first element is the original number of points. Second element is how many remain after simplification.
changeOverTime number Percent change of each interval relative to first value. Useful for comparing multiple stocks.
label number A human readable format of the date depending on the range.
average number IEX only data. Average price during the minute for trades on IEX.
notional number IEX only data. Total notional value during the minute for trades on IEX.
numberOfTrades number IEX only data. Number of trades during the minute on IEX.
high number IEX only data. Highest price during the minute on IEX.
low number IEX only data. Lowest price during the minute on IEX.
volume number IEX only data. Total volume during the minute on IEX.
open number IEX only data. First price during the minute on IEX.
close number IEX only data. Last price during the minute on IEX.

Key Stats

HTTP request

GET /stock/{symbol}/stats/{stat?}

JSON response

{
  "companyName": "Apple Inc.",
  "marketcap": 760334287200,
  "week52high": 156.65,
  "week52low": 93.63,
  "week52change": 58.801903,
  "sharesOutstanding": 5213840000,
  "float": null,
  "avg10Volume": 2774000,
  "avg30Volume": 12774000,
  "day200MovingAvg": 140.60541,
  "day50MovingAvg": 156.49678,
  "employees": 120000,
  "ttmEPS": 16.5,
  "ttmDividendRate": 2.25,
  "dividendYield": .021,
  "nextDividendDate": '2019-03-01',
  "exDividendDate": '2019-02-08',
  "nextEarningsDate": '2019-01-01',
  "peRatio": 14,
  "beta": 1.25,
  "maxChangePercent": 153.021,
  "year5ChangePercent": 0.5902546932200027,
  "year2ChangePercent": 0.3777449874142869,
  "year1ChangePercent": 0.39751716851558366,
  "ytdChangePercent": 0.36659492036160124,
  "month6ChangePercent": 0.12208398133748043,
  "month3ChangePercent": 0.08466584665846649,
  "month1ChangePercent": 0.009668596145283263,
  "day30ChangePercent": -0.002762605699968781,
  "day5ChangePercent": -0.005762605699968781
}

Data Weighting

5 per call per symbol for full stats
1 per call per symbol for single stat filter

Data Timing

End of day

Data Schedule

8am, 9am ET

Data Source(s)

IEX Cloud

Available Methods

GET /stock/{symbol}/stats/{stat?}

Examples

Path Parameter

Option Details
stat Optional.
• Case sensitive string matching the name of a single key to return one value. Ex: If you only want the next earnings date, you would call /stock/aapl/stats/nextEarningsDate

Response Attributes

Key Type Description
companyName string Company name of the security
marketcap number Market cap of the security calculated as shares outstanding * previous day close.
week52high number Based on 52 calendar weeks
week52low number Based on 52 calendar weeks
week52change number Based on 52 calendar weeks
sharesOutstanding number Number of shares outstanding as the difference between issued shares and treasury shares. Investopedia
avg30Volume number Average 30 day volume based on calendar days
avg10Volume number Average 10 day volume based on calendar days
float Returns null as of December 1, 2020
employees number
ttmEPS number Trailing twelve month earnings per share. Investopedia
This property will continue to be available after December 1, 2020.
ttmDividendRate number Trailing twelve month dividend rate per share
dividendYield number The ratio of trailing twelve month dividend compared to the previous day close price. The dividend yield is represented as a percentage calculated as (ttmDividendRate) / (previous day close price) Investopedia
nextDividendDate string Expected ex date of the next dividend
exDividendDate string Ex date of the last dividend
nextEarningsDate string Expected next earnings report date.
Note: This key may be temporarily unavailable starting December 1, 2020 and return null. We plan to continue offering this datapoint as soon as possible and are actively in the process of securing a new provider.
peRatio number Price to earnings ratio calculated as (previous day close price) / (ttmEPS)
beta number Beta is a measure used in fundamental analysis to determine the volatility of an asset or portfolio in relation to the overall market. Levered beta calculated with 1 year historical data and compared to SPY.
day200MovingAvg number Based on calendar days
day50MovingAvg number Based on calendar days
maxChangePercent number Based on calendar days
year5ChangePercent number Based on calendar days
year2ChangePercent number Based on calendar days
year1ChangePercent number Based on calendar days
ytdChangePercent number Based on calendar days
month6ChangePercent number Based on calendar days
month3ChangePercent number Based on calendar days
month1ChangePercent number Based on calendar days
day30ChangePercent number Based on calendar days
day5ChangePercent number Based on calendar days

Largest Trades

This returns 15 minute delayed, last sale eligible trades.

HTTP request

GET /stock/{symbol}/largest-trades

JSON response

[
  {
    "price": 186.39,
    "size": 10000,
    "time": 1527090690175,
    "timeLabel": "11:51:30",
    "venue": "EDGX",
    "venueName": "Cboe EDGX"
  },
  ...
]

Data Weighting

1 per trade returned

Data Timing

15min delayed

Data Schedule

9:30-4pm ET M-F during regular market hours

Data Source(s)

Consolidated Tape

Notes

Only included with paid subscription plans

Available Methods

GET /stock/{symbol}/largest-trades

Examples

Response Attributes

Key Type Description
price number Refers to the price of the trade.
size number Refers to the number of shares of the trade.
time number Refers to the time of the trade.
timeLabel string formatted time string as HH:MM:SS
venue string Refers to the venue where the trade occurred. None refers to a TRF (off exchange) trade.
venueName string formatted venue name where the trade occurred.

This is a helper function, but the Google APIs url is standardized.

HTTP request

GET /stock/{symbol}/logo

JSON response

{
  "url": "https://storage.googleapis.com/iex/api/logos/AAPL.png"
}

Data Weighting

1 per logo

Data Timing

End of day

Data Schedule

8am UTC daily

Data Source(s)

Web

Available Methods

GET /stock/{symbol}/logo

Examples

Response Attributes

Key Type
url string

OHLC

Returns the official open and close for a give symbol. The official open is available as soon as 9:45am ET and the official close as soon as 4:15pm ET. Some stocks can report late open or close prices.

HTTP request

GET /stock/{symbol}/ohlc

JSON response

{
  "open": {
    "price": 154,
    "time": 1506605400394
  },
  "close": {
    "price": 153.28,
    "time": 1506605400394
  },
  "high": 154.80,
  "low": 153.25
}

Data Weighting

2 per symbol

Data Timing

15min delayed

Data Schedule

9:30am-5pm ET Mon-Fri

Data Source(s)

Consolidated Tape

Notes

Only available to paid subscribers

Available Methods

GET /stock/{symbol}/ohlc

Examples

NOTE: /stock/market/ohlc currently only available to subscribers approved to receive UTP data by IEX Cloud

Response Attributes

Key Type Description
open Object Refers to the official open
    price number Refers to the official open price. Will return 0 if symbol has no volume for the day.
    time number Refers to the official listing exchange time for the open in millisecond epoch
close Object Refers to the official close
    price number Refers to the official close price. Will return 0 if symbol has no volume for the day.
    time number Refers to the official listing exchange time for the close in millisecond epoch
high number Refers to the market-wide highest price from the SIP (15 minute delayed)
low number Refers to the market-wide lowest price from the SIP (15 minute delayed)

Open / Close Price

Refer to ohlc

Peer Groups

HTTP request

GET /stock/{symbol}/peers

JSON response

[
    "MSFT",
    "NOK",
    "IBM",
    "BBRY",
    "HPQ",
    "GOOGL",
    "XLK"
]

Data Weighting

500 per call

Data Timing

End of day

Data Schedule

8am UTC daily

Data Source(s)

IEX Cloud

Notes

Only included with paid subscription plans

Available Methods

GET /stock/{symbol}/peers

Examples

Response Attributes

An array of peer symbols.

Previous Day Price

This returns previous day adjusted price data for one or more stocks.

HTTP request

GET /stock/{symbol}/previous

JSON response

{
  "close": 116.59,
  "high": 117.49,
  "low": 116.22,
  "open": 116.57,
  "symbol": "AAPL",
  "volume": 46691331,
  "id": "HISTORICAL_PRICES",
  "key": "AAPL",
  "subkey": "",
  "date": "2020-11-27",
  "updated": 1606746790000,
  "changeOverTime": 0,
  "marketChangeOverTime": 0,
  "uOpen": 116.57,
  "uClose": 116.59,
  "uHigh": 117.49,
  "uLow": 116.22,
  "uVolume": 46691331,
  "fOpen": 116.57,
  "fClose": 116.59,
  "fHigh": 117.49,
  "fLow": 116.22,
  "fVolume": 46691331,
  "label": "Nov 27, 20",
  "change": 0,
  "changePercent": 0
},

Data Weighting

2 per symbol

Data Timing

End of day

Data Schedule

Available after 4am ET Tue-Sat

Data Source(s)

IEX Cloud

Available Methods

GET /stock/{symbol}/previous
GET /stock/market/previous

Examples

Response Attributes

Returns the same attributes as historical prices

Price Only

HTTP request

GET /stock/{symbol}/price

JSON response

143.28

Data Weighting

1 per call

Data Timing

Real-time 15min delayed End of day

Data Schedule

4:30am-8pm ET Mon-Fri

Data Source(s)

IEX Cloud Investors Exchange Consolidated Tape

Notes

Only included with paid subscription plans

Available Methods

GET /stock/{symbol}/price

Examples

Path Parameters

Option Details
symbol Valid symbol

Response Attributes

Returns a number. Refer to the latestPrice attribute in the quote endpoint for a description.

Quote

Learn more about how to get real-time stock prices with the Quote endpoint in our help center.

HTTP request

GET /stock/{symbol}/quote/{field}

SSE Real-time Streaming Example (paid plans only)

curl --header 'Accept: text/event-stream' https://cloud-sse.iexapis.com/stable/stocksUS\?symbols\=spy\&token\=YOUR_TOKEN

JSON response

{
  "symbol": "BAC",
  "companyName": "Bank Of America Corp.",
  "primaryExchange": "NEW YORK STOCK EXCHANGE, INC.",
  "calculationPrice": "close",
  "open": 28.81,
  "openTime": 1607437801023,
  "openSource": "official",
  "close": 28.81,
  "closeTime": 1607461201852,
  "closeSource": "official",
  "high": 29.12,
  "highTime": 1607461198592,
  "highSource": "15 minute delayed price",
  "low": 27.68,
  "lowTime": 1607437803011,
  "lowSource": "15 minute delayed price",
  "latestPrice": 28.81,
  "latestSource": "Close",
  "latestTime": "December 8, 2020",
  "latestUpdate": 1607461201852,
  "latestVolume": 33820759,
  "iexRealtimePrice": 28.815,
  "iexRealtimeSize": 100,
  "iexLastUpdated": 1607461192396,
  "delayedPrice": 28.82,
  "delayedPriceTime": 1607461198592,
  "oddLotDelayedPrice": 28.82,
  "oddLotDelayedPriceTime": 1607461198391,
  "extendedPrice": 28.93,
  "extendedChange": 0.04,
  "extendedChangePercent": 0.00137,
  "extendedPriceTime": 1607471631362,
  "previousClose": 29.49,
  "previousVolume": 42197768,
  "change": -0.16,
  "changePercent": -0.0045,
  "volume": 33820759,
  "iexMarketPercent": 0.01709376134658947,
  "iexVolume": 578127,
  "avgTotalVolume": 60029202,
  "iexBidPrice": 0,
  "iexBidSize": 0,
  "iexAskPrice": 0,
  "iexAskSize": 0,
  "iexOpen": 28.815,
  "iexOpenTime": 1607461192355,
  "iexClose": 28.815,
  "iexCloseTime": 1607461192355,
  "marketCap": 2502673458439,
  "peRatio": 14.23,
  "week52High": 34.68,
  "week52Low": 17.50,
  "ytdChange": -0.1573975163337491,
  "lastTradeTime": 1607461198587,
  "isUSMarketOpen": false
}

Data Weighting

1 per quote called or streamed

Data Timing

Real-time 15min delayed End of day

Data Schedule

4:30am-8pm ET Mon-Fri

Data Source(s)

IEX Cloud Investors Exchange Consolidated Tape

Notes

Available Methods

GET /stock/{symbol}/quote
GET /stock/{symbol}/quote/{field}

Examples

Here is an example of how to pull the latest price of the stock as a number. This is a great way to get values into Excel.

Path Parameters

Option Details
field Optional.
• Case sensitive string matching a response attribute below. Specifying an attribute will return just the attribute value. This is useful for Excel Webservice calls.

Query String Parameters

Option Details
displayPercent Optional.
• If set to true, all percentage values will be multiplied by a factor of 100 (Ex: /stock/twtr/quote?displayPercent=true)

Response Attributes

Key Type Description
symbol string Refers to the stock ticker.
companyName string Refers to the company name.
primaryExchange string Refers to the primary listing exchange for the symbol.
calculationPrice string Refers to the source of the latest price.
Possible values are tops, sip, previousclose, close, or iexlasttrade. The iexlastrade value indicates that the latest price is the price of the last trade on IEX rather than the SIP closing price. iexlasttrade is provided for Nasdaq-listed symbols between 4:00 p.m. and 8 p.m. E.T. if you do not have UTP authorization.
open number Refers to the official open price from the SIP. 15 minute delayed (can be null after 00:00 ET, before 9:45 and weekends)
openTime number Refers to the official listing exchange time for the open from the SIP. 15 minute delayed
openSource string Source of open if available
close number Refers to the 15-minute delayed official close price from the SIP. For Nasdaq-listed stocks, if you do not have UTP authorization, between 4:00 p.m. and 8 p.m. E.T. this field will return the price of the last trade on IEX rather than the SIP closing price.
closeTime number Refers to the official listing exchange time for the close from the SIP. 15 minute delayed
closeSource string Source of close if available
high number Refers to the market-wide highest price from the SIP. 15 minute delayed during normal market hours 9:30 - 16:00 (null before 9:45 and weekends).
highTime number Refers to time high was updated as epoch timestamp
highSource string This will represent a human readable description of the source of high.
Possible values are IEX real time price, 15 minute delayed price, Close or Previous close
low number Refers to the market-wide lowest price from the SIP. 15 minute delayed during normal market hours 9:30 - 16:00 (null before 9:45 and weekends).
lowTime number Refers to time low was updated as epoch timestamp
lowSource string This will represent a human readable description of the source of low.
Possible values are IEX real time price, 15 minute delayed price, Close or Previous close
latestPrice number Use this to get the latest price
Refers to the latest relevant price of the security which is derived from multiple sources. We first look for an IEX real time price. If an IEX real time price is older than 15 minutes, 15 minute delayed market price is used. If a 15 minute delayed price is not available, we will use the current day close price. If a current day close price is not available, we will use the last available closing price (listed below as previousClose)
IEX real time price represents trades on IEX only. Trades occur across over a dozen exchanges, so the last IEX price can be used to indicate the overall market price.
15 minute delayed prices are from all markets using the Consolidated Tape.
This will not included pre or post market prices.
latestSource string This will represent a human readable description of the source of latestPrice.
Possible values are IEX real time price, 15 minute delayed price, Close or Previous close
latestTime string Refers to a human readable time/date of when latestPrice was last updated. The format will vary based on latestSource is inteded to be displayed to a user. Use latestUpdate for machine readable timestamp.
latestUpdate number Refers to the machine readable epoch timestamp of when latestPrice was last updated. Represented in milliseconds since midnight Jan 1, 1970.
latestVolume number Use this to get the latest volume
Refers to the latest total market volume of the stock across all markets. This will be the most recent volume of the stock during trading hours, or it will be the total volume of the last available trading day.
iexRealtimePrice number Refers to the price of the last trade on IEX.
iexRealtimeSize number Refers to the size of the last trade on IEX.
iexLastUpdated number Refers to the last update time of iexRealtimePrice in milliseconds since midnight Jan 1, 1970 UTC or -1 or 0. If the value is -1 or 0, IEX has not quoted the symbol in the trading day.
delayedPrice number Refers to the 15 minute delayed market price from the SIP during normal market hours 9:30 - 16:00 ET.
delayedPriceTime number Refers to the last update time of the delayed market price during normal market hours 9:30 - 16:00 ET.
oddLotDelayedPrice number Refers to the 15 minute delayed odd Lot trade price from the SIP during normal market hours 9:30 - 16:00 ET.
oddLotDelayedPriceTime number Refers to the last update time of the odd Lot trade price during normal market hours 9:30 - 16:00 ET.
extendedPrice number Refers to the 15 minute delayed price outside normal market hours 0400 - 0930 ET and 1600 - 2000 ET. This provides pre market and post market price. This is purposefully separate from latestPrice so users can display the two prices separately.
extendedChange number Refers to the price change between extendedPrice and latestPrice.
extendedChangePercent number Refers to the price change percent between extendedPrice and latestPrice.
extendedPriceTime number Refers to the last update time of extendedPrice
previousClose number Refers to the previous trading day closing price.
previousVolume number Refers to the previous trading day volume.
change number Refers to the change in price between latestPrice and previousClose
changePercent number Refers to the percent change in price between latestPrice and previousClose. For example, a 5% change would be represented as 0.05. You can use the query string parameter displayPercent to return this field multiplied by 100. So, 5% change would be represented as 5.
volume number Total volume for the stock, but only updated after market open. To get premarket volume, use latestVolume
iexMarketPercent number Refers to IEX’s percentage of the market in the stock.
iexVolume number Refers to shares traded in the stock on IEX.
avgTotalVolume number Refers to the 30 day average volume.
iexBidPrice number Refers to the best bid price on IEX.
iexBidSize number Refers to amount of shares on the bid on IEX.
iexAskPrice number Refers to the best ask price on IEX.
iexAskSize number Refers to amount of shares on the ask on IEX.
iexOpen number Refers to the open price from IEX.
iexOpenTime number Refers to the listing exchange time for the open from IEX.
iexClose number Refers to the close price from IEX.
iexCloseTime number Refers to the listing exchange time for the close from IEX.
marketCap number is calculated in real time using latestPrice.
peRatio number Refers to the price-to-earnings ratio for the company.
week52High number Refers to the adjusted 52 week high.
week52Low number Refers to the adjusted 52 week low.
ytdChange number Refers to the price change percentage from start of year to previous close.
lastTradeTime number Epoch timestamp in milliseconds of the last market hours trade excluding the closing auction trade.
isUSMarketOpen boolean For US stocks, indicates if the market is in normal market hours. Will be false during extended hours trading.

Real-time Quote

SEC Filings

Use the Financials As Reported endpoint for raw SEC filings data.

Splits (Basic)

HTTP request

GET /stock/{symbol}/splits/{range}

JSON response

[
  {
    "declaredDate": "2017-08-01",
    "description": "7-for-1 split",
    "exDate": "2017-08-10",
    "fromFactor": 1,
    "ratio": 0.142857,
    "refid": 6910760,
    "symbol": "AAPL",
    "toFactor": 7,
    "id": "SPLITS",
    "key": "AAPL",
    "subkey": "6846210",
    "updated": 1609576419432
  },
  // { ... }
]

Data Weighting

10 per symbol per record

Data Timing

End of day

Data Schedule

Updated at 9am UTC every day

Data Source(s)

IEX Cloud

Notes

Splits prior to last reported are only included with paid subscription plans

Available Methods

GET /stock/{symbol}/splits
GET /stock/{symbol}/splits/{range}

Examples

Path Parameters

Range Description Source
5y Five years Historical market data
2y Two years Historical market data
1y One year Historical market data
ytd Year-to-date Historical market data
6m Six months Historical market data
3m Three months Historical market data
1m One month (default) Historical market data
next Next upcoming split Historical market data

Response Attributes

This endpoint inherits common keys from Time Series.

Key Type Description
exDate string Refers to the split ex-date
declaredDate string Refers to the split declaration date
ratio number Refers to the split ratio. The split ratio is an inverse of the number of shares that a holder of the stock would have after the split divided by the number of shares that the holder had before.
For example: Split ratio of .5 = 2 for 1 split.
toFactor string To factor of the split. Used to calculate the split ratio fromfactor/tofactor = ratio (eg ½ = 0.5)
fromFactor string From factor of the split. Used to calculate the split ratio fromfactor/tofactor = ratio (eg ½ = 0.5)
description string Description of the split event.
symbol string Associated symbol or ticker
id string The dataset ID.
Inherited from time-series common.
source string Source of the data if available.
Inherited from time-series common.
key string The requested dataset key.
Inherited from time-series common.
subkey string The requested dataset subkey.
Inherited from time-series common.
date number The date field of the time series as epoch timestamp.
Inherited from time-series common.
updated number The time data was last updated as epoch timestamp.
Inherited from time-series common.

Technical Indicators

Technical indicators are available for any historical or intraday range. This endpoint calls the historical or intraday price endpoints for the given range, and the associated indicator for the price range.

HTTP request

GET /stock/{symbol}/indicator/{indicator-name}

JSON response

{
  "indicator": [
    [
      5974647,
      -11915723,
      // ...
    ]
  ],
  "chart": [
    {
      // chart keys
    },
    // ...
  ]
}

Data Weighting

50 per indicator value + weight of chart data returned as described in historical prices or intraday prices

Data Timing

On Demand

Data Schedule

On Demand

Data Source(s)

IEX Cloud

Notes

Only included with paid subscription plans

Examples

Query Parameters

All historical price and intraday price query parameters are supported. In addition, some technical indicators provide optional inputs which are listed in the table below. To use a custom input, pass in the numbered input query parameter to correspond with the option below.

Parameter Type Description
range string Required.
• This should match the range provided in historical prices
input1 number Optional.
input2 number Optional.
input3 number Optional.
input4 number Optional.

Indicators

Each indicator can be called by using the indicator name in the table. Some inidicators support optional inputs which can be specified with the query parameters in the table above.

Indicator Name Description Inputs Defaults Outputs
abs Vector Absolute Value abs
acos Vector Arccosine acos
ad Accumulation/Distribution Line ad
add Vector Addition add
adosc Accumulation/Distribution Oscillator short period,long period 2,5 adosc
adx Average Directional Movement Index period 5 dx
adxr Average Directional Movement Rating period 5 dx
ao Awesome Oscillator ao
apo Absolute Price Oscillator short period,long period 2,5 apo
aroon Aroon period 5 aroon_down,aroon_up
aroonosc Aroon Oscillator period 5 aroonosc
asin Vector Arcsine asin
atan Vector Arctangent atan
atr Average True Range period 5 atr
avgprice Average Price avgprice
bbands Bollinger Bands period,stddev 20,2 bbands_lower,bbands_middle,bbands_upper
bop Balance of Power
cci Commodity Channel Index period 5 cci
ceil Vector Ceiling ceil
cmo Chande Momentum Oscillator period 5 cmo
cos Vector Cosine cos
cosh Vector Hyperbolic Cosine cosh
crossany Crossany crossany
crossover Crossover crossover
cvi Chaikins Volatility period 5 cvi
decay Linear Decay period 5 decay
dema Double Exponential Moving Average period 5 dema
di Directional Indicator period 5 plus_di,minus_di
div Vector Division div
dm Directional Movement period 5 plus_dm,minus_dm
dpo Detrended Price Oscillator period 5 dpo
dx Directional Movement Index period 5 dx
edecay Exponential Decay period 5 edecay
ema Exponential Moving Average period 5 ema
emv Ease of Movement emv
exp Vector Exponential exp
fisher Fisher Transform period 5 fisher,fisher_signal
floor Vector Floor floor
fosc Forecast Oscillator period 5 fosc
hma Hull Moving Average period 5 hma
kama Kaufman Adaptive Moving Average period 5 kama
kvo Klinger Volume Oscillator short period,long period 2,5 kvo
lag Lag period 5 lag
linreg Linear Regression period 5 linreg
linregintercept Linear Regression Intercept period 5 linregintercept
linregslope Linear Regression Slope period 5 linregslope
ln Vector Natural Log ln
log10 Vector Base-10 Log log10
macd Moving Average Convergence/Divergence short period,long period,signal period 12,26,9 macd,macd_signal,macd_histogram
marketfi Market Facilitation Index marketfi
mass Mass Index period 5 mass
max Maximum In Period period 5 max
md Mean Deviation Over Period period 5 md
medprice Median Price medprice
mfi Money Flow Index period 5 mfi
min Minimum In Period period 5 min
mom Momentum period 5 mom
msw Mesa Sine Wave period 5 msw_sine,msw_lead
mul Vector Multiplication mul
natr Normalized Average True Range period 5 natr
nvi Negative Volume Index nvi
obv On Balance Volume obv
ppo Percentage Price Oscillator short period,long period 2,5 ppo
psar Parabolic SAR acceleration factor step,acceleration factor maximum .2,2 psar
pvi Positive Volume Index pvi
qstick Qstick period 5 qstick
roc Rate of Change period 5 roc
rocr Rate of Change Ratio period 5 rocr
round Vector Round round
rsi Relative Strength Index period 5 rsi
sin Vector Sine sin
sinh Vector Hyperbolic Sine sinh
sma Simple Moving Average period 5 sma
sqrt Vector Square Root sqrt
stddev Standard Deviation Over Period period 5 stddev
stderr Standard Error Over Period period 5 stderr
stoch Stochastic Oscillator %k period,%k slowing period,%d period 5,3,3 stoch_k,stoch_d
stochrsi Stochastic RSI period 5 stochrsi
sub Vector Subtraction sub
sum Sum Over Period period 5 sum
tan Vector Tangent tan
tanh Vector Hyperbolic Tangent tanh
tema Triple Exponential Moving Average period 5 tema
todeg Vector Degree Conversion degrees
torad Vector Radian Conversion radians
tr True Range tr
trima Triangular Moving Average period 5 trima
trix Trix period 5 trix
trunc Vector Truncate trunc
tsf Time Series Forecast period 5 tsf
typprice Typical Price typprice
ultosc Ultimate Oscillator short period,medium period,long period 2,3,5 ultosc
var Variance Over Period period 5 var
vhf Vertical Horizontal Filter period 5 vhf
vidya Variable Index Dynamic Average short period,long period,alpha 2,5,.2 vidya
volatility Annualized Historical Volatility period 5 volatility
vosc Volume Oscillator short period,long period 2,5 vosc
vwma Volume Weighted Moving Average period 5 vwma
wad Williams Accumulation/Distribution wad
wcprice Weighted Close Price wcprice
wilders Wilders Smoothing period 5 wilders
willr Williams %R period
wma Weighted Moving Average period 5 wma
zlema Zero-Lag Exponential Moving Average period 5 zlema

Response Attributes

Key Type Description
indicator array An array of arrays is returned. Some indicators return multiple outputs which are described in the above table. The first array contains each output. The second array contains the values of the indicator output. Note The number of values may be less than the number of chart items returned for most indicators.
chart array Returns the associated chart object as defined in historical prices or intraday prices

Volume by Venue

This returns 15 minute delayed and 30 day average consolidated volume percentage of a stock, by market. This call will always return 13 values, and will be sorted in ascending order by current day trading volume percentage.

HTTP request

GET /stock/{symbol}/volume-by-venue

JSON response

[
  {
    "volume": 289791,
    "venue": "IEXG",
    "venueName": "IEX",
    "date": "2017-09-19",
    "marketPercent": 0.014105441890783691,
  },
  // { ... }
]

Data Weighting

20 per call

Data Timing

15 min delayed

Data Schedule

Updated during regular market hours 9:30am-4pm ET

Data Source(s)

Consolidated Tape Investors Exchange

Examples

Response Attributes

Key Type Description
volume number Refers to the current day, 15 minute delayed volume
venue string Refers to the Market Identifier Code (MIC)
venueName string Refers to a readable version of the venue defined by IEX
date string Refers to the date the data was last updated in the format YYYY-MM-DD
marketPercent number Refers to the 15 minute delayed percent of total stock volume traded by the venue

Corporate Actions

Bonus Issue

Obtain up-to-date and detailed information on all new announcements, as well as 12+ years of historical records.

HTTP request

GET /time-series/advanced_bonus/{symbol?}/{refid?}

JSON response

[
  {
    "symbol": "BVHMF",
    "exDate": "2020-01-03",
    "recordDate": "2020-01-02",
    "paymentDate": "2020-01-03",
    "fromFactor": 1,
    "toFactor": 0.03819,
    "ratio": 26.184865147944485,
    "description": "Ordinary Shares",
    "flag": "Stock",
    "securityType": "Equity Shares",
    "resultSecurityType": "Equity Shares",
    "notes": "(As on 10/09/2019) CAB<BR><BR>SITUATION:      BONUS ISSUE <BR>",
    "figi": "BBG000FZ8989",
    "lastUpdated": "2019-11-08",
    "currency": "",
    "countryCode": "US",
    "parValue": 0.5,
    "parValueCurrency": "GBP",
    "lapsedPremium": 0,
    "refid": "5951486",
    "created": "2019-09-11",
    "id": "ADVANCED_BONUS",
    "source": "IEX Cloud",
    "key": "BVHMF",
    "subkey": "5951486",
    "date": 1578009600000,
    "updated": 1574690010000
  },
  // { ... }
]

Data Weighting

75,000 per item returned

Data Timing

End of day

Data Schedule

Updated at 5am, 10am, 8pm UTC daily

Data Source(s)

IEX Cloud

Notes

Only available to paid plans.

Available Methods

GET /time-series/advanced_bonus/{symbol?}/{refid?}

Examples

Path Parameters

Range Type Description
symbol string Optional.
• Symbol name.
refid string Optional.
• Id that matches the refid field returned in the response object. This allows you to pull a specific event for a symbol.

Response Attributes

Key Type Description
symbol string Symbol of the security
exDate string The date that determines which shareholders will be entitled to receive the issue, formatted as YYYY-MM-DD
recordDate string When the company examines its current list of shareholders to determine who will receive the issue. Only those who are registered as shareholders in the company’s books as of the record date will be entitled to receive the issue, formatted as YYYY-MM-DD
paymentDate string The date when the dividend is actually paid to eligible shareholders, formatted as YYYY-MM-DD
fromFactor number Number of starting shares
toFactor number Number of ending shares
ratio number fromFactor divided by toFactor
description string Security description.
flag string The payment type.
Supported values
Autocall
Cash&Stock
Cash
DissenterRights
Interest
Maturity
Rebate
Stock
Special
ToBeAnnounced
Blank
securityType string Type of security.
Supported values
A BLANK value is possible
Barbados Depository Receipts
Bond
Basket Warrant
Convertible Debenture
Share Depository Certificate
Chess Depository Interest
CEDEAR
Convertible Notes
Conversion
Commodity
Certificate
Convertible Unsecured Loan Stock
Currency
Contingent Value Rights
Covered Warrant
Debenture
Derivatives
Depository Receipts
Distribution Rights
Deferred Settlement Trading
Equity Shares
Exchange Traded Commodities
Exchange Traded Fund
Exchange Traded Notes
Fund
Global Depository Notes
Irredeemable Convertible Loan Stock
Index
Interval Fund
Inflation
Interbank Offered Rate
Letter of Allotment
Unit Trust
Non Convertible Debenture
Non-Redeemable Convertible Cumulative Preference S
Notes
Partly Convertible Debenture
Perpetual Exchangeable Repurchaseable Listed Share
Preferred Security
Poison Pill Rights
Preference Share
Parallel Line
Redeemable Convertible Secured Loan Stocks
Redeemable Convertible Secured Notes
Receipt
Redemption Rights
Redeemable Shares
Redeemable Optional Convertible Preference Shares
rights
Redeemable Unconvertible Notes
Structured Product
Subscription Receipts
Second Trading Line
Stapled Security
Swap Rate
Tradeable Rights
Tendered Shares Security
Unit Investment Trust
Units
Warrants
When Distributed
When Issued
resultSecurityType string Type of security.
Supported values
A BLANK value is possible
Barbados Depository Receipts
Bond
Basket Warrant
Convertible Debenture
Share Depository Certificate
Chess Depository Interest
CEDEAR
Convertible Notes
Conversion
Commodity
Certificate
Convertible Unsecured Loan Stock
Currency
Contingent Value Rights
Covered Warrant
Debenture
Derivatives
Depository Receipts
Distribution Rights
Deferred Settlement Trading
Equity Shares
Exchange Traded Commodities
Exchange Traded Fund
Exchange Traded Notes
Fund
Global Depository Notes
Irredeemable Convertible Loan Stock
Index
Interval Fund
Inflation
Interbank Offered Rate
Letter of Allotment
Unit Trust
Non Convertible Debenture
Non-Redeemable Convertible Cumulative Preference S
Notes
Partly Convertible Debenture
Perpetual Exchangeable Repurchaseable Listed Share
Preferred Security
Poison Pill Rights
Preference Share
Parallel Line
Redeemable Convertible Secured Loan Stocks
Redeemable Convertible Secured Notes
Receipt
Redemption Rights
Redeemable Shares
Redeemable Optional Convertible Preference Shares
rights
Redeemable Unconvertible Notes
Structured Product
Subscription Receipts
Second Trading Line
Stapled Security
Swap Rate
Tradeable Rights
Tendered Shares Security
Unit Investment Trust
Units
Warrants
When Distributed
When Issued
notes string Long description
figi string OpenFIGI id for the symbol
lastUpdated string Date the record was last changed, formatted as YYYY-MM-DD
currency string ISO currency code for the amount
countryCode string Refers to the country code for the symbol using ISO 3166-1 alpha-2
parValue number Par value is the face value of a bond. Par value is important for a bond or fixed-income instrument because it determines its maturity value as well as the dollar value of coupon payments. Par value for a share refers to the stock value stated in the corporate charter.
parValueCurrency string ISO currency code for parValue
lapsedPremium number
refid string Unique id representing the record
created string Date the record was created, formatted as YYYY-MM-DD

Distribution

Obtain up-to-date and detailed information on all new announcements, as well as 12+ years of historical records.

HTTP request

GET /time-series/advanced_distribution/{symbol?}/{refid?}

JSON response

[
  {
    "symbol": "KERRF",
    "exDate": "2019-11-26",
    "recordDate": "2019-11-19",
    "paymentDate": "2019-11-29",
    "withdrawalFromDate": null,
    "withdrawalToDate": null,
    "electionDate": null,
    "fromFactor": 3.451963,
    "toFactor": 1,
    "ratio": 3.451963,
    "minPrice": 0,
    "maxPrice": 0,
    "description": "Ordinary Shares",
    "flag": "Stock",
    "securityType": "Equity Shares",
    "hasWithdrawalRights": 1,
    "notes": "(As on 09/10/2019) CAB<BR>SITUATION:      CAPITAL REDUCTION AND DEMERGER <BR>",
    "figi": "BBG00N70C5N1",
    "lastUpdated": "2019-11-21",
    "countryCode": "US",
    "parValue": 0.0001,
    "parValueCurrency": "GBP",
    "refid": "6008685",
    "created": "2019-10-09",
    "id": "ADVANCED_DISTRIBUTION",
    "source": "IEX Cloud",
    "key": "KERRF",
    "subkey": "6008685",
    "date": 1574726400000,
    "updated": 1574691580000
  }
]

Data Weighting

75,000 per item returned

Data Timing

End of day

Data Schedule

Updated at 5am, 10am, 8pm UTC daily

Data Source(s)

IEX Cloud

Notes

Only available to paid plans.

Available Methods

GET /time-series/advanced_distribution/{symbol?}/{refid?}

Examples

Path Parameters

Range Type Description
symbol String Optional.
• Symbol name.
refid String Optional.
• Id that matches the refid field returned in the response object. This allows you to pull a specific event for a symbol.

Response Attributes

Key Type Description
symbol string Symbol of the security
exDate string The date that determines which shareholders will be entitled to receive the issue, formatted as YYYY-MM-DD
recordDate string When the company examines its current list of shareholders to determine who will receive the issue. Only those who are registered as shareholders in the company’s books as of the record date will be entitled to receive the issue, formatted as YYYY-MM-DD
paymentDate string The date paid to eligible shareholders, formatted as YYYY-MM-DD
announceDate string This is the date on which the company announces a future issue, formatted as YYYY-MM-DD
withdrawalFromDate string YYYY-MM-DD
withdrawalToDate string YYYY-MM-DD
electionDate string YYYY-MM-DD
fromFactor number Number of starting shares
toFactor number Number of ending shares
ratio number fromFactor divided by toFactor
minPrice number Minimum price
maxPrice number Maximum price
description string Security description.
flag string The payment type.
Supported Values
Autocall
Cash&Stock
Cash
DissenterRights
Interest
Maturity
Rebate
Stock
Special
ToBeAnnounced
Blank
securityType string Type of security.
Supported Values
A BLANK value is possible
Barbados Depository Receipts
Bond
Basket Warrant
Convertible Debenture
Share Depository Certificate
Chess Depository Interest
CEDEAR
Convertible Notes
Conversion
Commodity
Certificate
Convertible Unsecured Loan Stock
Currency
Contingent Value Rights
Covered Warrant
Debenture
Derivatives
Depository Receipts
Distribution Rights
Deferred Settlement Trading
Equity Shares
Exchange Traded Commodities
Exchange Traded Fund
Exchange Traded Notes
Fund
Global Depository Notes
Irredeemable Convertible Loan Stock
Index
Interval Fund
Inflation
Interbank Offered Rate
Letter of Allotment
Unit Trust
Non Convertible Debenture
Non-Redeemable Convertible Cumulative Preference S
Notes
Partly Convertible Debenture
Perpetual Exchangeable Repurchaseable Listed Share
Preferred Security
Poison Pill Rights
Preference Share
Parallel Line
Redeemable Convertible Secured Loan Stocks
Redeemable Convertible Secured Notes
Receipt
Redemption Rights
Redeemable Shares
Redeemable Optional Convertible Preference Shares
rights
Redeemable Unconvertible Notes
Structured Product
Subscription Receipts
Second Trading Line
Stapled Security
Swap Rate
Tradeable Rights
Tendered Shares Security
Unit Investment Trust
Units
Warrants
When Distributed
When Issued
hasWithdrawalRights boolean If has withdrawal rights
notes string Long description
figi string OpenFIGI id for the symbol
lastUpdated string Date the record was last changed, formatted as YYYY-MM-DD
countryCode string Refers to the country code for the symbol using ISO 3166-1 alpha-2
parValue number Par value is the face value of a bond. Par value is important for a bond or fixed-income instrument because it determines its maturity value as well as the dollar value of coupon payments. Par value for a share refers to the stock value stated in the corporate charter.
parValueCurrency string ISO currency code for parValue
refid string Unique id representing the record
created string Date the record was created, formatted as YYYY-MM-DD

Dividends

Obtain up-to-date and detailed information on all new dividend announcements, as well as 12+ years of historical dividend records. This endpoint covers over 39,000 US equities, international dividends, mutual funds, ADRs, and ETFs.

You’ll be provided with:

  • Detailed information on both cash and stock dividends including record, payment, ex, and announce dates
  • Gross and net amounts
  • Details of all currencies in which a dividend can be paid
  • Tax information
  • The ability to keep up with the growing number of complex dividend distributions

HTTP request

GET /time-series/advanced_dividends/{symbol?}/{refid?}

JSON response

[
  {
    "symbol": "ASML",
    "exDate": "2019-11-04",
    "recordDate": "2019-11-05",
    "paymentDate": "2019-11-15",
    "announceDate": "2019-10-16",
    "currency": "USD",
    "frequency": "semi-annual",
    "amount": "1.1697",
    "description": "New York Shares",
    "flag": "Cash",
    "securityType": "Depository Receipts",
    "notes": "(As on 04/11/2019) USDRJPM<BR>Security Name: ASML HOLDING NV (ASML US) - ADR - Final Announcement<BR>CUSIP: N07059210<BR>DR Record Date:November 05, 2019<BR>DR Payment/Value Date:November 15, 2019<BR>Foreign Payment Date:November 15, 2019<BR>Euro per foreign share 1.05<BR>DR Ratio 1 : 1<BR>Euro per DR 1.05<BR>Foreign Exchange Date<BR>Final Foreign Exchange Rate: 1.114<BR>Inclusive of a fee of 0.0000000<BR>All amounts are in USD<BR>Withholding Tax Rate 15%<BR>Rate per DR 1.1697000<BR>Withholding Amount 0.1754550<BR>Dividend Fee 0.0000000<BR>DSC 0.0000000<BR>Final Dividend Rate per DR 0.9942450<BR><BR>(As on 04/11/2019)USDIVINVEST <BR>Symbol ASML<BR>New.Amount 0.9942<BR>Exchange NASDAQ<BR>Div.DecDate 00-00-0000<BR>Div.ExDate 11/04/2019<BR>Div.RecDate 11/05/2019<BR>Div.PayDate 11-15-2019<BR><BR>(As on 01/11/2019)DEDIVS<BR>Ex date :04/11/2019<BR><BR>(As on 16/10/2019 ) USDRJPM_APPX<BR>Security Name: ASML HOLDING NV (ASML US) - ADR - Initial Announcement<BR>CUSIP: N07059210<BR>DR Record Date:November 05, 2019<BR>DR Payment/Value Date: November 15, 2019<BR>Foreign Exchange Date: 10/15/2019<BR>F X Conversion Rate :1.1034<BR>All amounts are in USD:<BR>Withholding Tax Rate 15%<BR>Rate per DR 1.1585700<BR>Withholding Amount 0.1737855<BR>Dividend Fee 0.0000000<BR>DSC 0.0000000<BR>Approximate Dividend Rate per DR 0.9847845<BR><BR>(As on 16/10/2019)USDIVINVEST<BR>Symbol ASML<BR>New.Amount 0.9848<BR>Exchange NASDAQ<BR>Div.DecDate 00-00-0000<BR>Div.ExDate 11/04/2019<BR>Div.RecDate 11/05/2019<BR>Div.PayDate 11-15-2019<BR>",
    "figi": "BBG000K6MRN4",
    "lastUpdated": "2019-11-05",
    "countryCode": "US",
    "parValue": "",
    "parValueCurrency": "USD",
    "netAmount": "0.994245",
    "grossAmount": "1.1697",
    "marker": "Interim",
    "taxRate": "15",
    "fromFactor": "",
    "toFactor": "",
    "adrFee": "",
    "coupon": "",
    "declaredCurrencyCD": "",
    "declaredGrossAmount": "",
    "isNetInvestmentIncome": 1,
    "isDAP": 1,
    "isApproximate": 1,
    "fxDate": "2019-11-15",
    "secondPaymentDate": null,
    "secondExDate": null,
    "fiscalYearEndDate": "2019-12-31",
    "periodEndDate": "2019-06-30",
    "optionalElectionDate": null,
    "toDate": null,
    "registrationDate": null,
    "installmentPayDate": null,
    "declaredDate": "2019-10-16",
    "refid": "1691530",
    "created": "2019-10-17",
    "id": "ADVANCED_DIVIDENDS",
    "source": "IEX Cloud",
    "key": "US",
    "subkey": "ASML",
    "date": 1572825600000,
    "updated": 1573134765000
  },
  // { ... }
]

Data Weighting

75,000 per dividend returned

Data Timing

End of day

Data Schedule

Updated at 5am, 10am, 8pm UTC daily

Data Source(s)

IEX Cloud

Notes

Only available to paid plans.

Available Methods

GET /time-series/advanced_dividends/{symbol?}/{refid?}

Examples

Path Parameters

Range Type Description
symbol String Optional.
• Symbol name.
refid String Optional.
• Id that matches the refid field returned in the response object. This allows you to pull a specific dividend for a symbol.

Response Attributes

Key Type Description
symbol string Symbol of the security
exDate string The date that determines which shareholders will be entitled to receive the dividend. Typically, the ex-dividend date is set two business days before the record date. Only those shareholders who owned their shares at least two full business days before the record date will be entitled to receive the dividend, formatted as YYYY-MM-DD
recordDate string When the company examines its current list of shareholders to determine who will receive dividends. Only those who are registered as shareholders in the company’s books as of the record date will be entitled to receive dividends, formatted as YYYY-MM-DD
paymentDate string The date when the dividend is actually paid to eligible shareholders, formatted as YYYY-MM-DD
announceDate string This is the date on which the company announces that it will be issuing a dividend in the future, formatted as YYYY-MM-DD
currency string ISO currency code for the amount
frequency string How often the dividend is paid.
Supported Values:
Every 35 Days
Annual
BiMonthly
Daily
Final
Interim
Interest on Maturity
Interest on Trigger
Irregular
Monthly
Quarterly
Semi-Annual
Trimesterly
Unspecified
Weekly
Blank
amount number Dividend rate. The amount paid.
description string Security description.
flag string The payment type.
Supported Values:
Autocall
Cash&Stock
Cash
DissenterRights
Interest
Maturity
Rebate
Stock
Special
ToBeAnnounced
Blank
securityType string Type of security.
Supported Values:
A BLANK value is possible
Barbados Depository Receipts
Bond
Basket Warrant
Convertible Debenture
Share Depository Certificate
Chess Depository Interest
CEDEAR
Convertible Notes
Conversion
Commodity
Certificate
Convertible Unsecured Loan Stock
Currency
Contingent Value Rights
Covered Warrant
Debenture
Derivatives
Depository Receipts
Distribution Rights
Deferred Settlement Trading
Equity Shares
Exchange Traded Commodities
Exchange Traded Fund
Exchange Traded Notes
Fund
Global Depository Notes
Irredeemable Convertible Loan Stock
Index
Interval Fund
Inflation
Interbank Offered Rate
Letter of Allotment
Unit Trust
Non Convertible Debenture
Non-Redeemable Convertible Cumulative Preference S
Notes
Partly Convertible Debenture
Perpetual Exchangeable Repurchaseable Listed Share
Preferred Security
Poison Pill Rights
Preference Share
Parallel Line
Redeemable Convertible Secured Loan Stocks
Redeemable Convertible Secured Notes
Receipt
Redemption Rights
Redeemable Shares
Redeemable Optional Convertible Preference Shares
rights
Redeemable Unconvertible Notes
Structured Product
Subscription Receipts
Second Trading Line
Stapled Security
Swap Rate
Tradeable Rights
Tendered Shares Security
Unit Investment Trust
Units
Warrants
When Distributed
When Issued
notes string Long description
figi string OpenFIGI id for the symbol
lastUpdated string Date the dividend record was last changed, formatted as YYYY-MM-DD
countryCode string Refers to the country code for the symbol using ISO 3166-1 alpha-2
parValue number Par value is the face value of a bond. Par value is important for a bond or fixed-income instrument because it determines its maturity value as well as the dollar value of coupon payments. Par value for a share refers to the stock value stated in the corporate charter.
parValueCurrency string ISO currency code for parValue
netAmount number Net amount is the dividend return after tax
grossAmount number Gross amount is the dividend return on a stock before any expenses, taxes or deductions are taken into account
marker string Supported Values:
Annual
Arrears
Capital Gain
Capital Gain Long Term
Capital Gain Short Term
Final
Installment
Interim
Interest on Capital
Memorial
Regular
Special
Supplementary
Unspecified
taxRate number The percent tax rate. Example: 15% tax rate is represented as “15”
fromFactor number Number of starting shares
toFactor number Number of ending shares
adrFee number ADR custody fee amount
coupon number The coupon payment or interest rate paid
declaredCurrencyCD string ISO currency code for certificate of deposit
declaredGrossAmount number Declared gross amount
isNetInvestmentIncome boolean Net investment income (NII) is income received from investment assets (before taxes) such as bonds, stocks, mutual funds, loans and other investments (less related expenses). The individual tax rate on net investment income depends on whether it is interest income, dividend income or capital gains. Investopedia
isDAP boolean Dividend Advantage Portfolio, a unit investment trust.
isApproximate boolean Is approximate
fxDate string Date used for the FX rate, formatted as YYYY-MM-DD
secondPaymentDate string Second payment date, formatted as YYYY-MM-DD
secondExDate string Second ex date, formatted as YYYY-MM-DD
fiscalYearEndDate string Fiscal year end date, formatted as YYYY-MM-DD
periodEndDate string Period end date, formatted as YYYY-MM-DD
optionalElectionDate string Optional election date, formatted as YYYY-MM-DD
toDate string To Date, formatted as YYYY-MM-DD
registrationDate string Registration date, formatted as YYYY-MM-DD
installmentPayDate string Installment payment date, formatted as YYYY-MM-DD
declaredDate string This is the date on which the company announces that it will be issuing a dividend in the future, formatted as YYYY-MM-DD
refid string Unique id representing the dividend record
created string Date the dividend record was created, formatted as YYYY-MM-DD

Return of Capital

Obtain up-to-date and detailed information on all new announcements, as well as 12+ years of historical records.

HTTP request

GET /time-series/advanced_return_of_capital/{symbol?}/{refid?}

JSON response


  {
    "symbol": "ICGGF",
    "exDate": "2020-06-26",
    "recordDate": "2020-06-30",
    "paymentDate": null,
    "withdrawalFromDate": null,
    "withdrawalToDate": null,
    "electionDate": null,
    "cashBack": 2190,
    "description": "Ordinary Shares",
    "flag": "Cash",
    "securityType": "Equity Shares",
    "hasWithdrawalRights": 1,
    "currency": "JPY",
    "notes": "As per the announcement company announced a dividend event and a return of capital event with record date 30-06-2020. The amount for cash dividend is JPY 1390 and the amount for Return of capital is JPY 2190 (1390+2190=3580).",
    "figi": "BBG00HPS2WC7",
    "lastUpdated": "2019-08-12",
    "countryCode": "US",
    "parValue": 0,
    "parValueCurrency": "JPY",
    "refid": "17077",
    "created": "2019-08-12",
    "id": "ADVANCED_RETURN_OF_CAPITAL",
    "source": "IEX Cloud",
    "key": "ICGGF",
    "subkey": "17077",
    "date": 1593129600000,
    "updated": 1574690148000
  }
  // { ... }
]

Data Weighting

75,000 per item returned

Data Timing

End of day

Data Schedule

Updated at 5am, 10am, 8pm UTC daily

Data Source(s)

IEX Cloud

Notes

Only available to paid plans.

Available Methods

GET /time-series/advanced_return_of_capital/{symbol?}/{refid?}

Examples

Path Parameters

Range Type Description
symbol String Optional.
• Symbol name.
refid String Optional.
• Id that matches the refid field returned in the response object. This allows you to pull a specific event for a symbol.

Response Attributes

Key Type Description
symbol string Symbol of the security
exDate string The date that determines which shareholders will be entitled to receive the issue, formatted as YYYY-MM-DD
recordDate string When the company examines its current list of shareholders to determine who will receive the issue. Only those who are registered as shareholders in the company’s books as of the record date will be entitled to receive the issue, formatted as YYYY-MM-DD
paymentDate string The date paid to eligible shareholders, formatted as YYYY-MM-DD
withdrawalFromDate string YYYY-MM-DD
withdrawalToDate string YYYY-MM-DD
electionDate string YYYY-MM-DD
cashBack number The amount paid.
description string Security description.
flag string The payment type.
Supported values
Autocall
Cash&Stock
Cash
DissenterRights
Interest
Maturity
Rebate
Stock
Special
ToBeAnnounced
Blank
securityType string Type of security.
Supported values
A BLANK value is possible
Barbados Depository Receipts
Bond
Basket Warrant
Convertible Debenture
Share Depository Certificate
Chess Depository Interest
CEDEAR
Convertible Notes
Conversion
Commodity
Certificate
Convertible Unsecured Loan Stock
Currency
Contingent Value Rights
Covered Warrant
Debenture
Derivatives
Depository Receipts
Distribution Rights
Deferred Settlement Trading
Equity Shares
Exchange Traded Commodities
Exchange Traded Fund
Exchange Traded Notes
Fund
Global Depository Notes
Irredeemable Convertible Loan Stock
Index
Interval Fund
Inflation
Interbank Offered Rate
Letter of Allotment
Unit Trust
Non Convertible Debenture
Non-Redeemable Convertible Cumulative Preference S
Notes
Partly Convertible Debenture
Perpetual Exchangeable Repurchaseable Listed Share
Preferred Security
Poison Pill Rights
Preference Share
Parallel Line
Redeemable Convertible Secured Loan Stocks
Redeemable Convertible Secured Notes
Receipt
Redemption Rights
Redeemable Shares
Redeemable Optional Convertible Preference Shares
rights
Redeemable Unconvertible Notes
Structured Product
Subscription Receipts
Second Trading Line
Stapled Security
Swap Rate
Tradeable Rights
Tendered Shares Security
Unit Investment Trust
Units
Warrants
When Distributed
When Issued
hasWithdrawalRights boolean 0 or 1
currency string ISO currency code for the amount
notes string Long description
figi string OpenFIGI id for the symbol
lastUpdated string Date the record was last changed, formatted as YYYY-MM-DD
countryCode string Refers to the country code for the symbol using ISO 3166-1 alpha-2
parValue number Par value is the face value of a bond. Par value is important for a bond or fixed-income instrument because it determines its maturity value as well as the dollar value of coupon payments. Par value for a share refers to the stock value stated in the corporate charter.
parValueCurrency string ISO currency code for parValue
refid string Unique id representing the record
created string Date the record was created, formatted as YYYY-MM-DD

Rights Issue

Obtain up-to-date and detailed information on all new announcements, as well as 12+ years of historical records.

HTTP request

GET /time-series/advanced_rights/{symbol?}/{refid?}

JSON response

[
  {
    "symbol": "OBDCF",
    "exDate": "2019-11-29",
    "recordDate": "2019-12-02",
    "paymentDate": null,
    "subscriptionStartDate": "2019-12-03",
    "subscriptionEndDate": "2019-12-17",
    "tradeStartDate": "2019-12-03",
    "tradeEndDate": "2019-12-13",
    "splitDate": null,
    "fromFactor": 30,
    "toFactor": 1,
    "ratio": 30,
    "description": "Ordinary Shares - Class B",
    "flag": "Stock",
    "securityType": "Equity Shares",
    "resultSecurityType": "Units",
    "currency": "SEK",
    "notes": "(As on 28/10/2019)SECA<BR>Obducat: guaranteed rights issue of 32,5 MSEK<BR>Not to be published in the USA, Australia, Japan or Canada<BR><BR>Ratio: 30 shares entitle to subscribe one unit. Each unit consists of five shares and three warrants. Price per warrant is SEK 9,25 and price per share is SEK 1,85.<BR>Ex-date: 29 November 2019<BR>Record date: 2 December 2019<BR>Subscription period: 3 - 17 December, 2019<BR>Trading period: 3 - 13 December, 2019<BR>",
    "figi": "BBG000FQBWJ2",
    "lastUpdated": "2019-10-28",
    "countryCode": "US",
    "parValue": 1,
    "parValueCurrency": "SEK",
    "issuePrice": 37,
    "lapsedPremium": 0,
    "isOverSubscription": 1,
    "refid": "6036935",
    "created": "2019-10-28",
    "id": "ADVANCED_RIGHTS",
    "source": "IEX Cloud",
    "key": "OBDCF",
    "subkey": "6036935",
    "date": 1574985600000,
    "updated": 1574691160000
  }
  // { ... }
]

Data Weighting

75,000 per item returned

Data Timing

End of day

Data Schedule

Updated at 5am, 10am, 8pm UTC daily

Data Source(s)

IEX Cloud

Notes

Only available to paid plans.

Available Methods

GET /time-series/advanced_rights/{symbol?}/{refid?}

Examples

Path Parameters

Range Type Description
symbol String Optional.
• Symbol name.
refid String Optional.
• Id that matches the refid field returned in the response object. This allows you to pull a specific event for a symbol.

Response Attributes

Key Type Description
symbol string Symbol of the security
exDate string The date that determines which shareholders will be entitled to receive the issue, formatted as YYYY-MM-DD
recordDate string When the company examines its current list of shareholders to determine who will receive the issue. Only those who are registered as shareholders in the company’s books as of the record date will be entitled to receive the issue, formatted as YYYY-MM-DD
paymentDate string The date paid to eligible shareholders, formatted as YYYY-MM-DD
subscriptionStartDate string YYYY-MM-DD
subscriptionEndDate string YYYY-MM-DD
tradeStartDate string YYYY-MM-DD
tradeEndDate string YYYY-MM-DD
splitDate string YYYY-MM-DD
fromFactor number Number of starting shares
toFactor number Number of ending shares
ratio number fromFactor divided by toFactor
description string Security description.
flag string The payment type.
Supported Values:
Autocall
Cash&Stock
Cash
DissenterRights
Interest
Maturity
Rebate
Stock
Special
ToBeAnnounced
Blank
securityType string Type of security.
Supported Values:
A BLANK value is possible
Barbados Depository Receipts
Bond
Basket Warrant
Convertible Debenture
Share Depository Certificate
Chess Depository Interest
CEDEAR
Convertible Notes
Conversion
Commodity
Certificate
Convertible Unsecured Loan Stock
Currency
Contingent Value Rights
Covered Warrant
Debenture
Derivatives
Depository Receipts
Distribution Rights
Deferred Settlement Trading
Equity Shares
Exchange Traded Commodities
Exchange Traded Fund
Exchange Traded Notes
Fund
Global Depository Notes
Irredeemable Convertible Loan Stock
Index
Interval Fund
Inflation
Interbank Offered Rate
Letter of Allotment
Unit Trust
Non Convertible Debenture
Non-Redeemable Convertible Cumulative Preference S
Notes
Partly Convertible Debenture
Perpetual Exchangeable Repurchaseable Listed Share
Preferred Security
Poison Pill Rights
Preference Share
Parallel Line
Redeemable Convertible Secured Loan Stocks
Redeemable Convertible Secured Notes
Receipt
Redemption Rights
Redeemable Shares
Redeemable Optional Convertible Preference Shares
rights
Redeemable Unconvertible Notes
Structured Product
Subscription Receipts
Second Trading Line
Stapled Security
Swap Rate
Tradeable Rights
Tendered Shares Security
Unit Investment Trust
Units
Warrants
When Distributed
When Issued
resultSecurityType string Type of security.
Supported Values:
A BLANK value is possible
Barbados Depository Receipts
Bond
Basket Warrant
Convertible Debenture
Share Depository Certificate
Chess Depository Interest
CEDEAR
Convertible Notes
Conversion
Commodity
Certificate
Convertible Unsecured Loan Stock
Currency
Contingent Value Rights
Covered Warrant
Debenture
Derivatives
Depository Receipts
Distribution Rights
Deferred Settlement Trading
Equity Shares
Exchange Traded Commodities
Exchange Traded Fund
Exchange Traded Notes
Fund
Global Depository Notes
Irredeemable Convertible Loan Stock
Index
Interval Fund
Inflation
Interbank Offered Rate
Letter of Allotment
Unit Trust
Non Convertible Debenture
Non-Redeemable Convertible Cumulative Preference S
Notes
Partly Convertible Debenture
Perpetual Exchangeable Repurchaseable Listed Share
Preferred Security
Poison Pill Rights
Preference Share
Parallel Line
Redeemable Convertible Secured Loan Stocks
Redeemable Convertible Secured Notes
Receipt
Redemption Rights
Redeemable Shares
Redeemable Optional Convertible Preference Shares
rights
Redeemable Unconvertible Notes
Structured Product
Subscription Receipts
Second Trading Line
Stapled Security
Swap Rate
Tradeable Rights
Tendered Shares Security
Unit Investment Trust
Units
Warrants
When Distributed
When Issued
currency string ISO currency code for the amount
notes string Long description
figi string OpenFIGI id for the symbol
lastUpdated string Date the record was last changed, formatted as YYYY-MM-DD
countryCode string Refers to the country code for the symbol using ISO 3166-1 alpha-2
parValue number Par value is the face value of a bond. Par value is important for a bond or fixed-income instrument because it determines its maturity value as well as the dollar value of coupon payments. Par value for a share refers to the stock value stated in the corporate charter.
parValueCurrency string ISO currency code for parValue
issuePrice number Issue price
lapsedPremium number
isOverSubscription boolean 0 or 1
refid string Unique id representing the record
created string Date the record was created, formatted as YYYY-MM-DD

Right to Purchase

Obtain up-to-date and detailed information on all new announcements, as well as 12+ years of historical records.

HTTP request

GET /time-series/advanced_right_to_purchase/{symbol?}/{refid?}

JSON response

[
  {
    "symbol": "APBCF",
    "exDate": "2019-12-05",
    "recordDate": "2019-12-06",
    "paymentDate": null,
    "subscriptionStart": "2019-12-13",
    "subscriptionEnd": "2019-12-17",
    "issuePrice": 38,
    "description": "Ordinary Shares",
    "flag": "Stock",
    "securityType": "Equity Shares",
    "resultSecurityType": "Equity Shares",
    "isOverSubscription": 1,
    "currency": "TWD",
    "notes": "(As on 21/11/2019) TWEM <BR>Company Name Applied BioCode Corporation<BR>ISIN code KYG0488D1051<BR>Ticker 6598<BR>Ex_date 20191205<BR>Record date 20191206<BR>pay date <BR>Listing Date <BR>rights ratio(1000 for X) 16.225<BR>rights price 38<BR>subscription period-start 20191213<BR>subscription period-end 20191217<BR>Issue size(thousand shares) 1280<BR>Sucess/Failed Sucess<BR>Subscribe stock 6598 Applied BioCode Corporation<BR>",
    "figi": "BBG00JLYZ733",
    "lastUpdated": "2019-11-21",
    "countryCode": "US",
    "parValue": 10,
    "parValueCurrency": "TWD",
    "refid": "6091477",
    "created": "2019-11-21",
    "id": "ADVANCED_RIGHT_TO_PURCHASE",
    "source": "IEX Cloud",
    "key": "APBCF",
    "subkey": "6091477",
    "date": 1575504000000,
    "updated": 1574694416000
  }
  // { ... }
]

Data Weighting

75,000 per item returned

Data Timing

End of day

Data Schedule

Updated at 5am, 10am, 8pm UTC daily

Data Source(s)

IEX Cloud

Notes

Only available to paid plans.

Available Methods

GET /time-series/advanced_right_to_purchase/{symbol?}/{refid?}

Examples

Path Parameters

Range Type Description
symbol String Optional.
• Symbol name.
refid String Optional.
• Id that matches the refid field returned in the response object. This allows you to pull a specific event for a symbol.

Response Attributes

Key Type Description
symbol string Symbol of the security
exDate string The date that determines which shareholders will be entitled to receive the issue, formatted as YYYY-MM-DD
recordDate string When the company examines its current list of shareholders to determine who will receive the issue. Only those who are registered as shareholders in the company’s books as of the record date will be entitled to receive the issue, formatted as YYYY-MM-DD
paymentDate string The date paid to eligible shareholders, formatted as YYYY-MM-DD
subscriptionStartDate string YYYY-MM-DD
subscriptionEndDate string YYYY-MM-DD
issuePrice number Issue price
description string Security description.
flag string The payment type.
Supported Values:
Autocall
Cash&Stock
Cash
DissenterRights
Interest
Maturity
Rebate
Stock
Special
ToBeAnnounced
Blank
securityType string Type of security.
Supported Values:
A BLANK value is possible
Barbados Depository Receipts
Bond
Basket Warrant
Convertible Debenture
Share Depository Certificate
Chess Depository Interest
CEDEAR
Convertible Notes
Conversion
Commodity
Certificate
Convertible Unsecured Loan Stock
Currency
Contingent Value Rights
Covered Warrant
Debenture
Derivatives
Depository Receipts
Distribution Rights
Deferred Settlement Trading
Equity Shares
Exchange Traded Commodities
Exchange Traded Fund
Exchange Traded Notes
Fund
Global Depository Notes
Irredeemable Convertible Loan Stock
Index
Interval Fund
Inflation
Interbank Offered Rate
Letter of Allotment
Unit Trust
Non Convertible Debenture
Non-Redeemable Convertible Cumulative Preference S
Notes
Partly Convertible Debenture
Perpetual Exchangeable Repurchaseable Listed Share
Preferred Security
Poison Pill Rights
Preference Share
Parallel Line
Redeemable Convertible Secured Loan Stocks
Redeemable Convertible Secured Notes
Receipt
Redemption Rights
Redeemable Shares
Redeemable Optional Convertible Preference Shares
rights
Redeemable Unconvertible Notes
Structured Product
Subscription Receipts
Second Trading Line
Stapled Security
Swap Rate
Tradeable Rights
Tendered Shares Security
Unit Investment Trust
Units
Warrants
When Distributed
When Issued
resultSecurityType string Type of security.
Supported Values:
A BLANK value is possible
Barbados Depository Receipts
Bond
Basket Warrant
Convertible Debenture
Share Depository Certificate
Chess Depository Interest
CEDEAR
Convertible Notes
Conversion
Commodity
Certificate
Convertible Unsecured Loan Stock
Currency
Contingent Value Rights
Covered Warrant
Debenture
Derivatives
Depository Receipts
Distribution Rights
Deferred Settlement Trading
Equity Shares
Exchange Traded Commodities
Exchange Traded Fund
Exchange Traded Notes
Fund
Global Depository Notes
Irredeemable Convertible Loan Stock
Index
Interval Fund
Inflation
Interbank Offered Rate
Letter of Allotment
Unit Trust
Non Convertible Debenture
Non-Redeemable Convertible Cumulative Preference S
Notes
Partly Convertible Debenture
Perpetual Exchangeable Repurchaseable Listed Share
Preferred Security
Poison Pill Rights
Preference Share
Parallel Line
Redeemable Convertible Secured Loan Stocks
Redeemable Convertible Secured Notes
Receipt
Redemption Rights
Redeemable Shares
Redeemable Optional Convertible Preference Shares
rights
Redeemable Unconvertible Notes
Structured Product
Subscription Receipts
Second Trading Line
Stapled Security
Swap Rate
Tradeable Rights
Tendered Shares Security
Unit Investment Trust
Units
Warrants
When Distributed
When Issued
isOverSubscription boolean 0 or 1
currency string ISO currency code for the amount
notes string Long description
figi string OpenFIGI id for the symbol
lastUpdated string Date the record was last changed, formatted as YYYY-MM-DD
countryCode string Refers to the country code for the symbol using ISO 3166-1 alpha-2
parValue number Par value is the face value of a bond. Par value is important for a bond or fixed-income instrument because it determines its maturity value as well as the dollar value of coupon payments. Par value for a share refers to the stock value stated in the corporate charter.
parValueCurrency string ISO currency code for parValue
refid string Unique id representing the record
created string Date the record was created, formatted as YYYY-MM-DD

Security Reclassification

Obtain up-to-date and detailed information on all new announcements, as well as 12+ years of historical records.

HTTP request

GET /time-series/advanced_security_reclassification/{symbol?}/{refid?}

JSON response

[
  {
    "symbol": "SSBFX",
    "exDate": "2020-03-27",
    "fromFactor": 0,
    "toFactor": 0,
    "ratio": null,
    "description": "State Street Target Retirement Class 2015 Fund Class I",
    "flag": "Stock",
    "securityType": "Unit Trust",
    "resultSecurityType": "Unit Trust",
    "notes": "(As on 18/04/13) USNYSE <BR>Symbol :  ADT<BR>Issue Name :  The ADT Corporation<BR>CUSIP :  00101J106           <BR>Issue Type : Common stock<BR>Frequency QUARTERLY<BR>Ex Date : 22/04/2013<BR>Declared Date : 14/03/2013<BR>Pay Date :  15/05/2013<BR>Record Date :  24/04/2013<BR>Dividend Amount :USD  0.125<BR>Notes: Return of Capital Return Of Capital = 0.125<BR>",
    "figi": "BBG006T4JVT6",
    "lastUpdated": "2019-08-22",
    "countryCode": "US",
    "parValue": 0,
    "parValueCurrency": "USD",
    "refid": "5844",
    "created": "2019-08-22",
    "id": "ADVANCED_SECURITY_RECLASSIFICATION",
    "source": "IEX Cloud",
    "key": "SSBFX",
    "subkey": "5844",
    "date": 1585267200000,
    "updated": 1574693523000
  }
  // { ... }
]

Data Weighting

75,000 per item returned

Data Timing

End of day

Data Schedule

Updated at 5am, 10am, 8pm UTC daily

Data Source(s)

IEX Cloud

Notes

Only available to paid plans.

Available Methods

GET /time-series/advanced_security_reclassification/{symbol?}/{refid?}

Examples

Path Parameters

Range Type Description
symbol String Optional.
• Symbol name.
refid String Optional.
• Id that matches the refid field returned in the response object. This allows you to pull a specific event for a symbol.

Response Attributes

Key Type Description
symbol string Symbol of the security
exDate string The date that determines which shareholders will be entitled to receive the issue formatted as YYYY-MM-DD
fromFactor number Number of starting shares
toFactor number Number of ending shares
ratio number fromFactor divided by toFactor
description string Security description.
flag string The payment type.
Supported Values:
Autocall
Cash&Stock
Cash
DissenterRights
Interest
Maturity
Rebate
Stock
Special
ToBeAnnounced
Blank
securityType string Type of security.
Supported Values:
A BLANK value is possible
Barbados Depository Receipts
Bond
Basket Warrant
Convertible Debenture
Share Depository Certificate
Chess Depository Interest
CEDEAR
Convertible Notes
Conversion
Commodity
Certificate
Convertible Unsecured Loan Stock
Currency
Contingent Value Rights
Covered Warrant
Debenture
Derivatives
Depository Receipts
Distribution Rights
Deferred Settlement Trading
Equity Shares
Exchange Traded Commodities
Exchange Traded Fund
Exchange Traded Notes
Fund
Global Depository Notes
Irredeemable Convertible Loan Stock
Index
Interval Fund
Inflation
Interbank Offered Rate
Letter of Allotment
Unit Trust
Non Convertible Debenture
Non-Redeemable Convertible Cumulative Preference S
Notes
Partly Convertible Debenture
Perpetual Exchangeable Repurchaseable Listed Share
Preferred Security
Poison Pill Rights
Preference Share
Parallel Line
Redeemable Convertible Secured Loan Stocks
Redeemable Convertible Secured Notes
Receipt
Redemption Rights
Redeemable Shares
Redeemable Optional Convertible Preference Shares
rights
Redeemable Unconvertible Notes
Structured Product
Subscription Receipts
Second Trading Line
Stapled Security
Swap Rate
Tradeable Rights
Tendered Shares Security
Unit Investment Trust
Units
Warrants
When Distributed
When Issued
resultSecurityType string Type of security.
Supported Values:
A BLANK value is possible
Barbados Depository Receipts
Bond
Basket Warrant
Convertible Debenture
Share Depository Certificate
Chess Depository Interest
CEDEAR
Convertible Notes
Conversion
Commodity
Certificate
Convertible Unsecured Loan Stock
Currency
Contingent Value Rights
Covered Warrant
Debenture
Derivatives
Depository Receipts
Distribution Rights
Deferred Settlement Trading
Equity Shares
Exchange Traded Commodities
Exchange Traded Fund
Exchange Traded Notes
Fund
Global Depository Notes
Irredeemable Convertible Loan Stock
Index
Interval Fund
Inflation
Interbank Offered Rate
Letter of Allotment
Unit Trust
Non Convertible Debenture
Non-Redeemable Convertible Cumulative Preference S
Notes
Partly Convertible Debenture
Perpetual Exchangeable Repurchaseable Listed Share
Preferred Security
Poison Pill Rights
Preference Share
Parallel Line
Redeemable Convertible Secured Loan Stocks
Redeemable Convertible Secured Notes
Receipt
Redemption Rights
Redeemable Shares
Redeemable Optional Convertible Preference Shares
rights
Redeemable Unconvertible Notes
Structured Product
Subscription Receipts
Second Trading Line
Stapled Security
Swap Rate
Tradeable Rights
Tendered Shares Security
Unit Investment Trust
Units
Warrants
When Distributed
When Issued
notes string Long description
figi string OpenFIGI id for the symbol
lastUpdated string Date the record was last changed formatted as YYYY-MM-DD
countryCode string Refers to the country code for the symbol using ISO 3166-1 alpha-2
parValue number Par value is the face value of a bond. Par value is important for a bond or fixed-income instrument because it determines its maturity value as well as the dollar value of coupon payments. Par value for a share refers to the stock value stated in the corporate charter.
parValueCurrency string ISO currency code for parValue
refid string Unique id representing the record
created string Date the record was created formatted as YYYY-MM-DD

Security Swap

Obtain up-to-date and detailed information on all new announcements, as well as 12+ years of historical records.

HTTP request

GET /time-series/advanced_security_swap/{symbol?}/{refid?}

JSON response

[
  {
    "symbol": "FCEDX",
    "exDate": "2020-02-07",
    "recordDate": null,
    "paymentDate": null,
    "fromFactor": 0,
    "toFactor": 0,
    "ratio": null,
    "description": "Franklin Select U.S. Equity Fund Class C",
    "flag": "Stock",
    "securityType": "Unit Trust",
    "resultSecurityType": "Unit Trust",
    "notes": "(As on 30/09/2019) <BR>Date 30-Sep-19<BR>Issuer CIK 0000872625<BR>Issuer Name Franklin Strategic Series<BR>Fund Name Franklin Select U.S. Equity Fund Class C",
    "figi": "BBG000QCG970",
    "lastUpdated": "2019-10-01",
    "countryCode": "US",
    "parValue": 0,
    "parValueCurrency": "USD",
    "refid": "5983233",
    "created": "2019-10-01",
    "id": "ADVANCED_SECURITY_SWAP",
    "source": "IEX Cloud",
    "key": "FCEDX",
    "subkey": "5983233",
    "date": 1581033600000,
    "updated": 1574691224000
  }
  // { ... }
]

Data Weighting

75,000 per item returned

Data Timing

End of day

Data Schedule

Updated at 5am, 10am, 8pm UTC daily

Data Source(s)

IEX Cloud

Notes

Only available to paid plans.

Available Methods

GET /time-series/advanced_security_swap/{symbol?}/{refid?}

Examples

Path Parameters

Range Type Description
symbol String Optional.
• Symbol name.
refid String Optional.
• Id that matches the refid field returned in the response object. This allows you to pull a specific event for a symbol.

Response Attributes

Key Type Description
symbol string Symbol of the security
exDate string The date that determines which shareholders will be entitled to receive the issue formatted as YYYY-MM-DD
recordDate string When the company examines its current list of shareholders to determine who will receive the issue. Only those who are registered as shareholders in the company’s books as of the record date will be entitled to receive the issue formatted as YYYY-MM-DD
paymentDate string The date paid to eligible shareholders formatted as YYYY-MM-DD
fromFactor number Number of starting shares
toFactor number Number of ending shares
ratio number fromFactor divided by toFactor
amount number The amount paid.
description string Security description.
flag string The payment type.
Supported Values:
Autocall
Cash&Stock
Cash
DissenterRights
Interest
Maturity
Rebate
Stock
Special
ToBeAnnounced
Blank
securityType string Type of security.
Supported Values:
A BLANK value is possible
Barbados Depository Receipts
Bond
Basket Warrant
Convertible Debenture
Share Depository Certificate
Chess Depository Interest
CEDEAR
Convertible Notes
Conversion
Commodity
Certificate
Convertible Unsecured Loan Stock
Currency
Contingent Value Rights
Covered Warrant
Debenture
Derivatives
Depository Receipts
Distribution Rights
Deferred Settlement Trading
Equity Shares
Exchange Traded Commodities
Exchange Traded Fund
Exchange Traded Notes
Fund
Global Depository Notes
Irredeemable Convertible Loan Stock
Index
Interval Fund
Inflation
Interbank Offered Rate
Letter of Allotment
Unit Trust
Non Convertible Debenture
Non-Redeemable Convertible Cumulative Preference S
Notes
Partly Convertible Debenture
Perpetual Exchangeable Repurchaseable Listed Share
Preferred Security
Poison Pill Rights
Preference Share
Parallel Line
Redeemable Convertible Secured Loan Stocks
Redeemable Convertible Secured Notes
Receipt
Redemption Rights
Redeemable Shares
Redeemable Optional Convertible Preference Shares
rights
Redeemable Unconvertible Notes
Structured Product
Subscription Receipts
Second Trading Line
Stapled Security
Swap Rate
Tradeable Rights
Tendered Shares Security
Unit Investment Trust
Units
Warrants
When Distributed
When Issued
resultSecurityType string Type of security.
Supported Values:
A BLANK value is possible
Barbados Depository Receipts
Bond
Basket Warrant
Convertible Debenture
Share Depository Certificate
Chess Depository Interest
CEDEAR
Convertible Notes
Conversion
Commodity
Certificate
Convertible Unsecured Loan Stock
Currency
Contingent Value Rights
Covered Warrant
Debenture
Derivatives
Depository Receipts
Distribution Rights
Deferred Settlement Trading
Equity Shares
Exchange Traded Commodities
Exchange Traded Fund
Exchange Traded Notes
Fund
Global Depository Notes
Irredeemable Convertible Loan Stock
Index
Interval Fund
Inflation
Interbank Offered Rate
Letter of Allotment
Unit Trust
Non Convertible Debenture
Non-Redeemable Convertible Cumulative Preference S
Notes
Partly Convertible Debenture
Perpetual Exchangeable Repurchaseable Listed Share
Preferred Security
Poison Pill Rights
Preference Share
Parallel Line
Redeemable Convertible Secured Loan Stocks
Redeemable Convertible Secured Notes
Receipt
Redemption Rights
Redeemable Shares
Redeemable Optional Convertible Preference Shares
rights
Redeemable Unconvertible Notes
Structured Product
Subscription Receipts
Second Trading Line
Stapled Security
Swap Rate
Tradeable Rights
Tendered Shares Security
Unit Investment Trust
Units
Warrants
When Distributed
When Issued
notes string Long description
figi string OpenFIGI id for the symbol
lastUpdated string Date the record was last changed formatted as YYYY-MM-DD
countryCode string Refers to the country code for the symbol using ISO 3166-1 alpha-2
parValue number Par value is the face value of a bond. Par value is important for a bond or fixed-income instrument because it determines its maturity value as well as the dollar value of coupon payments. Par value for a share refers to the stock value stated in the corporate charter.
parValueCurrency string ISO currency code for parValue
refid string Unique id representing the record
created string Date the record was created formatted as YYYY-MM-DD

Spinoff

Obtain up-to-date and detailed information on all new announcements, as well as 12+ years of historical records.

HTTP request

GET /time-series/advanced_spinoff/{symbol?}/{refid?}

JSON response

[
  {
    "symbol": "REPH",
    "exDate": "2019-11-22",
    "recordDate": "2019-11-15",
    "paymentDate": "2019-11-21",
    "withdrawalFromDate": null,
    "withdrawalToDate": null,
    "electionDate": null,
    "effectiveDate": null,
    "minPrice": 0,
    "maxPrice": 0,
    "description": "Ordinary Shares",
    "flag": "Stock",
    "securityType": "Equity Shares",
    "hasWithdrawalRights": 1,
    "currency": "",
    "notes": "(As on 05/11/19) USNWDIVS<BR>Recro Pharma `s Board of Directors Approves Separation of Acute Care Business Segment and Declares Special Dividend Distribution of Baudax Bio Common Stock<BR>2019-11-05 07:00 ET - News Release<BR>MALVERN, Pa., Nov. 05, 2019 (GLOBE NEWSWIRE) -- Recro Pharma, Inc. (NASDAQ:REPH), a specialty pharmaceutical company with a high-performing revenue generating contract development and manufacturing (CDMO) division, today announced that its board of directors has approved the planned spin-off of its Acute Care business segment, which will be known as Baudax Bio, Inc. and declared a special dividend distribution of all outstanding shares of Baudax Bio common stock.<BR>For every two and one half (2.5) shares of Recro common stock held of record as of the close of business on November 15, 2019, Recro shareholders will receive one (1) share of Baudax Bio common stock.  Shareholders will receive cash in lieu of fractional shares.  The special dividend distribution is expected to be paid on November 21, 2019.<BR>The distribution of Baudax Bio common stock will complete the separation of the Acute Care business segment from Recro. After the separation, Baudax Bio will become an independent, publicly-traded company focused on developing and commercializing innovative products for hospital and related acute care settings, and Recro will retain no ownership interest. Baudax Bio has applied for listing of its common stock on the NASDAQ Capital Market under the ticker symbol `BXRX.`<BR>The stock dividend distribution is subject to, among other conditions, the U.S. Securities and Exchange Commission (SEC) having declared effective Baudax Bio`s Registration Statement on Form 10, as amended, which Baudax Bio has filed with the SEC. The Registration Statement includes information regarding the details of the spin-off and Baudax Bio`s business. <BR>No action is required by Recro shareholders to receive shares of Baudax Bio common stock as part of this special dividend distribution. Any holder of Recro common stock who sells shares of Recro common stock on or before the distribution date may be selling the entitlement to receive shares of Baudax Bio common stock.<BR>",
    "figi": "BBG005H82125",
    "lastUpdated": "2019-11-22",
    "countryCode": "US",
    "parValue": 0.01,
    "parValueCurrency": "USD",
    "refid": "6053355",
    "created": "2019-11-05",
    "id": "ADVANCED_SPINOFF",
    "source": "IEX Cloud",
    "key": "REPH",
    "subkey": "6053355",
    "date": 1574380800000,
    "updated": 1574690765000
  }
  // { ... }
]

Data Weighting

75,000 per item returned

Data Timing

End of day

Data Schedule

Updated at 5am, 10am, 8pm UTC daily

Data Source(s)

IEX Cloud

Notes

Only available to paid plans.

Available Methods

GET /time-series/advanced_spinoff/{symbol?}/{refid?}

Examples

Path Parameters

Range Type Description
symbol String Optional.
• Symbol name.
refid String Optional.
• Id that matches the refid field returned in the response object. This allows you to pull a specific event for a symbol.

Response Attributes

Key Type Description
symbol string Symbol of the security
exDate string The date that determines which shareholders will be entitled to receive the issue, formatted as YYYY-MM-DD
recordDate string When the company examines its current list of shareholders to determine who will receive the issue. Only those who are registered as shareholders in the company’s books as of the record date will be entitled to receive the issue, formatted as YYYY-MM-DD
paymentDate string The date paid to eligible shareholders, formatted as YYYY-MM-DD
withdrawalFromDate string YYYY-MM-DD
withdrawalToDate string YYYY-MM-DD
electionDate string YYYY-MM-DD
effectiveDate string YYYY-MM-DD
minPrice number Minimum price
maxPrice number Maximum price
description string Security description.
flag string The payment type.
Supported Values:
Autocall
Cash&Stock
Cash
DissenterRights
Interest
Maturity
Rebate
Stock
Special
ToBeAnnounced
Blank
securityType string Type of security.
Supported Values:
A BLANK value is possible
Barbados Depository Receipts
Bond
Basket Warrant
Convertible Debenture
Share Depository Certificate
Chess Depository Interest
CEDEAR
Convertible Notes
Conversion
Commodity
Certificate
Convertible Unsecured Loan Stock
Currency
Contingent Value Rights
Covered Warrant
Debenture
Derivatives
Depository Receipts
Distribution Rights
Deferred Settlement Trading
Equity Shares
Exchange Traded Commodities
Exchange Traded Fund
Exchange Traded Notes
Fund
Global Depository Notes
Irredeemable Convertible Loan Stock
Index
Interval Fund
Inflation
Interbank Offered Rate
Letter of Allotment
Unit Trust
Non Convertible Debenture
Non-Redeemable Convertible Cumulative Preference S
Notes
Partly Convertible Debenture
Perpetual Exchangeable Repurchaseable Listed Share
Preferred Security
Poison Pill Rights
Preference Share
Parallel Line
Redeemable Convertible Secured Loan Stocks
Redeemable Convertible Secured Notes
Receipt
Redemption Rights
Redeemable Shares
Redeemable Optional Convertible Preference Shares
rights
Redeemable Unconvertible Notes
Structured Product
Subscription Receipts
Second Trading Line
Stapled Security
Swap Rate
Tradeable Rights
Tendered Shares Security
Unit Investment Trust
Units
Warrants
When Distributed
When Issued
hasWithdrawalRights boolean 0 or 1
currency string ISO currency code for the amount
notes string Long description
figi string OpenFIGI id for the symbol
lastUpdated string Date the record was last changed, formatted as YYYY-MM-DD
countryCode string Refers to the country code for the symbol using ISO 3166-1 alpha-2
parValue number Par value is the face value of a bond. Par value is important for a bond or fixed-income instrument because it determines its maturity value as well as the dollar value of coupon payments. Par value for a share refers to the stock value stated in the corporate charter.
parValueCurrency string ISO currency code for parValue
refid string Unique id representing the record
created string Date the record was created, formatted as YYYY-MM-DD

Splits

Obtain up-to-date and detailed information on all new announcements, as well as 12+ years of historical records.

HTTP request

GET /time-series/advanced_splits/{symbol?}/{refid?}

JSON response

[
  {
    "symbol": "CRPYF",
    "exDate": "2020-01-15",
    "recordDate": "2020-01-14",
    "paymentDate": "2020-01-15",
    "fromFactor": 10,
    "toFactor": 1,
    "ratio": 10,
    "description": "Ordinary Shares",
    "splitType": "Reverse Split",
    "flag": "Stock",
    "securityType": "Equity Shares",
    "notes": "(As on 07/11/2019) ZAJSE<BR>Share Consolidation<BR>It is intendVd tha:t following completion of the Proposed Transaction, the Company s issued share capital will be consolidated on the basis of 10 Ordinary Shares of 1 pence each for 1 new ordinary share of 10 pence (a  Consolidated Ordinary Share ), by reference to the Capital & Regional Shares in issue at 6.00 p.m. on 14 January 2020 on the UK Register",
    "figi": "BBG000CQTXJ4",
    "lastUpdated": "2019-11-08",
    "countryCode": "US",
    "parValue": 0.01,
    "parValueCurrency": "GBP",
    "oldParValue": 0.01,
    "oldParValueCurrency": "GBP",
    "refid": "6057319",
    "created": "2019-11-07",
    "id": "ADVANCED_SPLITS",
    "source": "IEX Cloud",
    "key": "CRPYF",
    "subkey": "6057319",
    "date": 1579046400000,
    "updated": 1574689890000
  }
  // { ... }
]

Data Weighting

75,000 per item returned

Data Timing

End of day

Data Schedule

Updated at 5am, 10am, 8pm UTC daily

Data Source(s)

IEX Cloud

Notes

Only available to paid plans.

Available Methods

GET /time-series/advanced_splits/{symbol?}/{refid?}

Examples

Path Parameters

Range Type Description
symbol String Optional.
• Symbol name.
refid String Optional.
• Id that matches the refid field returned in the response object. This allows you to pull a specific event for a symbol.

Response Attributes

Key Type Description
symbol string Symbol of the security
exDate string The date that determines which shareholders will be entitled to receive the issue, formatted as YYYY-MM-DD
recordDate string When the company examines its current list of shareholders to determine who will receive the issue. Only those who are registered as shareholders in the company’s books as of the record date will be entitled to receive the issue, formatted as YYYY-MM-DD
paymentDate string The date paid to eligible shareholders, formatted as YYYY-MM-DD
fromFactor number Number of starting shares
toFactor number Number of ending shares
ratio number fromFactor divided by toFactor
description string Security description.
splitType string Type of split
Supported Values:
Split
Reverse Split
flag string The payment type.
Supported Values:
Autocall
Cash&Stock
Cash
DissenterRights
Interest
Maturity
Rebate
Stock
Special
ToBeAnnounced
Blank
securityType string Type of security.
Supported Values:
A BLANK value is possible
Barbados Depository Receipts
Bond
Basket Warrant
Convertible Debenture
Share Depository Certificate
Chess Depository Interest
CEDEAR
Convertible Notes
Conversion
Commodity
Certificate
Convertible Unsecured Loan Stock
Currency
Contingent Value Rights
Covered Warrant
Debenture
Derivatives
Depository Receipts
Distribution Rights
Deferred Settlement Trading
Equity Shares
Exchange Traded Commodities
Exchange Traded Fund
Exchange Traded Notes
Fund
Global Depository Notes
Irredeemable Convertible Loan Stock
Index
Interval Fund
Inflation
Interbank Offered Rate
Letter of Allotment
Unit Trust
Non Convertible Debenture
Non-Redeemable Convertible Cumulative Preference S
Notes
Partly Convertible Debenture
Perpetual Exchangeable Repurchaseable Listed Share
Preferred Security
Poison Pill Rights
Preference Share
Parallel Line
Redeemable Convertible Secured Loan Stocks
Redeemable Convertible Secured Notes
Receipt
Redemption Rights
Redeemable Shares
Redeemable Optional Convertible Preference Shares
rights
Redeemable Unconvertible Notes
Structured Product
Subscription Receipts
Second Trading Line
Stapled Security
Swap Rate
Tradeable Rights
Tendered Shares Security
Unit Investment Trust
Units
Warrants
When Distributed
When Issued
notes string Long description
figi string OpenFIGI id for the symbol
lastUpdated string Date the record was last changed, formatted as YYYY-MM-DD
countryCode string Refers to the country code for the symbol using ISO 3166-1 alpha-2
parValue number Par value is the face value of a bond. Par value is important for a bond or fixed-income instrument because it determines its maturity value as well as the dollar value of coupon payments. Par value for a share refers to the stock value stated in the corporate charter.
parValueCurrency string ISO currency code for parValue
oldParValue number Par value is the face value of a bond. Par value is important for a bond or fixed-income instrument because it determines its maturity value as well as the dollar value of coupon payments. Par value for a share refers to the stock value stated in the corporate charter.
oldParValueCurrency string ISO currency code for parValue
refid string Unique id representing the record
created string Date the record was created, formatted as YYYY-MM-DD

Market Info

Collections

Returns an array of quote objects for a given collection type. Currently supported collection types are sector, tag, and list

HTTP request

GET /stock/market/collection/{collectionType}

JSON response

[
    quote,
    ...
]

Data Weighting

Weight of /stock/quote per quote returned

Examples

Query String Parameters

Option Details
collectionName Required.
• Name of the sector, tag, or list to return and is case sensitive.
• Supported lists can be found under the list section.
• Supported sectors can be found in the sector ref data.
• Supported tags can be found in the tag ref data.
* You must URL encode the collection name before sending

Response Attributes

Key Type Description
quote object See the quote section.

Earnings Today

Returns earnings that will be reported today as three arrays: before the open bto, after market close amc and during the trading day other. Each array contains an object with all keys from earnings, a quote object, and a headline key.

HTTP request

GET /stock/market/today-earnings

JSON response

{
  "bto": [
    {
        "consensusEPS": "-0.03",
        "announceTime": "BTO",
        "numberOfEstimates": 4,
        "fiscalPeriod": "Q4 2018",
        "fiscalEndDate": "2018-12-31",
        "symbol": "Z",
        "quote": {
          ...
        },
    },
    ...
  ],
  "amc": [
    {
        "consensusEPS": "-0.03",
        "announceTime": "AMC",
        "numberOfEstimates": 4,
        "fiscalPeriod": "Q4 2018",
        "fiscalEndDate": "2018-12-31",
        "symbol": "NBEV",
        "quote": {
          ...
        },
    },
    ...
  ],
  "dmt": []
}

Data Weighting

1000 per symbol returned + 1 per quote returned

Data Timing

End of day

Data Schedule

Updates at 9am, 11am, 12pm UTC daily

Data Source(s)

IEX Cloud

Available Methods

GET /stock/market/today-earnings

Examples

Response Attributes

Key Type Description
actualEPS number Actual earnings per share for the period
consensusEPS number Consensus EPS estimate trend for the period
announceTime string Time of earnings announcement. BTO (Before open), DMT (During trading or if the time is unknown), AMC (After close)
numberOfEstimates number Number of estimates for the period
EPSSurpriseDollar number Dollar amount of EPS surprise for the period
EPSReportDate string Expected earnings report date YYYY-MM-DD
fiscalPeriod string The fiscal quarter the earnings data applies to Q# YYYY
fiscalEndDate string Date representing the company fiscal quarter end YYYY-MM-DD
yearAgo number Represents the EPS of the quarter a year ago
yearAgoChangePercent number Represents the percent difference between the quarter a year ago actualEPS and current period actualEPS. Returned as a decimal – for example a 13% decline is returned as –0.13.
estimatedChangePercent number Represents the percent difference between the quarter a year ago actualEPS and current period consensusEPS
symbol string The symbol the earning relates to
quote object See quote

IPO Calendar

This returns a list of upcoming or today IPOs scheduled for the current and next month. The response is split into two structures: rawData and viewData. rawData represents all available data for an IPO. viewData represents data structured for display to a user.

HTTP request

GET /stock/market/upcoming-ipos
GET /stock/market/today-ipos

JSON response

{
  "rawData": [
    {
      "symbol": "VCNX",
      "companyName": "VACCINEX, INC.",
      "expectedDate": "2018-08-09",
      "leadUnderwriters": [
        "BTIG, LLC",
        "Oppenheimer & Co. Inc."
      ],
      "underwriters": [
        "Ladenburg Thalmann & Co. Inc."
      ],
      "companyCounsel": [
        "Hogan Lovells US LLP and Harter Secrest & Emery LLP"
      ],
      "underwriterCounsel": [
        "Mintz, Levin, Cohn, Ferris, Glovsky and Popeo, P.C."
      ],
      "auditor": "Computershare Trust Company, N.A",
      "market": "NASDAQ Global",
      "cik": "0001205922",
      "address": "1895 MOUNT HOPE AVE",
      "city": "ROCHESTER",
      "state": "NY",
      "zip": "14620",
      "phone": "585-271-2700",
      "ceo": "Maurice Zauderer",
      "employees": 44,
      "url": "www.vaccinex.com",
      "status": "Filed",
      "sharesOffered": 3333000,
      "priceLow": 12,
      "priceHigh": 15,
      "offerAmount": null,
      "totalExpenses": 2400000,
      "sharesOverAlloted": 499950,
      "shareholderShares": null,
      "sharesOutstanding": 11474715,
      "lockupPeriodExpiration": "",
      "quietPeriodExpiration": "",
      "revenue": 206000,
      "netIncome": -7862000,
      "totalAssets": 4946000,
      "totalLiabilities": 6544000,
      "stockholderEquity": -133279000,
      "companyDescription": "",
      "businessDescription": "",
      "useOfProceeds": "",
      "competition": "",
      "amount": 44995500,
      "percentOffered": "29.05"
    },
    // { ... }
  ],
  "viewData": [
    {
      "Company": "VACCINEX, INC.",
      "Symbol": "VCNX",
      "Price": "$12.00 - 15.00",
      "Shares": "3,333,000",
      "Amount": "44,995,500",
      "Float": "11,474,715",
      "Percent": "29.05%",
      "Market": "NASDAQ Global",
      "Expected": "2018-08-09"
    },
    // { ... }
  ]
}

Data Weighting

100 per IPO returned for upcoming-ipos
500 per IPO returned for today-ipos

Data Timing

End of day

Data Schedule

10am, 10:30am UTC daily

Data Source(s)

IEX Cloud

Notes

Only included with paid subscription plans

Available Methods

GET /stock/market/upcoming-ipos
GET /stock/market/today-ipos

Examples

Response Attributes

Key Type Description
symbol string Refers to the IPO symbol.
companyName string Refers to the name of the IPO company.
expectedDate string Refers to the date the IPO is expected to start trading.
leadUnderwriters array Refers to the list of investment banks leading the IPO.
underwriters array Refers to the list of investment banks underwriting the IPO.
companyCounsel array Refers to the list of legal firms representing the company.
underwriterCounsel array Refers to the list of legal firms representing the underwriter.
auditor string Refers to the auditing firm for the company.
market string Refers to the exchange listing the IPO.
cik string Refers to the unique identifier for this data set, the Central Index Key (“CIK”) is used to identify entities that are regulated by the Securities and Exchange Commission (“SEC”).
address string Refers to the company address.
city string Refers to the company city.
state string Refers to the company state.
zip string Refers to the company zip code.
phone string Refers to the company phone number.
ceo string Refers to the name of the company CEO.
employees number Refers to the number of employees in the company.
url string Refers to the URL of the company website.
status string Refers to the filing status of the SEC Form S-1.
sharesOffered number Refers to the number of shares offered in the IPO.
priceLow number Refers to the low end estimate of IPO share price. On the day of the IPO, this will be the syndicate price which is used similarly to previousClose to determine change versus current price.
priceHigh number Refers to the high end estimate of IPO share price. On the day of the IPO, this value may be null.
offerAmount number Refers to the notional value of the IPO in dollars.
totalExpenses number Refers to company total expenses in dollars.
sharesOverAlloted number Refers to number of shares alloted by underwriters in excess of IPO offering.
shareholderShares number Refers to number of shares offered by existing shareholders.
sharesOutstanding number Refers to the total number of company shares outstanding.
lockupPeriodExpiration string Refers to the date of insider lockup period expiration.
quietPeriodExpiration string Refers to the date following IPO when company quiet period expires.
revenue number Refers to company revenue in dollars.
netIncome number Refers to company net income in dollars.
totalAssets number Refers to company total assets in dollars.
totalLiabilities number Refers to company total liabilities in dollars.
stockholderEquity number Refers to stock holder equity in dollars.
companyDescription string Description of the company.
businessDescription string Description of the company’s business.
useOfProceeds string Description of the company’s planned use of proceeds from the IPO.
competition string Description of the company’s competition.
amount number Refers to the notional value of shares offered * average share price in dollars.
percentOffered string Refers to the percent of outstanding shares being offered as a whole number.
Company string Same as companyName
Symbol string Same as symbol
Price string Formatted as $priceLow - priceHigh
Shares string Same as sharesOffered
Amount string Same as amount
Float string Same as sharesOutstanding
Percent string Same as percentOffered
Market string Same as market
Expected string Same as expectedDate

List

Returns an array of quotes for the top 10 symbols in a specified list.

Requirements for being on a list:


HTTP request

GET /stock/market/list/{list-type}

JSON response

// Array of quotes
[
     {
      "symbol": "SHLL",
      "companyName": "Tortoise Acquisition Corp.",
      "primaryExchange": "New York Stock Exchange",
      "calculationPrice": "close",
      "open": 19.39,
      "openTime": 1593178209955,
      "openSource": "official",
      "close": 24.57,
      // ...
    },
    // { ... }
]

Data Weighting

Weight of /stock/quote for each quote returned in the list

Data Timing

Real-time
15 minute delayed

Data Schedule

Updated intraday

Data Source(s)

Investors Exchange Consolidated Tape

Available Methods

GET /stock/market/list/{list-type}

Examples

Query String Parameters

Option Details
displayPercent Optional.
• If set to true, all percentage values will be multiplied by a factor of 100 (Ex: /stock/aapl/quote?displayPercent=true)
listLimit Optional.
• Number of items to return, defaults to 10

Response Attributes

Refer to the quote section.

Market Volume (U.S.)

This endpoint returns real time traded volume on U.S. markets.

HTTP request

GET /stock/market/volume

JSON response

[
  {
    "mic": "TRF",
    "tapeId": "-",
    "venueName": "TRF Volume",
    "volume": 589171705,
    "tapeA": 305187928,
    "tapeB": 119650027,
    "tapeC": 164333750,
    "marketPercent": 0.37027,
    "lastUpdated": 1480433817317
  },
  {
    "mic": "XNGS",
    "tapeId": "Q",
    "venueName": "NASDAQ",
    "volume": 213908393,
    "tapeA": 90791123,
    "tapeB": 30731818,
    "tapeC": 92385452,
    "marketPercent": 0.13443,
    "lastUpdated": 1480433817311
  },
  {
    "mic": "XNYS",
    "tapeId": "N",
    "venueName": "NYSE",
    "volume": 204280163,
    "tapeA": 204280163,
    "tapeB": 0,
    "tapeC": 0,
    "marketPercent": 0.12838,
    "lastUpdated": 1480433817336
  },
  {
    "mic": "ARCX",
    "tapeId": "P",
    "venueName": "NYSE Arca",
    "volume": 180301371,
    "tapeA": 64642458,
    "tapeB": 78727208,
    "tapeC": 36931705,
    "marketPercent": 0.11331,
    "lastUpdated": 1480433817305
  },
  {
    "mic": "EDGX",
    "tapeId": "K",
    "venueName": "EDGX",
    "volume": 137022822,
    "tapeA": 58735505,
    "tapeB": 32753903,
    "tapeC": 45533414,
    "marketPercent": 0.08611,
    "lastUpdated": 1480433817310
  },
  {
    "mic": "BATS",
    "tapeId": "Z",
    "venueName": "BATS BZX",
    "volume": 100403461,
    "tapeA": 52509859,
    "tapeB": 25798360,
    "tapeC": 22095242,
    "marketPercent": 0.0631,
    "lastUpdated": 1480433817311
  },
  {
    "mic": "BATY",
    "tapeId": "Y",
    "venueName": "BATS BYX",
    "volume": 54413196,
    "tapeA": 28539960,
    "tapeB": 13638779,
    "tapeC": 12234457,
    "marketPercent": 0.03419,
    "lastUpdated": 1480433817310
  },
  {
    "mic": "XBOS",
    "tapeId": "B",
    "venueName": "NASDAQ BX",
    "volume": 31417461,
    "tapeA": 16673166,
    "tapeB": 5875538,
    "tapeC": 8868757,
    "marketPercent": 0.01974,
    "lastUpdated": 1480433817311
  },
  {
    "mic": "EDGA",
    "tapeId": "J",
    "venueName": "EDGA",
    "volume": 30670687,
    "tapeA": 15223428,
    "tapeB": 8276375,
    "tapeC": 7170884,
    "marketPercent": 0.01927,
    "lastUpdated": 1480433817311
  },
  {
    "mic": "IEXG",
    "tapeId": "V",
    "venueName": "IEX",
    "volume": 26907838,
    "tapeA": 16578501,
    "tapeB": 3889245,
    "tapeC": 6440092,
    "marketPercent": 0.01691,
    "lastUpdated": 1480433817235
  },
  {
    "mic": "XPHL",
    "tapeId": "X",
    "venueName": "NASDAQ PSX",
    "volume": 13334403,
    "tapeA": 5802294,
    "tapeB": 4239741,
    "tapeC": 3292368,
    "marketPercent": 0.00838,
    "lastUpdated": 1480433817071
  },
  {
    "mic": "XCHI",
    "tapeId": "M",
    "venueName": "CHX",
    "volume": 4719854,
    "tapeA": 834762,
    "tapeB": 3168434,
    "tapeC": 716658,
    "marketPercent": 0.00296,
    "lastUpdated": 1480433814711
  },
  {
    "mic": "XASE",
    "tapeId": "A",
    "venueName": "NYSE MKT",
    "volume": 4419196,
    "tapeA": 0,
    "tapeB": 4419196,
    "tapeC": 0,
    "marketPercent": 0.00277,
    "lastUpdated": 1480433816276
  },
  {
    "mic": "XCIS",
    "tapeId": "C",
    "venueName": "NSX",
    "volume": 187785,
    "tapeA": 39923,
    "tapeB": 62191,
    "tapeC": 85671,
    "marketPercent": 0.00011,
    "lastUpdated": 1480433816141
  }
]

Data Weighting

1 per call

Data Timing

Real-time

Data Schedule

7:45am-5:15pm ET Mon-Fri

Data Source(s)

IEX Cloud Consolidated Tape

Available Methods

GET /stock/market/volume

Examples

Query String Parameters

Option Details
format Optional.
• Value can only be csv
• When parameter is not present, format defaults to JSON

Response Attributes

Key Description
mic Refers to the Market Identifier Code (MIC).
tapeId Refers to the tape id of the venue.
venueName Refers to name of the venue defined by IEX.
volume Refers to the amount of traded shares reported by the venue.
tapeA Refers to the amount of Tape A traded shares reported by the venue.
tapeB Refers to the amount of Tape B traded shares reported by the venue.
tapeC Refers to the amount of Tape C traded shares reported by the venue.
marketPercent Refers to the venue’s percentage of shares traded in the market.
lastUpdated Refers to the last update time of the data in milliseconds since midnight Jan 1, 1970.

Sector Performance

This returns an array of each sector and performance for the current trading day. Performance is based on each sector ETF.

HTTP request

GET /stock/market/sector-performance

JSON response

[
  {
    "type": "sector",
    "name": "Industrials",
    "performance": 0.00711,
    "lastUpdated": 1533672000437
  },
  ...
]

Data Weighting

1 per sector

Data Timing

Real-time 15min delayed

Data Schedule

8am-5pm ET Mon-Fri

Data Source(s)

IEX Cloud

Notes

Only included with paid subscription plans

Available Methods

GET /stock/market/sector-performance

Examples

Response Attributes

Key Type Description
type string The type of performance data return. Should always be sector
name string The name of the sector
performance number Change percent of the sector for the trading day.
lastUpdated number Last updated time of the performance metric represented as millisecond epoch.

Upcoming Events

This will return all upcoming estimates, dividends, splits for a given symbol or the market. If market is passed for the symbol, IPOs will also be included.

HTTP request

GET /stock/{symbol}/upcoming-events
GET /stock/{symbol}/upcoming-earnings
GET /stock/{symbol}/upcoming-dividends
GET /stock/{symbol}/upcoming-splits
GET /stock/{symbol}/upcoming-ipos

JSON response

// If symbol is specified
{
    "earnings": [],
    "dividends": [],
    "splits": []
}


// If symbol is market
{
    "ipos": {
        "rawData": [],
        "viewData": []
    },
    "earnings": [],
    "dividends": [],
    "splits": []
}

Data Weighting

Weight is equal to the number of items return by each type. estimates, dividends, splits, ipos

By default, earnings will only return symbol and reportDate for a weight of 5 for each item. If you use fullUpcomingEarnings parameter, the full estimates object is returned for the full weight.

Data Timing

Timing based on each type

Data Schedule

Schedule of each type

Data Source(s)

IEX Cloud

Notes

Only included with paid subscription plans

Available Methods

GET /stock/{symbol}/upcoming-events
GET /stock/{symbol}/upcoming-dividends
GET /stock/{symbol}/upcoming-splits
GET /stock/{symbol}/upcoming-earnings
GET /stock/{symbol}/upcoming-ipos

Examples

Query String Parameters

Option Details
fullUpcomingEarnings Boolean. If set to true and passed to upcoming-events or upcoming-earnings, it will return the full estimate object at the full estimate weight. This can cause the call to be in the millions of messages.

Response Attributes

Response is an object with each item being an array of objects matching the type of data returned.

News

News

Provides intraday news from over 3,000 global news sources including major publications, regional media, and social.. This endpoint returns up to the last 50 articles. Use the historical news endpoint to fetch news as far back as January 2019

HTTP request

GET /stock/{symbol}/news/last/{last}

JSON response

[
  {
    "datetime": 1545215400000,
    "headline": "Voice Search Technology Creates A New Paradigm For Marketers",
    "source": "Benzinga",
    "url": "https://cloud.iexapis.com/stable/news/article/8348646549980454",
    "summary": "<p>Voice search is likely to grow by leap and bounds, with technological advancements leading to better adoption and fueling the growth cycle, according to Lindsay Boyajian, <a href=\"http://loupventures.com/how-the-future-of-voice-search-affects-marketers-today/\">a guest contributor at Loup Ventu...",
    "related": "AAPL,AMZN,GOOG,GOOGL,MSFT",
    "image": "https://cloud.iexapis.com/stable/news/image/7594023985414148",
    "lang": "en",
    "hasPaywall": true
  }
]

SSE Example

curl --header 'Accept: text/event-stream' https://cloud-sse.iexapis.com/stable/news-stream\?symbols\=aapl\&token\=YOUR_TOKEN

Data Weighting

1 per symbol per news item returned

Data Timing

Intraday

Data Schedule

Continuous

Data Source(s)

CityFalcon

Available Methods

GET /stock/{symbol}/news
GET /stock/{symbol}/news/last/{last}

Examples

Path Parameters

Option Description
symbol A stock symbol
last Number between 1 and 50. Default is 10. (i.e. .../news/last/1)

Response Attributes

Key Type Description
datetime number  Millisecond epoch of time of article
headline string 
source string  Source of the news article. Make sure to always attribute the source.
url string  URL to IEX Cloud for associated news image. Note: You will need to append your token before calling.
summary string 
related string  Comma-delimited list of tickers associated with this news article. Not all tickers are available on the API. Make sure to check against available ref-data
image string  URL to IEX Cloud for associated news image. Note: You will need to append your token before calling.
lang string  Language of the source article
hasPaywall boolean  Whether the news source has a paywall

Streaming News

This endpoint provides streaming news sourced from over 3,000 global news sources including major publications, regional media, and social.

SSE Streaming Example (Paid subscriptions only)

curl --header 'Accept: text/event-stream' 'https://cloud-sse.iexapis.com/stable/news-stream?token=YOUR_TOKEN&symbols=spy'

SSE Firehose - All News (Scale subscriptions only)

curl --header 'Accept: text/event-stream' 'https://cloud-sse.iexapis.com/stable/news-stream?token=YOUR_TOKEN'

JSON response

{
    "datetime": 1545215400000,
    "headline": "Voice Search Technology Creates A New Paradigm For Marketers",
    "source": "Benzinga",
    "url": "https://cloud.iexapis.com/stable/news/article/8348646549980454",
    "summary": "<p>Voice search is likely to grow by leap and bounds, with technological advancements leading to better adoption and fueling the growth cycle, according to Lindsay Boyajian, <a href=\"http://loupventures.com/how-the-future-of-voice-search-affects-marketers-today/\">a guest contributor at Loup Ventu...",
    "related": "AAPL,AMZN,GOOG,GOOGL,MSFT",
    "image": "https://cloud.iexapis.com/stable/news/image/7594023985414148",
    "lang": "en",
    "hasPaywall": true
}

Data Weighting

1 per symbol per update

Data Timing

Real-time

Data Schedule

Continous

Data Source(s)

CityFalcon

Notes

Only included with paid subscription plans
Firehose streaming of all news only available to Scale plans.

Query Parameters

Parameter Description
symbols Valid symbol

Response Attributes

Key Type Description
datetime number  Millisecond epoch of time of article
headline string 
source string  Source of the news article. Make sure to always attribute the source.
url string  URL to IEX Cloud for associated news image. Note: You will need to append your token before calling.
summary string 
related string  Comma-delimited list of tickers associated with this news article. Not all tickers are available on the API. Make sure to check against available ref-data
image string  URL to IEX Cloud for associated news image. Note: You will need to append your token before calling.
lang string  Language of the source article
hasPaywall boolean  Whether the news source has a paywall

Historical News

Historical news from January 2019 forward. Uses the time series endpoint to provide news across the market or by symbol using any type of supported range.

HTTP request

GET /time-series/news/{?symbol}

JSON response

[
  {
    "datetime": 1545215400000,
    "headline": "Voice Search Technology Creates A New Paradigm For Marketers",
    "source": "Benzinga",
    "url": "https://cloud.iexapis.com/stable/news/article/8348646549980454",
    "summary": "<p>Voice search is likely to grow by leap and bounds, with technological advancements leading to better adoption and fueling the growth cycle, according to Lindsay Boyajian, <a href=\"http://loupventures.com/how-the-future-of-voice-search-affects-marketers-today/\">a guest contributor at Loup Ventu...",
    "related": "AAPL,AMZN,GOOG,GOOGL,MSFT",
    "image": "https://cloud.iexapis.com/stable/news/image/7594023985414148",
    "lang": "en",
    "hasPaywall": true,
    "qmUrl": "https://source.url",
    "imageUrl": "https://image.url",
    "id": "NEWS",
    "key": "AAPL",
    "subkey": "7160327-cd7f-4d09-ae83-1c1d66fec8e3",
    "date": 1572161210000,
    "updated": 1573132090000
  }
]

Data Weighting

5,000 per news item returned

Data Timing

Intraday EOD

Data Schedule

Continuous

Data Source(s)

CityFalcon

Available Methods

GET /time-series/news/{?symbol}

Examples

Path Parameters

Option Description
symbol Optional.
• Valid symbol

Query Parameters

All query parameters supported by time series

Response Attributes

Key Type Description
datetime number  Millisecond epoch of time of article
headline string 
source string  Source of the news article. Make sure to always attribute the source.
url string  URL to IEX Cloud for associated news image. Note: You will need to append your token before calling.
summary string 
related string  Comma-delimited list of tickers associated with this news article. Not all tickers are available on the API. Make sure to check against available ref-data
image string  URL to IEX Cloud for associated news image. Note: You will need to append your token before calling.
lang string  Language of the source article
hasPaywall boolean  Whether the news source has a paywall
qmUrl string Source article url
imageUrl string Source image url

Cryptocurrency

Cryptocurrency Book

This returns a current snapshot of the book for a specified cryptocurrency. For REST, you will receive a current snapshot of the current book for the specific cryptocurrency. For SSE Streaming, you will get a full representation of the book updated as often as the book changes. Examples of each are below:

REST

HTTP request

GET /crypto/{symbol}/book

JSON response

{
  "bids": [
    {
      "price": "10120.04000000",
      "size": "0.48604100",
      "timestamp": 1566407875440
    }
  ],
  "asks": [
    {
      "price": "10121.22000000",
      "size": "0.00847400",
      "timestamp": 1566407875440
    }
  ]
}

SSE Streaming

HTTP request (SSE Streaming)

GET https://cloud-sse.iexapis.com/stable/cryptoBook?symbols={symbol}&token={YOUR_TOKEN}

curl SSE example

curl --header 'Accept: text/event-stream' https://cloud-sse.iexapis.com/stable/cryptoBook\?symbols\=btcusd\&token\=YOUR_TOKEN

JSON response (SSE)

[
  {
    "bid":[
      {
        "price":"0.01",
        "size":"112041.1",
        "timestamp":1566226856910
      },
      {
        "price":"0.02",
        "size":"17960",
        "timestamp":1566226856910
      },
      ...
    ],
    "symbol":"BTCUSD",
    "ask":[
      {
        "price":"10847.07",
        "size":"0.00003975",
        "timestamp":1566226861013
      },
      {
        "price":"10849.63",
        "size":"0.00003975",
        "timestamp":1566226861017
      },
      ...
    ]
  }
]

Data Weighting

10 per symbol per update

Data Timing

Real-time

Data Schedule

continuous

Data Source(s)

Gemini Bitstamp Crypto Provider

Examples

REST

SSE Streaming

Path Parameters

Option Details
symbol Valid cryptocurrency symbol

Response Attributes

Key Type Description
symbol string The symbol of the cryptocurrency
side object Either bid or ask
price string The price of the bid or ask
size string The total quantity remaining at the price
timestamp string Epoch timestamp of when the price level was last updated

Cryptocurrency Events

This returns a streaming list of event updates such as new and canceled orders.

HTTP request (SSE Streaming)

GET https://cloud-sse.iexapis.com/stable/cryptoEvents?symbols={symbol}&token={YOUR_TOKEN}

curl SSE example

curl --header 'Accept: text/event-stream' https://cloud-sse.iexapis.com/stable/cryptoEvents\?symbols\=btcusd\&token\=YOUR_TOKEN

JSON response

[
  {
    "symbol":"BTCUSD",
    "eventType":"change",
    "timestamp":1566314252386,
    "reason":"cancel",
    "price":"10621.50",
    "size":"0",
    "side":"bid"
  }
]

Data Weighting

2 per symbol per event

Data Timing

Real-time

Data Schedule

continuous

Data Source(s)

Gemini Bitstamp Crypto Provider

Examples

Path Parameters

Option Details
symbol Valid cryptocurrency symbol

Response Attributes

Key Type Description
symbol string The symbol of the cryptocurrency
eventType string Either change, trade, block_trade, or auction, to indicate why the type of event
timestamp number Epoch timestamp of when the event occurred
reason string Either place, trade, cancel, or initial, to indicate why the change has occurred. initial is for the initial response message, which will show the entire existing state of the order book
price string The price this trade executed at when reason is trade, otherwise it is the price of the bid or the ask
size string The size of the trade when reason is trade, otherwise it is the remaining volume at that price
side string Either bid or ask

Cryptocurrency Price

This returns the price for a specified cryptocurrency.

HTTP request

GET /crypto/{symbol}/price

JSON response

{
  "price": "10660.00",
  "symbol": "BTCUSD"
}

Data Weighting

1

Data Timing

Real-time

Data Schedule

continuous

Data Source(s)

Gemini Bitstamp Crypto Provider

Available Methods

GET /crypto/{symbol}/price

Examples

Path Parameters

Option Details
symbol Valid cryptocurrency symbol

Response Attributes

Key Type Description
price string The price of the cryptocurrency
symbol string The symbol of the cryptocurrency

Cryptocurrency Quote

This returns the quote for a specified cryptocurrency. Quotes are available via REST and SSE Streaming.

REST

HTTP request

GET /crypto/{symbol}/quote

JSON response

{
  "symbol": "BTCUSDT",
  "sector": "cryptocurrency",
  "calculationPrice": "realtime",
  "latestPrice": "10689.54000000",
  "latestSource": "Real time price",
  "latestUpdate": 1566249085120,
  "latestVolume": null,
  "bidPrice": "10691.17000000",
  "bidSize": "0.02080400",
  "askPrice": "10693.94000000",
  "askSize": "0.09739300",
  "high": null,
  "low": null,
  "previousClose": null
}

SSE Streaming

HTTP request (SSE Streaming)

GET https://cloud-sse.iexapis.com/stable/cryptoQuotes?symbols={symbol}&token={YOUR_TOKEN}

curl SSE example

curl --header 'Accept: text/event-stream' https://cloud-sse.iexapis.com/stable/cryptoQuotes\?symbols\=btcusdt\&token\=YOUR_TOKEN

JSON response (SSE)

[
  { 
    "symbol": "BTCUSDT",
    "sector": "cryptocurrency",
    "calculationPrice": "realtime",
    "latestPrice": "10691.20000000",
    "latestSource": "Real time price",
    "latestUpdate": 1566307331358,
    "latestVolume": null,
    "bidPrice": "10690.07000000",
    "bidSize": "1.34898500",
    "askPrice": "10692.55000000",
    "askSize": "0.02057300",
    "high": null,
    "low": null,
    "previousClose": null
  },
]

Data Weighting

2

Data Timing

Real-time

Data Schedule

continuous

Data Source(s)

Gemini Bitstamp Crypto Provider

Available Methods

GET /crypto/{symbol}/quote

Examples

REST

SSE Streaming

Path Parameters

Option Details
symbol Valid cryptocurrency symbol

Response Attributes

Key Type Description
symbol string The symbol of the cryptocurrency
sector string This will always return cryptocurrency
calculationPrice string This will always return realtime
high string The high of the cryptocurrency within the last 24 hours
low string The low of the cryptocurrency within the last 24 hours
latestPrice string The latest price for this cryptocurrency
latestSource string This will always be Real time price - this is a colloquial representation of calculationPrice
latestUpdate number Epoch timestamp of when the price was last updated
latestVolume string 24 hour trailing volume
previousClose string The price of the cryptocurrency 24 hours ago
bidPrice string The current bid price
bidSize string The current size of the bid
askPrice string The current ask price
askSize string The current size of the ask

Forex / Currencies

Real-time Streaming

This endpoint streams real-time foreign currency exchange rates.

SSE Streaming Example (Paid subscriptions only)

# Updates up to 4 times per second
curl --header 'Accept: text/event-stream' https://cloud-sse.iexapis.com/stable/forex\?symbols\=USDCAD\&token\=YOUR_TOKEN

# Updates no more than once per second
curl --header 'Accept: text/event-stream' https://cloud-sse.iexapis.com/stable/forex1Second\?symbols\=USDCAD\&token\=YOUR_TOKEN

# Updates no more than once per 5 seconds
curl --header 'Accept: text/event-stream' https://cloud-sse.iexapis.com/stable/forex5Second\?symbols\=USDCAD\&token\=YOUR_TOKEN

# Updates no more than once per 1 minute
curl --header 'Accept: text/event-stream' https://cloud-sse.iexapis.com/stable/forex1Minute\?symbols\=USDCAD\&token\=YOUR_TOKEN

# Firehose all news (Only Scale plans)
curl --header 'Accept: text/event-stream' https://cloud-sse.iexapis.com/stable/forex\?token\=YOUR_TOKEN

JSON response

{
  "symbol": "USDCAD",
  "rate": 1.31,
  "timestamp":  1288282222000
}

Data Weighting

500 per symbol per update

Data Timing

Real-time

Data Schedule

5pm Sun-4pm Fri UTC

Data Source(s)

360T

Notes

Only included with paid subscription plans

Query Parameters

Parameter Description
symbols The base currency code which will be used for rates

Response Attributes

Key Type Description
symbol string  symbol for the corresponding forex currency pair
rate number  corresponding rate for the given currency pair
timestamp number  epoch timestamp of the given rate

Latest Currency Rates

This endpoint returns real-time foreign currency exchange rates data updated every 250 milliseconds.

HTTP request

GET /fx/latest

JSON response

[ 
  {
    "symbol": "USDCAD",
    "rate": 1.31,
    "timestamp":  1288282222000
  },
  {
    "symbol": "USDGBP",
    "rate": 0.755,
    "timestamp":  1288282222000
  },
  {
    "symbol": "USDJPY",
    "rate": 100.43,
    "timestamp":  1288282222000
  },
//...
]

Data Weighting

500 per symbol per rate

Data Timing

Realtime

Data Schedule

5pm Sun-4pm Fri UTC

Data Source(s)

360T

Notes

Only included with paid subscription plans

Available Methods

GET /fx/latest

Examples

Query Parameters

Parameter Description
symbols The base currency code which will be used for rates

Response Attributes

Key Type Description
symbol string  symbol for the corresponding forex currency pair
rate number  corresponding rate for the given currency pair
timestamp number  epoch timestamp of the given rate

Currency Conversion

This endpoint performs a conversion from one currency to another for a supplied amount of the base currency. If an amount isn’t provided, the latest exchange rate will be provided and the amount will be null.

HTTP request

GET /fx/convert

JSON response

[ 
  {
    "symbol": "USDCAD",
    "rate": 1.31,
    "timestamp":  1288282222000,
    "amount": 95.63
  },
  {
    "symbol": "USDGBP",
    "rate": 0.755,
    "timestamp":  1288282222000,
    "amount": 56.113
  },
  {
    "symbol": "USDJPY",
    "rate": 100.43,
    "timestamp":  1288282222000,
    "amount": 7331.39
  },
//...
]

Data Weighting

500 per symbol per conversion

Data Timing

Realtime

Data Schedule

5pm Sun-4pm Fri UTC

Data Source(s)

360T

Notes

Only included with paid subscription plans

Available Methods

GET /fx/convert

Examples

Query Parameters

Parameter Description
symbols The base currency code which will be used for rates
amount The decimal amount to convert from one currency to another

Response Attributes

Key Type Description
symbol string  symbol for the corresponding forex currency pair
rate number  corresponding rate for the given currency pair
timestamp number  epoch timestamp of the given rate
amount number  amount of the converted currency, will return null if not specified

Historical Daily

This endpoint returns a daily value for the desired currency pair.

HTTP request

GET /fx/historical

JSON response

[
  [
    {
      "date": "2019-10-06",
      "symbol": "EURUSD",
      "timestamp": 1570406389000,
      "rate": 1.09834
    },
    {
      "date": "2019-10-07",
      "symbol": "EURUSD",
      "timestamp": 1570492793000,
      "rate": 1.09726
    },
  //...
  ],
  [
    {
      "date": "2019-10-06",
      "symbol": "GBPUSD",
      "timestamp": 1570406397000,
      "rate": 1.23347
    },
    {
      "date": "2019-10-07",
      "symbol": "GBPUSD",
      "timestamp": 1570492798000,
      "rate": 1.22885
    },
  //...
  ],
  //...
]

Data Weighting

100,000 per symbol per date

Data Timing

End of day

Data Schedule

1am Mon-Sat UTC

Data Source(s)

360T

Notes

Only included with paid subscription plans

Available Methods

GET /fx/historical

Examples

Query Parameters

Parameter Details
symbols Required.
• The desired currency pairs to get time series data for.
If no date or date range is specified, the last record in the series will be returned.
from Optional.
• Returns data on or after the given from date. Format YYYY-MM-DD. Used together with the to parameter to define a date range.
to Optional.
• Returns data on or before the given to date. Format YYYY-MM-DD
on Optional.
• Returns data on the given date. Format YYYY-MM-DD
last Optional.
• Returns the latest n number of records in the series
first Optional.
• Returns the first n number of records in the series
filter Optional.
• The standard filter parameter. Filters return data to the specified comma delimited list of keys (case-sensitive)
format Optional.
• The standard format parameter. Returns data as JSON by default. See the data format section for supported types.

Response Attributes

Key Type Description
date string the date of the given rate in the format of YYYY-MM-DD
symbol string  symbol for the corresponding forex currency pair
rate number  corresponding rate for the given currency pair
timestamp number  epoch timestamp of the given rate

Options

End of Day Options

Returns end of day options data

HTTP request

# Look up available expiration dates
GET /stock/{symbol}/options

JSON response

[
  "20201204",
  "20201211",
  "20201218",
  "20201231",
  "20210108",
  "20210115",
  "20210219",
  "20210319",
  "20210416",
  "20210618",
  "20210716",
  "20210917",
  "20220121",
  "20220617",
  "20220916",
  "20230120"
]

HTTP request

# Get options data
GET /stock/{symbol}/options/{expiration}/{optionSide?}

JSON response

[
  {
    "ask": 0.1,
    "bid": 0.05,
    "cfiCode": "OPAXXX",
    "close": 0.05,
    "closingPrice": 0.05,
    "contractDescription": "CVM Option Put 18/12/2020 2.5 on Ordinary Shares",
    "contractName": "Cel-Sci Corp",
    "contractSize": 100,
    "currency": "USD",
    "exchangeCode": null,
    "exchangeMIC": null,
    "exerciseStyle": "A",
    "expirationDate": "20201218",
    "figi": "BBG00PZWYFY7",
    "high": 0.1,
    "isAdjusted": false,
    "lastTradeDate": "2020-11-25",
    "lastTradeTime": "20:24:13",
    "lastUpdated": "2020-11-29",
    "low": 0.05,
    "marginPrice": 0,
    "open": 0.1,
    "openInterest": 2039,
    "settlementPrice": 0,
    "side": "put",
    "strikePrice": 3,
    "symbol": "CVM",
    "type": "equity",
    "volume": 17,
    "id": "CVM20201218P00003000",
    "key": "CVM",
    "subkey": "CVM20201218P00003000",
    "date": 1606262400000,
    "updated": 1606739117000
  },
  // { ... }
]

Data Weighting

1000 per symbol per expiration date
1 per date lookup

Data Timing

End of day

Data Schedule

9:30am ET Mon-Fri

Data Source(s)

IEX Cloud

Notes

Only included with paid subscription plans

Due to requirements from OPRA, EOD prices are not available until 9:30am ET of the next trading day. This means Friday prices cannot be published until the open on Monday.

Available Methods

GET /stock/{symbol}/options/{expiration}/{optionSide?}

Examples

Lookup available expiration dates for a symbol

Path Parameters

Option Details
symbol valid symbol
expiration expiration date as YYYYMMDD. Optional. If not passed, the call will return all available expiration dates for the symbol.
optionSide Optional.
• put or call will return just those types of contracts.

Response Attributes

This endpoint inherits common keys from Time Series.

Key Type Description
ask number Last ask price of the day
bid number Last bid price of the day
cfiCode string CFI code for determining what the contract is
close number The contract close price
closingPrice number The contract close price
contractDescription string English description of the contract
contractName string OCC options contract symbol
contractSize number The number of units for the contract expressed in the unit of measure
currency string ISO currency code for the contract
exchangeCode number Exchange symbol or ticker for the contract
exchangeMIC number MIC (Marker segment)
exerciseStyle string Exercise type for options.
A = American, E = European, X = Not applicable
expirationDate string The contract expiry date
figi string Financial Instrument Global Identifier (FIGI, formerly BBGID) for the contract if available
high number The contract high price for the day
isAdjusted boolean This will be true in instances where the option has been adjusted such that it is not a straightforward vanilla options contract. This is usually due to a corporate action or event such as an acquisition, merger, special dividend, stock split, reverse split, or spin off The ids for any contract that is flagged as adjusted will also end with _adj
lastTradeDate string Date of close formatted YYYY-MM-DD
lastTradeTime string Time of close formatted HH:MM:SS
lastUpdated string Date data was last updated formatted YYYY-MM-DD
low number The contract low price for the day
marginPrice number The exchange published price for margin calculations
open number The contract open price
openInterest number The total number of derivative contracts that have not been settled
settlementPrice number Not in use. Applies to futures contracts only.
side string call or put
strikePrice number Exercise price for option. Zero filled if not needed.
symbol string Associated symbol or ticker
type string equity or index
volume number The number of contracts transacted in the day or session
id string The dataset ID.
Inherited from time-series common.
source string Source of the data if available.
Inherited from time-series common.
key string The requested dataset key.
Inherited from time-series common.
subkey string The requested dataset subkey.
Inherited from time-series common.
date number The date field of the time series as epoch timestamp.
Inherited from time-series common.
updated number The time data was last updated as epoch timestamp.
Inherited from time-series common.

CEO Compensation

CEO Compensation

This endpoint provides CEO compensation for a company by symbol.

HTTP request

GET /stock/{symbol}/ceo-compensation

JSON response

// Daily
{
    "symbol": "AVGO",
    "name": "Hock E. Tan",
    "companyName": "Broadcom Inc.",
    "location": "Singapore, Asia",
    "salary": 1100000,
    "bonus": 0,
    "stockAwards": 98322843,
    "optionAwards": 0,
    "nonEquityIncentives": 3712500,
    "pensionAndDeferred": 0,
    "otherComp": 75820,
    "total": 103211163,
    "year": "2017"
}

Data Weighting

20 per symbol

Data Timing

End of day

Data Schedule

1am daily

Data Source(s)

IEX Cloud

Notes

Only included with paid subscription plans

Available Methods

GET /stock/{symbol}/ceo-compensation

Examples

Path Parameters

Option Description
symbol valid symbol

Response Attributes

Key Type Description
symbol string  Symbol of the company
name string  CEO name
companyName string  Name of the company
location string  Location of the company
salary number  Salary of the company CEO
bonus number  Bonus amount of the company CEO
stockAwards number 
optionAwards number 
nonEquityIncentives number 
pensionAndDeferred number 
otherComp number 
total number  Total compensation of the company CEO
year string  Fiscal year for the compensation data

Treasuries

Daily Treasury Rates

This endpoint provides the daily constant maturity rate for 30 year, 20 year, 10 year, 5 year, 2 year, 1 year, 6 month, 3 month, and 1 month treasuries.
History available since 1962.

HTTP request

GET /data-points/market/{symbol}

Plain Text Response

1.54

Time Series historical data

GET /time-series/treasury/{symbol?}

Plain Text Response

[
  {
    "value": 1.77,
    "id": "TREASURY",
    "source": "IEX Cloud",
    "key": "COMPOUT",
    "subkey": "NONE",
    "date": 1574208000000,
    "updated": 1574359220000
  }
  // { ... }
]

Data Weighting

1000 per symbol per date

Data Timing

End of day

Data Schedule

6am, 11pm UTC daily

Data Source(s)

Board of Governors of the Federal Reserve System (US)

Notes

This endpoint uses the generic data points endpoint

This endpoint uses the generic time series endpoint

Available Methods

GET /data-points/market/{symbol}
GET /time-series/treasury/{symbol}

Examples

Path Parameters

Option Value Description
symbol DGS30 30 Year constant maturity rate
DGS20 20 Year constant maturity rate
DGS10 10 Year constant maturity rate
DGS5 5 Year constant maturity rate
DGS2 2 Year constant maturity rate
DGS1 1 Year constant maturity rate
DGS6MO 6 Month constant maturity rate
DGS3MO 3 Month constant maturity rate
DGS1MO 1 Month constant maturity rate

Commodities

Oil Prices

This endpoint provides historical oil prices.
History available since 1986.

HTTP request

GET /data-points/market/{symbol}

Plain Text Response

55.95

Time Series historical data

GET /time-series/energy/{symbol?}

Plain Text Response

[
  {
    "value": 1.77,
    "id": "ENERGY",
    "source": "IEX Cloud",
    "key": "DCOILWTICO",
    "subkey": "NONE",
    "date": 1574208000000,
    "updated": 1574359220000
  }
  // { ... }
]

Data Weighting

1000 per symbol per date

Data Timing

Weekly

Data Schedule

6am UTC Friday

Data Source(s)

U.S. Energy Information Administration

Notes

This endpoint uses the generic data points endpoint
This endpoint uses the generic time series endpoint
Launch Grow Scale users only

Available Methods

GET /data-points/market/{symbol} GET /time-series/energy/{symbol?}

Examples

Path Parameters

Option Value Description
symbol DCOILWTICO Crude oil West Texas Intermediate - in dollars per barrel, not seasonally adjusted
DCOILBRENTEU Crude oil Brent Europe - in dollars per barrel, not seasonally adjusted

Natural Gas Price

This endpoint provides historical Henry Hub natural gas spot price.
History available since 1997.

HTTP request

GET /data-points/market/{symbol}

Plain Text Response

2.95

Time Series historical data

GET /time-series/energy/{symbol?}

Plain Text Response

[
  {
    "value": 1.77,
    "id": "ENERGY",
    "source": "IEX Cloud",
    "key": "DCOILWTICO",
    "subkey": "NONE",
    "date": 1574208000000,
    "updated": 1574359220000
  }
  // { ... }
]

Data Weighting

1000 per symbol per date

Data Timing

Daily

Data Schedule

6am UTC Daily

Data Source(s)

U.S. Energy Information Administration

Notes

This endpoint uses the generic data points endpoint
This endpoint uses the generic time series endpoint
Launch Grow Scale users only

Available Methods

GET /data-points/market/{symbol} GET /time-series/energy/{symbol}

Examples

Path Parameters

Option Value Description
symbol DHHNGSP Henry Hub Natural Gas Spot Price - in dollars per million BTU, not seasonally adjusted

Heating Oil Prices

This endpoint provides historical heating oil prices.
History available since 1986.

HTTP request

GET /data-points/market/{symbol}

Plain Text Response

2.95

Time Series historical data

GET /time-series/energy/{symbol?}

Plain Text Response

[
  {
    "value": 1.77,
    "id": "ENERGY",
    "source": "IEX Cloud",
    "key": "DCOILWTICO",
    "subkey": "NONE",
    "date": 1574208000000,
    "updated": 1574359220000
  }
  // { ... }
]

Data Weighting

1000 per symbol per date

Data Timing

Daily

Data Schedule

6am UTC Daily

Data Source(s)

U.S. Energy Information Administration

Notes

This endpoint uses the generic data points endpoint
This endpoint uses the generic time series endpoint
Launch Grow Scale users only

Available Methods

GET /data-points/market/{symbol} GET /time-series/energy/{symbol?}

Examples

Path Parameters

Option Value Description
symbol DHOILNYH No. 2 Heating Oil New York Harbor - in dollars per gallon, not seasonally adjusted

Jet Fuel Prices

This endpoint provides historical kerosene type jet fuel prices.
Historical data available since 1990.

HTTP request

GET /data-points/market/{symbol}

Plain Text Response

2.95

Time Series historical data

GET /time-series/energy/{symbol?}

Plain Text Response

[
  {
    "value": 1.77,
    "id": "ENERGY",
    "source": "IEX Cloud",
    "key": "DCOILWTICO",
    "subkey": "NONE",
    "date": 1574208000000,
    "updated": 1574359220000
  }
  // { ... }
]

Data Weighting

1000 per symbol per date

Data Timing

Daily

Data Schedule

6am UTC Daily

Data Source(s)

U.S. Energy Information Administration

Notes

This endpoint uses the generic data points endpoint
This endpoint uses the generic time series endpoint
Launch Grow Scale users only

Available Methods

GET /data-points/market/{symbol} GET /time-series/energy/{symbol?}

Examples

Path Parameters

Option Value Description
symbol DJFUELUSGULF Kerosense Type Jet Fuel US Gulf Coast - in dollars per gallon, not seasonally adjusted

Diesel Price

This endpoint provides historical US diesel sales price.
History available since 1994.

HTTP request

GET /data-points/market/{symbol}

Plain Text Response

3.15

Time Series historical data

GET /time-series/energy/{symbol?}

Plain Text Response

[
  {
    "value": 1.77,
    "id": "ENERGY",
    "source": "IEX Cloud",
    "key": "DCOILWTICO",
    "subkey": "NONE",
    "date": 1574208000000,
    "updated": 1574359220000
  }
  // { ... }
]

Data Weighting

1000 per symbol per date

Data Timing

Weekly

Data Schedule

6am UTC

Data Source(s)

U.S. Energy Information Administration

Notes

This endpoint uses the generic data points endpoint
This endpoint uses the generic time series endpoint
Launch Grow Scale users only

Available Methods

GET /data-points/market/{symbol} GET /time-series/energy/{symbol?}

Examples

Path Parameters

Option Value Description
symbol GASDESW US Diesel Sales Price - in dollars per gallon, not seasonally adjusted

Gas Prices

This endpoint provides historical US conventional gas prices.
History available since 1990.

HTTP request

GET /data-points/market/{symbol}

Plain Text Response

3.15

Time Series historical data

GET /time-series/energy/{symbol?}

Plain Text Response

[
  {
    "value": 1.77,
    "id": "ENERGY",
    "source": "IEX Cloud",
    "key": "DCOILWTICO",
    "subkey": "NONE",
    "date": 1574208000000,
    "updated": 1574359220000
  }
  // { ... }
]

Data Weighting

1000 per symbol per date

Data Timing

Weekly

Data Schedule

6am UTC

Data Source(s)

U.S. Energy Information Administration

Notes

This endpoint uses the generic data points endpoint
This endpoint uses the generic time series endpoint
Launch Grow Scale users only

Available Methods

GET /data-points/market/{symbol} GET /time-series/market/{symbol}

Examples

Path Parameters

Option Value Description
symbol GASREGCOVW US Regular Conventional Gas Price - in dollars per gallon, not seasonally adjusted
GASMIDCOVW US Midgrade Conventional Gas Price - in dollars per gallon, not seasonally adjusted
GASPRMCOVW US Premium Conventional Gas Price - in dollars per gallon, not seasonally adjusted

Propane Prices

This endpoint provides historical propane prices.
History available since 1992.

HTTP request

GET /data-points/market/{symbol}

Plain Text Response

2.95

Time Series historical data

GET /time-series/energy/{symbol?}

Plain Text Response

[
  {
    "value": 1.77,
    "id": "ENERGY",
    "source": "IEX Cloud",
    "key": "DCOILWTICO",
    "subkey": "NONE",
    "date": 1574208000000,
    "updated": 1574359220000
  }
  // { ... }
]

Data Weighting

1000 per symbol per date

Data Timing

Daily

Data Schedule

6am UTC Daily

Data Source(s)

U.S. Energy Information Administration

Notes

This endpoint uses the generic data points endpoint
This endpoint uses the generic time series endpoint
Launch Grow Scale users only

Available Methods

GET /data-points/market/{symbol} GET /time-series/energy/{symbol?}

Examples

Path Parameters

Option Value Description
symbol DPROPANEMBTX Propane Prices Mont Belvieu Texas - in dollars per gallon, not seasonally adjusted

Economic Data

CD Rates

This endpoint provides jumbo and non-jumbo CD rates.

HTTP request

GET /data-points/market/{symbol}

Plain Text Response

2.5

Data Weighting

1000 per symbol per date

Data Timing

Weekly

Data Schedule

6am UTC Friday

Data Source(s)

Federal Deposit Insurance Corporation

Notes

This endpoint uses the generic data points endpoint

Available Methods

GET /data-points/market/{symbol}

Examples

Path Parameters

Option Value Description
symbol MMNRNJ CD Rate Non-Jumbo less than $100,000 Money market
MMNRJD CD Rate Jumbo more than $100,000 Money market

Consumer Price Index

This endpoint provides the consumer price index for all urban consumers

HTTP request

GET /data-points/market/{symbol}

Plain Text Response

2.5

Data Weighting

1000 per symbol per date

Data Timing

Monthly

Data Schedule

6am UTC

Data Source(s)

Board of Governors of the Federal Reserve System (US)

Notes

This endpoint uses the generic data points endpoint

Available Methods

GET /data-points/market/{symbol}

Examples

Path Parameters

Option Value Description
symbol CPIAUCSL Consumer Price Index All Urban Consumers

Credit Card Interest Rate

This endpoint provides the commercial bank credit card interest rate

HTTP request

GET /data-points/market/{symbol}

Plain Text Response

15.1

Data Weighting

1000 per symbol per date

Data Timing

Monthly

Data Schedule

6am UTC

Data Source(s)

Board of Governors of the Federal Reserve System (US)

Notes

This endpoint uses the generic data points endpoint

Available Methods

GET /data-points/market/{symbol}

Examples

Path Parameters

Option Value Description
symbol TERMCBCCALLNS Commercial bank credit card interest rate as a percent, not seasonally adjusted

Federal Fund Rates

This endpoint provides the effective federal funds rate

HTTP request

GET /data-points/market/{symbol}

Plain Text Response

2.5

Data Weighting

1000 per symbol per date

Data Timing

Monthly

Data Schedule

6am UTC

Data Source(s)

Board of Governors of the Federal Reserve System (US)

Notes

This endpoint uses the generic data points endpoint

Available Methods

GET /data-points/market/{symbol}

Examples

Path Parameters

Option Value Description
symbol FEDFUNDS Effective federal funds rate

Real GDP

This endpoint provides the real gross domestic product.
History available since 1947.

HTTP request

GET /data-points/market/{symbol}

Plain Text Response

2.5

Time Series historical data

GET /time-series/economic/{symbol?}

Plain Text Response

[
  {
    "value": 1.77,
    "id": "ECONOMIC",
    "source": "IEX Cloud",
    "key": "DGS10",
    "subkey": "NONE",
    "date": 1574208000000,
    "updated": 1574359220000
  }
  // { ... }
]

Data Weighting

1000 per symbol per date

Data Timing

Quarterly

Data Schedule

6am UTC

Data Source(s)

Board of Governors of the Federal Reserve System (US)

Notes

This endpoint uses the generic data points endpoint

This endpoint uses the generic time series endpoint

Available Methods

GET /data-points/market/{symbol}
GET /time-series/economic/{symbol}

Examples

Path Parameters

Option Value Description
symbol A191RL1Q225SBEA Real Gross Domestic Product

Institutional Money Funds

This endpoint provides weekly institutional money funds

HTTP request

GET /data-points/market/{symbol}

Plain Text Response

2,195

Data Weighting

1000 per symbol per date

Data Timing

Weekly

Data Schedule

6am UTC

Data Source(s)

Board of Governors of the Federal Reserve System

Notes

This endpoint uses the generic data points endpoint

Available Methods

GET /data-points/market/{symbol}

Examples

Path Parameters

Option Value Description
symbol WIMFSL Institutional money funds returned as billions of dollars, seasonally adjusted

Initial Claims

This endpoint provides the initial claims 4-week moving average

HTTP request

GET /data-points/market/{symbol}

Plain Text Response

210,000

Data Weighting

1000 per symbol per date

Data Timing

Weekly ending Saturday

Data Schedule

6am UTC

Data Source(s)

U.S. Employment and Training Administration

Notes

This endpoint uses the generic data points endpoint

Available Methods

GET /data-points/market/{symbol}

Examples

Path Parameters

Option Value Description
symbol IC4WSA Returned as a number, seasonally adjusted

Industrial Production Index

This endpoint provides the industrial production index

HTTP request

GET /data-points/market/{symbol}

Plain Text Response

2.5

Data Weighting

1000 per symbol per date

Data Timing

Monthly

Data Schedule

6am UTC

Data Source(s)

Board of Governors of the Federal Reserve System (US)

Notes

This endpoint uses the generic data points endpoint

Available Methods

GET /data-points/market/{symbol}

Examples

Path Parameters

Option Value Description
symbol INDPRO Industrial Production Index

Mortgage Rates

This endpoint provides fixed and adjustable mortgage rates.
History available since 1971.

HTTP request

GET /data-points/market/{symbol}

Plain Text Response

2.5

Time Series historical data

GET /time-series/economic/{symbol?}

Plain Text Response

[
  {
    "value": 1.77,
    "id": "ECONOMIC",
    "source": "IEX Cloud",
    "key": "DGS10",
    "subkey": "NONE",
    "date": 1574208000000,
    "updated": 1574359220000
  }
  // { ... }
]

Data Weighting

1000 per symbol per date

Data Timing

Weekly

Data Schedule

6am UTC Friday

Data Source(s)

Freddie Mac

Notes

This endpoint uses the generic data points endpoint

This endpoint uses the generic time series endpoint

Available Methods

GET /data-points/market/{symbol}
GET /time-series/economic/{symbol?}

Examples

Path Parameters

Option Value Description
symbol MORTGAGE30US US 30-Year fixed rate mortgage average
MORTGAGE15US US 15-Year fixed rate mortgage average
MORTGAGE5US US 5/1-Year adjustable rate mortgage average

Total Housing Starts

This endpoint provides total US, privately owned housing starts.
History available since 1959.

HTTP request

GET /data-points/market/{symbol}

Plain Text Response

2000

Time Series historical data

GET /time-series/economic/{symbol?}

Plain Text Response

[
  {
    "value": 1.77,
    "id": "ECONOMIC",
    "source": "IEX Cloud",
    "key": "DGS10",
    "subkey": "NONE",
    "date": 1574208000000,
    "updated": 1574359220000
  }
  // { ... }
]

Data Weighting

1000 per symbol per date

Data Timing

Monthly

Data Schedule

6am UTC

Data Source(s)

U.S. Census Bureau and U.S. Department of Housing and Urban Development

Notes

This endpoint uses the generic data points endpoint

This endpoint uses the generic time series endpoint

Available Methods

GET /data-points/market/{symbol}
GET /time-series/economic/{symbol?}

Examples

Path Parameters

Option Value Description
symbol HOUST Total Housing Starts in thousands of units, seasonally adjusted annual rate

Total Payrolls

This endpoint provides total nonfarm payrolls

HTTP request

GET /data-points/market/{symbol}

Plain Text Response

160000

Data Weighting

1000 per symbol per date

Data Timing

Monthly

Data Schedule

6am UTC

Data Source(s)

U.S. Bureau of Labor Statistics

Notes

This endpoint uses the generic data points endpoint

Available Methods

GET /data-points/market/{symbol}

Examples

Path Parameters

Option Value Description
symbol PAYEMS Total nonfarm employees in thousands of persons seasonally adjusted

Total Vehicle Sales

This endpoint provides total vehicle sales

HTTP request

GET /data-points/market/{symbol}

Plain Text Response

15.5

Data Weighting

1000 per symbol per date

Data Timing

Monthly

Data Schedule

6am UTC

Data Source(s)

U.S. Bureau of Economic Analysis

Notes

This endpoint uses the generic data points endpoint

Available Methods

GET /data-points/market/{symbol}

Examples

Path Parameters

Option Value Description
symbol TOTALSA Total Vehicle Sales in millions of units

Retail Money Funds

This endpoint provides weekly retail money funds

HTTP request

GET /data-points/market/{symbol}

Plain Text Response

999

Data Weighting

1000 per symbol per date

Data Timing

Weekly

Data Schedule

6am UTC

Data Source(s)

Board of Governors of the Federal Reserve System

Notes

This endpoint uses the generic data points endpoint

Available Methods

GET /data-points/market/{symbol}

Examples

Path Parameters

Option Value Description
symbol WRMFSL Retail money funds returned as billions of dollars, seasonally adjusted

Unemployment Rate

This endpoint provides the civilian unemployment rate.
History available since 1948.

HTTP request

GET /data-points/market/{symbol}

Plain Text Response

3.2

Time Series historical data

GET /time-series/economic/{symbol?}

Plain Text Response

[
  {
    "value": 1.77,
    "id": "ECONOMIC",
    "source": "IEX Cloud",
    "key": "DGS10",
    "subkey": "NONE",
    "date": 1574208000000,
    "updated": 1574359220000
  }
  // { ... }
]

Data Weighting

1000 per symbol per date

Data Timing

Monthly

Data Schedule

6am UTC

Data Source(s)

U.S. Bureau of Labor Statistics

Notes

This endpoint uses the generic data points endpoint

This endpoint uses the generic time series endpoint

Available Methods

GET /data-points/market/{symbol}
GET /time-series/economic/{symbol?}

Examples

Path Parameters

Option Value Description
symbol UNRATE Unemployment rate returned as a percent, seasonally adjusted

US Recession Probabilities

This endpoint provides smoothed US recession probabilities

HTTP request

GET /data-points/market/{symbol}

Plain Text Response

.37

Data Weighting

1000 per symbol per date

Data Timing

Monthly

Data Schedule

6am UTC

Data Source(s)

U.S. Bureau of Economic Analysis

Notes

This endpoint uses the generic data points endpoint

Available Methods

GET /data-points/market/{symbol}

Examples

Path Parameters

Option Value Description
symbol RECPROUSM156N US Recession Probabilities. Smoothed recession probabilities for the United States are obtained from a dynamic-factor markov-switching model applied to four monthly coincident variables: non-farm payroll employment, the index of industrial production, real personal income excluding transfer payments, and real manufacturing and trade sales.

Reference Data

Returns an array of symbols up to the top 10 matches. Results will be sorted for relevancy. Search currently defaults to equities only, where the symbol returned is supported by endpoints listed under the Stocks category.

HTTP request

GET /search/{fragment}

JSON response

// GET /search/tsl
[
  {
    "symbol": "TSLA-SE",
    "cik": "0001318605",
    "securityName": "",
    "securityType": "SHARE",
    "region": "CH",
    "exchange": "SWX",
    "sector": "Manufacturing"
  },
  {
    "symbol": "TSLA-RM-RX",
    "cik": "0001318605",
    "securityName": "",
    "securityType": "SHARE",
    "region": "RU",
    "exchange": "MIC",
    "sector": "Manufacturing"
  },
  {
    "symbol": "TSLA-MM",
    "cik": "0001318605",
    "securityName": "",
    "securityType": "SHARE",
    "region": "MX",
    "exchange": "MEX",
    "sector": "Manufacturing"
  },
  {
    "symbol": "TSLA-AV",
    "cik": "0001318605",
    "securityName": "",
    "securityType": "SHARE",
    "region": "AT",
    "exchange": "WBO",
    "sector": "Manufacturing"
  },
  {
    "symbol": "TSLA",
    "cik": "0001318605",
    "securityName": "Tesla Inc",
    "securityType": "SHARE",
    "region": "US",
    "exchange": "NAS",
    "sector": "Manufacturing"
  },
  {
    "symbol": "TSLTF",
    "cik": "0001144800",
    "securityName": "",
    "securityType": "PREF",
    "region": "US",
    "exchange": "PINX",
    "sector": "Utilities"
  },
  {
    "symbol": "TSLX",
    "cik": "0001508655",
    "securityName": "Sixth Street Specialty Lending Inc",
    "securityType": "SHARE",
    "region": "US",
    "exchange": "NYS",
    "sector": "Finance and Insurance"
  },
  {
    "symbol": "TSLLF",
    "cik": null,
    "securityName": "",
    "securityType": "SHARE",
    "region": "US",
    "exchange": "PINX",
    "sector": "Manufacturing"
  },
  {
    "symbol": "TSL.ZW-ZH",
    "cik": null,
    "securityName": "TSL Limited",
    "securityType": "SHARE",
    "region": "ZW",
    "exchange": "ZIM",
    "sector": "Management of Companies and Enterprises"
  }
]

Data Weighting

1 per call (search)

Data Source(s)

Investors Exchange

Notes

Only included with paid subscription plans

Available Methods

GET /search/{fragment}

Examples

Path Parameters

Option Type Description
fragment string URL encoded search string. Currently search by symbol or security name.

Response Attributes

Key Type Description
symbol string Refers to the symbol represented in Nasdaq Integrated symbology (INET).
cik string Refers to the unique identifier for this data set, the Central Index Key (“CIK”) is used to identify entities that are regulated by the Securities and Exchange Commission (“SEC”).
securityName string Name of the security
securityType string Refers to the common issue type
AD - ADR
RE - REIT
CE - Closed end fund
SI - Secondary Issue
LP - Limited Partnerships
CS - Common Stock
ET - ETF
WT - Warrant
OEF - Open Ended Fund
CEF - Closed Ended Fund
PS - Preferred Stock)
UT- Unit
TEMP - Temporary
region string Refers to the country code for the symbol using ISO 3166-1 alpha-2
exchange string Refers to Exchange using IEX Supported Exchanges list
sector string Refers to the sector the security belongs to.

Cryptocurrency Symbols

This provides a full list of supported cryptocurrencies by IEX Cloud.

HTTP request

GET /ref-data/crypto/symbols

JSON response

[
  {
    "symbol": "BTCUSD",
    "name": "Bitcoin to USD",
    "exchange": null,
    "date": "2019-08-19",
    "type": "crypto",
    "iexId": null,
    "region": "US",
    "currency": "USD",
    "isEnabled": true
  },
  {
    "symbol": "ETHUSD",
    "name": "Ethereum to USD",
    "exchange": null,
    "date": "2019-08-19",
    "iexId": null,
    "type": "crypto",
    "region": "US",
    "currency": "USD",
    "isEnabled": true
  },
  ...
]

Data Weighting

1

Data Schedule

8AM UTC daily

Data Source(s)

Gemini Crypto Provider

Available Methods

GET /ref-data/crypto/symbols

Examples

Response Attributes

Key Type Description
symbol string The symbol of the cryptocurrency
name string The name of the cryptocurrency
exchange string Will return null for cryptocurrency, this field is present to maintain consistency with other ref data endpoints
iexId string Will return null for cryptocurrency, this field is present to maintain consistency with other ref data endpoints
currency string The currency in which this symbol will be quoted in. For example, BTCUSD will be in the currency of “USD”
date string The last time we as IEX updated it
type string The type of the symbol – defaults to “crypto”
isEnabled boolean Whether or not the cryptocurrency is currently live and updating
region string The region in which this cryptocurrency comes from – defaults to “US”

FX Symbols

This call returns a list of supported currencies and currency pairs.

HTTP request

GET /ref-data/fx/symbols

JSON response

{
  "currencies": [
    {
      "code": "USD",
      "name": "U.S. Dollar"
    },
  //...
  ],
  "pairs": [
    { 
      "fromCurrency": "EUR",
      "toCurrency": "USD",
      "symbol": "EURUSD"
    }, 
  //...
  ]
}

Data Weighting

1 per call

Data Timing

End of day

Data Schedule

7am, 9am, UTC daily

Data Source(s)

360T

Available Methods

GET /ref-data/fx/symbols

Examples

Response Attributes

Key Type Description
currencies array Array of currencies. Each currency is an object containing a code and name as strings.
pairs array Array of supported currency pairs. Each pair is an object containing from code and to code.

IEX Symbols

This call returns an array of symbols the Investors Exchange supports for trading. This list is updated daily as of 7:45 a.m. ET. Symbols may be added or removed by the Investors Exchange after the list was produced.

HTTP request

GET /ref-data/iex/symbols

JSON response

[
  {
    "symbol": "A",
    "date": "2017-04-19",
    "isEnabled": true,
  },
  {
    "symbol": "AA",
    "date": "2017-04-19",
    "isEnabled": true,
  }
]

Data Weighting

Free

Data Timing

End of day

Data Schedule

8am, 9am, 12pm, 1pm UTC daily

Data Source(s)

Investors Exchange

Available Methods

GET /ref-data/iex/symbols

Query String Parameters

Option Details
format Optional.
• Value can only be csv
• When parameter is not present, format defaults to JSON

Response Attributes

Key Description
symbol Refers to the symbol represented in Nasdaq Integrated symbology (INET).
date Refers to the date the symbol reference data was generated.
isEnabled will be true if the symbol is enabled for trading on IEX.

International Symbols

This call returns an array of international symbols that IEX Cloud supports for API calls.

HTTP request

GET /ref-data/region/{region}/symbols
GET /ref-data/exchange/{exchange}/symbols

JSON response

[
  {
    "symbol": "A.V",
    "exchange": "TSX",
    "name": "Armor Minerals Inc.",
    "date": "2019-03-12",
    "type": "cs",
    "iexId": "IEX_4656374258322D52",
    "region": "CA",
    "currency": "CAD",
    "isEnabled": true
  },
  {
    "symbol": "AA.V",
    "exchange": "TSX",
    "name": "Alba Minerals Ltd.",
    "date": "2019-03-12",
    "type": "cs",
    "iexId": "IEX_4E44474238422D52",
    "region": "CA",
    "currency": "CAD",
    "isEnabled": true
  }
]

Data Weighting

100 per call

Data Timing

End of day

Data Schedule

8am, 9am, 12pm, 1pm UTC daily

Data Source(s)

IEX Cloud Investors Exchange

Notes

Currently International symbols only have End of Day prices.

Available Methods

GET /ref-data/region/{region}/symbols
GET /ref-data/exchange/{exchange}/symbols

Examples

Path Parameters

Option Details
region • Required.
• 2 letter case insensitive string of country codes using ISO 3166-1 alpha-2
exchange • Required.
• Case insensitive string of Exchange using IEX Supported Exchanges list

Query String Parameters

Option Details
format Optional.
• Value can only be csv
• When parameter is not present, format defaults to JSON

Response Attributes

Key Description
symbol Refers to the symbol
exchange Refers to Exchange using IEX Supported Exchanges list
name Refers to the name of the company or security.
date Refers to the date the symbol reference data was generated.
isEnabled will be true if the symbol is trading.
type Refers to the common issue type
ad - ADR
re - REIT
ce - Closed end fund
si - Secondary Issue
lp - Limited Partnerships
cs - Common Stock
et - ETF
wt - Warrant
oef - Open Ended Fund
cef - Closed Ended Fund
ps - Preferred Stock
ut - Unit
temp - Temporary
region Refers to the region of the world the symbol is in
currency Refers to the currency the symbol is traded in
iexId unique ID applied by IEX to track securities through symbol changes.

International Exchanges

Returns an array of exchanges.

HTTP request

GET /ref-data/exchanges

JSON response

[
  {
    "exchange": "ADS",
    "region": "AE",
    "description": "Abu Dhabi Securities Exchange",
    "mic": "XADS",
    "exchangeSuffix": "-DH"
  }
]

Data Weighting

1 per call

Data Timing

End of day

Data Schedule

8am, 9am, 12pm, 1pm UTC daily

Data Source(s)

Investors Exchange

Available Methods

GET /ref-data/exchanges

Examples

Query String Parameters

Option Details
format Optional.
• Value can only be csv
• When parameter is not present, format defaults to JSON

Response Attributes

Key Type Description
exchange string Exchange abbreviation
region string 2 letter case insensitive string of country codes using ISO 3166-1 alpha-2
description string Full name of the exchange.
mic string Market Identifier Code using ISO 10383
exchangeSuffix string Exchange Suffix to be added for symbols on that exchange

ISIN Mapping

Helper call to convert ISIN to IEX Cloud symbols. Note that due to licensing restrictions we are unable to return the ISIN.

HTTP request

GET /ref-data/isin

JSON response

[
    {
        "symbol" : "foo",
        "exchange" : "NAS",
        "region" : "US"
    }
]

Data Weighting

100 per call

Data Source(s)

Investors Exchange

Available Methods

GET /ref-data/isin

Examples

Query Parameters

Key Type Description
isin string ISIN number. Pass comma delimited ISINs to process more than one.

Response Attributes

Key Type Description
symbol string The ticker
exchange string An identifier of where the symbol is listed
region string The geographic identifier where the symbol is listed

FIGI Mapping

Helper call to convert FIGI to IEX Cloud symbols. Note that due to licensing restrictions we are unable to return the FIGI.

HTTP request

GET /ref-data/figi

JSON response

[
    {
        "symbol" : "foo",
        "exchange" : "NAS",
        "region" : "US"
    }
]

Data Weighting

100 per call

Data Source(s)

Investors Exchange

Available Methods

GET /ref-data/figi

Examples

Query Parameters

Key Type Description
figi string FIGI Composite. Pass comma delimited FIGI to process more than one.

Response Attributes

Key Type Description
symbol string The ticker
exchange string An identifier of where the symbol is listed
region string The geographic identifier where the symbol is listed
iexId string

Mutual Fund Symbols

This call returns an array of mutual fund symbols that IEX Cloud supports for API calls.

HTTP request

GET /ref-data/mutual-funds/symbols

JSON response

[
  {
    "symbol": "AAAAX",
    "name": "DWS Alternative Asset Allocation Fund Class A",
    "date": "2019-03-07",
    "type": "oef",
    "iexId": "IEX_4258444437432D52",
    "region": "US",
    "currency": "USD",
    "isEnabled": true
  },
]

Data Weighting

100 per call

Data Timing

End of day

Data Schedule

8am, 9am, 12pm, 1pm UTC daily

Data Source(s)

IEX Cloud Investors Exchange

Examples

Query String Parameters

Option Details
format Optional.
• Value can only be csv
• When parameter is not present, format defaults to JSON

Response Attributes

Key Description
symbol Refers to the symbol
name Refers to the name of the company or security.
date Refers to the date the symbol reference data was generated.
type Refers to the common issue type
OEF - Open Ended Fund
CEF - Closed Ended Fund
region Refers to the region of the world the symbol is in
currency Refers to the currency the symbol is traded in
iexId Unique ID applied by IEX to track securities through symbol changes.

Options Symbols

This call returns an object keyed by symbol with the value of each symbol being an array of available contract dates.

HTTP request

GET /ref-data/options/symbols

JSON response

{
  "DAL": [
    "201904",
    "201905",
    "201906",
    "201909",
    "201912",
    "202001",
    "202101"
  ],
  "RUSS": [
    "201905",
    "201906",
    "201909",
    "201912"
  ],

  //...
}

Data Weighting

100 per call

Data Timing

End of day

Data Schedule

10:00am ET Tue-Sat

Data Source(s)

IEX Cloud Investors Exchange

Notes

Only included with paid subscription plans

Available Methods

GET /ref-data/options/symbols

Examples

Response Attributes

Key Description
symbol Array of available contract date strings formatted as YYYYMM

OTC Symbols

This call returns an array of OTC symbols that IEX Cloud supports for API calls.

HTTP request

GET /ref-data/otc/symbols

JSON response

[
  {
    "symbol": "A",
    "name": "AGILENT TECHNOLOGIES INC",
    "date": "2019-01-01",
    "type": "cs",
    "iexId": "IEX_46574843354B2D52"
  },
]

Data Weighting

100 per call

Data Timing

End of day

Data Schedule

8am, 9am, 12pm, 1pm UTC daily

Data Source(s)

IEX Cloud Investors Exchange

Examples

Query String Parameters

Option Details
format Optional.
• Value can only be csv
• When parameter is not present, format defaults to JSON

Response Attributes

Key Description
symbol Refers to the symbol
name Refers to the name of the company or security.
date Refers to the date the symbol reference data was generated.
type Refers to the common issue type
ad - ADR
re - REIT
ce - Closed end fund
si - Secondary Issue
lp - Limited Partnerships
cs - Common Stock
et - ETF
wt - Warrant
region Refers to the region of the world the symbol is in
currency Refers to the currency the symbol is traded in
iexId unique ID applied by IEX to track securities through symbol changes.

Sectors

Returns an array of sectors.

HTTP request

GET /ref-data/sectors

JSON response

[
  { "name": "Technology" },
  { "name": "Consumer Cyclical" },

    //...
]

Data Weighting

1 per call

Data Source(s)

IEX Cloud Investors Exchange

Available Methods

GET /ref-data/sectors

Examples

Response Attributes

Key Type Description
name string Name of Sector

Symbols

This refdata endpoint returns the list of symbols that IEX Cloud supports for intraday price updates.

HTTP request

GET /ref-data/symbols

JSON response

[
  {
    "symbol": "A",
    "name": "Agilent Technologies Inc.",
    "date": "2019-03-07",
    "type": "cs",
    "iexId": "IEX_46574843354B2D52",
    "region": "US",
    "currency": "USD",
    "isEnabled": true,
    "figi": "BBG000C2V3D6",
    "cik": "1090872",
  },
  {
    "symbol": "AA",
    "name": "Alcoa Corp.",
    "date": "2019-03-07",
    "type": "cs",
    "iexId": "IEX_4238333734532D52",
    "region": "US",
    "currency": "USD",
    "isEnabled": true,
    "figi": "BBG00B3T3HD3",
    "cik": "1675149",
  },
  // { ... }
]

Data Weighting

100 per call

Data Timing

End of day

Data Schedule

8am, 9am, 12pm, 1pm UTC daily

Data Source(s)

IEX Cloud Investors Exchange

Examples

Query String Parameters

Option Details
format Optional.
• Value can only be csv
• When parameter is not present, format defaults to JSON

Response Attributes

Key Type Description
symbol string Refers to the symbol represented in Nasdaq Integrated symbology (INET).
exchange string Refers to Exchange using IEX Supported Exchanges list
name string Refers to the name of the company or security.
date string Refers to the date the symbol reference data was generated.
isEnabled boolean Will be true if the symbol is enabled for trading on IEX.
type string Refers to the common issue type
ad - ADR
gdr - GDR
re - REIT
ce - Closed end fund
si - Secondary Issue
lp - Limited Partnerships
cs - Common Stock
et - ETF
wt - Warrant
rt – Right
oef - Open Ended Fund
cef - Closed Ended Fund
ps - Preferred Stock
ut - Unit
struct - Structured Product
region string Refers to the country code for the symbol using ISO 3166-1 alpha-2
currency string Refers to the currency the symbol is traded in using ISO 4217
iexId string Unique ID applied by IEX to track securities through symbol changes.
figi string OpenFIGI id for the security if available
cik string CIK number for the security if available

Tags

Returns an array of tags. Tags can be found on each company.

HTTP request

GET /ref-data/tags

JSON response

[
  { "name" : "Financial Services" },
  { "name" : "Industrials" },
    ...
]

Data Weighting

1 per call

Data Source(s)

IEX Cloud Investors Exchange

Available Methods

GET /ref-data/tags

Examples

Response Attributes

Key Type Description
name string Name of Tag

U.S. Exchanges

Returns an array of U.S. exchanges.

HTTP request

GET /ref-data/market/us/exchanges

JSON response

[
  {
    "name": "IEX",
    "longName": "Investors Exchange",
    "mic": "IEXG",
    "tapeId": "V",
    "oatsId": "XV",
    "refId": "IEXG",
    "type": "equities"
  },
]

Data Weighting

1 per call

Data Timing

End of day

Data Schedule

8am, 9am, 12pm, 1pm UTC daily

Data Source(s)

Investors Exchange

Available Methods

GET /ref-data/market/us/exchanges

Examples

Response Attributes

Key Type Description
name string Short name of the exchange.
longName string Full name of the exchange.
mic string Market identifier code for the exchange.
tapeId string ID used to identify the exchange on the Consolidated Tape.
oatsId string FINRA OATS exchange participant ID.
refId string ID used to map exchange across individual markets. Useful when mapping ISIN
type string Type of securities traded by the exchange

U.S. Holidays and Trading Dates

This call allows you to fetch a number of trade dates or holidays from a given date. For example, if you want the next trading day, you would call /ref-data/us/dates/trade/next/1.

HTTP request

GET /ref-data/us/dates/{type}/{direction}/{last?}/{startDate?}

JSON response

[
  {
    "date": "2019-02-07",
    "settlementDate": "2019-02-09",
  },
]

Data Weighting

1 per row returned

Data Timing

End of day

Data Schedule

Back to 2017 to forward 2 years.

Data Source(s)

Investors Exchange

Available Methods

GET /ref-data/us/dates/{type}/{direction?}/{last?}/{startDate?}

Examples

Path Parameters

Option Type Details
type string Required.
• Can be trade or holiday
direction string Required.
• Can be next or last. Default is next. next will return today if today is a holiday.
last number Optional.
• Number of days to go back or forward. Default is 1
startDate string Optional.
• Used to specify the start date for next or last. Format is YYYYMMDD. Defaults to today.

Response Attributes

Key Type Description
date string Trading or holiday date depending on the type specified. Formatted as YYYY-MM-DD.
settlementDate string T+2 trade settlement date depending on the type specified. Formatted as YYYY-MM-DD.

Investors Exchange Data

DEEP

DEEP is used to receive real-time depth of book quotations direct from IEX. The depth of book quotations received via DEEP provide an aggregated size of resting displayed orders at a price and side, and do not indicate the size or number of individual orders at any price level. Non-displayed orders and non-displayed portions of reserve orders are not represented in DEEP.

DEEP also provides last trade price and size information. Trades resulting from either displayed or non-displayed orders matching on IEX will be reported. Routed executions will not be reported.

HTTP request

GET /deep?symbols=snap

JSON response

{
  "symbol": "SNAP",
  "marketPercent": 0.00837,
  "volume": 359425,
  "lastSalePrice": 22.975,
  "lastSaleSize": 100,
  "lastSaleTime": 1494446394043,
  "lastUpdated": 1494446715171,
  "bids": [
      {
        "price": 19.13,
        "size": 650,
        "timestamp": 1494446715171
      }
  ],
  "asks": [
      {
        "price": 19.15,
        "size": 891,
        "timestamp": 1494446717238
      }
  ],
  "systemEvent": {
    "systemEvent": "R",
    "timestamp": 1494627280251
  },
  "tradingStatus": {
    "status": "T",
    "reason": "NA",
    "timestamp": 1494588017687
  },
  "opHaltStatus": {
    "isHalted": false,
    "timestamp": 1494588017687
  },
  "ssrStatus": {
    "isSSR": true,
    "detail": "N",
    "timestamp": 1494588094067
  },
  "securityEvent": {
    "securityEvent": "MarketOpen",
    "timestamp": 1494595800005
  },
  "trades": [
    {
      "price": 19.145,
      "size": 400,
      "tradeId": 517365191,
      "isISO": false,
      "isOddLot": false,
      "isOutsideRegularHours": false,
      "isSinglePriceCross": false,
      "isTradeThroughExempt": false,
      "timestamp": 1494619192193
    }
  ],
  "tradeBreaks": [
    {
      "price": 19.145,
      "size": 400,
      "tradeId": 517365191,
      "isISO": false,
      "isOddLot": false,
      "isOutsideRegularHours": false,
      "isSinglePriceCross": false,
      "isTradeThroughExempt": false,
      "timestamp": 1494619192193
    }
  ],
  "auction": {
      "auctionType": "Open",
      "pairedShares": 3600,
      "imbalanceShares": 600,
      "referencePrice": 1.05,
      "indicativePrice": 1.05,
      "auctionBookPrice": 1.05,
      "collarReferencePrice": 1.05,
      "lowerCollarPrice": 0.5,
      "upperCollarPrice": 1.6,
      "extensionNumber": 0,
      "startTime": "09:30:00",
      "lastUpdate": 1506706199025
  }
}

SSE Streaming Example

curl --header 'Accept: text/event-stream' https://cloud-sse.iexapis.com/stable/deep?token=YOUR_TOKEN&symbols=twtr&channels=deep

Data Weighting

Free

Data Timing

Real-time

Data Schedule

9:30am-4pm ET market hours

Data Source(s)

Investors Exchange

Examples

Query String Parameters

Options Details
symbols Required.
• Value needs to be a single symbol (i.e snap)

Response Attributes

Key Type
symbol string
marketPercent number
volume number
lastSalePrice number
lastSaleSize number
lastSaleTime number
lastUpdated number
bids array
asks array
systemEvent object
tradingStatus object
opHaltStatus object
ssrStatus object
securityEvent object
trades array
tradeBreaks array
auction object

DEEP Auction

DEEP broadcasts an Auction Information Message every one second between the Lock-in Time and the auction match for Opening and Closing Auctions, and during the Display Only Period for IPO, Halt, and Volatility Auctions. Only IEX listed securities are eligible for IEX Auctions.

HTTP request

GET /deep/auction?symbols=ziext

JSON response

{
  "ZIEXT": {
    "auctionType": "Open",
    "pairedShares": 3600,
    "imbalanceShares": 600,
    "referencePrice": 1.05,
    "indicativePrice": 1.05,
    "auctionBookPrice": 1.05,
    "collarReferencePrice": 1.05,
    "lowerCollarPrice": 0.5,
    "upperCollarPrice": 1.6,
    "extensionNumber": 0,
    "startTime": "09:30:00",
    "lastUpdate": 1506706199025
  }
}

SSE Streaming Example

curl --header 'Accept: text/event-stream' https://cloud-sse.iexapis.com/stable/deep?token=YOUR_TOKEN&symbols=twtr&channels=deep-auction

Data Weighting

Free

Data Source(s)

Investors Exchange

Examples

Query String Parameters

Option Details
symbols Required.
• Value needs to be a comma-separated list of symbols (i.e ziext,zexit)
• Maximum of 10 symbols

Response Attributes

Key Type Values
auctionType string Refers to the auction type (Open, Close, Halt, Volatility, IPO)
pairedShares number Refers to the number of shares paired at the referencePrice using orders on the auction book
imbalanceShares number Refers to the number of unpaired shares at the referencePrice using orders on the auction book
referencePrice number Refers to the clearing price at or within the reference price range using ordes on the auction book
indicativePrice number Refers to the clearing price using eligible auction orders
auctionBookPrice number Refers to the clearing price using orders on the auction book
collarReferencePrice number Refers to the reference price used for the auction collar, if any
lowerCollarPrice number Refers to the lower threshold price of the auction collar, if any
upperCollarPrice number Refers to the upper threshold price of the auction collar, if any
extensionNumber number Refers to the number of extensions an auction has received
startTime string Refers to the projected time of the auction match. Formatted as HH:MM:SS
lastUpdate number Refers to the timestamp of the auction information

DEEP Book

Returns IEX’s bids and asks for given symbols.

HTTP request

GET /deep/book?symbols=yelp

JSON response

{
    "YELP": {
        "bids": [
            {
                "price": 63.09,
                "size": 300,
                "timestamp": 1494538496261
            },
        ],
        "asks": [
            {
                "price": 63.92,
                "size": 300,
                "timestamp": 1494538381896
            },
            {
                "price": 63.97,
                "size": 300,
                "timestamp": 1494538381885
            }
        ]
    }
}

SSE Streaming Example

curl --header 'Accept: text/event-stream' https://cloud-sse.iexapis.com/stable/deep?token=YOUR_TOKEN&symbols=twtr&channels=book

Data Weighting

Free

Data Source(s)

Investors Exchange

Examples

Query String Parameters

Option Details
symbols Required.
• Value needs to be a comma-separated list of symbols (i.e SNAP,fb)
• Maximum of 10 symbols

Response Attributes

Key Type
bids array
asks array
price number
size number
timestamp number

DEEP Operational Halt Status

The Exchange may suspend trading of one or more securities on IEX for operational reasons and indicates such operational halt using the Operational halt status message.

IEX disseminates a full pre-market spin of Operational halt status messages indicating the operational halt status of all securities. In the spin, IEX will send out an Operational Halt Message with “N” (Not operationally halted on IEX) for all securities that are eligible for trading at the start of the Pre-Market Session. If a security is absent from the dissemination, firms should assume that the security is being treated as operationally halted in the IEX Trading System at the start of the Pre-Market Session.

After the pre-market spin, IEX will use the Operational halt status message to relay changes in operational halt status for an individual security.

HTTP request

GET /deep/op-halt-status?symbols=snap

JSON response

{
  "SNAP": {
    "isHalted": false,
    "timestamp": 1494588017674
  }
}

SSE Streaming Example

curl --header 'Accept: text/event-stream' https://cloud-sse.iexapis.com/stable/deep?token=YOUR_TOKEN&symbols=twtr&channels=op-halt-status

Data Weighting

Free

Data Source(s)

Investors Exchange

Examples

Query String Parameters

Option Details
symbols Required.
• Value needs to be a comma-separated list of symbols (i.e SNAP,fb)
• Maximum of 10 symbols

Response Attributes

Key Type
isHalted boolean
timestamp number

DEEP Official Price

The Official Price message is used to disseminate the IEX Official Opening and Closing Prices.

These messages will be provided only for IEX Listed Securities.

HTTP request

GET /deep/official-price?symbols=snap

JSON response

{
  "SNAP": {
    "priceType": "Open",
    "price": 1.05,
    "timestamp": 1494595800005
  }
}

SSE Streaming Example

curl --header 'Accept: text/event-stream' https://cloud-sse.iexapis.com/stable/deep?token=YOUR_TOKEN&symbols=twtr&channels=official-price

Data Weighting

Free

Data Source(s)

Investors Exchange

Examples

Query String Parameters

Option Details
symbols Required.
• Value needs to be a comma-separated list of symbols (i.e SNAP,fb)
• Maximum of 1 symbol

Response Attributes

Key Type Values
priceType string Open - Official Open Price
Close - Official Close Price
price number
timestamp number

DEEP Security Event

The Security event message is used to indicate events that apply to a security. A Security event message will be sent whenever such event occurs.

HTTP request

GET /deep/security-event?symbols=snap

JSON response

{
  "SNAP": {
    "securityEvent": "MarketOpen",
    "timestamp": 1494595800005
  }
}

SSE Streaming Example

curl --header 'Accept: text/event-stream' https://cloud-sse.iexapis.com/stable/deep?token=YOUR_TOKEN&symbols=twtr&channels=security-event

Data Weighting

Free

Data Source(s)

Investors Exchange

Examples

Query String Parameters

Option Details
symbols Required.
• Value needs to be a comma-separated list of symbols (i.e SNAP,fb)
• Maximum of 10 symbols

Response Attributes

Key Type Values
securityEvent string 'MarketOpen' or 'MarketClose'
timestamp number

DEEP Short Sale Price Test Status

In association with Rule 201 of Regulation SHO, the Short Sale Price Test message is used to indicate when a Short Sale Price Test restriction is in effect for a security.

IEX disseminates a full pre-market spin of Short Sale Price Test Status messages indicating the Rule 201 status of all securities. After the pre-market spin, IEX will use the Short Sale Price Test status message in the event of an intraday status change.

The IEX Trading System will process orders based on the latest Short Sale Price Test restriction status.

HTTP request

GET /deep/ssr-status?symbols=snap

JSON response

{
  "SNAP": {
    "isSSR": true,
    "detail": "N",
    "timestamp": 1494588094067
  }
}

SSE Streaming Example

curl --header 'Accept: text/event-stream' https://cloud-sse.iexapis.com/stable/deep?token=YOUR_TOKEN&symbols=twtr&channels=ssr-status

Data Weighting

Free

Data Source(s)

Investors Exchange

Examples

Query String Parameters

Option Details
symbols Required.
• Value needs to be a comma-separated list of symbols (i.e SNAP,fb)
• Maximum of 10 symbols

Response Attributes

Key Type
isSSR boolean
detail string
timestamp number

DEEP System Event

The System Event message is used to indicate events that apply to the market or the data feed.

There will be a single message disseminated per channel for each System Event type within a given trading session.

HTTP request

GET /deep/system-event

JSON response

{
  "systemEvent": "S",
  "timestamp": 1494595800005
}

SSE Streaming Example

curl --header 'Accept: text/event-stream' https://cloud-sse.iexapis.com/stable/deep?token=YOUR_TOKEN&symbols=twtr&channels=system-event

Data Weighting

Free

Data Source(s)

Investors Exchange

Examples

Response Attributes

Key Type Values
systemEvent string O - Start of messages
S - Start of system hours
R - Start of regular market hours
M - End of regular market hours
E - End of system hours
C - End of messages
timestamp number

DEEP Trades

Trade report messages are sent when an order on the IEX Order Book is executed in whole or in part. DEEP sends a Trade report message for every individual fill.

HTTP request

GET /deep/trades?symbols=snap

JSON response

{
  "SNAP": [
    {
      "price": 156.1,
      "size": 100,
      "tradeId": 517341294,
      "isISO": false,
      "isOddLot": false,
      "isOutsideRegularHours": false,
      "isSinglePriceCross": false,
      "isTradeThroughExempt": false,
      "timestamp": 1494619192003
    }
  ]
}

SSE Streaming Example

curl --header 'Accept: text/event-stream' https://cloud-sse.iexapis.com/stable/deep?token=YOUR_TOKEN&symbols=twtr&channels=trades

Data Weighting

Free

Data Source(s)

Investors Exchange

Examples

Query String Parameters

Option Details
symbols Required.
• Value needs to be a comma-separated list of symbols (i.e SNAP,fb)
• Maximum of 10 symbols
last Optional.
• Value needs to be a number (i.e 5)
• Default is 20
• Maximum of 500

Response Attributes

Key Type
price number
size number
tradeId number
isISO boolean
isOddLot boolean
isOutsideRegularHours boolean
isSinglePriceCross boolean
isTradeThroughExempt boolean
timestamp number

DEEP Trade Break

Trade break messages are sent when an execution on IEX is broken on that same trading day. Trade breaks are rare and only affect applications that rely upon IEX execution based data.

HTTP request

GET /deep/trade-breaks?symbols=snap

JSON response

{
  "SNAP": [
    {
      "price": 156.1,
      "size": 100,
      "tradeId": 517341294,
      "isISO": false,
      "isOddLot": false,
      "isOutsideRegularHours": false,
      "isSinglePriceCross": false,
      "isTradeThroughExempt": false,
      "timestamp": 1494619192003
    }
  ]
}

SSE Streaming Example

curl --header 'Accept: text/event-stream' https://cloud-sse.iexapis.com/stable/deep?token=YOUR_TOKEN&symbols=twtr&channels=trade-breaks

Data Weighting

Free

Data Source(s)

Investors Exchange

Examples

Query String Parameters

Option Details
symbols Required.
• Value needs to be a comma-separated list of symbols (i.e SNAP,fb)
• Maximum of 10 symbols
last Optional.
• Value needs to be a number (i.e 5)
• Default is 20
• Maximum of 500

Response Attributes

Key Type
price number
size number
tradeId number
isISO boolean
isOddLot boolean
isOutsideRegularHours boolean
isSinglePriceCross boolean
isTradeThroughExempt boolean
timestamp number

DEEP Trading Status

The Trading status message is used to indicate the current trading status of a security. For IEX-listed securities, IEX acts as the primary market and has the authority to institute a trading halt or trading pause in a security due to news dissemination or regulatory reasons. For non-IEX-listed securities, IEX abides by any regulatory trading halts and trading pauses instituted by the primary or listing market, as applicable.

IEX disseminates a full pre-market spin of Trading status messages indicating the trading status of all securities. In the spin, IEX will send out a Trading status message with “T” (Trading) for all securities that are eligible for trading at the start of the Pre-Market Session. If a security is absent from the dissemination, firms should assume that the security is being treated as operationally halted in the IEX Trading System.

After the pre-market spin, IEX will use the Trading status message to relay changes in trading status for an individual security. Messages will be sent when a security is:

HTTP request

GET /deep/trading-status?symbols=snap

JSON response

{
  "SNAP": {
    "status": "T",
    "reason": " ",
    "timestamp": 1494588017674
  }
}

SSE Streaming Example

curl --header 'Accept: text/event-stream' https://cloud-sse.iexapis.com/stable/deep?token=YOUR_TOKEN&symbols=twtr&channels=trading-status

Data Weighting

Free

Data Source(s)

Investors Exchange

Examples

Query String Parameters

Option Details
symbols Required.
• Value needs to be a comma-separated list of symbols (i.e SNAP,fb)
• Maximum of 10 symbols

Response Attributes

Key Type Values
status string H - Trading halted across all US equity markets
O - Trading halt released into an Order Acceptance Period (IEX-listed securities only)
P - Trading paused and Order Acceptance Period on IEX (IEX-listed securities only)
T - Trading on IEX
reason string Trading Halt Reasons
T1 - Halt News Pending
IPO1 - IPO/New Issue Not Yet Trading
IPOD - IPO/New Issue Deferred
MCB3 - Market-Wide Circuit Breaker Level 3 – Breached
NA - Reason Not Available

Order Acceptance Period Reasons
T2 - Halt News Dissemination
IPO2 - IPO/New Issue Order Acceptance Period
IPO3 - IPO Pre-Launch Period
MCB1 - Market-Wide Circuit Breaker Level 1 – Breached
MCB2 - Market-Wide Circuit Breaker Level 2 – Breached
timestamp number

Last

Last provides trade data for executions on IEX. It is a near real time, intraday API that provides IEX last sale price, size and time. Last is ideal for developers that need a lightweight stock quote.

HTTP request

GET /last?symbols=snap

JSON response

[
  {
    "symbol": "SNAP",
    "price": 111.76,
    "size": 5,
    "time": 1480446905681
  },
  {
    "symbol": "FB",
    "price": 121.41,
    "size": 100,
    "time": 1480446908666
  },
  {
    "symbol": "AIG+",
    "price": 21.52,
    "size": 100,
    "time": 1480446206461
  }
]

Data Weighting

Free

Data Timing

Real-time

Data Schedule

9:30am-4pm ET market hours

Data Source(s)

Investors Exchange

Examples

Query String Parameters

Option Details
symbols Optional.
• Value needs to be a comma-separated list of symbols (i.e SNAP,fb)
• When parameter is not present, request returns all symbols
format Optional.
• Value can only be csv
• When parameter is not present, format defaults to JSON
• Our eligible symbol reference is updated daily. Use these symbols as values in your symbols parameter.

Response Attributes

Key Description
symbol Refers to the stock ticker.
price Refers to last sale price of the stock on IEX.
size Refers to last sale size of the stock on IEX.
time Refers to last sale time in epoch time of the stock on IEX.

Listed Regulation SHO Threshold Securities List In Dev

The following are IEX-listed securities that have an aggregate fail to deliver position for five consecutive settlement days at a registered clearing agency, totaling 10,000 shares or more and equal to at least 0.5% of the issuer’s total shares outstanding (i.e., “threshold securities”).

The report data will be published to the IEX website daily at 8:30 p.m. ET with data for that trading day.

HTTP request

GET /stock/{symbol}/threshold-securities

JSON response

[
  {
    "TradeDate": "20171013",
    "SymbolinINET Symbology": "ZIEXT",
    "SymbolinCQS Symbology": "ZIEXT",
    "SymbolinCMS Symbology": "ZIEXT",
    "SecurityName": "ZIEXT Common Stock"
  },
  {...}
]

Data Weighting

Free

Data Source(s)

Investors Exchange

Examples

Path Parameters

Range Description Source
date Specific date Daily list data for a specified date in the format YYYYMMDD,if available, or sample. If sample, a sample file will be returned

Query String Parameters

Option Details
format Optional.
• Value can be csv or psv
• When parameter is not present, format defaults to JSON
token Optional.
• Value is the API token from your IEX user account
• If you have been permissioned for CUSIP information you’ll receive a CUSIP field, othewise data defaults to exclude CUSIP.

Response Attributes

Refer to the Threshold Securities specification for further details

Stats Historical Daily In Dev

This call will return daily stats for a given month or day.

HTTP request

GET /stats/historical/daily?last=5

JSON response

[
  {
    "date": "2017-05-09",
    "volume": 152907569,
    "routedVolume": 46943802,
    "marketShare": 0.02246,
    "isHalfday": 0,
    "litVolume": 35426666
  },
  {
    "date": "2017-05-08",
    "volume": 142923030,
    "routedVolume": 39507295,
    "marketShare": 0.02254,
    "isHalfday": 0,
    "litVolume": 32404585
  },
  {
    "date": "2017-05-05",
    "volume": 155118117,
    "routedVolume": 39974788,
    "marketShare": 0.02358,
    "isHalfday": 0,
    "litVolume": 35124994
  },
  {
    "date": "2017-05-04",
    "volume": 185715463,
    "routedVolume": 56264408,
    "marketShare": 0.02352,
    "isHalfday": 0,
    "litVolume": 40634976
  },
  {
    "date": "2017-05-03",
    "volume": 183103198,
    "routedVolume": 50953175,
    "marketShare": 0.025009999999999998,
    "isHalfday": 0,
    "litVolume": 40296158
  }
]

Data Weighting

Free

Data Source(s)

Investors Exchange

Examples

The /stats/historical/daily endpoint without any parameters will return the last trading day.

Query String Parameters

Option Details
date Optional.
• Option 1: Value needs to be in four-digit year, two-digit month format (YYYYMM) (i.e January 2017 would be written as 201701)
• Option 2: Value needs to be in four-digit year, two-digit month, two-digit day format (YYYYMMDD) (i.e January 21, 2017 would be written as 20170121)
• Historical data is only available for prior months, starting with January 2014
last Optional.
• Is used in place of date to retrieve last n number of trading days.
• Value can only be a number up to 90
format Optional.
• Value can only be csv
• When parameter is not present, format defaults to JSON

Response Attributes

Key Description
date Refers to the trading day.
volume Refers to executions received from order routed to away trading centers.
routedVolume Refers to single counted shares matched from executions on IEX.
marketShare Refers to IEX’s percentage of total US Equity market volume.
isHalfday Will be true if the trading day is a half day.
litVolume Refers to the number of lit shares traded on IEX (single-counted).

Stats Historical Summary

HTTP request

GET /stats/historical?date=201605

JSON response

[
  {
    "averageDailyVolume": 112247378.5,
    "averageDailyRoutedVolume": 34282226.24,
    "averageMarketShare": 0,
    "averageOrderSize": 493,
    "averageFillSize": 287,
    "bin100Percent": 0.61559,
    "bin101Percent": 0.61559,
    "bin200Percent": 0.61559,
    "bin300Percent": 0.61559,
    "bin400Percent": 0.61559,
    "bin500Percent": 0.61559,
    "bin1000Percent": 0.61559,
    "bin5000Percent": 0.61559,
    "bin10000Percent": 0.61559,
    "bin10000Trades": 4666,
    "bin20000Trades": 1568,
    "bin50000Trades": 231,
    "uniqueSymbolsTraded": 7419,
    "blockPercent": 0.08159,
    "selfCrossPercent": 0.02993,
    "etfPercent": 0.12646,
    "largeCapPercent": 0.40685,
    "midCapPercent": 0.2806,
    "smallCapPercent": 0.18609,
    "venueARCXFirstWaveWeight": 0.22063,
    "venueBATSFirstWaveWeight": 0.06249,
    "venueBATYFirstWaveWeight": 0.07361,
    "venueEDGAFirstWaveWeight": 0.01083,
    "venueEDGXFirstWaveWeight": 0.0869,
    "venueOverallFirstWaveWeight": 1,
    "venueXASEFirstWaveWeight": 0.00321,
    "venueXBOSFirstWaveWeight": 0.02935,
    "venueXCHIFirstWaveWeight": 0.00108,
    "venueXCISFirstWaveWeight": 0.00008,
    "venueXNGSFirstWaveWeight": 0.20358,
    "venueXNYSFirstWaveWeight": 0.29313,
    "venueXPHLFirstWaveWeight": 0.01511,
    "venueARCXFirstWaveRate": 0.97737,
    "venueBATSFirstWaveRate": 0.99357,
    "venueBATYFirstWaveRate": 0.99189,
    "venueEDGAFirstWaveRate": 0.98314,
    "venueEDGXFirstWaveRate": 0.99334,
    "venueOverallFirstWaveRate": 0.98171,
    "venueXASEFirstWaveRate": 0.94479,
    "venueXBOSFirstWaveRate": 0.97829,
    "venueXCHIFirstWaveRate": 0.65811,
    "venueXCISFirstWaveRate": 0.9468,
    "venueXNGSFirstWaveRate": 0.98174,
    "venueXNYSFirstWaveRate": 0.98068,
    "venueXPHLFirstWaveRate": 0.93629
  }
]

Data Weighting

Free

Data Timing

End of month

Data Source(s)

Investors Exchange

Examples

The /stats/historical endpoint without any parameters will return the current month’s stats.

Query String Parameters

Option Details
date Optional.
• Value needs to be in four-digit year, two-digit month format (YYYYMM) (i.e January 2017 would be written as 201701)
• Historical data is only available for prior months, starting with January 2014
• When parameter is not present, request returns prior month’s data
format Optional.
• Value can only be csv
• When parameter is not present, format defaults to JSON

Response Attributes

See our stats page for a reference of the keys.

Stats Intraday

HTTP request

GET /stats/intraday

JSON response

{
  "volume": {
    "value": 26908038,
    "lastUpdated": 1480433817323
  },
  "symbolsTraded": {
    "value": 4089,
    "lastUpdated": 1480433817323
  },
  "routedVolume": {
    "value": 10879651,
    "lastUpdated": 1480433816891
  },
  "notional": {
    "value": 1090683735,
    "lastUpdated": 1480433817323
  },
  "marketShare": {
    "value": 0.01691,
    "lastUpdated": 1480433817336
  }
}

Data Weighting

Free

Data Timing

Real-time

Data Schedule

Regular market hours

Data Source(s)

Investors Exchange

Examples

Response Attributes

Key Description
volume Refers to single counted shares matched from executions on IEX.
symbolsTraded Refers to number of symbols traded on IEX.
routedVolume Refers to executions received from order routed to away trading centers.
notional Refers to sum of matched volume times execution price of those trades.
marketShare Refers to IEX’s percentage of total US Equity market volume.
lastUpdated Refers to the last update time of the data in milliseconds since midnight Jan 1, 1970.

Stats Recent

This call will return a minimum of the last five trading days up to all trading days of the current month.

HTTP request

GET /stats/recent

JSON response

[
  {
    "date": "2017-01-11",
    "volume": 128048723,
    "routedVolume": 38314207,
    "marketShare": 0.01769,
    "isHalfday": false,
    "litVolume": 30520534
  },
  {
    "date": "2017-01-10",
    "volume": 135116521,
    "routedVolume": 39329019,
    "marketShare": 0.01999,
    "isHalfday": false,
    "litVolume": 29721789
  },
  {
    "date": "2017-01-09",
    "volume": 109850518,
    "routedVolume": 31283422,
    "marketShare": 0.01704,
    "isHalfday": false,
    "litVolume": 27699365
  },
  {
    "date": "2017-01-06",
    "volume": 116680433,
    "routedVolume": 29528471,
    "marketShare": 0.01805,
    "isHalfday": false,
    "litVolume": 29357729
  },
  {
    "date": "2017-01-05",
    "volume": 130389657,
    "routedVolume": 40977180,
    "marketShare": 0.01792,
    "isHalfday": false,
    "litVolume": 33169236
  },
  {
    "date": "2017-01-04",
    "volume": 124428433,
    "routedVolume": 38859989,
    "marketShare": 0.01741,
    "isHalfday": false,
    "litVolume": 31563256
  },
  {
    "date": "2017-01-03",
    "volume": 130195733,
    "routedVolume": 34990159,
    "marketShare": 0.01733,
    "isHalfday": false,
    "litVolume": 34150804
  }
]

Data Weighting

Free

Data Source(s)

Investors Exchange

Examples

Response Attributes

Key Description
date Refers to the trading day.
volume Refers to executions received from order routed to away trading centers.
routedVolume Refers to single counted shares matched from executions on IEX.
marketShare Refers to IEX’s percentage of total US Equity market volume.
isHalfday will be true if the trading day is a half day.
litVolume Refers to the number of lit shares traded on IEX (single-counted).

Stats Records

HTTP request

GET /stats/records

JSON response

{
  "volume": {
    "recordValue": 233000477,
    "recordDate": "2016-01-20",
    "previousDayValue": 99594714,
    "avg30Value": 138634204.5
  },
  "symbolsTraded": {
    "recordValue": 6046,
    "recordDate": "2016-11-10",
    "previousDayValue": 5500,
    "avg30Value": 5617
  },
  "routedVolume": {
    "recordValue": 74855222,
    "recordDate": "2016-11-10",
    "previousDayValue": 29746476,
    "avg30Value": 44520084
  },
  "notional": {
    "recordValue": 9887832327.8355,
    "recordDate": "2016-11-10",
    "previousDayValue": 4175710684.3897,
    "avg30Value": 5771412969.2662
  }
}

Data Weighting

Free

Data Timing

End of day

Data Schedule

7am ET

Data Source(s)

Investors Exchange

Examples

Response Attributes

Key Description
volume Refers to single counted shares matched from executions on IEX.
symbolsTraded Refers to number of symbols traded on IEX.
routedVolume Refers to executions received from order routed to away trading centers.
notional Refers to sum of matched volume times execution price of those trades.

TOPS

TOPS provides IEX’s aggregated best quoted bid and offer position in near real time for all securities on IEX’s displayed limit order book. TOPS is ideal for developers needing both quote and trade data.

For an example of an app that’s using TOPS, see the TOPS viewer app.

HTTP request

GET /tops?symbols=snap

JSON response

[
  {
    "symbol": "SNAP",
    "bidSize": 200,
    "bidPrice": 110.94,
    "askSize": 100,
    "askPrice": 111.82,
    "volume": 177265,
    "lastSalePrice": 111.76,
    "lastSaleSize": 5,
    "lastSaleTime": 1480446905681,
    "lastUpdated": 1480446910557,
    "sector": "softwareservices",
    "securityType": "commonstock"
  },
  {
    "symbol": "FB",
    "bidSize": 200,
    "bidPrice": 120.8,
    "askSize": 100,
    "askPrice": 122.5,
    "volume": 205208,
    "lastSalePrice": 121.41,
    "lastSaleSize": 100,
    "lastSaleTime": 1480446908666,
    "lastUpdated": 1480446923942,
    "sector": "softwareservices",
    "securityType": "commonstock"
  },
  {
    "symbol": "AIG+",
    "bidSize": 0,
    "bidPrice": 0,
    "askSize": 0,
    "askPrice": 0,
    "volume": 3400,
    "lastSalePrice": 21.52,
    "lastSaleSize": 100,
    "lastSaleTime": 1480446206461,
    "lastUpdated": -1,
    "sector": "insurance",
    "securityType": "commonstock"
  }
]

Data Weighting

Free

Data Timing

Real-time

Data Schedule

9:30am-4pm ET Market hours

Data Source(s)

Investors Exchange

Examples

Query String Parameters

Option Details
symbols Optional.
• Value needs to be a comma-separated list of symbols (i.e SNAP,fb)
• When parameter is not present, request returns all symbols
format Optional.
• Value can only be csv
• When parameter is not present, format defaults to JSON

Response Attributes

Key Description
symbol Refers to the stock ticker.
bidSize Refers to amount of shares on the bid on IEX.
bidPrice Refers to the best bid price on IEX.
askSize Refers to amount of shares on the ask on IEX.
askPrice Refers to the best ask price on IEX.
volume Refers to shares traded in the stock on IEX.
lastSalePrice Refers to last sale price of the stock on IEX. (Refer to the attribution section above.)
lastSaleSize Refers to last sale size of the stock on IEX.
lastSaleTime Refers to last sale time in epoch time of the stock on IEX.
lastUpdated Refers to the last update time of the data in milliseconds since midnight Jan 1, 1970 or -1. If the value is -1, IEX has not quoted the symbol in the trading day.
sector Refers to the sector the security belongs to.
securityType Refers to the common issue type.

Premium Data

Premium Data is specialized, curated data sourced directly from other data creators. To access an endpoint included with Premium Data, enable access to that dataset in the IEX Cloud Console under the Premium Data tab.

Estimates Data

Analyst Recommendations

Pulls data from the last four months.

HTTP request

GET /stock/{symbol}/recommendation-trends

JSON response

[
  {
    "consensusEndDate": 1542240000000,
    "consensusStartDate": 1541462400000,
    "corporateActionsAppliedDate": 1055721600000,
    "ratingBuy": 8,
    "ratingOverweight": 2,
    "ratingHold": 1,
    "ratingUnderweight": 1,
    "ratingSell": 1,
    "ratingNone": 2,
    "ratingScaleMark": 1.042857
  }
]

Data Weighting

Premium Data

1000 per symbol

Data Timing

End of day

Data Schedule

Updates at 9am, 11am, 12pm UTC every day

Data Source(s)

IEX Cloud

Notes

Only included with paid subscription plans

Available Methods

GET /stock/{symbol}/recommendation-trends

Examples

Response Attributes

Key Type Description
consensusEndDate number Date that represents the last date the consensus value was effective. A NULL value indicates the consensus value is considered current. Represented as millisecond epoch time
consensusStartDate number Date that represents the earliest date the consensus value was effective Represented as millisecond epoch time
corporateActionsAppliedDate number Date through which corporate actions have been applied Represented as millisecond epoch time
ratingBuy number Number of recommendations that fall into the Buy category
ratingOverweight number Number of recommendations that fall into the Overweight category
ratingHold number Number of recommendations that fall into the Hold category
ratingUnderweight number Number of recommendations that fall into the Underweight category
ratingSell number Number of recommendations that fall into the Sell category
ratingNone number Number of brokers where no recommendation is available
ratingScaleMark number Numeric value based on a standardized scale representing the consensus of broker recommendations.
Recommendations are divided into five categories: Buy, Overweight, Hold, Underweight, and Sell. Each is rated between 1 and 3 as shown in the table below.

Recommendation ratings

Rating Category Description
1 Buy Also known as ‘strong buy’, is a recommendation to purchase a specific security.
1.5 Overweight Also known as ‘outperform’ or ‘moderate buy’, overweight means a stock is expected to do slightly better than the overall market return.
2 Hold A security is expected to perform at the same pace as comparable companies or in-line with the market.
2.5 Underweight Also known as ‘underperform’ or ‘moderate sell’, underweight means a stock is expected to do slightly worse than the overall market return.
3 Sell Also known as ‘strong sell’, is a recommendation to sell a security or to liquidate an asset.

Earnings

Earnings data for a given company including the actual EPS, consensus, and fiscal period. Earnings are available quarterly (last 4 quarters) and annually (last 4 years).

HTTP request

GET /stock/{symbol}/earnings/{last}/{field}

JSON response

{
  "symbol": "AAPL",
  "earnings": [
    {
      "EPSReportDate": "2020-10-22",
      "EPSSurpriseDollar": 0.330098697767743855,
      "EPSSurpriseDollarPercent": 0.1440300992341432,
      "actualEPS": 5.07,
      "announceTime": "AMC",
      "consensusEPS": 2.703327,
      "currency": "USD",
      "fiscalEndDate": "2020-09-18",
      "fiscalPeriod": "Q4 2020",
      "numberOfEstimates": 31,
      "periodType": "quarterly",
      "symbol": "AAPL",
      "yearAgo": 4.7006,
      "yearAgoChangePercent": -0.7303425659240847,
      "id": "PREMIUM_EARNINGS",
      "key": "AAPL",
      "subkey": "Q42020",
      "date": 1606312125071,
      "updated": 1606312125071
    }
  ]
}

Data Weighting

Premium Data

1000 per symbol per period

Data Timing

End of day

Data Schedule

Updates at 9am, 11am, 12pm UTC every day

Data Source(s)

IEX Cloud

Notes

Earnings prior to last quarter are only included with paid subscription plans

Available Methods

GET /stock/{symbol}/earnings
GET /stock/{symbol}/earnings/{last}
GET /stock/{symbol}/earnings/{last}/{field}
GET /stock/{symbol}/earnings/{last}?period=annual

Examples

Path Parameters

Option Details
last Optional.
• number - Number of quarters or years to return. Default is 1.
field Optional.
• string - case sensitive string matching a response attribute below. Returns raw value of field specified. Useful for Excel Webservice calls.

Query Parameters

Option Details
last Optional.
• number. Number of quarters or years to return. Default is 1.
period Optional.
• string. Allows you to specify annual or quarterly earnings. Values should be annual or quarter. Default is quarter.

Response Attributes

This endpoint inherits common keys from Time Series.

Key Type Description
EPSReportDate string Expected earnings report date YYYY-MM-DD
EPSSurpriseDollar number Dollar amount of EPS surprise for the period
EPSSurpriseDollarPercent number EPSSurpriseDollar expressed as percent
actualEPS number Actual earnings per share for the period. EPS data is split-adjusted by default. Earnings data accounts for all corporate actions including dilutions, splits, reverse splits, spin-offs, exceptional dividends, and rights issues.
announceTime string Time of earnings announcement. BTO (Before open), DMT (During trading), AMC (After close)
consensusEPS number Consensus EPS estimate trend for the period
currency string Asset currency
fiscalEndDate string Date representing the company fiscal quarter end YYYY-MM-DD
fiscalPeriod string The fiscal quarter Q# YYYY or the fiscal year FY ending in YYYY the earnings data applies to
numberOfEstimates number Number of estimates for the period
periodType string Report period, returns quarterly or annually
symbol string Associated symbol or ticker
yearAgo number Represents the EPS of the quarter a year ago
yearAgoChangePercent number Represents the percent difference between the quarter a year ago actualEPS and current period actualEPS. Returned as a decimal – for example a 13% decline is returned as –0.13..
id string The dataset ID.
Inherited from time-series common.
source string Source of the data if available.
Inherited from time-series common.
key string The requested dataset key.
Inherited from time-series common.
subkey string The requested dataset subkey.
Inherited from time-series common.
date number The date field of the time series as epoch timestamp.
Inherited from time-series common.
updated number The time data was last updated as epoch timestamp.
Inherited from time-series common.

Estimates

Provides the latest consensus estimate for the next fiscal period

HTTP request

GET /stock/{symbol}/estimates

JSON response

{
  "symbol": "AAPL",
  "estimates": [
    {
      "announceTime": "AMC",
      "consensusEPS": 1.42,
      "currency": "USD",
      "fiscalEndDate": "2020-12-23",
      "fiscalPeriod": "Q1 2021",
      "numberOfEstimates": 29,
      "periodType": "quarterly",
      "reportDate": "2020-12-06",
      "symbol": "AAPL",
      "id": "PREMIUM_ESTIMATES",
      "key": "AAPL",
      "subkey": "Q12021",
      "updated": 1660039752352
    }
  ]
}

Data Weighting

Premium Data

10,000 per symbol per period

Data Timing

End of day

Data Schedule

Updates at 9am, 11am, 12pm UTC every day

Data Source(s)

IEX Cloud

Notes

Only included with paid subscription plans

Available Methods

GET /stock/{symbol}/estimates

Examples

Query Parameters

Option Details
last Optional.
• number. Number of quarters or years to return. Default is 1.
period Optional.
• string. Allows you to specify annual or quarterly estimates. Values should be annual or quarter. Default is quarter.

Response Attributes

This endpoint inherits common keys from Time Series.

Key Type Description
announceTime string When the EPS will be announced.
BTO before the open.
AMC after market close
DMT during market
consensusEPS number Consensus EPS estimate trend for the period. EPS data is split-adjusted by default. Earnings data accounts for all corporate actions including dilutions, splits, reverse splits, spin-offs, exceptional dividends, and rights issues. Investopedia
currency string Currency the EPS is reported in
fiscalEndDate string Date representing the company fiscal quarter end YYYY-MM-DD
fiscalPeriod string The fiscal quarter the earnings data applies to Q# YYYY
numberOfEstimates number Number of estimates for the period
periodType string Report period, returns quarterly or annually
reportDate string Expected report date of next earnings
symbol string Associated ticker or symbol
id string The dataset ID.
Inherited from time-series common.
source string Source of the data if available.
Inherited from time-series common.
key string The requested dataset key.
Inherited from time-series common.
subkey string The requested dataset subkey.
Inherited from time-series common.
date number The date field of the time series as epoch timestamp.
Inherited from time-series common.
updated number The time data was last updated as epoch timestamp.
Inherited from time-series common.

Price Target

Provides the latest avg, high, and low analyst price target for a symbol.

HTTP request

GET /stock/{symbol}/price-target

JSON response

{
  "symbol": "AAPL",
  "updatedDate": "2019-01-30",
  "priceTargetAverage": 178.59,
  "priceTargetHigh": 245,
  "priceTargetLow": 140,
  "numberOfAnalysts": 34,
  "currency": "USD"
}

Data Weighting

Premium Data

500 per symbol

Data Timing

End of day

Data Schedule

Updates at 10am, 11am, 12pm UTC every day

Data Source(s)

IEX Cloud

Notes

Only included with paid subscription plans

Available Methods

GET /stock/{symbol}/price-target

Examples

Response Attributes

Key Type Description
symbol number
updatedDate string Date of the most recent price target
priceTargetAverage number Average price target
priceTargetHigh number Highest price target
priceTargetLow number Lowest price target
numberOfAnalysts number Number of analysts that provided price targets
currency string Currency of the price target

Wall Street Horizon

Wall Street Horizon monitors multiple primary sources of corporate event data, including press releases, company websites, SEC filings, and corporate IR information. Their process uses proprietary algorithms for information combined with the team’s proactive outreach to corporate IR officers.

This market intelligence can inform strategies, create opportunities, or help manage risk. Wall Street Horizon believes a company’s silent cues can provide the earliest indication that something positive or negative is about to happen in a company.

Academic research has shown that corporate event revisions, such as delayed earnings releases or speaker changes at an investor conference, can affect a company’s stock price. For example, a recent study from Northwestern “The Speed of the Market Reaction to Pre-Open versus Post-Close Announcements” finds that firms which announce in the pre-open have higher abnormal volatility following the announcement relative to firms that announce in the post-close.

Wall Street Horizon’s whitepaper “Exploring Corporate Events and Volatility: Considerations for Financial and Academic research” details how leveraging data to understand patterns - such as repetitive and sporadic scheduling, time/day of week schedules and a confluence of events at the same company or comparisons to peer companies - can benefit the financial community’s investing strategies.

How to use Wall Street Horizon data

An effective way to consume this data is as a calendar of events, and then running daily updates to find changes. Using the time series calendar feature, you can use short-hand codes to pull future event data such as tomorrow, next-week, this-month, next-month, and more.

To pull event updates that occurred on the current date, use time series without the calendar parameter, range=today, and updated=true. Using the updated parameter will query for data by update date rather than event date.

Analyst Days

This is a meeting where company executives provide information about the company’s performance and its future prospects.

HTTP request

GET /time-series/PREMIUM_WALLSTREETHORIZON_ANALYST_DAY/{symbol?}/{eventId?}

JSON response

[
  {
    "eventId": "14OUEA38",
    "symbol": "AAPL",
    "companyName": "Apple, Inc.",
    "announceDate": null,
    "organizer": "ONEN",
    "eventDesc": "This is an example Event description",
    "eventStatus": "PENDING",
    "sectorNames": "Technology",
    "startDate": "2019-11-01",
    "endDate": "2019-10-31",
    "localTimeStart": "11:00AM",
    "timeZone": "EST",
    "venue": null,
    "venueAddress": null,
    "venueCity": null,
    "venueState": null,
    "venueCountry": "United States",
    "venueCountryIso": "USA",
    "purl": "h89o=cih/oztuson/am.?2/.tmteam.rlwr9tmps6l4:upe",
    "inviteUrl": "fcm2/srduceie2nm.imfdi/taalrh:esatd.ha/x8lpmur3/0lstpeia9.rmtmrc4ftotdone9g7ed//eh/a/4o",
    "scheduleUrl": null,
    "additionalInfoUrl": null,
    "externalNote": null,
    "referenceLink": null,
    "updated": "1619301935435",
    "id": "PREMIUM_WALLSTREETHORIZON_ANALYST_DAY",
    "source": "WallStreetHorizon",
    "key": "IGLR",
    "subkey": "18AOU3E4",
    "date": "1571832000000"
  }
]

Data Weighting

Premium Data 1,125,000 per event

Data Timing

Intraday

Data Schedule

6am , 10am , 2pm , 6pm and 9pm daily

Data Source(s)

Wall Street Horizon

Notes

This is a Premium Data end-point available to only paying customers. You will be charged directly at pay-as-you-go rates and the messages consumed from this end-point will not come from your base subscription message allocation.

Available Methods

GET /time-series/PREMIUM_WALLSTREETHORIZON_ANALYST_DAY/{symbol?}/{eventId?}

Examples

Query Parameters

This end point uses all standard time-series query parameters.

Response Attributes

Key Type Description
eventId string Unique WallStreetHorizon event identifier
symbol string The symbol of the company
companyName string The name of the company
announceDate string Event announcement date, formatted YYYY-MM-DD
organizer string Event organizer
eventDesc string A description of the event
eventStatus string Status of event, possible values are PENDING, INPROCESS or CANCEL. PENDING indicates a future event. INPROCESS indicates today is inclusive of the start and end dates for the event.
sectorNames string The sector/industry for the company
startDate string The start date of the event, formatted YYYY-MM-DD
endDate string The end date of the event, formatted YYYY-MM-DD
localTimeStart string The local start time of the event
timeZone string ISO time zone code of the event start time
venue string Location of the event
venueAddress string The street address of the venue
venueCity string The city of the venue
venueState string The state of the venue
venueCountry string The country of the venue
venueCountryIso string The ISO country code of the venue
purl string Link to the event website
inviteUrl string Link to the event registration
scheduleUrl string Link to the event schedule
additionalInfoUrl string Link to additional event information
externalNote string Important information regarding the event
referenceLink string Link to the latest press release for the event
updated string Date and time data was returned in epoch format

Board of Directors Meeting

This is an end-point for getting information about a formal meeting of a company’s board of directors to establish corporate management related policies and to make decisions on major company issues.

HTTP request

GET /time-series/PREMIUM_WALLSTREETHORIZON_BOARD_OF_DIRECTORS_MEETING/{symbol?}/{eventId?}

JSON response

[
  {
    "eventId": "46ZG38B3",
    "symbol": "AAPL",
    "companyName": "Apple, Inc.",
    "announceDate": "2019-10-21",
    "startDate": "2019-10-31",
    "endDate": "2019-10-31",
    "updated": "1573178864659",
    "id": "PREMIUM_WALLSTREETHORIZON_BOARD_OF_DIRECTORS_MEETING",
    "source": "WallStreetHorizon",
    "key": "TJFPS",
    "subkey": "4Z3368BG",
    "date": "1571832000000"
  }
]

Data Weighting

Premium Data 1,125,000 per event

Data Timing

Intraday

Data Schedule

6am , 10am , 2pm , 6pm and 9pm daily

Data Source(s)

Wall Street Horizon

Notes

This is a Premium Data end-point available to only paying customers. You will be charged directly at pay-as-you-go rates and the messages consumed from this end-point will not come from your base subscription message allocation.

Available Methods

GET /time-series/PREMIUM_WALLSTREETHORIZON_BOARD_OF_DIRECTORS_MEETING/{symbol?}/{eventId?}

Examples

Query Parameters

This end point uses all standard time-series query parameters.

Response Attributes

Key Type Description
eventId string Unique WallStreetHorizon event identifier
symbol string The symbol of the company
companyName string The name of the company
announceDate string Event announcement date and time, formatted YYYY-MM-DD
startDate string The start date of the event, formatted YYYY-MM-DD
endDate string The end date of the event, formatted YYYY-MM-DD
updated string Date and time data was returned in epoch format

Business Updates

This is a meeting orconference call in which company information is reviewed by one or more company executives.

HTTP request

GET /time-series/PREMIUM_WALLSTREETHORIZON_BUSINESS_UPDATE/{symbol?}/{eventId?}

JSON response

[
  {
    "eventId": "4BI1AA34",
    "symbol": "AAPL",
    "companyName": "Apple, Inc.",
    "announceDate": "2017-01-15",
    "organizer": "NOEN",
    "eventDesc": "This is an example of an event's description.",
    "eventStatus": "PENDING",
    "sectorNames": "Technology",
    "startDate": "2019-11-02",
    "endDate": "2019-10-29",
    "localTimeStart": null,
    "timeZone": "EST",
    "venue": null,
    "venueAddress": null,
    "venueCity": "San Francisco",
    "venueState": "CA",
    "venueCountry": "United States",
    "venueCountryIso": "USA",
    "purl": "http://example-link-to-url.com",
    "inviteUrl": null,
    "scheduleUrl": null,
    "additionalInfoUrl": null,
    "externalNote": null,
    "referenceLink": null,
    "updated": "1625894809888",
    "id": "PREMIUM_WALLSTREETHORIZON_BUSINESS_UPDATE",
    "source": "WallStreetHorizon",
    "key": "NLT-STA",
    "subkey": "A1ABI443",
    "date": "1571832000000"
  }
]

Data Weighting

Premium Data 1,125,000 per event

Data Timing

Intraday

Data Schedule

6am , 10am , 2pm , 6pm and 9pm daily

Data Source(s)

Wall Street Horizon

Notes

This is a Premium Data end-point available to only paying customers. You will be charged directly at pay-as-you-go rates and the messages consumed from this end-point will not come from your base subscription message allocation.

Available Methods

GET /time-series/PREMIUM_WALLSTREETHORIZON_BUSINESS_UPDATE/{symbol?}/{eventId?}

Examples

Query Parameters

This end point uses all standard time-series query parameters.

Response Attributes

Key Type Description
eventId string Unique WallStreetHorizon event identifier
symbol string The symbol of the company
companyName string The name of the company
announceDate string Event announcement date, formatted YYYY-MM-DD
organizer string Event organizer
eventDesc string A description of the event
eventStatus string Status of event, possible values are PENDING, INPROCESS or CANCEL. PENDING indicates a future event. INPROCESS indicates today is inclusive of the start and end dates for the event.
sectorNames string The sector/industry for the company
startDate string The start date of the event, formatted YYYY-MM-DD
endDate string The end date of the event, formatted YYYY-MM-DD
localTimeStart string The local start time of the event
timeZone string ISO time zone code of the event start time
venue string Location of the event
venueAddress string The street address of the venue
venueCity string The city of the venue
venueState string The state of the venue
venueCountry string The country of the venue
venueCountryIso string The ISO country code of the venue
purl string Link to the event website
inviteUrl string Link to the event registration
scheduleUrl string Link to the event schedule
additionalInfoUrl string Link to additional event information
externalNote string Important information regarding the event
referenceLink string Link to the latest press release for the event
updated string Date and time data was returned in epoch format

Buybacks

The repurchase of outstanding shares by a company to reduce the number of shares on the market.

HTTP request

GET /time-series/PREMIUM_WALLSTREETHORIZON_BUYBACK/{symbol?}/{eventId?}

JSON response

[
  {
    "eventId": "E43BVKB6",
    "recordType": "INITIAL",
    "symbol": "AAPL",
    "companyName": "Apple, Inc.",
    "buybackStatus": "OPEN",
    "buybackMethod": "OPEN MARKET",
    "announceDate": "2019-11-05",
    "approvalDate": null,
    "numberOfShares": 276562,
    "sharesDifferent": null,
    "percentOfShares": 5,
    "shareValue": 0,
    "shareValueCurrency": "USD",
    "valueDifferent": null,
    "endDate": null,
    "priceFrom": null,
    "priceTo": null,
    "tenderResult": null,
    "tenderExpiration": null,
    "newsReferences": "tirplts3eenot--hf5w/stuoniihe./o3rcn1rro-asc.rn47aw.hasgp-/lc0nne:-c6m/ylcooe0aootsmmoe",
    "externalNotes": null,
    "created": "029121: -5 -P23041M:00",
    "updated": "1626477653842",
    "id": "PREMIUM_WALLSTREETHORIZON_BUYBACK",
    "source": "WallStreetHorizon",
    "key": "TFKBL",
    "subkey": "VEBKB634",
    "date": "1571745600000"
  }
]

Data Weighting

Premium Data 1,125,000 per event

Data Timing

Intraday

Data Schedule

6am , 10am , 2pm , 6pm and 9pm daily

Data Source(s)

Wall Street Horizon

Notes

This is a Premium Data end-point available to only paying customers. You will be charged directly at pay-as-you-go rates and the messages consumed from this end-point will not come from your base subscription message allocation.

Available Methods

GET /time-series/PREMIUM_WALLSTREETHORIZON_BUYBACK/{symbol?}/{eventId?}

Examples

Query Parameters

This end point uses all standard time-series query parameters.

Key Type Description
eventId string Unique WallStreetHorizon event identifier.
recordType string Always INITIAL
symbol string The symbol of the company.
companyName string The name of the company.
buybackStatus string OPEN, COMPLETED, CANCELED or RETIRED
buybackMethod string OPEN MARKET or TENDER OFFER
announceDate string Event announcement date, formatted YYYY-MM-DD
approvalDate string Event approval date, formatted YYYY-MM-DD
numberOfShares number Number of authorized shares to be repurchased
sharesDifferent number Identifies whether the number of shares changes since first published
percentOfShares number Percent of outstanding shares changed since first published
shareValue number The value of shares authorized to be purchased
shareValueCurrency string The currency of the share value
valueDifferent number Identified whether the share value changed since first published
endDate number The end date of the event, formatted YYYY-MM-DD
priceFrom number The low end of the tender offer range
priceTo number The high end of the tender offer range
tenderResult number Stock purcahse price for tender offer
tenderExpiration string The expiration date and time of the tender offer, formatted YYYY-MM-DD
newsReferences string Link to the latest press release for the event
externalNotes string Important information regarding the event
created string -
updated string Refers to the machine readable epoch timestamp of when this entry was last updated

Capital Markets Day

This is a meeting where company executives provide information about the company’s performance and its future prospects.

HTTP request

GET /time-series/PREMIUM_WALLSTREETHORIZON_CAPITAL_MARKETS_DAY

JSON response

[
  {
    "eventId": "2VXM3O04",
    "symbol": "UTGPF",
    "companyName": "Apple, Inc.",
    "announceDate": null,
    "organizer": "NEON",
    "eventDesc": "An example of an event description.",
    "eventStatus": "INPROCESS",
    "sectorNames": "Technology",
    "startDate": "2019-10-29",
    "endDate": "2019-11-03",
    "localTimeStart": null,
    "timeZone": "GTM",
    "venue": null,
    "venueAddress": null,
    "venueCity": null,
    "venueState": null,
    "venueCountry": "United Kingdom",
    "venueCountryIso": "GBR",
    "purl": "t7mtosao/ehpil.25:u7l.eaop9rurt=twcz6.sm?m//nhm",
    "inviteUrl": null,
    "scheduleUrl": null,
    "additionalInfoUrl": null,
    "externalNote": "tee.aaht rP l svapntnaiossldieith ot ieso",
    "referenceLink": null,
    "updated": "1627694513103",
    "id": "PREMIUM_WALLSTREETHORIZON_CAPITAL_MARKETS_DAY",
    "source": "WallStreetHorizon",
    "key": "PTFGU",
    "subkey": "OMXV0234",
    "date": "1571832000000"
  }
]

Data Weighting

Premium Data 1,125,000 per event

Data Timing

Intraday

Data Schedule

6am , 10am , 2pm , 6pm and 9pm daily

Data Source(s)

Wall Street Horizon

Notes

This is a Premium Data end-point available to only paying customers. You will be charged directly at pay-as-you-go rates and the messages consumed from this end-point will not come from your base subscription message allocation.

Available Methods

GET /time-series/PREMIUM_WALLSTREETHORIZON_CAPITAL_MARKETS_DAY

Examples

Query Parameters

This end point uses all standard time-series query parameters.

Response Attributes

Key Type Description
eventId string Unique WallStreetHorizon event identifier
symbol string The symbol of the company
companyName string The name of the company
announceDate string Event announcement date, formatted YYYY-MM-DD
organizer string Event organizer
eventDesc string A description of the event
eventStatus string Status of event, possible values are PENDING, INPROCESS or CANCEL. PENDING indicates a future event. INPROCESS indicates today is inclusive of the start and end dates for the event.
sectorNames string The sector/industry for the company
startDate string The start date of the event, formatted YYYY-MM-DD
endDate string The end date of the event, formatted YYYY-MM-DD
localTimeStart string The local start time of the event
timeZone string ISO time zone code of the event start time
venue string Location of the event
venueAddress string The street address of the venue
venueCity string The city of the venue
venueState string The state of the venue
venueCountry string The country of the venue
venueCountryIso string The ISO country code of the venue
purl string Link to the event website
inviteUrl string Link to the event registration
scheduleUrl string Link to the event schedule
additionalInfoUrl string Link to additional event information
externalNote string Important information regarding the event
referenceLink string Link to the latest press release for the event
updated string Refers to the machine readable epoch timestamp of when this entry was last updated

Company Travel

This is a roadshow or bus tour event in which one or more company executives speaks to interested investors and analysts.

HTTP request

GET /time-series/PREMIUM_WALLSTREETHORIZON_COMPANY_TRAVEL/{symbol?}/{eventId?}

JSON response

[
  {
    "eventId": "HG39VAAT",
    "symbol": "GVDBF",
    "companyName": "Apple, Inc.",
    "announceDate": "2018-12-19",
    "organizer": "ONNE",
    "eventDesc": "This is example of an event description",
    "eventStatus": "INPROCESS",
    "sectorNames": "Technology",
    "startDate": "2019-10-28",
    "endDate": "2019-11-07",
    "localTimeStart": null,
    "timeZone": "HKT",
    "venue": null,
    "venueAddress": null,
    "venueCity": "Hong Kong",
    "venueState": null,
    "venueCountry": "Hong Kong",
    "venueCountryIso": "HKG",
    "purl": "pnotteruotm/wls.r:cm1itsp/.7zmhaue1m0?=5ola.h8/",
    "inviteUrl": null,
    "scheduleUrl": null,
    "additionalInfoUrl": null,
    "externalNote": null,
    "referenceLink": "igo-dw.slrhcrs/awcntiororriot/tepmhaaofeswe:taio-vlseti/n?teih/onnvasnuisntino=as.trddsreenvavn/dm",
    "updated": "1610374377729",
    "id": "PREMIUM_WALLSTREETHORIZON_COMPANY_TRAVEL",
    "source": "WallStreetHorizon",
    "key": "BDFVG",
    "subkey": "H9AGV3AT",
    "date": "1571659200000"
  }
]

Data Weighting

Premium Data 1,125,000 per event

Data Timing

Intraday

Data Schedule

6am , 10am , 2pm , 6pm and 9pm daily

Data Source(s)

Wall Street Horizon

Notes

This is a Premium Data end-point available to only paying customers. You will be charged directly at pay-as-you-go rates and the messages consumed from this end-point will not come from your base subscription message allocation.

Available Methods

GET /time-series/PREMIUM_WALLSTREETHORIZON_COMPANY_TRAVEL/{symbol?}/{eventId?}

Examples

Query Parameters

This end point uses all standard time-series query parameters.

Response Attributes

Key Type Description
eventId string Unique WallStreetHorizon event identifier
symbol string The symbol of the company
companyName string The name of the company
announceDate string Event announcement date, formatted YYYY-MM-DD
organizer string Event organizer
eventDesc string A description of the event
eventStatus string Status of event, possible values are PENDING, INPROCESS or CANCEL. PENDING indicates a future event. INPROCESS indicates today is inclusive of the start and end dates for the event.
sectorNames string The sector/industry for the company
startDate string The start date of the event, formatted YYYY-MM-DD
endDate string The end date of the event, formatted YYYY-MM-DD
localTimeStart string The local start time of the event
timeZone string ISO time zone code of the event start time
venue string Location of the event
venueAddress string The street address of the venue
venueCity string The city of the venue
venueState string The state of the venue
venueCountry string The country of the venue
venueCountryIso string The ISO country code of the venue
purl string Link to the event website
inviteUrl string Link to the event registration
scheduleUrl string Link to the event schedule
additionalInfoUrl string Link to additional event information
externalNote string Important information regarding the event
referenceLink string Link to the latest press release for the event
updated string Refers to the machine readable epoch timestamp of when this entry was last updated

Filing Due Dates

This is an estimated date, based on historical trends for this company in which a company must file the appropriate Form for the quarter/year or file for an extension.

HTTP request

GET /time-series/PREMIUM_WALLSTREETHORIZON_FILING_DUE_DATE

JSON response

[
  {
    "eventId": "6VFAR3H2",
    "symbol": "COLFF",
    "companyName": "Colabor Group Inc.",
    "filingDueDate": "2019-11-03",
    "quarter": "3Q",
    "fiscalYear": 2037,
    "updated": "1598878238947",
    "id": "PREMIUM_WALLSTREETHORIZON_FILING_DUE_DATE",
    "source": "WallStreetHorizon",
    "key": "LFOFC",
    "subkey": "AF36RHV2",
    "date": "1571745600000"
  }
]

Data Weighting

Premium Data 1,125,000 per event

Data Timing

Intraday

Data Schedule

6am , 10am , 2pm , 6pm and 9pm daily

Data Source(s)

Wall Street Horizon

Notes

This is a Premium Data end-point available to only paying customers. You will be charged directly at pay-as-you-go rates and the messages consumed from this end-point will not come from your base subscription message allocation.

Available Methods

GET /time-series/PREMIUM_WALLSTREETHORIZON_FILING_DUE_DATE

Examples

Query Parameters

This end point uses all standard time-series query parameters.

Response Attributes

Key Type Description
eventId string Unique WallStreetHorizon event identifier
symbol string The symbol of the company
companyName string The name of the company
filingDueDate string Company’s filing due date for the fiscal year in epoch format, formatted YYYY-MM-DD
quarter string Event time period, Q1-Q4, H1, H2
fiscalYear number Company’s fiscal year for the event
updated string Refers to the machine readable epoch timestamp of when this entry was last updated

Fiscal Quarter End

This is a forecasted quarterly ending announcement date for a company. This may or may not correspond to a calendar quarter.

HTTP request

GET /time-series/PREMIUM_WALLSTREETHORIZON_FISCAL_QUARTER_END_DATE

JSON response

[
  {
    "eventId": "VTF6AF31",
    "symbol": "ANCTF",
    "companyName": "Apple, Inc.",
    "quarterEndDate": "2019-10-22",
    "quarter": "2Q",
    "fiscalYear": 2018,
    "updated": "1643353256029",
    "id": "PREMIUM_WALLSTREETHORIZON_FISCAL_QUARTER_END_DATE",
    "source": "WallStreetHorizon",
    "key": "CNAFT",
    "subkey": "FAT6VF31",
    "date": "1570968000000"
  }
]

Data Weighting

Premium Data 1,125,000 per event

Data Timing

Intraday

Data Schedule

6am , 10am , 2pm , 6pm and 9pm daily

Data Source(s)

Wall Street Horizon

Notes

This is a Premium Data end-point available to only paying customers. You will be charged directly at pay-as-you-go rates and the messages consumed from this end-point will not come from your base subscription message allocation.

Available Methods

GET /time-series/PREMIUM_WALLSTREETHORIZON_FISCAL_QUARTER_END_DATE

Examples

Query Parameters

This end point uses all standard time-series query parameters.

Response Attributes

Key Type Description
eventId string Unique WallStreetHorizon event identifier
symbol string The symbol of the company
companyName string The name of the company
quarterEndDate string Company’s fiscal quarter/half-year end date, formatted YYYY-MM-DD
quarter string Event time period, Q1-Q4, H1, H2
fiscalYear number Company’s fiscal year for the event
updated string Refers to the machine readable epoch timestamp of when this entry was last updated

Forum

This is a meeting where ideas and views of a business nature can be exchanged.

HTTP request

GET /time-series/PREMIUM_WALLSTREETHORIZON_FORUM

JSON response

[
  {
    "eventId": "394E9E2H",
    "announceDate": "ndealdvaitI ",
    "organizer": "NONE",
    "eventDesc": "r0m ArmNr0u2ct 2aoX i CeFoh",
    "eventStatus": "ENNPIGD",
    "sectorNames": "TNMSINETEV",
    "startDate": "2020-06-16",
    "endDate": "2020-06-18",
    "localTimeStart": { },
    "timeZone": "EST",
    "venue": { },
    "venueAddress": { },
    "venueCity": "ikwtroN CeyY",
    "venueState": "NY",
    "venueCountry": "inetsSeUattd ",
    "venueCountryIso": "SUA",
    "purl": "8np.?w/9zl:eues=rhmt32lam/9mht/aoucptos.mri.t5o",
    "inviteUrl": { },
    "scheduleUrl": { },
    "additionalInfoUrl": { },
    "externalNote": { },
    "referenceLink": { },
    "updated": "1584001101524",
    "presenters": {
      "presenter": {
        "eventId": "EI9E9432",
        "symbol": "FORR",
        "companyName": "Forrester Research",
        "startDate": "2020-06-23",
        "endDate": "2020-06-27",
        "time": { },
        "announceDate": "2019-10-31",
        "presenterName": "mneMeatgan",
        "presenterTitle": { },
        "created": "83:914M220A0-1 -311:1",
        "updated": "2019-10-28"
      }
    },
    "symbol": "FORR",
    "id": "ITR_LHUEPURR_ZETSWOMLNRAOMMOEFI",
    "source": "Htiazen SeroWlort l",
    "key": "RRFO",
    "subkey": "E949H32E",
    "date": "1592308800000"
  }
]

Data Weighting

Premium Data 1,125,000 per event

Data Timing

Intraday

Data Schedule

6am , 10am , 2pm , 6pm and 9pm daily

Data Source(s)

Wall Street Horizon

Notes

This is a premium data end-point available to only paying customers. You will be charged directly at pay-as-you-go rates and the messages consumed from this end-point will not come from your base subscription message allocation.

Available Methods

GET /time-series/PREMIUM_WALLSTREETHORIZON_FORUM

Examples

Query Parameters

This end point uses all standard time-series query parameters.

Response Attributes

Key Type Description
eventId string Unique WallStreetHorizon event identifier.
announceDate string Event announcement date.
organizer string Event organizer.
eventDesc string Event description.
eventStatus string Status of event, possible values are PENDING, INPROCESS or CANCEL. PENDING indicates a future event. INPROCESS indicates today is inclusive of the start and end dates for the event.
sectorNames string The sector/industry for the company.
startDate string The start date of the event, formatted YYYY-MM-DD
endDate string The end date of the event, formatted YYYY-MM-DD
localTimeStart number The local start time of the event.
timeZone string ISO time zone code.
venue string Location of the event.
venueAddress string The street address of the venue.
venueCity string The city of the venue.
venueState string The state of the venue.
venueCountry string The country of the venue.
venueCountryIso string The ISO country code of the venue.
purl string Link to the event website.
inviteUrl string Link to the event registration.
scheduleUrl string Link to the event schedule.
additionalInfoUrl string Link to additional event information.
externalNote string Important information regarding the event.
referenceLink string Link to the latest press release for the event.
updated string Refers to the machine readable epoch timestamp of when this entry was last updated
presenters object The presenters of the event
symbol string The symbol of the company.

General Conference

This is a formal meeting in which representatives of many companies gather to discuss ideas or issues related to a particular topic or business, usually held for several days. This item indicates at least one representative from the company will be presenting at the conference on the specified date and time. Note: Conference details include full Conference dates.

HTTP request

GET /time-series/PREMIUM_WALLSTREETHORIZON_GENERAL_CONFERENCE

JSON response

[
  {
    "eventId": "3BT4B8FA",
    "announceDate": "2019-09-22",
    "organizer": "NNOE",
    "eventDesc": "oeCSxceC I0)srui 2XpEeCm(tr200e2 n",
    "eventStatus": "INPEGDN",
    "sectorNames": "EHTNYLGOCO",
    "startDate": "2020-10-16",
    "endDate": "2020-10-16",
    "localTimeStart": { },
    "timeZone": "TSE",
    "venue": "ge lknrheRSiCn esoe",
    "venueAddress": { },
    "venueCity": "odaOnrl",
    "venueState": "FL",
    "venueCountry": "neetStsdatU i",
    "venueCountryIso": "SUA",
    "purl": "t?l/ulue5/wtnh.oz2m96moreo.pichr8mamsp=8ts/:.ta",
    "inviteUrl": { },
    "scheduleUrl": { },
    "additionalInfoUrl": { },
    "externalNote": { },
    "referenceLink": "f:pwwscitc.sb//whmcwcotsoei/.n",
    "updated": "1638110152939",
    "presenters": {
      "presenter": {
        "eventId": "B4A38UFB",
        "symbol": "CSVI",
        "companyName": "Computer Services Inc.",
        "startDate": "2020-10-18",
        "endDate": "2020-10-16",
        "time": { },
        "announceDate": "2019-10-03",
        "presenterName": "teameagnMn",
        "presenterTitle": { },
        "created": "031-0 M: 92-8:3091A082",
        "updated": "2019-09-30"
      }
    },
    "symbol": "CSVI",
    "id": "EENNELATHETRN_WEOARIPRRRMSE_EZEMUFLIOCGN_CLO",
    "source": "rS aHotl zoWerietnl",
    "key": "VCIS",
    "subkey": "T3BAB4F8",
    "date": "1601985600000"
  }
]

Data Weighting

Premium Data 1,125,000 per event

Data Timing

Intraday

Data Schedule

6am , 10am , 2pm , 6pm and 9pm daily

Data Source(s)

Wall Street Horizon

Notes

This is a premium data end-point available to only paying customers. You will be charged directly at pay-as-you-go rates and the messages consumed from this end-point will not come from your base subscription message allocation.

Available Methods

GET /time-series/PREMIUM_WALLSTREETHORIZON_GENERAL_CONFERENCE

Examples

Query Parameters

This end point uses all standard time-series query parameters.

Response Attributes

Key Type Description
eventId string Unique WallStreetHorizon event identifier.
announceDate string Event announcement date.
organizer string Event organizer.
eventDesc string Event description.
eventStatus string Status of event, possible values are PENDING, INPROCESS or CANCEL. PENDING indicates a future event. INPROCESS indicates today is inclusive of the start and end dates for the event.
sectorNames string The sector/industry for the company.
startDate string The start date of the event.
endDate string The end date of the event
localTimeStart string The local start time of the event.
timeZone string ISO time zone code.
venue string Location of the event.
venueAddress string The street address of the venue.
venueCity string The city of the venue.
venueState string The state of the venue.
venueCountry string The country of the venue.
venueCountryIso string The ISO country code of the venue.
purl string Link to the event website.
inviteUrl string Link to the event registration.
scheduleUrl string Link to the event schedule.
additionalInfoUrl string Link to additional event information.
externalNote string Important information regarding the event.
referenceLink string Link to the latest press release for the event.
updated string Refers to the machine readable epoch timestamp of when this entry was last updated
presenters object The presenters of the event
symbol string The symbol of the company.

FDA Advisory Committee Meetings

The FDA uses 50 committees and panels to obtain independent expert advice on scientific, technical, and policy matters

HTTP request

GET /time-series/PREMIUM_WALLSTREETHORIZON_STOCK_SPECIFIC_FDA_ADVISORY_COMMITTEE_MEETING

JSON response

[
  {
    "eventId": "BMT438US",
    "symbol": "SGIOF",
    "companyName": "Apple, Inc.",
    "organizer": "FDA",
    "eventDesc": "Example event description",
    "eventStatus": "EDOIMNRFC",
    "startDate": "2019-10-17",
    "endDate": "2019-10-28",
    "localTimeStart": "8:00 AM",
    "timeZone": "EST",
    "venue": "Example Venue",
    "venueAddress": "10 Weehawken road",
    "venueCity": "Springs Town",
    "venueState": "MD",
    "venueCountry": "United States",
    "venueCountryIso": "USA",
    "externalNote": null,
    "referenceLink": "iwerr-detodtv6ciegt/i1m6iuodug/1ar2e6-ayavmoeiros:./d1e--/f-em---cewmydne.i9aiocs/-oavmnrc0gse01tri-9nr0n2l11nvn1otothed2bmamia0t0psbtc91t-sicleaytonmc--woosmatt",
    "updated": "1624095887197",
    "id": "PREMIUM_WALLSTREETHORIZON_STOCK_SPECIFIC_FDA_ADVISORY_COMMITTEE_MEETING",
    "source": "WallStreetHorizon",
    "key": "OIFSG",
    "subkey": "M84S3TBU",
    "date": "1571227200000"
  }
]

Data Weighting

Premium Data 1,125,000 per event

Data Timing

Intraday

Data Schedule

6am , 10am , 2pm , 6pm and 9pm daily

Data Source(s)

Wall Street Horizon

Notes

This is a Premium Data end-point available to only paying customers. You will be charged directly at pay-as-you-go rates and the messages consumed from this end-point will not come from your base subscription message allocation.

Available Methods

GET /time-series/PREMIUM_WALLSTREETHORIZON_STOCK_SPECIFIC_FDA_ADVISORY_COMMITTEE_MEETING

Examples

Query Parameters

This end point uses all standard time-series query parameters.

Response Attributes

Key Type Description
eventId string Unique WallStreetHorizon event identifier
symbol string The symbol of the company
companyName string The name of the company
organizer string Event organizer
eventDesc string The name of the meeting
eventStatus string This returns CONFIRMED or UNCONFIRMED
startDate string The start date of the event, formatted YYYY-MM-DD
endDate string The end date of the event, formatted YYYY-MM-DD
localTimeStart string The local start time of the event
timeZone string ISO time zone code of the event start time
venue string Location of the event
venueAddress string The street address of the venue
venueCity string The city of the venue
venueState string The state of the venue
venueCountry string The country of the venue
venueCountryIso string The ISO country code of the venue
externalNote string Important information regarding the event
referenceLink string Link to the latest press release for the event
updated string Refers to the machine readable epoch timestamp of when this entry was last updated

Holidays

This returns a list of market holidays.

HTTP request

GET /time-series/PREMIUM_WALLSTREETHORIZON_HOLIDAYS

JSON response

[
  {
    "eventId": "4380B020",
    "eventDate": "2020-10-20",
    "eventDay": "Mno",
    "eventName": "yDauluobms C",
    "earlyCloseTime": { },
    "countryCode": "US",
    "financialCenterName": "srS aUiuesTer ",
    "updated": "1646024873087",
    "symbol": "MARKET",
    "id": "RSALOUPTEEMNIW_DYHSOORIAER_MLILZTH",
    "source": "ezWtrr ilaol netHSo",
    "key": "AMKRET",
    "subkey": "B0024308",
    "date": "1602504000000"
  }
]

Data Weighting

Premium Data 1,125,000 per event

Data Timing

Intraday

Data Schedule

6am , 10am , 2pm , 6pm and 9pm daily

Data Source(s)

Wall Street Horizon

Notes

This is a premium data end-point available to only paying customers. You will be charged directly at pay-as-you-go rates and the messages consumed from this end-point will not come from your base subscription message allocation.

Available Methods

GET /time-series/PREMIUM_WALLSTREETHORIZON_HOLIDAYS

Examples

Query Parameters

This end point uses all standard time-series query parameters.

Response Attributes

Key Type Description
eventId string Unique WallStreetHorizon event identifier.
eventDate string Event date, formatted YYYY-MM-DD
eventDay string Event day, formatted YYYY-MM-DD
eventName string The name of the event
earlyCloseTime string -
countryCode string -
financialCenterName string -
updated string Refers to the machine readable epoch timestamp of when this entry was last updated
symbol string The symbol of the company.

Index Changes

This shows additions and removals from various indexes for particular stocks.

HTTP request

GET /time-series/PREMIUM_WALLSTREETHORIZON_INDEX_CHANGE

JSON response

[
  {
    "eventId": "J177834B",
    "symbol": "LVS",
    "companyName": "Las Vegas Sands Corp.",
    "changeType": "REPLACE",
    "indexName": "SP500",
    "announceDate": "2019-10-01",
    "announceUrl": "iae-wpa4n0-lrempe0esut-epe-rarg-psavop3apt.j0ejhna-a-kwcsg5-er.o52-wetniotpsmo/6-o/p-na9nninjtschect/-i0tntnss-s6elt0e--tista-c9-w0r-sptwsl-ossu0o-sl-homw-h:r/e0i-6dml-pdan.",
    "effectiveDate": "2019-10-03",
    "replaceCompanyId": 1337,
    "replaceTicker": "RTKN",
    "replaceIsin": "8U426S638001",
    "replaceTickerName": "aeTptNkeaieurscth r",
    "updated": "1632191685686",
    "id": "PREMIUM_WALLSTREETHORIZON_INDEX_CHANGE",
    "source": "WallStreetHorizon",
    "key": "SLV",
    "subkey": "J7B74813",
    "date": "1570104000000"
  }
]

Data Weighting

Premium Data 1,125,000 per event

Data Timing

Intraday

Data Schedule

6am , 10am , 2pm , 6pm and 9pm daily

Data Source(s)

Wall Street Horizon

Notes

This is a Premium Data end-point available to only paying customers. You will be charged directly at pay-as-you-go rates and the messages consumed from this end-point will not come from your base subscription message allocation.

Available Methods

GET /time-series/PREMIUM_WALLSTREETHORIZON_INDEX_CHANGE

Examples

Query Parameters

This end point uses all standard time-series query parameters.

Response Attributes

Key Type Description
eventId string Unique WallStreetHorizon event identifier
symbol string The symbol of the company
companyName string The name of the company
changeType string This returns ADD, REMOVE, or REPLACE
indexName string This returns DJIA, SP500, NASDAQ100, CAC, DAX, FTSE, HANG SENG, NIKKEI, or F1000
announceDate string Event announcement date, formatted YYYY-MM-DD
announceUrl string Link to the latest press release for the event
effectiveDate string The date the index change will take effect, formatted YYYY-MM-DD
replaceCompanyId number WallStreetHorizon company ID of the company being REPLACED
replaceTicker string Ticker symbol of the company being REPLACED
replaceIsin string ISINof the company being REPLACED
replaceTickerName string Company name being REPLACED
updated string Refers to the machine readable epoch timestamp of when this entry was last updated

IPOs

Get a list of upcoming IPOs.

HTTP request

GET /time-series/PREMIUM_WALLSTREETHORIZON_INITIAL_PUBLIC_OFFERING

JSON response

[
  {
    "eventId": "93594BNP",
    "ipoStatus": "Friday",
    "symbol": "CNSP",
    "modified": "/242/:0P01M 2251 90",
    "iposcoopId": 24944,
    "iposcoopCompanyName": "NCRUSATIH MAESLCAPC",
    "industry": "R EATECHALH",
    "fileddate": "2019-07-12",
    "offeringdate": "2019-11-19",
    "offerprice": 0,
    "firstdayclose": 0,
    "currentprice": 0,
    "return": 0,
    "shares": 2.16,
    "pricerangelow": 4,
    "pricerangehigh": 5,
    "volume": 9.93,
    "managers": "CHAKRNMEB",
    "quietperiod": { },
    "lockupperiod": { },
    "rating": 0,
    "updated": "1578246364593",
    "id": "EIPOEITRSII_MNO_IUFLPLAEBT_NIRL_ANUHROTILMFEGCWRZ",
    "source": "loSlz HetWoran teir",
    "key": "PNCS",
    "subkey": "3BNP9549",
    "date": "1573214400000"
  }
]

Data Weighting

Premium Data 1,125,000 per event

Data Timing

Intraday

Data Schedule

6am , 10am , 2pm , 6pm and 9pm daily

Data Source(s)

Wall Street Horizon

Notes

This is a premium data end-point available to only paying customers. You will be charged directly at pay-as-you-go rates and the messages consumed from this end-point will not come from your base subscription message allocation.

Available Methods

GET /time-series/PREMIUM_WALLSTREETHORIZON_INITIAL_PUBLIC_OFFERING

Examples

Query Parameters

This end point uses all standard time-series query parameters.

Response Attributes

Key Type Description
eventId string Unique WallStreetHorizon event identifier.
ipoStatus string Possible values are Priced, Withdrawn, Postponed, Week of, Monday, Tuesday, Wednesday, Thursday, Friday, Day-to-Day
symbol string The symbol of the company.
modified string Date of last update to IPO by IPOScoop
iposcoopId number IPOScoop unique identifier
iposcoopCompanyName string IPO Company name
industry string Company industry sector
fileddate string IPO file date
offeringdate string The IPO offering date, formatted YYYY-MM-DD
offerprice number Initial offering price (USD)
firstdayclose number Price after the first trade day (USD)
currentprice number Current Price (USD)
return number Return value (Percentage)
shares number Shares (millions)
pricerangelow number The low end of share price range
pricerangehigh number The high end of share price range
volume number Estimated $ volume (millions)
managers string Company lead managers
quietperiod - Date the quiet period expires.
lockupperiod - Date the lockup period expires
rating number IPOScoop rating. Possible values are: 0 = No rating 1 = Flat (up to $0.49 per share) 2 = OK ($0.49 to $1 per share)3 = Good ($1 to $3 per share)4 = Hot ($4 per share and higher)5 =Moonshot (a potential double)
updated string Refers to the machine readable epoch timestamp of when this entry was last updated

These are legal actions where an individual represents a group in a court claim. The judgment from the suit is for all the members of the group or class.

HTTP request

GET /time-series/PREMIUM_WALLSTREETHORIZON_LEGAL_ACTIONS

JSON response

[
  {
    "eventId": "3C0E4R6E",
    "symbol": "GRUB",
    "companyName": "GrubHub Inc.",
    "announceDate": "2019-11-02",
    "contactAddress": { },
    "caseDescription": "sl ioaom no i eToetbuete ain n sfaybysrouteroo ekbarna sirbnft .aeytsti toetea acooc pn ,tessetu cadc ca cdi ehi nhrnhtmaneot snonyetlyf cs,cche suicni, r.eunnaeeetitraacynn romI r las ed",
    "contactEmail": { },
    "caseUrl": "a/hlipcn?o-/uunc=.lb5tjsr-h:ifcmfcnr1lr&d/2oout/iihigm-2bsm=tasgo",
    "contactName": { },
    "lawfirm": "LrhFiawlmc Sa l",
    "category": "IUTEUFARSDEC_RIS",
    "contactPhone": { },
    "lawfirmHomepage": "mrtf/ctpl/isom/c:hahl.",
    "classPeriodBegin": { },
    "motionDeadline": { },
    "classPeriodEnd": { },
    "prUrl": "/w0uc60/hi103/5t/ioe0r2eshnw/20.:wpos6/nb1s9emneme.sws/tw",
    "stage": "NVITAGISOITNE",
    "updated": "1617102737243",
    "id": "NZTIAEI_RTLSRUMEOAW_S_IOOGLECALRLPNHMTE",
    "source": " tioHt erSnWloleazr",
    "key": "GRUB",
    "subkey": "3R6E4E0C",
    "date": "1572436800000"
  }
]

Data Weighting

Premium Data 1,125,000 per event

Data Timing

Intraday

Data Schedule

6am , 10am , 2pm , 6pm and 9pm daily

Data Source(s)

Wall Street Horizon

Notes

This is a Premium Data end-point available to only paying customers. You will be charged directly at pay-as-you-go rates and the messages consumed from this end-point will not come from your base subscription message allocation.

Available Methods

GET /time-series/PREMIUM_WALLSTREETHORIZON_LEGAL_ACTIONS

Examples

Query Parameters

This end point uses all standard time-series query parameters.

Response Attributes

Key Type Description
eventId string Unique WallStreetHorizon event identifier
symbol string The symbol of the company
companyName string The name of the company
announceDate string Event announcement date, formatted YYYY-MM-DD
contactAddress string The address of the contact person for the lawsuit
caseDescription string There is typically a short paragraph in the press release that describes the nature of the lawsuit
contactEmail string The email addressof the contact person for the lawsuit
caseUrl string The web address for information regarding the specific lawsuit
contactName string The name of the contact person for the lawsuit
lawfirm string The name of the law firm that is handling the lawsuit
category string Categories include Consumer Fraud, Employment, Securities Fraud, Environmental Disaster, Antitrust, Privacy and Consumer Rights, Americans with Disabilities Act Violations, and Other
contactPhone string The phone number of the contact person for the lawsuit
lawfirmHomepage string The website for the law firm handling the lawsuit
classPeriodBegin number The beginning of the class period window
motionDeadline number The deadline in which to contact the law firm if you wish to be a part of the lawsuit
classPeriodEnd number The end of the class period window
prUrl string Link to the latest press release for the event
stage string This returns INVESTIGATION, FILING, DROPPED, SETTLED, or UNKNOWN
updated string Refers to the machine readable epoch timestamp of when this entry was last updated

Mergers & Acquisitions

These are a type of corporate action in which two companies combine to form a single company, or one company is taken over by another.

HTTP request

GET /time-series/PREMIUM_WALLSTREETHORIZON_MERGER_ACQUISITIONS/{symbol?}/{eventId?}

JSON response

[
  {
    "acquirerCompanyId": 1431888103,
    "acquirerName": "Athene Holding Ltd.",
    "acquirerSymbol": "ATH",
    "actionNotes": "American Equity Investment Life Holding Company today confirmed that it received an unsolicited non-binding proposal from Athene Holding Ltd. with Massachusetts Mutual Life Insurance Company to acquire all outstanding common shares of American Equity for $36.00 per share in cash.",
    "actionStatus": "PROPOSED",
    "actionType": "ACQUISITION",
    "announceDate": "2020-10-01",
    "etFlag": "N",
    "eventId": "4B3D1NFN",
    "newsReferences": "https://www.businesswire.com/news/home/20201001005694/en/",
    "pricePerShareCurrency": "USD",
    "purchasePricePerShare": 36,
    "srFlag": "N",
    "targetCompanyId": 1402521109,
    "targetName": "American Equity Investment Life Holding Co",
    "targetSymbol": "AEL",
    "updated": 1601921212000,
    "id": "PREMIUM_WALLSTREETHORIZON_MERGER_ACQUISITIONS",
    "key": "AEL",
    "subkey": "4B3D1NFN",
    "date": 1601883607000
  },
  ...
]

Data Weighting

Premium Data 1,125,000 per event

Data Timing

Intraday

Data Schedule

6am , 10am , 2pm , 6pm and 9pm daily

Data Source(s)

Wall Street Horizon

Notes

This is a premium data end-point available to only paying customers. You will be charged directly at pay-as-you-go rates and the messages consumed from this end-point will not come from your base subscription message allocation.

Available Methods

GET /time-series/PREMIUM_WALLSTREETHORIZON_MERGER_ACQUISITIONS/{symbol?}/{eventId?}

Examples

Query Parameters

This end point uses all standard time-series query parameters.

Response Attributes

Key Type Description
eventId string Unique WallStreetHorizon event identifier.
acquirerCompanyId number Acquirer company ID
acquirerName string Company name of acquirer
acquirerSymbol string Symbol of acquirer
actionNotes string Notes on action
actionStatus string Status of action
actionType string Type of action
announceDate string Announcement Date of action, formatted YYYY-MM-DD
etFlag string
newsReferences string News sources about action
pricePerShareCurrency string
purchasePricePerShare number Purchase price per share of action
srFlag string
targetCompanyId number Target company ID
targetName string Company name of target
targetSymbol string Symbol of target
updated number Refers to the machine readable epoch timestamp of when this entry was last updated
id string
key string
subkey string
date number

Product Events

Represents movie and video releases. This is the date on which a movie distributor plans to release a movie to theaters

HTTP request

GET /time-series/PREMIUM_WALLSTREETHORIZON_PRODUCT_EVENTS/{symbol?}/{eventId?}

JSON response

[
  {
    "eventId": "43AH0W5A",
    "symbol": "CIDM",
    "companyName": "Cinedigm Corp.",
    "releaseDate": "2019-10-24",
    "releaseTitle": "swah:e tel l TafuoiBDetaysntMd",
    "region": "NORTH AMERICA",
    "distributor": "igiemndC",
    "accuracy": "DAY",
    "updated": "1640475837785",
    "id": "PREMIUM_WALLSTREETHORIZON_PRODUCT_EVENTS",
    "source": "WallStreetHorizon",
    "key": "CMDI",
    "subkey": "3WH4A5A0",
    "date": "1571745600000"
  }
]

Data Weighting

Premium Data 1,125,000 per event

Data Timing

Intraday

Data Schedule

6am , 10am , 2pm , 6pm and 9pm daily

Data Source(s)

Wall Street Horizon

Notes

This is a Premium Data end-point available to only paying customers. You will be charged directly at pay-as-you-go rates and the messages consumed from this end-point will not come from your base subscription message allocation.

Available Methods

GET /time-series/PREMIUM_WALLSTREETHORIZON_PRODUCT_EVENTS/{symbol?}/{eventId?}

Examples

Query Parameters

This end point uses all standard time-series query parameters.

Response Attributes

Key Type Description
eventId string Unique WallStreetHorizon event identifier
symbol string The symbol of the company
companyName string The name of the company
releaseDate string The release date of the movie, formatted YYYY-MM-DD
releaseTitle string The title of the movie
region string The region of the world that the movie is being released
distributor string The theatrical distributor of the film
releasePattern string Describes how widely the movie played in theaters. Possible values include: WIDE, LIMITED, EXCLUSIVE, EXPANDS WIDE, SPECIAL ENGAGEMENT, OSCAR QUALIFYING RUN, FESTIVAL SCREENING, IMAX
accuracy string The accuracy of the release date. If the precise day of the release is known, this is set to DAY. If just the month is known, this is set to MONTH. Other values may be FALL, SUMMER, or YEAR
updated string Refers to the machine readable epoch timestamp of when this entry was last updated

Research and Development Days

This is a day in which investors and analysts can meet with a company’s R&D representatives to learn more about new or improved products and services.

HTTP request

GET /time-series/PREMIUM_WALLSTREETHORIZON_RD_DAY

JSON response

[
  {
    "eventId": "B913BE54",
    "symbol": "THTX",
    "companyName": "Theratechnologies Inc.",
    "announceDate": null,
    "organizer": "OENN",
    "eventDesc": "This is an example event description.",
    "eventStatus": "REPSCOINS",
    "sectorNames": "HSCEARER",
    "startDate": "2019-10-25",
    "endDate": "2019-11-05",
    "localTimeStart": " 1M2P00:",
    "timeZone": "EST",
    "venue": null,
    "venueAddress": "3 WTC",
    "venueCity": "New York",
    "venueState": "NY",
    "venueCountry": "United States",
    "venueCountryIso": "UAS",
    "purl": "s=t9thrmheta0otu2e/s.l0zonia1omu.plmm?.1//wp:rc",
    "inviteUrl": "mti9s/rh/mf/e.deec./papgveiods2tm-:r/c7mestd",
    "scheduleUrl": null,
    "additionalInfoUrl": null,
    "externalNote": null,
    "referenceLink": null,
    "updated": "1620013408360",
    "id": "PREMIUM_WALLSTREETHORIZON_RD_DAY",
    "source": "WallStreetHorizon",
    "key": "TXTH",
    "subkey": "9B53EB41",
    "date": "1571832000000"
  }
]

Data Weighting

Premium Data 1,125,000 per event

Data Timing

Intraday

Data Schedule

6am , 10am , 2pm , 6pm and 9pm daily

Data Source(s)

Wall Street Horizon

Notes

This is a Premium Data end-point available to only paying customers. You will be charged directly at pay-as-you-go rates and the messages consumed from this end-point will not come from your base subscription message allocation.

Available Methods

GET /time-series/PREMIUM_WALLSTREETHORIZON_RD_DAY

Examples

Query Parameters

This end point uses all standard time-series query parameters.

Response Attributes

Key Type Description
eventId string Unique WallStreetHorizon event identifier
symbol string The symbol of the company
companyName string The name of the company
announceDate string Event announcement date, formatted YYYY-MM-DD
organizer string Event organizer
eventDesc string A description of the event
eventStatus string Status of event, possible values are PENDING, INPROCESS or CANCEL. PENDING indicates a future event. INPROCESS indicates today is inclusive of the start and end dates for the event.
sectorNames string The sector/industry for the company
startDate string The start date of the event, formatted YYYY-MM-DD
endDate string The end date of the event, formatted YYYY-MM-DD
localTimeStart string The local start time of the event
timeZone string ISO time zone code of the event start time
venue string Location of the event
venueAddress string The street address of the venue
venueCity string The city of the venue
venueState string The state of the venue
venueCountry string The country of the venue
venueCountryIso string The ISO country code of the venue
purl string Link to the event website
inviteUrl string Link to the event registration
scheduleUrl string Link to the event schedule
additionalInfoUrl string Link to additional event information
externalNote string Important information regarding the event
referenceLink string Link to the latest press release for the event
updated string Refers to the machine readable epoch timestamp of when this entry was last updated

Same Store Sales

Same-store sales, also referred to as comparable-store sales, SSS or identical-store sales, is a financial metric that companies in the retail industry use to evaluate the total dollar amount of sales in the company’s stores that have been operating for a year or more.

HTTP request

GET /time-series/PREMIUM_WALLSTREETHORIZON_SAME_STORE_SALES/{symbol?}/{eventId?}

JSON response

[
  {
    "eventId": "XJ045443",
    "symbol": "LAD",
    "companyName": "Lithia Motors Inc",
    "timePeriod": "Q3",
    "fiscalYear": 2018,
    "year": null,
    "sameStoreSalesDate": "2019-11-06",
    "sameStoreSalesDateStatus": "CONFIRMED",
    "publicationLink": null,
    "updated": "1650381005856",
    "id": "PREMIUM_WALLSTREETHORIZON_SAME_STORE_SALES",
    "source": "WallStreetHorizon",
    "key": "LAD",
    "subkey": "XJ045443",
    "date": "1571832000000"
  }
]

Data Weighting

Premium Data 1,125,000 per event

Data Timing

Intraday

Data Schedule

6am , 10am , 2pm , 6pm and 9pm daily

Data Source(s)

Wall Street Horizon

Notes

This is a Premium Data end-point available to only paying customers. You will be charged directly at pay-as-you-go rates and the messages consumed from this end-point will not come from your base subscription message allocation.

Available Methods

GET /time-series/PREMIUM_WALLSTREETHORIZON_SAME_STORE_SALES/{symbol?}/{eventId?}

Examples

Query Parameters

This end point uses all standard time-series query parameters.

Response Attributes

Key Type Description
eventId string Unique WallStreetHorizon event identifier
symbol string The symbol of the company
companyName string The name of the company
timePeriod string Event time period, Q1-Q4 or month name
fiscalYear number Company’s fiscal year for the event
year number Year for the monthly same store sales data
sameStoreSalesDate number Same store sales release date
sameStoreSalesDateStatus string This returns CONFIRMED or UNCONFIRMED
publicationLink string Link to the latest press release for the event
updated string Refers to the machine readable epoch timestamp of when this entry was last updated

Secondary Offerings

Secondary Offerings are the issuance of new stock for public sale from a company that has already made its initial public offering (IPO). Usually, these kinds of public offerings are made by companies wishing to refinance, or raise capital for growth. Money raised from these kinds of secondary offerings goes to the company, through the investment bank that underwrites the offering. Investment banks are issued an allotment, and possibly an overallotment which they may choose to exercise if there is a strong possibility of making money on the spread between the allotment price and the selling price of the securities. Short Selling is prohibited during the period of the secondary offering.

HTTP request

GET /time-series/PREMIUM_WALLSTREETHORIZON_SECONDARY_OFFERING

JSON response

[
  {
    "eventId": "4V6EK3ZB",
    "symbol": "NMFC",
    "companyName": "New Mountain Finance Corporation",
    "offeringStage": "EOPN",
    "sellingShareholder": "The selling Shareholder",
    "numberOfShares": 8341468,
    "sharePrice": null,
    "currency": "USD",
    "sharesDifferent": null,
    "announceDate": "2019-10-27",
    "effectiveDate": null,
    "closingDate": null,
    "offeringProceeds": "Y",
    "underwriterManager": "n.e.eorc gensngSCuenrshs c Lr eSa yta& anC,S,ctydauLhcBg pr-Bir Loens& imnac oj.to.a&Gu emcan koA,, a eoeLtrMAt e cnalteS or.oL i yaes neog-lnglCr gashtrcieuctp,d fesJ St t -,in, ihe r,,rCtdSindW Fyoml ImCD i onLoeeirLkSKSmeueMBnb&IteBe Ceeeltoaiiti nySaaWUe L,n sLhelnoCneeosea L. C OufdpC afouotrcmrs",
    "prospectusLink": "/1/o0ew.7:0vp.aA2s4/c60w//ec0/v8g109ha0s250adt99r2r9h.649tw7044a9/5zde33mtit14/shg9",
    "linkToPublication": " ru n2esbcin lFm0MauNEt i2hCpl/Crt,Ft eswwr6n8m d-0g .nu cenc/D6saA por:i0Cms:8eWw0otsNS.S/eooe1io ns1/o9n2/0 :/SMhcs winoiBstsn Ehie0e an f eOkoe0e2st9eh1wsmYr0iyNaTr w,feoeC 0o:tf:2msfoim/ o1Scnnr0o2m bOn0t2",
    "updated": "1609541557951",
    "id": "PREMIUM_WALLSTREETHORIZON_SECONDARY_OFFERING",
    "source": "WallStreetHorizon",
    "key": "NFCM",
    "subkey": "V64BZE3K",
    "date": "1571745600000"
  }
]

Data Weighting

Premium Data 1,125,000 per event

Data Timing

Intraday

Data Schedule

6am , 10am , 2pm , 6pm and 9pm daily

Data Source(s)

Wall Street Horizon

Notes

This is a Premium Data end-point available to only paying customers. You will be charged directly at pay-as-you-go rates and the messages consumed from this end-point will not come from your base subscription message allocation.

Available Methods

GET /time-series/PREMIUM_WALLSTREETHORIZON_SECONDARY_OFFERING

Examples

Query Parameters

This end point uses all standard time-series query parameters.

Response Attributes

Key Type Description
eventId string Unique WallStreetHorizon event identifier
symbol string The symbol of the company
companyName string The name of the company
offeringStage string Valid values are Open, Closed, Postponed, and Canceled
sellingShareholder string The individual(s) and/or firm(s) who own the offering shares
numberOfShares number The number of shares in the offering, most times referred to as the “public offering”
sharePrice number The share price of the offering
currency string A 3-digit code identifying the currency of the share price
sharesDifferent string Identifies whether the offering number of shares is different than first published
announceDate string Event announcement date, formatted YYYY-MM-DD
effectiveDate string The date the offering shares are available for sale on the market
closingDate string The date the offering shares are no longer available
offeringProceeds string Identifies whether thecompany whose shares are being sold will receive any proceeds from the sale
underwriterManager string Identifies the designated underwriter or manager of the secondary offering
prospectusLink string The link to the secondary offering prospectus
linkToPublication string Link to the latest press release for the event
updated string Refers to the machine readable epoch timestamp of when this entry was last updated

Seminars

This is an educational event that features one or more subject matter experts delivering information via lecture and discussion.

HTTP request

GET /time-series/PREMIUM_WALLSTREETHORIZON_SEMINAR

JSON response

[
  {
    "eventId": "68834KH5",
    "announceDate": "adtealiI vnd",
    "organizer": "OENN",
    "eventDesc": " ia2 2miraeTtaOcS0h0 vnen",
    "eventStatus": "NEDPING",
    "sectorNames": "VITETNMSNE",
    "startDate": "2020-01-22",
    "endDate": "2020-01-20",
    "localTimeStart": { },
    "timeZone": "CET",
    "venue": { },
    "venueAddress": { },
    "venueCity": { },
    "venueState": { },
    "venueCountry": "Setlwnairzd",
    "venueCountryIso": "HCE",
    "purl": "mr=auzo6e.oa/ite4ltwpomhsr:c4thmm2u//t2n..3lp?s",
    "inviteUrl": { },
    "scheduleUrl": { },
    "additionalInfoUrl": { },
    "externalNote": { },
    "referenceLink": { },
    "updated": "1596789564392",
    "presenters": {
      "presenter": {
        "eventId": "845L38H6",
        "symbol": "LGYRF",
        "companyName": "Landis+Gyr Group AG",
        "startDate": "2020-01-22",
        "endDate": "2020-01-21",
        "time": { },
        "announceDate": "dtl edavaniI",
        "presenterName": "anMetmgena",
        "presenterTitle": { },
        "created": ":1 0-M0-792505:00970A",
        "updated": "2019-07-17"
      }
    },
    "symbol": "LGYRF",
    "id": "ELNMMSOWNEAIORHIETSTRUMRIE_LRAPZ_",
    "source": "niHtS lorzreta eWol",
    "key": "GRFYL",
    "subkey": "6H384K85",
    "date": "1579176000000"
  }
]

Data Weighting

Premium Data 1,125,000 per event

Data Timing

Intraday

Data Schedule

6am , 10am , 2pm , 6pm and 9pm daily

Data Source(s)

Wall Street Horizon

Notes

This is a premium data end-point available to only paying customers. You will be charged directly at pay-as-you-go rates and the messages consumed from this end-point will not come from your base subscription message allocation.

Available Methods

GET /time-series/PREMIUM_WALLSTREETHORIZON_SEMINAR

Examples

Query Parameters

This end point uses all standard time-series query parameters.

Response Attributes

Key Type Description
eventId string Unique WallStreetHorizon event identifier.
announceDate string Event announcement date, formatted YYYY-MM-DD
organizer string Event organizer.
eventDesc string Event description
eventStatus string Status of event, possible values are PENDING, INPROCESS or CANCEL. PENDING indicates a future event. INPROCESS indicates today is inclusive of the start and end dates for the event.
sectorNames string The sector/industry for the company.
startDate string The start date of the event, formatted YYYY-MM-DD
endDate string The end date of the event, formatted YYYY-MM-DD
localTimeStart string The local start time of the event.
timeZone string ISO time zone code.
venue string Location of the event.
venueAddress string The street address of the venue.
venueCity string The city of the venue.
venueState string The state of the venue.
venueCountry string The country of the venue.
venueCountryIso string The ISO country code of the venue.
purl string Link to the event website.
inviteUrl string Link to the event registration.
scheduleUrl string Link to the event schedule.
additionalInfoUrl string Link to additional event information.
externalNote string Important information regarding the event.
referenceLink string Link to the latest press release for the event.
updated string Refers to the machine readable epoch timestamp of when this entry was last updated
presenters object The presenters of the event
symbol string The symbol of the company.

Shareholder Meetings

This is a meeting, held at least annually, to elect members to the board of directors and hear reports on the business’ financial situation as well as new policy initiatives from the corporation’s management.

HTTP request

GET /time-series/PREMIUM_WALLSTREETHORIZON_SHAREHOLDER_MEETING

JSON response

[
  {
    "eventId": "8LRI763V",
    "symbol": "MCFT",
    "companyName": "MasterCraft Boat Holdings, Inc.",
    "announceDate": "2019-10-18",
    "startDate": "2019-11-04",
    "endDate": "2019-10-27",
    "localTimeStart": "8:00 AM",
    "timeZone": "EST",
    "recordDate": "2019-10-18",
    "venue": "Event Venue Name",
    "venueAddress": "16 Pomme Treat Road",
    "venueCity": "Knoxville",
    "venueState": "TN",
    "venueCountry": "United States",
    "venueCountryIso": "USA",
    "purl": null,
    "shmDistance": null,
    "referenceLink": "cs0r.eh648a1i7d/.f1d:ectmet172120h/v656o39269/sw8vt2wg1//.a4r/d0aghd9d/6t1s/23Ae9w0ap",
    "shmMeetingType": "nalnau",
    "updated": "1650130247570",
    "id": "PREMIUM_WALLSTREETHORIZON_SHAREHOLDER_MEETING",
    "source": "WallStreetHorizon",
    "key": "FTCM",
    "subkey": "6LIRV783",
    "date": "1571832000000"
  }
]

Data Weighting

Premium Data 1,125,000 per event

Data Timing

Intraday

Data Schedule

6am , 10am , 2pm , 6pm and 9pm daily

Data Source(s)

Wall Street Horizon

Notes

This is a Premium Data end-point available to only paying customers. You will be charged directly at pay-as-you-go rates and the messages consumed from this end-point will not come from your base subscription message allocation.

Available Methods

GET /time-series/PREMIUM_WALLSTREETHORIZON_SHAREHOLDER_MEETING

Examples

Query Parameters

This end point uses all standard time-series query parameters.

Response Attributes

Key Type Description
eventId string Unique WallStreetHorizon event identifier
symbol string The symbol of the company
companyName string The name of the company
announceDate string Event announcement date, formatted YYYY-MM-DD
startDate string The start date of the event, formatted YYYY-MM-DD
endDate string The end date of the event, formatted YYYY-MM-DD
localTimeStart string The local start time of the event
timeZone string ISO time zone code of the event start time
recordDate string The date on which a shareholder must officially own shares to attend the shareholder meeting, formatted YYYY-MM-DD
venue string Location of the event
venueAddress string The street address of the venue
venueCity string The city of the venue
venueState string The state of the venue
venueCountry string The country of the venue
venueCountryIso string The ISO country code of the venue
purl string Link to the event website
shmDistance number The distance between the company’s corporate headquarters and the meeting venue
referenceLink string Link to the latest press release for the event
shmMeetingType string This returns ANNUAL, SPECIAL, or EXTRAORDINARY
updated string Refers to the machine readable epoch timestamp of when this entry was last updated

Summit Meetings

This is a gathering of people who are interested in the same business subject or topic.

HTTP request

GET /time-series/PREMIUM_WALLSTREETHORIZON_SUMMIT_MEETING

JSON response

[
  {
    "eventId": "8T4H3A2B",
    "announceDate": "2019-09-11",
    "organizer": "OENN",
    "eventDesc": "gDmuv0t2i iea ii sS&D2aMnmi dcecte0cslo",
    "eventStatus": "GNINEDP",
    "sectorNames": "ACIDMLE",
    "startDate": "2020-06-12",
    "endDate": "2020-06-12",
    "localTimeStart": { },
    "timeZone": "CTS",
    "venue": { },
    "venueAddress": { },
    "venueCity": "linipnMoeas",
    "venueState": "MN",
    "venueCountry": "ts dentaSUite",
    "venueCountryIso": "SAU",
    "purl": "mr.phu?r/wnus.362loteasmzhtlcea:t/81o/=ot.pmmi6",
    "inviteUrl": "vtl/cv.dhscop.osdtiv:mue-e/aeceiaim/tmgme-",
    "scheduleUrl": { },
    "additionalInfoUrl": { },
    "externalNote": { },
    "referenceLink": "asvvemwiui-oe/tvslncewcpm.av/me:w/-e/tdchet/dti.mse",
    "updated": "1600367641921",
    "presenters": {
      "presenter": {
        "eventId": "V48HB3A2",
        "symbol": "VEEV",
        "companyName": "Veeva Systems Inc.",
        "startDate": "2020-06-10",
        "endDate": "2020-06-08",
        "time": { },
        "announceDate": "2019-09-20",
        "presenterName": "tnganMmaee",
        "presenterTitle": { },
        "created": ": 0- 30102M2-A29:19070",
        "updated": "2019-09-17"
      }
    },
    "symbol": "VEEV",
    "id": "TGLESNEIM_UEMTUMZRIO_IMTWSLEEROMTHPNAR_I",
    "source": "ol iWaneHSrtlozert",
    "key": "VEEV",
    "subkey": "A3B84T2H",
    "date": "1591012800000"
  }
]

Data Weighting

Premium Data 1,125,000 per event

Data Timing

Intraday

Data Schedule

6am , 10am , 2pm , 6pm and 9pm daily

Data Source(s)

Wall Street Horizon

Notes

This is a premium data end-point available to only paying customers. You will be charged directly at pay-as-you-go rates and the messages consumed from this end-point will not come from your base subscription message allocation.

Available Methods

GET /time-series/PREMIUM_WALLSTREETHORIZON_SUMMIT_MEETING

Examples

Query Parameters

This end point uses all standard time-series query parameters.

Response Attributes

Key Type Description
eventId string Unique WallStreetHorizon event identifier.
announceDate string Event announcement date, formatted YYYY-MM-DD
organizer string Event organizer.
eventDesc string Event description
eventStatus string Status of event, possible values are PENDING, INPROCESS or CANCEL. PENDING indicates a future event. INPROCESS indicates today is inclusive of the start and end dates for the event.
sectorNames string The sector/industry for the company.
startDate string The start date of the event, formatted YYYY-MM-DD
endDate string The end date of the event, formatted YYYY-MM-DD
localTimeStart string The local start time of the event.
timeZone string ISO time zone code.
venue string Location of the event.
venueAddress string The street address of the venue.
venueCity string The city of the venue.
venueState string The state of the venue.
venueCountry string The country of the venue.
venueCountryIso string The ISO country code of the venue.
purl string Link to the event website.
inviteUrl string Link to the event registration.
scheduleUrl string Link to the event schedule.
additionalInfoUrl string Link to additional event information.
externalNote string Important information regarding the event.
referenceLink string Link to the latest press release for the event.
updated string Refers to the machine readable epoch timestamp of when this entry was last updated
presenters object The presenters of the event
symbol string The symbol of the company.

Trade Shows

This is a large gathering in which different companies in a particular field or industry show their products to possible customers.

HTTP request

GET /time-series/PREMIUM_WALLSTREETHORIZON_TRADE_SHOW

JSON response

[
  {
    "eventId": "8VA1AID3",
    "announceDate": "id lanadevIt",
    "organizer": "ONNE",
    "eventDesc": "r FA huoh0tboroonawrIt2ain Fa lAri0gnI2sne",
    "eventStatus": "EGDNPNI",
    "sectorNames": "OVIATAIN",
    "startDate": "2020-07-20",
    "endDate": "2020-07-24",
    "localTimeStart": { },
    "timeZone": "GTM",
    "venue": "en owetCShr",
    "venueAddress": " PdoERaST",
    "venueCity": "bgoarohFurn",
    "venueState": { },
    "venueCountry": "Udnitdg iKnemo",
    "venueCountryIso": "GRB",
    "purl": "phatw=m/e6utcta7?uzomer.7hm:l72splo/.tnsr/.i2mo",
    "inviteUrl": { },
    "scheduleUrl": "ptcwaasiunlthh/.adihitn//ro-ewcoeigbndh/e:otgoonfsxrww.o/rrbmw",
    "additionalInfoUrl": { },
    "externalNote": { },
    "referenceLink": { },
    "updated": "1631560434974",
    "presenters": {
      "presenter": {
        "eventId": "48DXEH93",
        "symbol": "MOG.A",
        "companyName": "Moog Inc. CL A",
        "startDate": "2020-07-31",
        "endDate": "2020-07-30",
        "time": { },
        "announceDate": " ieaIdtnadvl",
        "presenterName": "Mennagmeat",
        "presenterTitle": { },
        "created": "M:70: 289-A2-1 2000191",
        "updated": "2019-11-11"
      }
    },
    "symbol": "MOG.A",
    "id": "TERTUEWOH_ITMOIDPNWEALLSMR_S_RAHROZE",
    "source": "ttSirH ozoaWrlle ne",
    "key": "GMOA.",
    "subkey": "8VA1AID3",
    "date": "1595246400000"
  }
]

Data Weighting

Premium Data 1,125,000 per event

Data Timing

Intraday

Data Schedule

6am , 10am , 2pm , 6pm and 9pm daily

Data Source(s)

Wall Street Horizon

Notes

This is a premium data end-point available to only paying customers. You will be charged directly at pay-as-you-go rates and the messages consumed from this end-point will not come from your base subscription message allocation.

Available Methods

GET /time-series/PREMIUM_WALLSTREETHORIZON_TRADE_SHOW

Examples

Query Parameters

This end point uses all standard time-series query parameters.

Response Attributes

Key Type Description
eventId string Unique WallStreetHorizon event identifier.
announceDate string Event announcement date, formatted YYYY-MM-DD
organizer string Event organizer.
eventDesc string Event description
eventStatus string Status of event, possible values are PENDING, INPROCESS or CANCEL. PENDING indicates a future event. INPROCESS indicates today is inclusive of the start and end dates for the event.
sectorNames string The sector/industry for the company.
startDate string The start date of the event, formatted YYYY-MM-DD
endDate string The end date of the event, formatted YYYY-MM-DD
localTimeStart string The local start time of the event.
timeZone string ISO time zone code.
venue string Location of the event.
venueAddress string The street address of the venue.
venueCity string The city of the venue.
venueState string The state of the venue.
venueCountry string The country of the venue.
venueCountryIso string The ISO country code of the venue.
purl string Link to the event website.
inviteUrl string Link to the event registration.
scheduleUrl string Link to the event schedule.
additionalInfoUrl string Link to additional event information.
externalNote string Important information regarding the event.
referenceLink string Link to the latest press release for the event.
updated string Refers to the machine readable epoch timestamp of when this entry was last updated
presenters object The presenters of the event
symbol string The symbol of the company.

Witching Hours

This is when option contracts and futures contracts expire on the exact same day.

HTTP request

GET /time-series/PREMIUM_WALLSTREETHORIZON_WITCHING_HOURS

JSON response

[
  {
    "eventId": "H030E45B",
    "eventDate": "2020-10-30",
    "eventDay": "Fir",
    "eventName": " uioleoucrigtW bHDhn",
    "financialCenterName": "sO UitnpoS",
    "updated": "1579751773252",
    "symbol": "MARKET",
    "id": "OTWGMERCOSLHRTPOUMTRIU__N_ESNZIHILAIHWER",
    "source": "eaWteSlzlt nH rorio",
    "key": "ETKAMR",
    "subkey": "0E3H405B",
    "date": "1602849600000"
  }
]

Data Weighting

Premium Data 1,125,000 per event

Data Timing

Intraday

Data Schedule

6am , 10am , 2pm , 6pm and 9pm daily

Data Source(s)

Wall Street Horizon

Notes

This is a premium data end-point available to only paying customers. You will be charged directly at pay-as-you-go rates and the messages consumed from this end-point will not come from your base subscription message allocation.

Available Methods

GET /time-series/PREMIUM_WALLSTREETHORIZON_WITCHING_HOURS

Examples

Query Parameters

This end point uses all standard time-series query parameters.

Response Attributes

Key Type Description
eventId string Unique WallStreetHorizon event identifier.
eventDate string Event date, formatted YYYY-MM-DD
eventDay string Event day, formatted YYYY-MM-DD
eventName string The name of the event
financialCenterName string -
updated string Refers to the machine readable epoch timestamp of when this entry was last updated
symbol string The symbol of the company.

Workshops

This is a meeting or series of meetings at which a group of people engage in discussion and activity on a particular subject, product or service to gain hands-on experience.

HTTP request

GET /time-series/PREMIUM_WALLSTREETHORIZON_WORKSHOP

JSON response

[
  {
    "eventId": "5K344VA8",
    "announceDate": "2019-08-02",
    "organizer": "BechksDna ute",
    "eventDesc": "te DgchnSsaEseBaD s c c nmedatnebuGkgayeE",
    "eventStatus": "EIGNPDN",
    "sectorNames": "ENVENTISTM",
    "startDate": "2019-12-04",
    "endDate": "2019-12-03",
    "localTimeStart": { },
    "timeZone": "MGT",
    "venue": { },
    "venueAddress": { },
    "venueCity": { },
    "venueState": { },
    "venueCountry": "idteKom ngdinU",
    "venueCountryIso": "RBG",
    "purl": { },
    "inviteUrl": { },
    "scheduleUrl": { },
    "additionalInfoUrl": ".tn/pnf/toe:ecscor/mbd.ehc",
    "externalNote": { },
    "referenceLink": { },
    "updated": "1623672154124",
    "presenters": {
      "presenter": {
        "eventId": "L4A438V5",
        "symbol": "PHG",
        "companyName": "Koninklijke Philips NV",
        "startDate": "2019-12-02",
        "endDate": "2019-11-29",
        "time": { },
        "announceDate": "2019-07-24",
        "presenterName": "egmMenaant",
        "presenterTitle": { },
        "created": "17 A007200:M927:32 -1-",
        "updated": "2019-07-25"
      }
    },
    "symbol": "PHG",
    "id": "ORREWREREMWSMLOTNASHOLP_ZTPIHUIK_O",
    "source": "lnWt rtzoirleeH Soa",
    "key": "PHG",
    "subkey": "8V3AK445",
    "date": "1574251200000"
  }
]

Data Weighting

Premium Data 1,125,000 per event

Data Timing

Intraday

Data Schedule

6am , 10am , 2pm , 6pm and 9pm daily

Data Source(s)

Wall Street Horizon

Notes

This is a premium data end-point available to only paying customers. You will be charged directly at pay-as-you-go rates and the messages consumed from this end-point will not come from your base subscription message allocation.

Available Methods

GET /time-series/PREMIUM_WALLSTREETHORIZON_WORKSHOP

Examples

Query Parameters

This end point uses all standard time-series query parameters.

Response Attributes

Key Type Description
eventId string Unique WallStreetHorizon event identifier.
announceDate string Event announcement date, formatted YYYY-MM-DD
organizer string Event organizer.
eventDesc string Event description
eventStatus string Status of event, possible values are PENDING, INPROCESS or CANCEL. PENDING indicates a future event. INPROCESS indicates today is inclusive of the start and end dates for the event.
sectorNames string The sector/industry for the company.
startDate string The start date of the event, formatted YYYY-MM-DD
endDate string The end date of the event, formatted YYYY-MM-DD
localTimeStart string The local start time of the event.
timeZone string ISO time zone code.
venue string Location of the event.
venueAddress string The street address of the venue.
venueCity string The city of the venue.
venueState string The state of the venue.
venueCountry string The country of the venue.
venueCountryIso string The ISO country code of the venue.
purl string Link to the event website.
inviteUrl string Link to the event registration.
scheduleUrl string Link to the event schedule.
additionalInfoUrl string Link to additional event information.
externalNote string Important information regarding the event.
referenceLink string Link to the latest press release for the event.
updated string Refers to the machine readable epoch timestamp of when this entry was last updated
presenters object The presenters of the event
symbol string The symbol of the company

Fraud Factors

Fraud Factors leverages machine learning and natural language processing techniques to uncover corporate governance issues before they play out in its full form. For their investment management clients, these data sets are a potential source of alpha that is uncorrelated to market returns.

Their clients make use of these insights to adjust investment exposure based on firms’ underlying corporate governance reality. Taken at scale, these adjustments increase capital allocation efficiency in the area of corporate governance, one of the three pillars of ESG investing.

Similarity Index

The Similarity Index quantifies the textual differences between a given company’s annual or quarterly filings on an “as disclosed” basis. For example, a similarity score is calculated by comparing a company’s 2017 10-K with the 2016 10-K; or a company’s 2017 Q3 10-Q compared to the 2016 Q3 10-Q a year ago.

Intuitively, firms breaking from routine phrasing and content in mandatory disclosures give clues about their future performance which eventually drive stock returns over time. This data set captures significant changes in disclosure texts in the form of low similarity scores.

Academic research has shown that a portfolio that shorts low similarity scores and longs high similarity scores earns non-trivial and uncorrelated returns over a period of 12-18 months.

Data available from 2001 with coverage of about 23,000 equities

HTTP request

GET /time-series/PREMIUM_FRAUD_FACTORS_SIMILARITY_INDEX/{symbol?}

JSON response

[
  {
    "symbol": "LAD",
    "cik": "12345678",
    "updated": 1650381005856,
    "cosineScore": 0.7983342305783572,
    "jaccardScore": 0.6643408005875873,
    "periodDate": "2019-09-30",
    "filingDate": "2019-11-06",
    "id": "PREMIUM_FRAUD_FACTORS_SIMILARITY_INDEX",
    "source": "Fraud Factors",
    "key": "LAD",
    "subkey": "2019-11-06",
    "date": 1571832000000
  }
]

Data Weighting

Premium Data 10,000 per event

Data Timing

End of day

Data Schedule

7am , 8am , 8pm UTC daily

Data Source(s)

Fraud Factors

Notes

This is a Premium Data end-point available to only paying customers. You will be charged directly at pay-as-you-go rates and the messages consumed from this end-point will not come from your base subscription message allocation.

Available Methods

GET /time-series/PREMIUM_FRAUD_FACTORS_SIMILARITY_INDEX

Examples

Query Parameters

This end point uses all standard time-series query parameters.

Response Attributes

Key Type Description
symbol string IEX Cloud symbol that maps to provided CIK. If a symbol is not mapped, this will return the CIK.
cik string The unique identifier for this data set, the Central Index Key (“CIK”) is used to identify entities that are regulated by the Securities and Exchange Commission (“SEC”).
cosineScore number The cosine similarity score is computed between two documents - D1 and D2.

D1 and D2 are year on year comparisons based on period date. For example, in the case of 10-Ks, D2 (2018-12-31) will be compared with D1 (2017-12-31). In the case of 10-Qs, each quarter will be compared to the same quarter a year ago. For example, D2 (2015-03-31) will be compared with D1 (2014-03-31).

Let DS1 and DS2 be the set of terms occurring in D1 and D2, respectively. Define T as the union of DS1 and DS2, and let ti be the ith element of T. Define the term frequency vectors of D1 and D2 as:

D1TF = [nD1(t1),nD1(t2),…, nD1tN]; D2TF = [nD2(t1), nD2(t2), …, nD2tN]

 where nDk(ti) is the number of occurrences of term ti in Dk. The cosine similarity between

two documents is then defined as:

𝐃1𝑻𝑭 ∙ 𝐃2𝑻𝑭
‖𝐃1𝑻𝑭‖ × ‖𝐃2𝑻𝑭‖

Where the dot product, ∙, is the scalar product and norm, ‖ ‖, is the Euclidean norm.

Two perfectly similar documents will have a score of 1 and two documents that have no similarity at all will have a score of 0.
jaccardScore number The jaccard similarity score is computed between two documents - D1 and D2.

D1 and D2 are year on year comparisons based on period date. For example, in the case of 10-Ks, D2 (2018-12-31) will be compared with D1 (2017-12-31). In the case of 10-Qs, each quarter will be compared to the same quarter a year ago. For example, D2 (2015-03-31) will be compared with D1 (2014-03-31).

Let DS1 and DS2 be the set of terms occurring in D1 and D2, respectively. Define T as the union of DS1 and DS2, and let ti be the ith element of T. Define the term frequency vectors of D1 and D2 as:

D1TF = [nD1(t1),nD1(t2),…, nD1tN]; D2TF = [nD2(t1), nD2(t2), …, nD2tN]

where nDk(ti) is the number of occurrences of term ti in Dk. The jaccard similarity between

two documents is then defined as:

|𝑫1𝑻𝑭 ∩ 𝑫2𝑻𝑭|
|𝑫𝟏TF ∪ 𝑫𝟐TF|

Two perfectly similar documents will have a score of 1 and two documents that have no similarity at all will have a score of 0.
periodDate string For two documents, D1 and D2, being compared, D1 is the older document and D2 the document that was more recently released.

Period Date is the end of the annual or quarterly period of D2.
filingDate string For two documents, D1 and D2, being compared, D1 is the older document and D2 the document that was more recently released.

Filing Date is defined as the day the D2 was filed with the SEC, at a time between 6AM to 530PM Eastern Time. The similarity score between D2 and D1 will be made available in the next trading day at 3AM Eastern Time.

For example, if an entity files D2 on 10th January 2019 at 320PM, the Filing Date of the similarity score is recorded as 10th January 2019. However, this score is only made available before market opens on the 11th January 2019. Specifically, it will be updated on 11th January 2019, at 300AM Eastern Time.
updated string Refers to the machine readable epoch timestamp of when this entry was last updated

Non-Timely Filings

The data set records the date in which a firm files a Non-Timely notification with the SEC.

Companies regulated by the SEC are required to file a Non-Timely notification when they are unable to file their annual or quarterly disclosures on time. In most cases, the inability to file annual/quarterly disclosures on time is a red-flag and thus a valuable signal for algorithmic strategies and fundamental investing alike.

Data available from 1994 with coverage of about 18,000 equities

HTTP request

GET /time-series/PREMIUM_FRAUD_FACTORS_NON_TIMELY_FILINGS/{symbol?}

JSON response

[
  {
    "symbol": "LAD",
    "cik": "12345678",
    "companyName": "Lithia Motors Inc",
    "filingDate": "2019-10-31",
    "filingType": "NT 10-K",
    "updated": 1650381005856,
    "id": "PREMIUM_FRAUD_FACTORS_NON_TIMELY_FILINGS",
    "source": "Fraud Factors",
    "key": "LAD",
    "subkey": "2019-10-31",
    "date": 1571832000000
  }
]

Data Weighting

Premium Data 1 per event

Data Timing

End of day

Data Schedule

7am , 8am , 8pm UTC daily

Data Source(s)

Fraud Factors

Notes

This is a Premium Data end-point available to only paying customers. You will be charged directly at pay-as-you-go rates and the messages consumed from this end-point will not come from your base subscription message allocation.

Available Methods

GET /time-series/PREMIUM_FRAUD_FACTORS_NON_TIMELY_FILINGS

Examples

Query Parameters

This end point uses all standard time-series query parameters.

Response Attributes

Key Type Description
symbol string IEX Cloud symbol that maps to provided CIK. If a symbol is not mapped, this will return the CIK.
cik string The unique identifier for this data set, the Central Index Key (“CIK”) is used to identify entities that are regulated by the Securities and Exchange Commission (“SEC”).
companyName string Represents the legal name of the entity as reported in disclosures made to the SEC
filingDate string For two documents, D1 and D2, being compared, D1 is the older document and D2 the document that was more recently released.
Filing Date is defined as the day the D2 was filed with the SEC, at a time between 6AM to 530PM Eastern Time. The similarity score between D2 and D1 will be made available in the next trading day at 3AM Eastern Time.
For example, if an entity files D2 on 10th January 2019 at 320PM, the Filing Date of the similarity score is recorded as 10th January 2019. However, this score is only made available before market opens on the 11th January 2019. Specifically, it will be updated on 11th January 2019, at 300AM Eastern Time.
filingType string Includes all non-timely filings for annual/quarterly and related amendment filings disclosed during the period. Specifically, the data set includes the following non-timely disclosures: NT 10-K, NT 10-Q, NT 20-F, NT 10-K/A, NT 10-Q/A, NT 20-F/A
updated string Refers to the machine readable epoch timestamp of when this entry was last updated

ExtractAlpha

ExtractAlpha is an independent research firm that delivers curated alternative data to investors.

Cross-Asset Model 1

The ExtractAlpha Cross-Asset Model 1 (CAM1) is an innovative quantitative stock selection model designed to capture the information contained in options market prices and volumes. The listed equity options market is composed of investors who on average are more informed and information-driven than their cash equity counterparts, due to the higher levels of conviction that are associated with levered bets. This results in a unique model which profits from gradual cross-asset information flows.

In historical simulations, high-scoring stocks according to CAM1 outperform low-scoring stocks by 17% per annum with a market-neutral Sharpe ratio of 3.0 before transaction costs. CAM1 is particularly effective in volatile regimes and for mid- and small-cap stocks, and is best used in conjunction with other alpha signals with similar time horizons.

History available from July 2005

HTTP request

GET /time-series/PREMIUM_EXTRACT_ALPHA_CAM/{symbol?}

JSON response

[
  {
    "spreadComponent":47,
    "skewComponent":42,
    "volumeComponent":61,
    "cam1":48,
    "cam1Slow":48,
    "updated": 1650381005856,
    "updated": 1650381005856,
    "id": "PREMIUM_EXTRACT_ALPHA_CAM",
    "source": "ExtractAlpha",
    "key": "AAPL",
    "subkey": "2019-10-31",
    "date": 1571832000000
  }
]

Data Weighting

Premium Data 76,190 per event

Data Timing

End of day

Data Schedule

3am UTC daily

Data Source(s)

ExtractAlpha

Notes

This is a Premium Data end-point available to only paying customers. You will be charged directly at pay-as-you-go rates and the messages consumed from this end-point will not come from your base subscription message allocation.

Available Methods

GET /time-series/PREMIUM_EXTRACT_ALPHA_CAM

Examples

Query Parameters

This end point uses all standard time-series query parameters.

Response Attributes

Key Type Description
key string Most recent IEX Cloud ticker/symbol
spreadComponent number CAM1 Spread Component, 1 to 100 percentile rank, 100 representing the stocks most likely to outperform according to that component

In an arbitrage-free, frictionless framework, puts and calls with identical strike prices and expirations should theoretically have identical prices, and identical implied volatilities. Practically, however, deviations between the implied volatilities of matched puts and calls do occur fairly frequently. In particular they may occur on the listed equity options of stocks which are experiencing short sale constraints in the underlying equity, such as limited short inventory or high borrow costs. But they may also occur in the presence of informational asymmetries between the option and cash equity markets. And most importantly for this use case, informed investors with high confidence in their views may choose to express those views in the options markets, taking advantage of the higher levels of available leverage (Jin et al, 2012). A bullish informed investor may buy calls or sell puts in order to enact this trade, and either transaction would widen the put-call spread (Cremers and Weinbaum, 2010).

The Spread Component of CAM1 captures these deviations from put-call parity by comparing the implied volatilities of puts and calls with matched moneyness and expirations, using volatility surface data. Stocks with calls which are relatively expensive to puts, and for which this spread is growing over time, tend to outperform stocks with relatively expensive puts.
skewComponent number CAM1 Skew Component, 1, to 100

The volatility skew, or smirk, is defined as the difference in implied volatilities between an out-of-the- money put and an at-the-money call on the same underlying instrument with the same expiration. Steep skews represent options traders expressing very negative views, as out-of-the-money put options are relatively cheap and pay out only upon large drops in the underlying (Xing et al, 2010).

The Skew Component of CAM1 captures this moneyness slope, and its recent change over time.

The points on the option implied volatility surface used to calculate the Spread and Skew Components were chosen based on their stability and efficacy in predicting future stock price changes. For example, extremely out-of-the-money options, or those with very distant expirations, tended to exhibit somewhat less robust predictive power.
volumeComponent number CAM1 Volume Component, 1 to 100

The relative volume of calls and puts, and of options and the underlying equity generally, is also informative of future stock price changes. For example high volumes of calls relative to puts should signal increased demand for calls, given that buying calls is the most straightforward way to express a positive view; and this should be a positive signal for the underlying stock. Similarly the overall demand for calls versus puts can be captured by the total open interest, in addition to volume (Pan and Poteshman, 2006; Fodor et al, 2011).

Furthermore, in the presence of short sale constraints, informed traders with negative views will trade relatively more in options and relatively less in the underlying stock. Therefore a high ratio of options volume to stock volume can also be seen as a negative signal. Pearson et al (2015) also demonstrate that more components of total options volume negatively predict stock price than positively predict stock price, in part because the negative alpha associated with the unwinding of long call positions is not offset by a positive alpha from the unwinding of long put positions.

The Volume Component of CAM1 captures each of these volume dynamics. Although the volume effects tend to be relatively short-lived and are a more indirect way to estimate demand for options, since there is no way to know with certainty whether a trade was buyer- or seller-initiated, there is value in including these factors in the model.

cam1 number Cross-Asset Model score, 1 to 100
cam1Slow number Moving average of Cross-Asset Model score, 1 to 100

ESG CFPB Complaints

Financial firms have been under scrutiny for their business practices since the Global Financial Crisis. The Consumer Financial Protection Bureau’s Consumer Complaint Database is a collection of complaints on a range of consumer financial products and services, sent to companies for response. The Consumer Financial Protection Board doesn’t verify all the facts alleged in these complaints, but we take steps to confirm a commercial relationship between the consumer and the company.

Since the CFPB started accepting complaints in July 2011, they have helped consumers connect with financial companies to understand issues with their mortgages, fix errors on their credit reports, stop harassment from debt collectors, and get direct responses about problems with their credit cards, checking and savings accounts, student loans, and more.

The database generally updates daily, and contains certain information for each complaint, including the source of the complaint, the date of submission, and the company the complaint was sent to for response. The database also includes information about the actions taken by the company in response to the complaint, such as, whether the company’s response was timely and how the company responded. If the consumer opts to share it and after we take steps to remove personal information, we publish the consumer’s description of what happened. Companies also have the option to select a public response. Complaints referred to other regulators, such as complaints about depository institutions with less than $10 billion in assets, are not published in the Consumer Complaint Database.

History available from 2011

HTTP request

GET /time-series/PREMIUM_EXTRACT_ALPHA_ESG/{symbol?}/1

JSON response

[
  {
    "eventId":"312317",

    "masterName":"Flagstar Bancorp, Inc.",
    "company":"Flagstar Bank",
    "product":"Mortgage",
    "subproduct":"FHA mortgage",
    "issue":"Loan modification, collection, foreclosure",
    "subissue":"",
    "consumerComplaintNarrative":"",
    "companyPublicResponse":"",
    "consumerConsentProvided":"N/A",
    "dateSentToCompany":"2011-12-23",
    "companyResponseToConsumer":"Closed without relief",
    "timelyResponse":"Yes",
    "consumerDisputed":"No",
    "complaintId":"2302",
    "updated": 1650381005856,
    "id": "PREMIUM_EXTRACT_ALPHA_ESG",
    "source": "ExtractAlpha",
    "key": "FBP",
    "subkey": "2019-10-31",
    "date": 1571832000000
  }
]

Data Weighting

Premium Data 40,000 per event

Data Timing

Daily

Data Schedule

3am UTC daily
Median Lag 400 days

Data Source(s)

ExtractAlpha

Notes

This is a Premium Data end-point available to only paying customers. You will be charged directly at pay-as-you-go rates and the messages consumed from this end-point will not come from your base subscription message allocation.

Available Methods

GET /time-series/PREMIUM_EXTRACT_ALPHA_ESG

Examples

Path Parameters

Name Type Description
symbol string Optional.
• Ticker symbol
eventType number Optional.
• 1 for ESG CFPB Complaints

Query Parameters

This end point uses all standard time-series query parameters.

Response Attributes

Key Type Description
key string Most recent IEX Cloud ticker/symbol
eventId string Identifier for the event
masterName string Company name
eventType string ESG event type
company string
dateReceived string
product string
subproduct string
issue string
subissue string
consumerComplaintNarrative string
companyPublicResponse string
consumerConsentProvided string
dateSentToCompany string
companyResponseToConsumer string
timelyResponse string
consumerDisputed string
complaintId string

ESG CPSC Recalls

Product recalls can be a sign that a company did not employ sufficient safety or quality standards when releasing its products. A product recall can have significant negative impact on a company’s brand, sales, and stock price [Kin, Shenoy, and Subramaniam, 2013]. CPSC is charged with protecting the public from unreasonable risks of injury or death associated with the use of the thousands of types of consumer products under the agency’s jurisdiction. CPSC is committed to protecting consumers and families from products that pose a fire, electrical, chemical, or mechanical hazard.

Note that CPSC recalls data is collected from multiple different data formats and so the available fields will vary substantially across records in their availability.

Future versions may include consumers’ reports on product safety-related incidents.

History available from 1974

HTTP request

GET /time-series/PREMIUM_EXTRACT_ALPHA_ESG/{symbol?}/5

JSON response

[
  {
    "eventId":"16371",
    "masterName":"Target Corporation",
    "name":"Target",
    "recallID":"3020",
    "recallNumber":"5275",
    "description":"September 21, 2005 Release # 05-275 Firm Recall Hotline: (800) 919-6330CPSC Consumer Hotline: (800) 638-2772CPSC Media Contact: (301) 504-7908 CPSC, Pacific Market International, LLC (PMI) Announce Recall of Stanley Vacuum Bottles WASHINGTON, D.C. - The U.S. Consumer Product Safety Commission announces the following recall in voluntary cooperation with the firm listed below. Consumers should stop using recalled products immediately unless otherwise instructed. It is illegal to resell or attempt to resell a recalled consumer product. Name of Product: Stanley thermos bottles Units: About 45, 000 Manufacturer: PMI, of Seattle, Wash. Hazard: The handle on the thermos bottles can break, causing the vacuum seal to fail and release organic, non-toxic charcoal powder insulation into the air. This can cause consumers to suffer short-term vision problems and temporary breathing problems when they inhale the powder. Incidents/Injuries: PMI has received 654 reports of handles breaking and non-tox", 
    "URL":"https://www.cpsc.gov/Recalls/2005/CPSC-Pacific-Market-International-LLC-PMI-Announce-Recall-of-Stanley-Vacuum-Bottles",
    "title":"CPSC,
     Pacific Market International,
     LLC (PMI) Announce Recall of Stanley Vacuum Bottles",
    "consumerContact":"",
    "lastPublishDate":"2014-05-23"
    "updated": 1650381005856,

    "id": "PREMIUM_EXTRACT_ALPHA_ESG",
    "source": "ExtractAlpha",
    "key": "TGT",
    "subkey": "2019-10-31",
    "date": 1571832000000
  }
]

Data Weighting

Premium Data 40,000 per event

Data Timing

Daily

Data Schedule

3am UTC daily

Data Source(s)

ExtractAlpha

Notes

This is a Premium Data end-point available to only paying customers. You will be charged directly at pay-as-you-go rates and the messages consumed from this end-point will not come from your base subscription message allocation.

Available Methods

GET /time-series/PREMIUM_EXTRACT_ALPHA_ESG

Examples

Path Parameters

Name Type Description
symbol string Optional.
• Ticker symbol
eventType number Optional.
• 5 for ESG CPSC Recalls

Query Parameters

This end point uses all standard time-series query parameters.

Response Attributes

Key Type Description
key string Most recent IEX Cloud ticker/symbol
eventId string Identifier for the event
masterName string Company name
eventType string ESG event type
name string
recallDate string
recallID string
recallNumber string
description string
URL string
title string
consumerContact string
lastPublishDate string

ESG DOL Visa Applications

Companies often hire foreign knowledge workers if they wish to invest in innovation. Hiring foreign workers for employment in the U.S. normally requires approval from several government agencies. First, employers must seek labor certification through the U.S. Department of Labor (DOL). Once the application is certified (approved), the employer must petition the U.S. Citizenship and Immigration Services (CIS) for a visa. Approval by DOL does not guarantee a visa issuance. The Department of State (DOS) will issue an immigrant visa number to the foreign worker for U.S. entry.

The Office of Foreign Labor Certification (OFLC) Disclosure Data consists of select extracted data fields from application tables within OFLC case management systems. Each Excel file is cumulative, containing unique records identified by the applicable OFLC case number based on the most recent date a case determination decision was issued.

This endpoint includes data on Permanent and H-1B visas only. The H-1B program allows employers to temporarily employ foreign workers in the U.S. on a nonimmigrant basis in specialty occupations or as fashion models of distinguished merit and ability. A specialty occupation requires the theoretical and practical application of a body of specialized knowledge and a bachelor’s degree or the equivalent in the specific specialty (e.g. sciences, medicine, health care, education, biotechnology, and business specialties, etc.).

Note that because of the different data structures available by year and across application type (H1B and PERM), the density of many of these fields will vary substantially across the dataset.

History available from 1999

HTTP request

GET /time-series/PREMIUM_EXTRACT_ALPHA_ESG/{symbol?}/8

JSON response

[
  {
    "eventId":"2527889",
    "masterName":"Federal Home Loan Mortgage Corporation",
    "employerName":"Federal Home Loan Mortgage Corp.",
    "caseNumber":"03320647",
    "jobTitle":"Data Base Design Analyst",
    "totalWorkers":"",
    "type":"PERM",
    "dcaseSubmitted":"",
    "demploymentStartDate":"",
    "demploymentEndDate":"",
    "caseStatus":"Certified",
    "updated": 1650381005856,
    "id": "PREMIUM_EXTRACT_ALPHA_ESG",
    "source": "ExtractAlpha",
    "key": "FMCC",
    "subkey": "2019-10-31",
    "date": 1571832000000
  }
]

Data Weighting

Premium Data 40,000 per event

Data Timing

Quarterly

Data Schedule

3am UTC daily

Data Source(s)

ExtractAlpha

Notes

This is a Premium Data end-point available to only paying customers. You will be charged directly at pay-as-you-go rates and the messages consumed from this end-point will not come from your base subscription message allocation.

Available Methods

GET /time-series/PREMIUM_EXTRACT_ALPHA_ESG

Examples

Path Parameters

Name Type Description
symbol string Optional.
• Ticker symbol
eventType number Optional.
• 8 for ESG DOC Visa Applications

Query Parameters

This end point uses all standard time-series query parameters.

Response Attributes

Key Type Description
key string Most recent IEX Cloud ticker/symbol
eventId string Identifier for the event
masterName string Company name
eventType string ESG event type
employerName string
dDecisionDate string
caseNumber string
jobTitle string
totalWorkers number
type string
dCaseSubmitted string
dEmploymentStartDate string
dEmploymentEndDate string
caseStatus string

ESG EPA Enforcements

Violations of Environmental Protection Agency regulations can indicate a company’s negligence in its environmental and emissions standards, or a disregard for regulatory risks.

The Enforcement and Compliance History Online (ECHO) system incorporates Federal enforcement and compliance (FE&C) data from the Integrated Compliance Information System (ICIS), used to track federal enforcement cases. ICIS contains information on federal administrative and federal judicial cases under the following environmental statutes: the Clean Air Act (CAA), the Clean Water Act (CWA), the Resource Conservation and Recovery Act (RCRA), the Emergency Planning and Community Right-to-Know Act (EPCRA) Section 313, the Toxic Substances Control Act (TSCA), the Federal Insecticide, Fungicide, and Rodenticide Act (FIFRA), the Comprehensive Environmental Response, Compensation, and Liability Act (CERCLA or Superfund), the Safe Drinking Water Act (SDWA), and the Marine Protection, Research, and Sanctuaries Act (MPRSA).

ICIS is a case activity tracking and management system for civil, judicial, and administrative federal EPA enforcement cases. Case information is supplied and updated by EPA’s Offices of Regional Counsel and Office of Civil Enforcement case attorneys. The basic structure of an ICIS FE&C record focuses on an enforcement case. It is assigned a case number and a case name which identifies the defendant (or principal defendant if more than one is named in the complaint). For administrative actions, the record includes the nature of the violation, statute(s) involved, and milestone dates (e.g., the date the order was issued). Judicial actions contain information similar to that for administrative actions, but include more detailed milestone dates.

Data is organized around two concepts: the enforcement case and a resulting settlement(s) (enforcement conclusion). Enforcement case data describe the enforcement action from initiation through to its conclusion. If multiple defendants, facilities, and/or violations are cited in the case, then a single case may result in multiple settlements. These case conclusions describe what has been ordered and/or agreed upon to be performed to address violations identified by the case complaint.

History available from 1975

HTTP request

GET /time-series/PREMIUM_EXTRACT_ALPHA_ESG/{symbol?}/2

JSON response

[
  {
    "eventId":"52646",
    "masterName":"Exxon Mobil Corporation",
    "defendantName":"EXXON MOBIL CORPORATION",
    "namedInComplaintFlag":"N",
    "namedInSettlementFlag":"N",
    "activityId":"34690",
    "activityName":"ARCO/SIKES",
    "stateCode":"",
    "regionCode":"06",
    "fiscalYear":"1989",
    "caseNumber":"06-1989-0141",
    "caseName":"ARCO/SIKES",
    "activityTypeCode":"JDC",
    "activityTypeDesc":"Judicial",
    "activityStatusDate":"1998-02-12",
    "lead":"EPA",
    "dojDocketNmbr":"90-11-3-1419",
    "enfOutcomeCode":"",
    "enfOutcomeDesc":"",
    "totalPenaltyAssessedAmt":"",
    "totalCostRecoveryAmt":"",
    "totalCompActionAmt":"",
    "hqDivision":"CER",
    "branch":"6SFW",
    "voluntarySelfDisclosureFlag":"N",
    "multimediaFlag":"N",
    "enfSummaryText":"02/22/91:  HAVE REQUESTED CASE SUMMARY FROM ATTORNEY AND   WILL ENTER WHEN RECEIVED.",
    "updated": 1650381005856,
    "id": "PREMIUM_EXTRACT_ALPHA_ESG",
    "source": "ExtractAlpha",
    "key": "XONA-GY",
    "subkey": "2019-10-31",
    "date": 1571832000000
  }
]

Data Weighting

Premium Data 40,000 per event

Data Timing

Weekly - Saturday

Data Schedule

3am UTC daily
Median Lag 60 days

Data Source(s)

ExtractAlpha

Notes

This is a Premium Data end-point available to only paying customers. You will be charged directly at pay-as-you-go rates and the messages consumed from this end-point will not come from your base subscription message allocation.

Available Methods

GET /time-series/PREMIUM_EXTRACT_ALPHA_ESG

Examples

Path Parameters

Name Type Description
symbol string Optional.
• Ticker symbol
eventType number Optional.
• 2 for ESG EPA Enforcements

Query Parameters

This end point uses all standard time-series query parameters.

Response Attributes

Key Type Description
key string Most recent IEX Cloud ticker/symbol
eventId string Identifier for the event
masterName string Company name
eventType string ESG event type
defendantName string
caseStatusDate string
namedInComplaintFlag string
namedInSettlementFlag string
activityId string
activityName string
stateCode string
regionCode string
fiscalYear number
caseNumber string
caseName string
activityTypeCode string
activityTypeDesc string
activityStatusDate string
lead string
dojDocketNmbr string
enfOutcomeCode string
enfOutcomeDesc string
totalPenaltyAssessedAmt number
totalCostRecoveryAmt number
totalCompActionAmt number
hqDivision string
branch string
voluntarySelfDisclosureFlag string
multimediaFlag string
enfSummaryText string

ESG EPA Milestones

As described in EPA Enforcements, but including all milestones for an EPA violation event, not just enforcement actions.

History available from 1975

HTTP request

GET /time-series/PREMIUM_EXTRACT_ALPHA_ESG/{symbol?}/3

JSON response

[
  {
    "eventId":"269204",
    "masterName":"Ford Motor Company",
    "defendantName":"FORD MOTOR COMPANY, INC.",
    "namedInComplaintFlag":"Y",
    "namedInSettlementFlag":"Y",
    "activityId":"20524",
    "caseNumber":"04-1989-0131",
    "subActivityTypeCode":"ROPNJ",
    "subActivityTypeDesc":"Enforcement Action Data Entered",
    "updated": 1650381005856,
    "id": "PREMIUM_EXTRACT_ALPHA_ESG",
    "source": "ExtractAlpha",
    "key": "AAPL",
    "subkey": "2019-10-31",
    "date": 1571832000000
  }
]

Data Weighting

Premium Data 40,000 per event

Data Timing

Daily

Data Schedule

3am UTC daily
Median Lag 400 days

Data Source(s)

ExtractAlpha

Notes

This is a Premium Data end-point available to only paying customers. You will be charged directly at pay-as-you-go rates and the messages consumed from this end-point will not come from your base subscription message allocation.

Available Methods

GET /time-series/PREMIUM_EXTRACT_ALPHA_ESG

Examples

Path Parameters

Name Type Description
symbol string Optional.
• Ticker symbol
eventType number Optional.
• 3 for ESG EPA Milestones

Query Parameters

This end point uses all standard time-series query parameters.

Response Attributes

Key Type Description
key string Most recent IEX Cloud ticker/symbol
eventId string Identifier for the event
masterName string Company name
eventType string ESG event type
defendantName string
actualDate string
namedInComplaintFlag string
namedInSettlementFlag string
activityId number
caseNumber string
subActivityTypeCode string
subActivityTypeDesc string

ESG FEC Individual Campaign Contributions

Individuals often contribute to political campaigns, and when doing so they are asked to disclose their employer. The individual contributions file contains each campaign contribution from an individual to a federal committee. The files for the current election cycle plus the two most recent election cycles are regularly updated.

History available from 1997

HTTP request

GET /time-series/PREMIUM_EXTRACT_ALPHA_ESG/{symbol?}/7

JSON response

[
  {
    "eventId":"7085177",
    "masterName":"First American Corporation",
    "employer":"FIRST AMERICAN CORPORATION",
    "amndInd":"A",
    "transactionAmt":"720",
    "tranId":"",
    "fileNum":"",
    "updated": 1650381005856,
    "id": "PREMIUM_EXTRACT_ALPHA_ESG",
    "source": "ExtractAlpha",
    "key": "FEYE",
    "subkey": "2019-10-31",
    "date": 1571832000000
  }
]

Data Weighting

Premium Data 40,000 per event

Data Timing

Weekly - Sundays

Data Schedule

3am UTC daily
Median Lag 130 days

Data Source(s)

ExtractAlpha

Notes

This is a Premium Data end-point available to only paying customers. You will be charged directly at pay-as-you-go rates and the messages consumed from this end-point will not come from your base subscription message allocation.

Available Methods

GET /time-series/PREMIUM_EXTRACT_ALPHA_ESG

Examples

Path Parameters

Name Type Description
symbol string Optional.
• Ticker symbol
eventType number Optional.
• 7 for ESG FEC Individual Campaign Contributions

Query Parameters

This end point uses all standard time-series query parameters.

Response Attributes

Key Type Description
key string Most recent IEX Cloud ticker/symbol
eventId string Identifier for the event
masterName string Company name
eventType string ESG event type
employer string
transactionDate string
amndInd string
transactionAmt number
tranId string
fileNum number

ESG OSHA Inspections

Workplace injuries can be an indication of a company’s under investment in worker safety and reasonable working conditions. The dataset consists of inspection case detail for Occupational Safety and Health Administration (OSHA) inspections. The dataset includes information regarding the impetus for conducting the inspections, which are often prompted by workplace accidents, injuries, and fatalities.

Future versions may include data on the workplace injuries themselves.

History available from 1972

HTTP request

GET /time-series/PREMIUM_EXTRACT_ALPHA_ESG/{symbol?}/4

JSON response

[
  {
    "eventId":"1481414",
    "masterName":"Fleetwood Enterprises, Inc.",
    "estabName":"FLEETWOOD ENTERPRISES INC",
    "activityNr":"13306741",
    "inspType":"H",
    "updated": 1650381005856,
    "id": "PREMIUM_EXTRACT_ALPHA_ESG",
    "source": "ExtractAlpha",
    "key": "F3A-GY",
    "subkey": "2019-10-31",
    "date": 1571832000000
  }
]

Data Weighting

Premium Data 40,000 per event

Data Timing

Daily

Data Schedule

3am UTC daily
Median Lag 45 days

Data Source(s)

ExtractAlpha

Notes

This is a Premium Data end-point available to only paying customers. You will be charged directly at pay-as-you-go rates and the messages consumed from this end-point will not come from your base subscription message allocation.

Available Methods

GET /time-series/PREMIUM_EXTRACT_ALPHA_ESG

Examples

Path Parameters

Name Type Description
symbol string Optional.
• Ticker symbol
eventType number Optional.
• 4 for ESG OSHA Inspections

Query Parameters

This end point uses all standard time-series query parameters.

Response Attributes

Key Type Description
key string Most recent IEX Cloud ticker/symbol
eventId string Identifier for the event
masterName string Company name
eventType string ESG event type
estabName string
openDate string
activityNr number
inspType string

ESG Senate Lobbying

Companies often employ lobbyists to influence legislation in their favor, and lobbying can be a very high ROI activity for a company [Hutchens, Rego, and Sheneman, 2016]. Under the Lobbying Disclosure Act, in-house and outside lobbyists must file quarterly reports describing lobbying activity. These reports disclose the amount spent on lobbying. The lobbying data is compiled using the lobbying disclosure reports filed with the Secretary of the Senate’s Office of Public Records (SOPR). Quarterly reports are due on the 20th day of January, April, July, and October. Lobbying firms are required to provide a good- faith estimate rounded to the nearest $10,000 of all lobbying-related income from their clients in each quarter. Total spending on lobbying activities are reported each quarter, but are not broken down by how much was spent on a particular issue or bill.

History available from 1999

HTTP request

GET /time-series/PREMIUM_EXTRACT_ALPHA_ESG/{symbol?}/6

JSON response

[
  {
    "eventId":"418288",
    "masterName":"Florida Progress Corp.",
    "clientName":"FLORIDA PROGRESS CORP",
    "ID":"1ECDE666-5AD1-4074-A96C-2F41BD9DCE15",
    "year":"1999",
    "received":"1999-08-12T00:00:00",
    "amount":60000,
    "updated": 1650381005856,
    "id": "PREMIUM_EXTRACT_ALPHA_ESG",
    "source": "ExtractAlpha",
    "key": "AAPL",
    "subkey": "2019-10-31",
    "date": 1571832000000
  }
]

Data Weighting

Premium Data 40,000 per event

Data Timing

Weekly

Data Schedule

3am UTC daily
Median Lag 35 days

Data Source(s)

ExtractAlpha

Notes

This is a Premium Data end-point available to only paying customers. You will be charged directly at pay-as-you-go rates and the messages consumed from this end-point will not come from your base subscription message allocation.

Available Methods

GET /time-series/PREMIUM_EXTRACT_ALPHA_ESG

Examples

Path Parameters

Name Type Description
symbol string Optional.
• Ticker symbol
eventType number Optional.
• 6 for ESG Senate Lobbying

Query Parameters

This end point uses all standard time-series query parameters.

Response Attributes

Key Type Description
key string Most recent IEX Cloud ticker/symbol
eventId string Identifier for the event
masterName string Company name
eventType string ESG event type
clientName string
receivedDate string
ID string
year number
__received string
amount number

ESG USA Spending

Companies seek government contracts as these are very sticky sources of revenue. The Federal Funding Accountability and Transparency Act of 2006 (FFATA) requires that federal contract, grant, loan, and other financial assistance awards of more than $25,000 be displayed on a searchable, publicly accessible website. As a matter of discretion, the data set also contains certain federal contracts of more than $3,000.

All the data on prime recipient transactions is submited by the federal agencies making federal contract, grant, loan, and other financial assistance awards. Agencies are required to submit data within 30 days of making the award or after making a modification or amendment to an award. The exception is the Department of Defense which delays its submission by 90 days to protect operations.

History available from 1995

HTTP request

GET /time-series/PREMIUM_EXTRACT_ALPHA_ESG/{symbol?}/9

JSON response

[
  {
    "eventId":"17824306",
    "masterName":"Ford Motor Company",
    "vendorName":"FORD MOTOR COMPANY",
    "vendorAlternateName":"",
    "vendorLegalOrganizationName":"",
    "vendorDoingBusinessAsName":"",
    "divisionName":"",
    "modParent":"FORD MOTOR COMPANY",
    "uniqueTransactionID":"058b0e97392064b9a73a",
    "dollarsObligated":"122000",
    "signedDate":"2000-01-15",
    "majAgencyCat":"4700: GENERAL SERVICES ADMINISTRATION",
    "updated": 1650381005856,
    "id": "PREMIUM_EXTRACT_ALPHA_ESG",
    "source": "ExtractAlpha",
    "key": "F",
    "subkey": "2019-10-31",
    "date": 1571832000000
  }
]

Data Weighting

Premium Data 40,000 per event

Data Timing

Daily

Data Schedule

3am UTC daily
Median Lag 120 days

Data Source(s)

ExtractAlpha

Notes

This is a Premium Data end-point available to only paying customers. You will be charged directly at pay-as-you-go rates and the messages consumed from this end-point will not come from your base subscription message allocation.

Available Methods

GET /time-series/PREMIUM_EXTRACT_ALPHA_ESG

Examples

Path Parameters

Name Type Description
symbol string Optional.
• Ticker symbol
eventType number Optional.
• 9 for ESG USA Spending

Query Parameters

This end point uses all standard time-series query parameters.

Response Attributes

Key Type Description
key string Most recent IEX Cloud ticker/symbol
eventId string Identifier for the event
masterName string Company name
eventType string ESG event type
vendorName string
vendorAlternateName string
vendorLegalOrganizationName string
vendorDoingBusinessAsName string
divisionName string
modParent string
effectiveDate string
uniqueTransactionId string
dollarsObligated number
signedDate string
majAgencyCat string

ESG USPTO Patent Applications

Patent applications and grants are indications that a company is investing in future innovation [Hirshleifer, Hsu, and Li, 2013]. The United States Patent and Trademark Office (USPTO) is the federal agency for granting U.S. patents and registering trademarks. Patent applications data is issued weekly on Thursdays.

Future versions may contain more detail on the content of patent applications.

History available from 2002

HTTP request

GET /time-series/PREMIUM_EXTRACT_ALPHA_ESG/{symbol?}/10

JSON response

[
  {
    "eventId":"828256",
    "masterName":"FMC Technologies, Inc.",
    "organizationName":"FMC Corporation",
    "appNumber":"20020012706",
    "documentDate":"2002-01-31",
    "filingDate":"2001-06-21",
    "updated": 1650381005856,
    "id": "PREMIUM_EXTRACT_ALPHA_ESG",
    "source": "ExtractAlpha",
    "key": "FLEX",
    "subkey": "2019-10-31",
    "date": 1571832000000
  }
]

Data Weighting

Premium Data 40,000 per event

Data Timing

Weekly - Thursdays

Data Schedule

3am UTC daily
Median Lag 15 days

Data Source(s)

ExtractAlpha

Notes

This is a Premium Data end-point available to only paying customers. You will be charged directly at pay-as-you-go rates and the messages consumed from this end-point will not come from your base subscription message allocation.

Available Methods

GET /time-series/PREMIUM_EXTRACT_ALPHA_ESG

Examples

Path Parameters

Name Type Description
symbol string Optional.
• Ticker symbol
eventType number Optional.
• 10 for ESG USPTO Patent Applications

Query Parameters

This end point uses all standard time-series query parameters.

Response Attributes

Key Type Description
key string Most recent IEX Cloud ticker/symbol
eventId string Identifier for the event
masterName string Company name
eventType string ESG event type
organizationName string
usptoDate string YYYY-MM-DD
appNumber string
documentDate string YYYY-MM-DD
filingDate string YYYY-MM-DD

ESG USPTO Patent Grants

Patent grants are indications that a company has successfully signaled that it values its IP, that its IP is unique in the eyes of the USPTO, and that its initial patent application was a reasonable one.

Patent grants data is issued weekly on Tuesdays.

Currently only the first three assignees listed on the patent are included. Future versions may contain more detail on the content of patent grants, including assignees beyond the first three listed on the grant.

History available from 2002

HTTP request

GET /time-series/PREMIUM_EXTRACT_ALPHA_ESG/{symbol?}/11

JSON response

[
  {
    "eventId":"651821",
    "masterName":"International Business Machines Corporation",
    "name1":"DaimlerChrysler AG",
    "name2":"International Business Machines Corporation",
    "name3":"",
    "patentNumber":"06336128",
    "filingDate":"1998-11-03",
    "publicationDate":"2002-01-01",
    "updated": 1650381005856,
    "id": "PREMIUM_EXTRACT_ALPHA_ESG",
    "source": "ExtractAlpha",
    "key": "F",
    "subkey": "2019-10-31",
    "date": 1571832000000
  }
]

Data Weighting

Premium Data 40,000 per event

Data Timing

Weekly - Tuesdays

Data Schedule

3am UTC daily
Median Lag 15 days

Data Source(s)

ExtractAlpha

Notes

This is a Premium Data end-point available to only paying customers. You will be charged directly at pay-as-you-go rates and the messages consumed from this end-point will not come from your base subscription message allocation.

Available Methods

GET /time-series/PREMIUM_EXTRACT_ALPHA_ESG

Examples

Path Parameters

Name Type Description
symbol string Optional.
• Ticker symbol
eventType number Optional.
• 11 for ESG USPTO Patent Grants

Query Parameters

This end point uses all standard time-series query parameters.

Response Attributes

Key Type Description
key string Most recent IEX Cloud ticker/symbol
eventId string Identifier for the event
masterName string Company name
eventType string ESG event type
name1 string
name2 string
name3 string
usptoDate string YYYY-MM-DD
patentNumber string
filingDate string YYYY-MM-DD

Tactical Model 1

The ExtractAlpha Tactical Model 1 (TM1) is a quantitative stock selection model designed to capture the technical dynamics of single US equities over one to ten trading day horizons. TM1 is a tactical factor, in that it can assist a longer- horizon investor in timing their entry or exit points, or be used in combination with existing systematic or qualitative strategies with similar holding periods.

In historical simulations, high-scoring stocks according to TM1 outperform low- scoring stocks by 59% per annum with a market-neutral Sharpe ratio of 4.4 before transaction costs, versus 25% and a Sharpe of 1.1 for a basic reversal factor with comparable turnover. Unlike many quantitative stock selection factors, TM1 exhibits comparable returns for large-cap stocks and small-cap stocks, and it is particularly effective in volatile regimes.

TM1’s alpha is realized between one and ten days, and so may not be appropriate as a signal on which to trade directly for some investment managers with long horizons or large AUMs. However TM1 could be used to time trades that a longer-horizon strategy would enter regardless, thereby improving the price of the entry and exit points without incurring incremental transaction costs.

A basic fundamental and momentum strategy with annual net returns of 5.5%, a net Sharpe Ratio of 0.55, and daily turnover of 6.4% can be improved to annual net returns of 10.0% and a net Sharpe Ratio of 0.97, with a slight reduction of turnover, by implementing simple TM1-based entry and exit rules. The value added is very consistent over time, offers drawdown protection in volatile markets, and survives reasonable transaction cost and latency assumptions.

TM1 is therefore effective as a tactical overlay which can improve risk-adjusted returns without unduly influencing the underlying strategy. The implementation could be as straightforward as a daily pre-trade screen on position entries and exits prior to the open.

History available from January 2000

HTTP request

GET /time-series/PREMIUM_EXTRACT_ALPHA_TM/{symbol?}

JSON response

[
  {
    "reversalComponent":65,
    "factorMomentumComponent":43,
    "liquidityShockComponent":76,
    "seasonalityComponent":43,
    "tm1":64,
    "updated": 1650381005856,
    "id": "PREMIUM_EXTRACT_ALPHA_TM",
    "source": "ExtractAlpha",
    "key": "AAPL",
    "subkey": "2019-10-31",
    "date": 1571832000000
  }
]

Data Weighting

Premium Data 42,850 per event

Data Timing

End of day

Data Schedule

3am UTC daily

Data Source(s)

ExtractAlpha

Notes

This is a Premium Data end-point available to only paying customers. You will be charged directly at pay-as-you-go rates and the messages consumed from this end-point will not come from your base subscription message allocation.

Available Methods

GET /time-series/PREMIUM_EXTRACT_ALPHA_TM

Examples

Query Parameters

This end point uses all standard time-series query parameters.

Response Attributes

Key Type Description
key string Most recent IEX Cloud ticker/symbol
reversalComponent number TM1 Reversal Component, 1 to 100 percentile rank, 100 representing the stocks most likely to outperform according to that component
There is a long history of academic research which documents the tendency for single stock returns to reverse over a one-month horizon (De Bondt and Thaler, 1985). Common explanations for the effect include investor overreaction; statistical artifacts due to the bid-ask bounce; and, most frequently, demand for liquidity. Noise traders produce short term dislocations in stock prices, but these movements are temporary since stock fundamentals have remained unchanged. Hedge funds and trading desks often employ statistical arbitrage strategies to effectively take the other side of these trades, providing liquidity to less-nimble or less-informed traders.
Reversals are by their nature stock-specific, so a model which captures idiosyncratic stock movements should outperform one which also includes movements driven by a stock’s industry or risk exposures (Blitz et al, 2013). TM1 utilized returns which have been residualized to industry and common risk factors such as value, leverage, and momentum.
In constructing a reversal factor, it is important to be able to differentiate between stock movements which are liquidity-driven versus those which are driven by information. For example, returns around earnings announcements are more likely to reflect changing fundamentals, and are therefore less likely to reverse. TM1 addresses this issue by effectively capturing reversals in liquidity time rather than calendar time (Avellaneda and Lee, 2010). That is, large price movements which occur on high volume, which are more likely to be informationally driven and permanent, are underweighted relative to those which occur on low volume and are more likely to reverse. Using volume allows us to capture high- information trading environments without relying on explicit information events such as news data or earnings events.
factorMomentumComponent number TM1 Factor Momentum Component, 1, to 100
Stock idiosyncratic returns tend to reverse, but their common factor components tend to trend (Hameed, 1997). Large institutions often shift their exposures into groups of stocks at once, resulting in cross-asset autocorrelation in factor returns. For example, value stocks tend to move together as investor preferences shift. These movements usually manifest more slowly in the smaller, less liquid names, as institutions move into more liquid names more quickly and must spread their trades in smaller names across multiple trading sessions.
TM1 captures this lead-lag factor momentum by measuring the autocorrelation in factor returns. The factor returns – for example, the recent returns to the Value factor – are mapped back to stocks with Value exposure, so that each stock has a factor return profile based on its particular risk exposures’ recent factor movements.
Because factor momentum tends to spread across a group of stocks of a particular style relatively quickly, moving from more liquid to less liquid names within a group, this component of TM1 is relatively short-lived, and exhibits most of its strength among smaller capitalization names. The same is not true of TM1 as a whole, which exhibits strong returns for large cap stocks, particularly after accounting for transaction costs.
liquidityShockComponent number TM1 Liquidity Shock Component, 1 to 100
In addition to informing us about the likelihood of reversals, liquidity shocks themselves can signal information about short horizon returns (Rohal et al, 2015; Bali et al, 2014). Stocks which have short- term increases in liquidity command additional attention from investors and become more accessible to investors with short sale constraints. Stocks with liquidity which has unexpectedly dried up may exit the tradable universe of long-only institutions and may command less attention. TM1 captures this effect by measuring recent liquidity levels relative to a moving average, and residualizing the variable to capture idiosyncratic, stock-specific shocks.
seasonalityComponent number TM1 Seasonality Component, 1 to 100
In recent years academic researchers have uncovered strong seasonality patterns in the cross-section of returns, both in the US and internationally (Heston and Sadka, 2008). That is, stocks which have historically outperformed during a particular time of year in past years tend to continue to outperform at that same time of year in subsequent years. Various rationales have been proposed, including earnings and tax seasonality, the January effect, or simply seasonal trends in investor appetite for particular topical names. TM1 refines this effect by measuring seasonality at shorter horizons and using residual returns rather than raw returns, to better capture idiosyncratic seasonality.
tm1 number Tactical Model score, 1 to 100

Precision Alpha

Precision Alpha offers unbiased, machine learned price dynamics of Nasdaq and NYSE listed equities, in generally non-equilibrium financial markets.

Precision Alpha Price Dynamics

Precision Alpha performs an unbiased non-equilibrium market analysis on six months of closing price data for all NASDAQ and NYSE listed equities, every day after market close. Precision Alpha calculates scientifically and exactly: market emotion, power, resistance, noise/efficiency, and next day probabilities

HTTP request

GET /time-series/PREMIUM_PRECISION_ALPHA_PRICE_DYNAMICS/{symbol?}

JSON response

[
  {
    "id": "PREMIUM_PRECISION_ALPHA_PRICE_DYNAMICS",
    "source": "Decision Machines",
    "key": "BAC",
    "subkey": "2020-01-13",
    "symbol": "BAC",
    "companyName": "Bank of America Corp.",
    "closeDate": "2020-01-13",
    "probabilityUp": 0.5545,
    "probabilityDown": 0.4455,
    "marketEmotion": 379.8855,
    "marketPower": 52492.8458,
    "marketResistance": 2.7492,
    "marketNoise": 1.5152,
    "date": 1578891600000,
    "updated": 1579028315000
  }
]

Data Weighting

Premium Data 350,000 per day, per symbol

Data Timing

End of day

Data Schedule

8am UTC daily

Data Source(s)

Precision Alpha

Notes

This is a Premium Data end-point available to only paying customers. You will be charged directly at pay-as-you-go rates and the messages consumed from this end-point will not come from your base subscription message allocation.

Available Methods

GET /time-series/PREMIUM_PRECISION_ALPHA_PRICE_DYNAMICS

Example

Query Parameters

This end point uses all standard time-series query parameters.

Response Attributes

Key Type Description
symbol string Symbol of the security
companyName string Name of the company
closeDate string Date of the last closing price used in the price dynamic calculations
probabilityUp number Computed, machine learned probability that the value of the measured asset will go up in the next time step (next day probability). The probability is computed exactly (up to double precision numerical error). Value is between 0 and 1.
probabilityDown number Computed, machine learned probability that the value of the measured asset will go down in the next time step (next day probability). The probability is computed exactly (up to double precision numerical error). Value is between 0 and 1.
marketEmotion number Computed, machine learned Behavioral Energy measured from the equilibrium energy as zero offset. Positive: Bull, Negative: Bear. Measured in millivolts.
marketPower number Power is the rate (energy amount per time period) at which work is done or energy converted to price movement. Market power combines Emotion and Resistance. At equilibrium, Power is equal to Emotion squared divided by R, that is, V2/R). Measured in microWatts. Power is zero at equilibrium.
marketResistance number Market resistance to changing price. Same as market viscosity. Measured in ohms.
marketNoise number Computed, machine learned market (Nyquist) noise that dissipates Behavioral Energy so that it is not used to generate price movement. Measured in dBs.
updated string Refers to the machine readable epoch timestamp of when this entry was last updated

BRAIN Company

BRAIN is a research company that creates alternative datasets and develops proprietary algorithms for investment strategies on financial markets.

BRAIN Company’s 30 Day Sentiment Indicator

Brain Company’s Sentiment Indicator monitors the stock sentiment from the last 30 days of public financial news for about 5,000 US stocks. The sentiment scoring technology is based on a combination of various natural language processing techniques. The sentiment score assigned to each stock is a value ranging from -1 (most negative) to +1 (most positive) that is updated daily.

HTTP request

GET /time-series/PREMIUM_BRAIN_SENTIMENT_30_DAYS/{symbol?}

JSON response

[
  {
    "id": "PREMIUM_BRAIN_SENTIMENT_30_DAYS",
    "source": "Brain Company",
    "key": "BAC",
    "subkey": "2020-01-13",
    "calculationDate": "2020-01-13",
    "companyName": "Bank of America Corp.",
    "compositeFigi": "BBG000BCTLF6",
    "symbol": "BAC",
    "volume": 45,
    "volumeSentiment": 41,
    "sentimentScore": 0.0452,
    "numberOfDaysIncluded": 30
  }
]

Data Weighting

Premium Data 60,000 per day, per symbol

Data Timing

End of day

Data Schedule

8am UTC daily

Data Source(s)

BRAIN Company

Notes

This is a Premium Data end-point available to only paying customers. You will be charged directly at pay-as-you-go rates and the messages consumed from this end-point will not come from your base subscription message allocation.

Available Methods

GET /time-series/PREMIUM_BRAIN_SENTIMENT_30_DAYS

Example

Query Parameters

This end point uses all standard time-series query parameters.

Response Attributes

Key Type Description
calculationDate string The calculation date for the sentiment score in format YYYY-MM-DD. Calculation is done in the morning and encompasses previous 30 days.
companyName string Name of the company
compositeFigi string The FIGI composite code that identifies the stock across related exchanges in the same country.
symbol string Symbol of the security
volume number Number of news articles detected in the previous 30 days for the company.
volumeSentiment number Number of news articles in the previous 30 days used to calculate the sentiment. This number is less or equal to the volume and corresponds to non-neutral news according to the sentiment algorithm.
sentimentScore number Sentiment score from -1 to 1 where 1 is the most positive and -1 the most negative. The sentiment score is calculated as an average of sentiment of news articles collected in the previous 30 days for the specific company.
numberOfDaysIncluded number 30
updated string Refers to the machine readable epoch timestamp of when this entry was last updated

BRAIN Company’s 7 Day Sentiment Indicator

Brain Company’s Sentiment Indicator monitors the stock sentiment from the last 7 days of public financial news for about 5,000 US stocks. The sentiment scoring technology is based on a combination of various natural language processing techniques. The sentiment score assigned to each stock is a value ranging from -1 (most negative) to +1 (most positive) that is updated daily.

HTTP request

GET /time-series/PREMIUM_BRAIN_SENTIMENT_7_DAYS/{symbol?}

JSON response

[
  {
    "id": "PREMIUM_BRAIN_SENTIMENT_7_DAYS",
    "source": "Brain Company",
    "key": "BAC",
    "subkey": "2020-01-13",
    "calculationDate": "2020-01-13",
    "companyName": "Bank of America Corp.",
    "compositeFigi": "BBG000BCTLF6",
    "symbol": "BAC",
    "volume": 45,
    "volumeSentiment": 41,
    "sentimentScore": 0.0452,
    "numberOfDaysIncluded": 7
  }
]

Data Weighting

Premium Data 80,000 per day, per symbol

Data Timing

End of day

Data Schedule

8am UTC daily

Data Source(s)

BRAIN Company

Notes

This is a Premium Data end-point available to only paying customers. You will be charged directly at pay-as-you-go rates and the messages consumed from this end-point will not come from your base subscription message allocation.

Available Methods

GET /time-series/PREMIUM_BRAIN_SENTIMENT_7_DAYS

Example

Query Parameters

This end point uses all standard time-series query parameters.

Response Attributes

Key Type Description
calculationDate string The calculation date for the sentiment score in format YYYY-MM-DD. Calculation is done in the morning and encompasses previous 7 days.
companyName string Name of the company
compositeFigi string The FIGI composite code that identifies the stock across related exchanges in the same country.
symbol string Symbol of the security
volume number Number of news articles detected in the previous 7 days for the company.
volumeSentiment number Number of news articles in the previous 7 days used to calculate the sentiment. This number is less or equal to the volume and corresponds to non-neutral news according to the sentiment algorithm.
sentimentScore number Sentiment score from -1 to 1 where 1 is the most positive and -1 the most negative. The sentiment score is calculated as an average of sentiment of news articles collected in the previous 7 days for the specific company.
numberOfDaysIncluded number 7
updated string Refers to the machine readable epoch timestamp of when this entry was last updated

BRAIN Company’s 21 Day Machine Learning Estimated Return Ranking

Brain Company’s Machine Learning proprietary platform is used to generate a daily stock ranking based on the predicted future returns of a universe of around 1,000 stocks over 21 days. The model implements a voting scheme of machine learning classifiers that non linearly combine a variety of features with a series of techniques aimed at mitigating the well-known overfitting problem for financial data with a low signal to noise ratio.

HTTP request

GET /time-series/PREMIUM_BRAIN_RANKING_21_DAYS/{symbol?}

JSON response

[
  {
    "id": "PREMIUM_BRAIN_RANKING_21_DAYS",
    "source": "Brain Company",
    "key": "BAC",
    "subkey": "2020-01-13",
    "calculationDate": "2020-01-13",
    "companyName": "Bank of America Corp.",
    "compositeFigi": "BBG000BCTLF6",
    "symbol": "BAC",
    "mlAlpha": -0.034,
    "daysForecast": 21
  }
]

Data Weighting

Premium Data 211,538 per day, per symbol

Data Timing

End of day

Data Schedule

8am UTC daily

Data Source(s)

BRAIN Company

Notes

This is a Premium Data end-point available to only paying customers. You will be charged directly at pay-as-you-go rates and the messages consumed from this end-point will not come from your base subscription message allocation.

Available Methods

GET /time-series/PREMIUM_BRAIN_RANKING_21_DAYS

Example

Query Parameters

This end point uses all standard time-series query parameters.

Response Attributes

Key Type Description
calculationDate string The calculation date for the sentiment score in format YYYY-MM-DD. Calculation is done in the morning before market open.
companyName string Name of the company
compositeFigi string The FIGI composite code that identifies the stock across related exchanges in the same country.
symbol string Symbol of the security
mlAlpha number Score related to the predicted return over the next 21 days.
daysForecast number 21
updated string Refers to the machine readable epoch timestamp of when this entry was last updated

BRAIN Company’s 10 Day Machine Learning Estimated Return Ranking

Brain Company’s Machine Learning proprietary platform is used to generate a daily stock ranking based on the predicted future returns of a universe of around 1,000 stocks over 10 days. The model implements a voting scheme of machine learning classifiers that non linearly combine a variety of features with a series of techniques aimed at mitigating the well-known overfitting problem for financial data with a low signal to noise ratio.

HTTP request

GET /time-series/PREMIUM_BRAIN_RANKING_10_DAYS/{symbol?}

JSON response

[
  {
    "id": "PREMIUM_BRAIN_RANKING_10_DAYS",
    "source": "Brain Company",
    "key": "BAC",
    "subkey": "2020-01-13",
    "calculationDate": "2020-01-13",
    "companyName": "Bank of America Corp.",
    "compositeFigi": "BBG000BCTLF6",
    "symbol": "BAC",
    "mlAlpha": -0.034,
    "daysForecast": 10
  }
]

Data Weighting

Premium Data 211,538 per day, per symbol

Data Timing

End of day

Data Schedule

8am UTC daily

Data Source(s)

BRAIN Company

Notes

This is a Premium Data end-point available to only paying customers. You will be charged directly at pay-as-you-go rates and the messages consumed from this end-point will not come from your base subscription message allocation.

Available Methods

GET /time-series/PREMIUM_BRAIN_RANKING_10_DAYS

Example

Query Parameters

This end point uses all standard time-series query parameters.

Response Attributes

Key Type Description
calculationDate string The calculation date for the sentiment score in format YYYY-MM-DD. Calculation is done in the morning before market open.
companyName string Name of the company
compositeFigi string The FIGI composite code that identifies the stock across related exchanges in the same country.
symbol string Symbol of the security
mlAlpha number Score related to the predicted return over the next 10 days.
daysForecast number 10
updated string Refers to the machine readable epoch timestamp of when this entry was last updated

BRAIN Company’s 5 Day Machine Learning Estimated Return Ranking

Brain Company’s Machine Learning proprietary platform is used to generate a daily stock ranking based on the predicted future returns of a universe of around 1,000 stocks over 10 days. The model implements a voting scheme of machine learning classifiers that non linearly combine a variety of features with a series of techniques aimed at mitigating the well-known overfitting problem for financial data with a low signal to noise ratio.

HTTP request

GET /time-series/PREMIUM_BRAIN_RANKING_5_DAYS/{symbol?}

JSON response

[
  {
    "id": "PREMIUM_BRAIN_RANKING_5_DAYS",
    "source": "Brain Company",
    "key": "BAC",
    "subkey": "2020-01-13",
    "calculationDate": "2020-01-13",
    "companyName": "Bank of America Corp.",
    "compositeFigi": "BBG000BCTLF6",
    "symbol": "BAC",
    "mlAlpha": -0.034,
    "daysForecast": 5
  }
]

Data Weighting

Premium Data 211,538 per day, per symbol

Data Timing

End of day

Data Schedule

8am UTC daily

Data Source(s)

BRAIN Company

Notes

This is a Premium Data end-point available to only paying customers. You will be charged directly at pay-as-you-go rates and the messages consumed from this end-point will not come from your base subscription message allocation.

Available Methods

GET /time-series/PREMIUM_BRAIN_RANKING_5_DAYS

Example

Query Parameters

This end point uses all standard time-series query parameters.

Response Attributes

Key Type Description
calculationDate string The calculation date for the sentiment score in format YYYY-MM-DD. Calculation is done in the morning before market open.
companyName string Name of the company
compositeFigi string The FIGI composite code that identifies the stock across related exchanges in the same country.
symbol string Symbol of the security
mlAlpha number Score related to the predicted return over the next 5 days.
daysForecast number 5
updated string Refers to the machine readable epoch timestamp of when this entry was last updated

BRAIN Company’s 3 Day Machine Learning Estimated Return Ranking

Brain Company’s Machine Learning proprietary platform is used to generate a daily stock ranking based on the predicted future returns of a universe of around 1,000 stocks over 10 days. The model implements a voting scheme of machine learning classifiers that non linearly combine a variety of features with a series of techniques aimed at mitigating the well-known overfitting problem for financial data with a low signal to noise ratio.

HTTP request

GET /time-series/PREMIUM_BRAIN_RANKING_3_DAYS/{symbol?}

JSON response

[
  {
    "id": "PREMIUM_BRAIN_RANKING_3_DAYS",
    "source": "Brain Company",
    "key": "BAC",
    "subkey": "2020-01-13",
    "calculationDate": "2020-01-13",
    "companyName": "Bank of America Corp.",
    "compositeFigi": "BBG000BCTLF6",
    "symbol": "BAC",
    "mlAlpha": -0.034,
    "daysForecast": 3
  }
]

Data Weighting

Premium Data 211,538 per day, per symbol

Data Timing

End of day

Data Schedule

8am UTC daily

Data Source(s)

BRAIN Company

Notes

This is a Premium Data end-point available to only paying customers. You will be charged directly at pay-as-you-go rates and the messages consumed from this end-point will not come from your base subscription message allocation.

Available Methods

GET /time-series/PREMIUM_BRAIN_RANKING_3_DAYS

Example

Query Parameters

This end point uses all standard time-series query parameters.

Response Attributes

Key Type Description
calculationDate string The calculation date for the sentiment score in format YYYY-MM-DD. Calculation is done in the morning before market open.
companyName string Name of the company
compositeFigi string The FIGI composite code that identifies the stock across related exchanges in the same country.
symbol string Symbol of the security
mlAlpha number Score related to the predicted return over the next 3 days.
daysForecast number 3
updated string Refers to the machine readable epoch timestamp of when this entry was last updated

BRAIN Company’s 2 Day Machine Learning Estimated Return Ranking

Brain Company’s Machine Learning proprietary platform is used to generate a daily stock ranking based on the predicted future returns of a universe of around 1,000 stocks over 10 days. The model implements a voting scheme of machine learning classifiers that non linearly combine a variety of features with a series of techniques aimed at mitigating the well-known overfitting problem for financial data with a low signal to noise ratio.

HTTP request

GET /time-series/PREMIUM_BRAIN_RANKING_2_DAYS/{symbol?}

JSON response

[
  {
    "id": "PREMIUM_BRAIN_RANKING_2_DAYS",
    "source": "Brain Company",
    "key": "BAC",
    "subkey": "2020-01-13",
    "calculationDate": "2020-01-13",
    "companyName": "Bank of America Corp.",
    "compositeFigi": "BBG000BCTLF6",
    "symbol": "BAC",
    "mlAlpha": -0.034,
    "daysForecast": 2
  }
]

Data Weighting

Premium Data 211,538 per day, per symbol

Data Timing

End of day

Data Schedule

8am UTC daily

Data Source(s)

BRAIN Company

Notes

This is a Premium Data end-point available to only paying customers. You will be charged directly at pay-as-you-go rates and the messages consumed from this end-point will not come from your base subscription message allocation.

Available Methods

GET /time-series/PREMIUM_BRAIN_RANKING_2_DAYS

Example

Query Parameters

This end point uses all standard time-series query parameters.

Response Attributes

Key Type Description
calculationDate string The calculation date for the sentiment score in format YYYY-MM-DD. Calculation is done in the morning before market open.
companyName string Name of the company
compositeFigi string The FIGI composite code that identifies the stock across related exchanges in the same country.
symbol string Symbol of the security
mlAlpha number Score related to the predicted return over the next 2 days.
daysForecast number 2
updated string Refers to the machine readable epoch timestamp of when this entry was last updated

BRAIN Company’s Language Metrics on Company Filings (Quarterly and Annual)

Metrics about the language used in a company’s most recent annual or quarterly filings (10Ks and 10Qs). Includes metrics on the financial sentiment and the scores based on the prevalence of words in the statement categorized into four themes: constraining language, interesting language, litigious language, and language indicating uncertainty.

HTTP request

GET /time-series/PREMIUM_BRAIN_LANGUAGE_METRICS_ALL/{symbol?}

JSON response

[
  {
    "id": "PREMIUM_BRAIN_LANGUAGE_METRICS_ALL",
    "source": "Brain Company",
    "key": "BAC",
    "subkey": "2020-01-13",
    "calculationDate": "2020-01-13",
    "companyName": "Bank of America Corp.",
    "compositeFigi": "BBG000BCTLF6",
    "symbol": "BAC",
    "lastReportCategory": "10K",
    "lastReportDate": "2019-12-31",
    "sentiment": 0.2755,
    "scoreUncertainty": 0.2372,
    "scoreLitigious": 0.1595,
    "scoreConstraining": 0.122,
    "scoreInteresting": 0.0754
  }
]

Data Weighting

Premium Data 218,254 per day, per symbol

Data Timing

End of day

Data Schedule

8am UTC daily

Data Source(s)

BRAIN Company

Notes

This is a Premium Data end-point available to only paying customers. You will be charged directly at pay-as-you-go rates and the messages consumed from this end-point will not come from your base subscription message allocation.

Available Methods

GET /time-series/PREMIUM_BRAIN_LANGUAGE_METRICS_ALL

Example

Query Parameters

This end point uses all standard time-series query parameters.

Response Attributes

Key Type Description
calculationDate string The calculation date for the sentiment score in format YYYY-MM-DD. Calculation is done in the morning before market open.
companyName string Name of the company
compositeFigi string The FIGI composite code that identifies the stock across related exchanges in the same country.
symbol string Symbol of the security
lastReportCategory string 10-K or 10-Q
lastReportDate string Date of the last report referenced
sentiment number Score related to the financial sentiment in the filing, range is [-1, 1]
scoreUncertainty number The percentage of financial domain “uncertainty” language present in the last report. Range is [0, 1]
scoreLitigious number The percentage of financial domain “litigious” language present in the last report. Range is [0, 1]
scoreConstraining number The percentage of financial domain “constraining” language present in the last report. Range is [0, 1]
scoreInteresting number The percentage of financial domain “interesting” language present in the last report. Range is [0, 1]
updated string Refers to the machine readable epoch timestamp of when this entry was last updated

BRAIN Company’s Language Metrics on Company FIlings (Annual Only)

Metrics about the language used in a company’s most recent annual filing (10Ks). Includes metrics on the financial sentiment and the scores based on the prevalence of words in the statement categorized into four themes: constraining language, interesting language, litigious language, and language indicating uncertainty.

HTTP request

GET /time-series/PREMIUM_BRAIN_LANGUAGE_METRICS_10K/{symbol?}

JSON response

[
  {
    "id": "PREMIUM_BRAIN_LANGUAGE_METRICS_ALL",
    "source": "Brain Company",
    "key": "BAC",
    "subkey": "2020-01-13",
    "calculationDate": "2020-01-13",
    "companyName": "Bank of America Corp.",
    "compositeFigi": "BBG000BCTLF6",
    "symbol": "BAC",
    "lastReportCategory": "10K",
    "lastReportDate": "2019-12-31",
    "sentiment": 0.2755,
    "scoreUncertainty": 0.2372,
    "scoreLitigious": 0.1595,
    "scoreConstraining": 0.122,
    "scoreInteresting": 0.0754,
  }
]

Data Weighting

Premium Data 218,254 per day, per symbol

Data Timing

End of day

Data Schedule

8am UTC daily

Data Source(s)

BRAIN Company

Notes

This is a Premium Data end-point available to only paying customers. You will be charged directly at pay-as-you-go rates and the messages consumed from this end-point will not come from your base subscription message allocation.

Available Methods

GET /time-series/PREMIUM_BRAIN_LANGUAGE_METRICS_10K

Example

Query Parameters

This end point uses all standard time-series query parameters.

Response Attributes

Key Type Description
calculationDate string The calculation date for the sentiment score in format YYYY-MM-DD. Calculation is done in the morning before market open.
companyName string Name of the company
compositeFigi string The FIGI composite code that identifies the stock across related exchanges in the same country.
symbol string Symbol of the security
lastReportCategory string 10-K
lastReportDate string Date of the last report referenced
sentiment number Score related to the financial sentiment in the filing, range is [-1, 1]
scoreUncertainty number The percentage of financial domain “uncertainty” language present in the last report. Range is [0, 1]
scoreLitigious number The percentage of financial domain “litigious” language present in the last report. Range is [0, 1]
scoreConstraining number The percentage of financial domain “constraining” language present in the last report. Range is [0, 1]
scoreInteresting number The percentage of financial domain “interesting” language present in the last report. Range is [0, 1]
updated string Refers to the machine readable epoch timestamp of when this entry was last updated

BRAIN Company’s Differences in Language Metrics on Company Filings(Quarterly and Annual) From Prior Period

Compares Brain’s sentiment and language metrics from the company’s most recent repot (annual or quarterly) to the report from last year (10Ks) or the corresponding quarter the prior year (10Qs).

HTTP request

GET /time-series/PREMIUM_BRAIN_LANGUAGE_DIFFERENCES_ALL/{symbol?}

JSON response

[
  {
    "id": "PREMIUM_BRAIN_LANGUAGE_DIFFERENCES_ALL",
    "source": "Brain Company",
    "key": "BAC",
    "subkey": "2020-01-13",
    "calculationDate": "2020-01-13",
    "companyName": "Bank of America Corp.",
    "compositeFigi": "BBG000BCTLF6",
    "symbol": "BAC",
    "lastReportCategory": "10K",
    "lastReportDate": "2019-12-31",
    "lastReportPeriod": 2019,
    "prevReportCategory": "10K",
    "prevReportDate": "2018-12-31",
    "prevReportPeriod": 2018,
    "deltaSentiment": 0.0044,
    "deltaScoreUncertainty": -0.0243,
    "deltaScoreLitigious": 0.0115,
    "deltaScoreConstraining": 0.0102,
    "deltaScoreInteresting": -0.0087,
    "similarityAll": 0.9507,
    "similarityNegative": 0.9704,
    "similarityPositive": 0.9636,
    "similarityUncertainty": 0.9943,
    "similarityLitigious": 0.8906,
    "similarityConstraining": 0.9495,
    "similarityInteresting": 0.9805
  }
]

Data Weighting

Premium Data 218,254 per day, per symbol

Data Timing

End of day

Data Schedule

8am UTC daily

Data Source(s)

BRAIN Company

Notes

This is a Premium Data end-point available to only paying customers. You will be charged directly at pay-as-you-go rates and the messages consumed from this end-point will not come from your base subscription message allocation.

Available Methods

GET /time-series/PREMIUM_BRAIN_LANGUAGE_DIFFERENCES_ALL

Example

Query Parameters

This end point uses all standard time-series query parameters.

Response Attributes

Key Type Description
calculationDate string The calculation date for the sentiment score in format YYYY-MM-DD. Calculation is done in the morning before market open.
companyName string Name of the company
compositeFigi string The FIGI composite code that identifies the stock across related exchanges in the same country.
symbol string Symbol of the security
lastReportCategory string 10-K or 10-Q
lastReportDate string Date of the last report referenced
lastReportPeriod number Fiscal year or calendar quarter (1, 2, or 3) for the last report
prevReportCategory string 10-K or 10-Q
prevReportDate string Date of the prior report referenced
prevReportPeriod number Fiscal year or calendar quarter (1, 2, or 3) for the prior report
deltaSentiment number Difference from prior to last report in sentiment score
deltaScoreUncertainty number Difference from prior to last report in uncertainty score
deltaScoreLitigious number Difference from prior to last report in litigious score
deltaScoreConstraining number Difference from prior to last report in constraining score
deltaScoreInteresting number Difference from prior to last report in interesting score
similarityAll number Language similarity betwee prior and last report. Range is [0, 1]
similarityNegative number Negative language similarity betwee prior and last report. Range is [0, 1]
similarityPositive number Positive language similarity betwee prior and last report. Range is [0, 1]
similarityUncertainty number Simiarity betwee prior and last report with regard to language in the financial domain “uncertainty”. Range is [0, 1
similarityLitigious number Simiarity betwee prior and last report with regard to language in the financial domain “litigious”. Range is [0, 1]
similarityConstraining number Simiarity betwee prior and last report with regard to language in the financial domain “constraining”. Range is [0, 1]
similarityInteresting number Simiarity betwee prior and last report with regard to language in the financial domain “interesting”. Range is [0, 1]
updated string Refers to the machine readable epoch timestamp of when this entry was last updated

BRAIN Company’s Differences in Language Metrics on Company Annual Filings From Prior Year

Compares Brain’s sentiment and language metrics from the company’s most recent annual filing (10K) to the report from last year.

HTTP request

GET /time-series/PREMIUM_BRAIN_LANGUAGE_DIFFERENCES_10K/{symbol?}

JSON response

[
  {
    "id": "PREMIUM_BRAIN_LANGUAGE_DIFFERENCES_10K",
    "source": "Brain Company",
    "key": "BAC",
    "subkey": "2020-01-13",
    "calculationDate": "2020-01-13",
    "companyName": "Bank of America Corp.",
    "compositeFigi": "BBG000BCTLF6",
    "symbol": "BAC",
    "lastReportCategory": "10K",
    "lastReportDate": "2019-12-31",
    "lastReportPeriod": 2019,
    "prevReportCategory": "10K",
    "prevReportDate": "2018-12-31",
    "prevReportPeriod": 2018,
    "deltaSentiment": 0.0044,
    "deltaScoreUncertainty": -0.0243,
    "deltaScoreLitigious": 0.0115,
    "deltaScoreConstraining": 0.0102,
    "deltaScoreInteresting": -0.0087,
    "similarityAll": 0.9507,
    "similarityNegative": 0.9704,
    "similarityPositive": 0.9636,
    "similarityUncertainty": 0.9943,
    "similarityLitigious": 0.8906,
    "similarityConstraining": 0.9495,
    "similarityInteresting": 0.9805
  }
]

Data Weighting

Premium Data 218,254 per day, per symbol

Data Timing

End of day

Data Schedule

8am UTC daily

Data Source(s)

BRAIN Company

Notes

This is a Premium Data end-point available to only paying customers. You will be charged directly at pay-as-you-go rates and the messages consumed from this end-point will not come from your base subscription message allocation.

Available Methods

GET /time-series/PREMIUM_BRAIN_LANGUAGE_DIFFERENCES_10K

Example

Query Parameters

This end point uses all standard time-series query parameters.

Response Attributes

Key Type Description
calculationDate string The calculation date for the sentiment score in format YYYY-MM-DD. Calculation is done in the morning before market open.
companyName string Name of the company
compositeFigi string The FIGI composite code that identifies the stock across related exchanges in the same country.
symbol string Symbol of the security
lastReportCategory string 10-K
lastReportDate string Date of the last report referenced
lastReportPeriod number Fiscal year for the last report
prevReportCategory string 10-K
prevReportDate string Date of the prior report referenced
prevReportPeriod number Fiscal year the prior report
deltaSentiment number Difference from prior to last report in sentiment score
deltaScoreUncertainty number Difference from prior to last report in uncertainty score
deltaScoreLitigious number Difference from prior to last report in litigious score
deltaScoreConstraining number Difference from prior to last report in constraining score
deltaScoreInteresting number Difference from prior to last report in interesting score
similarityAll number Language similarity betwee prior and last report. Range is [0, 1]
similarityNegative number Negative language similarity betwee prior and last report. Range is [0, 1]
similarityPositive number Positive language similarity betwee prior and last report. Range is [0, 1]
similarityUncertainty number Simiarity betwee prior and last report with regard to language in the financial domain “uncertainty”. Range is [0, 1
similarityLitigious number Simiarity betwee prior and last report with regard to language in the financial domain “litigious”. Range is [0, 1]
similarityConstraining number Simiarity betwee prior and last report with regard to language in the financial domain “constraining”. Range is [0, 1]
similarityInteresting number Simiarity betwee prior and last report with regard to language in the financial domain “interesting”. Range is [0, 1]
updated string Refers to the machine readable epoch timestamp of when this entry was last updated

Kavout

Kavout’s mission is to democratize AI and Machine Learning, empowering institutions and investors with augmented intelligence to generate alpha, manage wealth and do more with less.

Harnessing years of historical data and a variety of data sources, Kavout takes in structured and unstructured data including fundamental information, pricing and trading volumes, technical signals, and alternative data, to deliver an actionable and easy-to-use equity rating score from 1 to 9.

The development of K Scores apply the best-of-breed learning algorithms, and encompass methods such as regression, classification, model selection, deep learning and more to produce a rating to rank stocks. Our state-of-the-art machine learning (ML) models identify the intrinsic relationships, uncover the dependency structure and calculates predictive analytics for future performance.

On any given day, Kavout processes millions of diverse data sets, and runs models encompassing many traditional and advanced financial engineering methods such as regression, classification, deep learning, and reinforcement learning to produce a predictive rating to rank stocks.

K Score For US Equities

Kavout takes in over 200 factors and signals including fundamentals, pricing, technical indicators, and alternative data, and then uses an ensemble machine learning technique to analyze and rank stocks.

K Score is a stock rating and ranking score with values ranging from 1-to-9. A higher K Score (7-9) assigned to a stock indicates a higher probability of outperformance, whereas a lower K Score (1-3) indicates a lower probability of outperformance in the next month.

For quantitative users, overlay K Score as a signal in investment models. Mitigate risk in portfolio construction by avoiding stocks with low K scores (1-3).

HTTP request

GET /time-series/PREMIUM_KAVOUT_KSCORE/{symbol?}

JSON response

[
  {
    "id": "PREMIUM_KAVOUT_KSCORE",
    "source": "Kavout",
    "key": "BAC",
    "subkey": "2020-01-13",
    "symbol": "BAC",
    "companyName": "Bank of America Corp.",
    "tradeDate": "2020-01-13",
    "kscore": 5,
    "qualityScore": 7,
    "growthScore": 4,
    "valueScore": 5,
    "momentumScore": 6,
    "date": 1578891600000,
    "updated": 1579028315000
  }
]

Data Weighting

Premium Data 126,263 per day, per symbol

Data Timing

End of day

Data Schedule

12pm UTC M-F

Data Source(s)

Kavout

Notes

This is a Premium Data end-point available to only paying customers. You will be charged directly at pay-as-you-go rates and the messages consumed from this end-point will not come from your base subscription message allocation.

Any use of Kavout data requires attribution of Data provided by Kavout via IEX Cloud

Available Methods

GET /time-series/PREMIUM_KAVOUT_KSCORE

Example

Query Parameters

This end point uses all standard time-series query parameters.

Response Attributes

Key Type Description
symbol string Symbol of the security
companyName string Name of the company
tradeDate string Date on which the score calculation is done. Scores are calculated at least three hours prior to market open.
kscore number A predictive analytics equity rating score with possible values from 1 to 9. Taking into consideration over 200 factors and signals from fundamental to price/volume to alternative data, and using machine learning techniques and ranking algorithms, Kavout assigns an easy to understand and actionable 1-9 equity rating score.
qualityScore number A score indicative of how well-managed a company is and whether its financial strength is solid. Factors include but are not limited to: working capital to long-term debt ratio, Greenblatt ROC, dividend payout, and operating profitability.
growthScore number A score indcative of a stock’s growth and growth factors. Factors include but are not limited to: ROA/ROE three year growth rate and sustainable earnings.
valueScore number A score indicative of whether a stock is overpriced or underpriced. Factors include but are not limited to: earnings yield, price to book, enterprise value to EBITDA, and price to sales.
momentumScore number A score indicative of the stock’s momentum. Factors include but are not limited to: relative strength index, 52-week high/low, earnings momentum.
updated string Refers to the machine readable epoch timestamp of when this entry was last updated

K Score For China A-Shares

Kavout takes in over 200 factors and signals including fundamentals, pricing, technical indicators, and alternative data, and then uses an ensemble machine learning technique to analyze and rank stocks.

K Score is a stock rating and ranking score with values ranging from 1-to-9. A higher K Score (7-9) assigned to a stock indicates a higher probability of outperformance, whereas a lower K Score (1-3) indicates a lower probability of outperformance in the next month.

For quantitative users, overlay K Score as a signal in investment models. Mitigate risk in portfolio construction by avoiding stocks with low K scores (1-3).

China Stock Market at a Glance

The China A-share stock market has two exchanges – Shanghai stock exchange (SSE) and Shenzhen stock exchange (SZSE). The SSE and the SZSE are the world’s 5th largest and 8th largest stock market by market capitalization respectively.

The most important Indices in China A-share are CSI 300, CSI 500 and CSI 800.

CSI 300 Index consists of the 300 largest and most liquid A-share stocks, similar to the largest 500 stocks by market cap in the US.

CSI 500 Index consists of the largest remaining 500 A-Share stocks after excluding the CSI 300 Index, similar to the largest 2,000 US stocks by market cap. CSI 500 Index reflects the overall performance of small-mid cap A-shares.

CSI 800 Index consists of all the constituents of the CSI 300 Index and CSI 500 Index, similar to the largest 3,000 US stocks by market cap.

HTTP request

GET /time-series/PREMIUM_KAVOUT_KSCORE_A_SHARES/{symbol?}

JSON response

[
  {
    "id": "PREMIUM_KAVOUT_KSCORE_A_SHARES",
    "source": "Kavout",
    "key": "601988-CN",
    "subkey": "2020-01-13",
    "symbol": "601988-CN",
    "companyName": "Bank of China",
    "tradeDate": "2020-01-13",
    "kscore": 2,
    "qualityScore": 4,
    "growthScore": 1,
    "valueScore": 5,
    "momentumScore": 2,
    "date": 1578891600000,
    "updated": 1579028315000
  }
]

Data Weighting

Premium Data 340,909 per day, per symbol

Data Timing

End of day

Data Schedule

9am UTC M-F

Data Source(s)

Kavout

Notes

This is a Premium Data end-point available to only paying customers. You will be charged directly at pay-as-you-go rates and the messages consumed from this end-point will not come from your base subscription message allocation.

Please be advised of China’s public holidays.

Any use of Kavout data requires attribution of Data provided by Kavout via IEX Cloud

Available Methods

GET /time-series/PREMIUM_KAVOUT_KSCORE_A_SHARES

Example

Query Parameters

This end point uses all standard time-series query parameters.

Response Attributes

Key Type Description
symbol string China A-Shares code
companyName string Name of the company
tradeDate string Date on which the score calculation is done. Scores are calculated at least three hours prior to market open.
kscore number A predictive analytics equity rating score with possible values from 1 to 9. Taking into consideration over 200 factors and signals from fundamental to price/volume to alternative data, and using machine learning techniques and ranking algorithms, Kavout assigns an easy to understand and actionable 1-9 equity rating score.
qualityScore number A score indicative of how well-managed a company is and whether its financial strength is solid. Factors include but are not limited to: working capital to long-term debt ratio, Greenblatt ROC, dividend payout, and operating profitability.
growthScore number A score indcative of a stock’s growth and growth factors. Factors include but are not limited to: ROA/ROE three year growth rate and sustainable earnings.
valueScore number A score indicative of whether a stock is overpriced or underpriced. Factors include but are not limited to: earnings yield, price to book, enterprise value to EBITDA, and price to sales.
momentumScore number A score indicative of the stock’s momentum. Factors include but are not limited to: relative strength index, 52-week high/low, earnings momentum.
updated string Refers to the machine readable epoch timestamp of when this entry was last updated

Audit Analytics

Audit Analytics provides detailed research on over 150,000 active audits and more than 10,000 accounting firms.

Audit Analytics Director and Officer Changes

The Director & Officer Changes data set covers all SEC registrants who have disclosed a director or officer change in Item 5.02 of an 8-K or 8-K/A since August 2004. As of January 1, 2018, the dataset also includes director or officer change disclosures in 6-K & 6-K/A filings.

HTTP request

GET /time-series/PREMIUM_AUDIT_ANALYTICS_DIRECTOR_OFFICER_CHANGES/{symbol?}

JSON response

[
  {
    "id": "PREMIUM_AUDIT_ANALYTICS_DIRECTOR_OFFICER_CHANGES",
    "source": "Audit Analytics",
    "key": "BAC",
    "subkey": "685cbf905bf07a37744777de7bc0e062",
    "symbol": "BAC",
    "effectiveDate": "2019-12-20",
    "titleAsReported": "Chief Operating Officer",
    "isCLevel": 1,
    "isBoardmemberPerson": 0,
    "isScienceTechPerson": 0,
    "isLegal": 1,
    "isAdministrativePerson": 1,
    "isFinancialPerson": 0,
    "isOperationsPerson": 1,
    "isController": 0,
    "isCharimanOfBoard": 0,
    "isCharimanOther": 0,
    "isSecretary": 0,
    "isCoo": 1,
    "isPresident": 0,
    "isCeo": 0,
    "isCfo": 0,
    "isExecOrSrVp": 0,
    "titleStandardized": "COO",
    "committeesAsReported": "Executive Committte, Audit Committee",
    "committeesStandardized": "Executive Committte, Audit Committee",
    "interim": 0,
    "directorOfficerRemainsOnBoard": 0,
    "reatainsOtherPositions": 0,
    "effectiveDateIsUnspecified": 0,
    "isEffectiveOnDateOfNextAnnualMeeting": 0,
    "action": "Resigned",
    "reasons": null,
    "employmentEducationText": null,
    "firstName": "Mary",
    "middleName": null, 
    "lastName": "Wollstonecraft",
    "suffix": null,
    "nameSuffix": null,
    "degreesSuffix": null,
    "approxYOB": null,
    "subsidiaryName": null,
    "directorOfficerChangeText": "COO Mary Wollstonecraft has resgigned effective immediately",
    "ftpFileNameFkey": "edgar/data/783211/0001097246-01-500009.txt",
    "formFkey": "8-k",
    "fileDate": "2019-12-20",
    "fileSize": "114 KB",
    "fileAccepted": "2019-12-20 00:00:00",
     "httpFileNameHtml": "/Archives/edgar/data/783211/000109724601500009/0001097246-01-500009-index.htm",
     "httpFileNameText": "/Archives/edgar/data/783211/000109724601500009/0001097246-01-500009.txt",
    "date": 1578891600000,
    "updated": 1579028315000
  }
]

Data Weighting

Premium Data 849,673 per record

Data Timing

End of day

Data Schedule

10:30am UTC daily

Data Source(s)

Audit Analytics

Notes

This is a Premium Data end-point available to only paying customers. You will be charged directly at pay-as-you-go rates and the messages consumed from this end-point will not come from your base subscription message allocation.

Available Methods

GET /time-series/PREMIUM_AUDIT_ANALYTICS_DIRECTOR_OFFICER_CHANGES

Example

Query Parameters

This end point uses all standard time-series query parameters.

Response Attributes

Key Type Description
symbol string Symbol of the security
effectiveDate string This field is populated both manually and by software; however note that it sometimes is only populated with just year. May contain incomplete data or have zeros where data was unavailable.
titleAsReported string Identifies title of position to which the change pertains.
isCLevel number Identifies whether individual has in their title_as_reported CFO, CEO, COO, chief, or princ.
isBoardmemberPerson number Identifies whether individual is board member.
isScienceTechPerson number Identifies whether individual is science/technology.
isLegal number Identifies whether individual performs legal functions.
isAdministrativePerson number Identifies whether individual is administrative level.
isFinancialPerson number Identifies whether individual performs financial duties.
isOperationsPerson number Identifies whether individual performs operations duties.
isController number Identifies whether individual is company controller.
isCharimanOfBoard number Identifies whether individual is chair of board.
isSecretary number Identifies whether individual is secretary.
isCoo number Identifies whether individual is Chief Operating Officer.
isPresident number Identifies whether individual is president.
isCeo number Identifies whether individual is Chief Executive Officer.
isCfo number Identifies whether individual is Chief Financial Officer.
isExecOrSrVp number Identifies whether individual is Executive Vice President or Senior Vice President.
titleStandardized number Title standardized.
committeesAsReported number Identifies Board committee(s) to which the change pertains.
committeesStandardized number Committees standardized.
interim number Signals when a position change is interim.
directorOfficerRemainsOnBoard number Indicates whether a Director/Officer remains on the Board of Directors.
reatainsOtherPositions number If the filing indicates that the person has resigned or been dismissed from one or several positions, but still retains one or more positions at the company, the parenthetical “retains other positions” will appear after the title implicated in the change.
effectiveDateIsUnspecified number Indicates that the effective date of the change is not specified.
isEffectiveOnDateOfNextAnnualMeeting number Indicates that the effective date of the change is the next annual shareholder meeting.
action string Indicates the particular action that explains the change, i.e., appointment, dismissal, etc.
reasons string Indicates the reason for the change, if given.
employmentEducationText string Employment and education text if given.
firstName string Identifies Director/Officer first name.
middleName string Identifies Director/Officer middle name.
lastName string Identifies Director/Officer last name.
suffix string Identifies Director/Officer suffix.
nameSuffix string Name suffix contains II, III, Jr, Sr, IV etc.
degreesSuffix string Degree suffix contains PhD, CPA etc.
approxYOB string Identifies Director/Officer age.
subsidiaryName string Indicates name of subsidiary that applies to a Director/Officer change.
directorOfficerChangeText string Text from 5.02 filing.
ftpFileNameFkey string FTP file name filed with SEC foreign key.
formFkey string Form type of filing.
fileDate string Date file accepted by SEC/Edgar.
fileSize string Size of file submitted to SEC/Edgar.
fileAccepted string Timestamp file accepted by SEC/Edgar.
httpFileNameHtml string HTTP file name html submission.
httpFileNameText string HTTP file name text submission.
date string Equivalent to the file date. Can be used in time series API calls.
updated string Refers to the machine readable epoch timestamp of when this entry was last updated

Audit Analytics Accounting Quality and Risk Matrix

AQRM is an interactive tool designed to quickly identify and understand qualitative and contextual metrics of governance and reporting quality. Red flags and events highlighted in the risk matrix can be used for screening, idea generation, portfolio monitoring, and risk management for every SEC registrant.

HTTP request

GET /time-series/PREMIUM_AUDIT_ANALYTICS_ACCOUNTING_QUALITY_RISK_MATRIX/{symbol?}

JSON response

[
  {
    "id": "PREMIUM_AUDIT_ANALYTICS_ACCOUNTING_QUALITY_RISK_MATRIX",
    "source": "Audit Analytics",
    "key": "BAC",
    "subkey": "685cbf905bf07a37744777de7bc0e062",
    "symbol": "BAC",
    "flagYear": 2001,
    "auditorRatificationSeverity": null,
    "goingConcernSeverity": null,
    "auditorChangeSeverity": 2,
    "internalControlsSeverity": null,
    "ceoChangeSeverity": null,
    "disclosureControlsSeverity": null,
    "lateFilingSeverity": null,
    "periodAdjustmentSeverity": null,
    "materialImpairmentSeverity": null,
    "cfoChangeSeverity": null,
    "shareholderActivismSeverity": null,
    "regulatoryLitigationSeverity": null,
    "civilRightsLitigationSeverity": null,
    "employmentLaborLitigationSeverity": null,
    "environmentalLitigationSeverity": null,
    "intellectualPropertyLitigationSeverity": null,
    "illegalActivitiesLitigationSeverity": null,
    "shareholderActionLitigationSeverity": null,
    "accountingEstimateChangeSeverity": null,
    "financialRestatementSeverity": null,
    "disclosureComplexitySeverity": null,
    "benfordsLawSeverity": null,
    "auditFeesChangeSeverity": null,
    "beneishScoreSeverity": null,
    "altmanScoreSeverity": null,
    "engagePartnerChangeSeverity": null,
    "nonAuditFeesSeverity": null,
    "auditFeesOutlierSeverity": null,
    "date": 1578891600000,
    "updated": 1579028315000
  }
]

Data Weighting

Premium Data 485,714 per record

Data Timing

End of day

Data Schedule

10:30am UTC daily

Data Source(s)

Audit Analytics

Notes

This is a Premium Data end-point available to only paying customers. You will be charged directly at pay-as-you-go rates and the messages consumed from this end-point will not come from your base subscription message allocation.

Available Methods

GET /time-series/PREMIUM_AUDIT_ANALYTICS_ACCOUNTING_QUALITY_RISK_MATRIX

Example

Query Parameters

This end point uses all standard time-series query parameters.

Response Attributes

Key Type Description
symbol string Symbol of the security
flagYear number Year of filing.
auditorRatificationSeverity number 2 = Auditor had > 50% votes against. 1 = Auditor had >5% votes against. Otherwise null.
goingConcernSeverity number 3 = Audit opinion had a going concern modification. Otherwise null.
auditorChangeSeverity number 3 = Auditor change with issues. 2 = Auditor change without issues. Otherwise null.
internalControlsSeverity number 3 = Auditor or Management Assessment was adverse. Otherwise null.
ceoChangeSeverity number 3 = change had concerns. 1 = normal CEO change. Otherwise null.
disclosureControlsSeverity number 3 = ineffective and there is material weakness. 2 = ineffective without material weakness. 1 = effective but has other deficiencies. Otherwise null.
lateFilingSeverity number 3 = more than 4 weeks late or had tier 1 issues. 2 = had tier 2 issues. 1 = late filing. Otherwise null.
periodAdjustmentSeverity number 1 = had an out of period adjustment. Otherwise null.
materialImpairmentSeverity number 2 = Significant impairment. Otherwise null.
cfoChangeSeverity number 3 = change had concerns. 1 = normal CFO change. Otherwise null.
shareholderActivismSeverity number 3 = Dispute, 2 = Control, 1 = Concern. Otherwise null.
regulatoryLitigationSeverity number 3 = company is a defendant in a legal case centered around Regulatory Infractions. Otherwise null.
civilRightsLitigationSeverity number 1 = company is a defendant in a legal case centered around Civil Rights. Otherwise null.
employmentLaborLitigationSeverity number 1 = company is a defendant in a legal case centered around Employment and Labor. Otherwise null.
environmentalLitigationSeverity number 2 = company is a defendant in a legal case centered around Environmental Concerns. Otherwise null.
intellectualPropertyLitigationSeverity number 1 = company is a defendant in a legal case centered around Intellectual Property. Otherwise null.
illegalActivitiesLitigationSeverity number 3 = company is a defendant in a legal case centered around Illegal Activities and Corruption. Otherwise null.
shareholderActionLitigationSeverity number 3 = company is a defendant in a legal case centered around Shareholder Action. Otherwise null.
accountingEstimateChangeSeverity number 3 = change in estimate for revenue, inventory, or allowance and has a positive impact on income. 2 = change has positive impact on income. 1 = any other change. Otherwise null.
financialRestatementSeverity number 3 = Reissuance restatement. 2 = Qualitative restatement. 1 = Technical restatement. Otherwise null.
disclosureComplexitySeverity number 1 = ADC is > 2*stddev of industry group average. Otherwise null.
benfordsLawSeverity number Benford’s Law Severity. Can be 1 or 2. Otherwise null.
auditFeesChangeSeverity number 1 = significant unusual change in audit fees. Otherwise null.
beneishScoreSeverity number Beneish M-Score Calculation. Can be 1. Otherwise null.
altmanScoreSeverity number Altman Z-Score Calculation. Can be 1. Otherwise null.
engagePartnerChangeSeverity number 1 = Engagement Partner change. Otherwise null.
nonAuditFeesSeverity number 1 = Non Audit Fee ratio to Audit Fees > .25, 2 = Non Audit Fee ratio to Audit Fees > .50. Otherwise null.
auditFeesOutlierSeverity number 1 = Audit Fees to Revenue Ratio / Audit Fees to Assets Ratio is >= 85th percentile of ratios for that naics group or <= 15th percentile of ratios for that naics group. Otherwise null.
date string Equivalent to 12/31 00:00 UTC for the given flag year. Can be used in time series API calls.
updated string Refers to the machine readable epoch timestamp of when this entry was last updated

ValuEngine

ValuEngine provides research on over 5,000 stocks with stock valuations, Buy/Hold/Sell recommendations, and forecasted target prices, so that you the individual investor can make informed decisions, not emotional ones. VE employs a complex Quantitative model that evaluates all available data, all the time.

ValuEngine Stock Research Report

ValuEngine provides research on over 5,000 stocks with stock valuations, Buy/Hold/Sell recommendations, and forecasted target prices, so that you the individual investor can make informed decisions. Every ValuEngine Valuation and Forecast model for the U.S. equities markets has been extensively back-tested. ValuEngine’s performance exceeds that of many well-known stock-picking styles. Reports available since March 19th, 2020.

HTTP request

GET /files/download/VALUENGINE_REPORT


The call returns an HTTP redirect to a one time secure URL for the PDF file.

Data Weighting

Premium Data 40,000,000 per report
This equates to $13 - $40 per report depending on your IEX Cloud tier

Data Timing

End of day

Data Schedule

10am ET Mon-Fri

Data Source(s)

ValuEngine

Notes

This is a Premium Data end-point available to only paying customers. You will be charged directly at pay-as-you-go rates and the messages consumed from this end-point will not come from your base subscription message allocation.
You are allowed up to 3 downloads per individual file for the message rate above.
This uses our generic Files API

Available Methods

GET /files/download/VALUENGINE_REPORT?symbol={symbol}&date={date}

Example

Query Parameters

Name Type Description
symbol string Required.
• Stock symbol for the report Ex: AAPL
date string Required.
• The date of the report formatted as YYYYMMDD Ex: 20200219

Stocktwits

Daily and by-minute snapshots of social sentiments for stocks based on activity on Stocktwits, the online community for investors and traders.

Social Sentiment

This endpoint provides social sentiment data from StockTwits. Data can be viewed as a daily value, or by minute for a given date.

HTTP request

GET /stock/{symbol}/sentiment/{type?}/{date?}

SSE Streaming Example

curl --header 'Accept: text/event-stream' https://cloud-sse.iexapis.com/stable/sentiment\?symbols\=aapl\&token\=YOUR_TOKEN

JSON response

// Daily
{
  "sentiment": 0.20365833333333336,
  "totalScores": 24,
  "positive": 0.88,
  "negative": 0.12
}

// By minute
[
  {
    "sentiment": 0.23336666666666664,
    "totalScores": 3,
    "positive": 1,
    "negative": 0,
    "minute": "1258"
  },
]

// SSE
{
  "symbol": "AAPL",
  "score": -.41,
  "sequence": 6808168,
  "date": 1506605400394,
}

Data Weighting

30,000 per symbol per sentiment record

Data Timing

Real-time

Data Schedule

continuous

Data Source(s)

StockTwits

Notes

This is a Premium Data end-point available to only paying customers. You will be charged directly at pay-as-you-go rates and the messages consumed from this end-point will not come from your base subscription message allocation.

Available Methods

GET /stock/{symbol}/sentiment/{type?}/{date?}

Examples

Path Parameters

Option Description
symbol Valid symbol
type Optional.
• Can only be daily or minute. Default is daily.
date Optional.
• Format YYYYMMDD date to fetch sentiment data. Default is today.

Response Attributes

Key Type Description
sentiment number  Number between -1 and 1 where -1 is most bearish and 1 is most bullish.
totalScores number  Number of social data inputs to generate the sentiment value.
positive string  Percent of social messages with positive sentiment.
negative string  Percent of social messages with negative sentiment.
minute string  Only provided when minute is requested. Minute represented as HHmm.

New Constructs

New Constructs is an independent investment research firm, specializing in quality-of-earnings, forensic accounting and discounted cash flow valuation analyses for public companies.

New Constructs Report

Powered by the best fundamental data in the world, New Constructs’ research provides unrivalled insights into the profitability and valuation of public and private companies.Our risk/reward ratings empower clients to make more informed investing decisions based on true, not reported or distorted, earnings. Research reports for 3,000+ stocks, 400+ ETFs, and 7,000+ mutual funds.

HTTP request

GET /files/download/NEW_CONSTRUCTS_REPORT


The call returns an HTTP redirect to a one time secure URL for the PDF file.

Data Weighting

Premium Data 5,000,000 per report
This about $5 per report depending on your IEX Cloud tier

Data Timing

End of day

Data Schedule

10am ET

Data Source(s)

New Constructs LLC

Notes

This is a Premium Data end-point available to only paying customers. You will be charged directly at pay-as-you-go rates and the messages consumed from this end-point will not come from your base subscription message allocation.
You are allowed up to 3 downloads per individual file for the message rate above.
This uses our generic Files API

Available Methods

GET /files/download/NEW_CONSTRUCTS_REPORT?symbol={symbol}&date={date}

Example

Query Parameters

Name Type Description
symbol string Required.
• Stock symbol for the report Ex: AAPL
date string Required.
• The date of the report formatted as YYYYMMDD Ex: 20210126