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.
- The base url for the API is:
https://cloud.iexapis.com/
- We support JSONP for all endpoints.
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:
- Adding new response attributes
- Adding new endpoints
- Adding new methods to an existing endpoint
- Adding new query string parameters
- Adding new path parameters
- Adding new webhook events
- Adding new streaming endpoints
- Changing the order of existing response attributes
Versions are added to the base url:
- Example:
https://cloud.iexapis.com/beta
- Example:
https://cloud.iexapis.com/v1
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.
Publishable API tokens are meant solely to identify your account with IEX Cloud, they aren’t secret. They can be published in places like your website JavaScript code, or in an iPhone or Android app.
Secret API tokens should be kept confidential and only stored on your own servers. Your account’s secret API token can perform any API request to IEX Cloud.
Protecting your API tokens
- Keep your secret token safe. Your secret token can make any API call on behalf of your account, including changes that may impact billing such as enabling pay-as-you-go charges. Do not store your secret token in your version control system. Do not use your secret token outside your web server, such as a browser, mobile app, or distributed file.
- Monitor usage of your API for anomalies. If you observe unauthorized or abnormal usage, rotate your API token. IEX Cloud provides multiple options to address abnormal usage. ..* You may use the IEX Cloud console to rotate an API token. Rotating a token will disable access to IEX Cloud for the rotated token within 10 seconds. ..* You may use the IEX Cloud API or console to disable pay-as-you-go. This may prevent unexpected charges due to unauthorized or abnormal usage.
- Do not embed API keys directly in code. Instead of directly embedding API keys in your application’s code, put them in environment variables or in include files that are stored separately from the bulk of your code—outside the source repository of your application. Then, if you share your code, the API keys will not be included in the shared files.
- Do not store API tokens in inside your application’s source control. If you store API tokens in files, keep the files outside your application’s source control system. This is particularly important if you use a public source code management system such as GitHub.
- Limit access with restricted tokens. IEX Cloud console will allow you to specify the IP addresses or referrer URLs associated with each token, reducing the impact of a compromised API token.
- Use independent API tokens for different apps. This limits the scope of each token. If an API token is compromised, you can rotate the impacted token without impacting other 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
/stock/aapl/batch?types=quote,news,chart&range=1m&last=10
/stock/market/batch?symbols=aapl,fb,tsla&types=quote,news,chart&range=1m&last=5
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
- Required: If you display any delayed price data, you must display “15 minute delayed price” as a disclaimer.
- Required: If you display
latestVolume
you must display “Consolidated Volume in Real-time” as a disclaimer. - Note on pricing data: All CTA and UTP pricing data is delayed at least 15 minutes.
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:
Type of data: Different API calls have different weightings, all of which is included in our documentation.
Frequency: If you’re requesting a data point every minute versus every hour, you’ll use 60x the messages. No surprise there.
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
- Parameter values must be comma-delimited when requesting multiple.
- (i.e.
?symbols=SNAP,fb
is correct.)
- (i.e.
- Case does not matter when passing values to a parameter unless specified in the docs.
- (i.e. Both
?symbols=fb
and?symbols=FB
will work.)
- (i.e. Both
- Be sure to url-encode the values you pass.
- (i.e.
?symbols=AIG+
encoded is?symbols=AIG%2b
.)
- (i.e.
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.
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.
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
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.
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 | |
2Investing | |
Go | goinvest |
Haskell | iexcloud |
Hubot | hubot-stock-checker |
KDB | iex_q |
Java | IEXTrading4j |
NodeJS | iexcloud-api-wrapper |
Outlook | IEX-Outlook-Sharp |
PHP | iex-cloud-sdk |
PowerPoint | IEX-PowerPoint-Sharp |
Python | pyEX |
iexfinance | |
FinMesh | |
R | iexcloudR |
Riex | |
Ruby | iex-ruby-client |
Word | IEX-Word-Sharp |
Applications that support IEX Cloud
Application | URL |
---|---|
Perspective | GitHub Link |
Postman Collections | GitHub Link |
Stock Analysis Engine | GitHub Link Docs |
TOP - an HTML5 Trading Terminal from SoftCapital | Top - By SoftCapital |
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
- The base url is
https://sandbox.iexapis.com
- You can also test SSE with
https://sandbox-sse.iexapis.com
- Your test token is available on the console by click the “View Test Data” toggle in the nav.
- All tier features are enforced at this time, but you are not limited by the number of calls you can make. You are not charged for test usage.
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:
- Your publishable token which is found in the Console.
- The URL for the type of data you would like to request.
REST calls are made up of:
- Base url. Example:
https://cloud.iexapis.com
- Version. Example:
beta
- Token. All REST requests require a valid token and can be added to a url like
?token=YOUR_TOKEN_HERE
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
/time-series/REPORTED_FINANCIALS/AAPL
/time-series/REPORTED_FINANCIALS/AAPL/10-K
/time-series/REPORTED_FINANCIALS/AAPL/10-Q?range=1y
/time-series/REPORTED_FINANCIALS/AAPL/10-Q?range=next-week&calendar=true
/time-series/REPORTED_FINANCIALS/AAPL/10-Q?last=2
/time-series/REPORTED_FINANCIALS/AAPL/10-Q?first=3
/time-series/REPORTED_FINANCIALS/AAPL/10-Q?from=2018-01-01&to=2019-06-01
/time-series/REPORTED_FINANCIALS/AAPL/10-Q?from=2016-01-01&limit=10
/time-series/REPORTED_FINANCIALS/AAPL/10-Q?on=2016-01-01
/time-series/REPORTED_FINANCIALS/AAPL/10-Q?from=2010-01-01&interval=2&format=csv
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. |
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, hasPaywallBy 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=sector|Technology 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 |
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
- GET
/data-points/{symbol}
- GET
/data-points/{symbol}/{key}
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. |
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:
- Your publishable token which is found in the console
- Your secret key for your publishable token, can be found below using the GET /account/signed API call
- The URL for the type of data you would like to request
Signed REST calls are made up of:
- Base url. Example:
https://cloud.iexapis.com
- Version. Example:
beta
- Token. All REST requests require a valid token and can be added to a url like
?token=YOUR_TOKEN_HERE
- The “authorization” header
- The “x-iex-date” header
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
- Requires SK token to access
- Only available to Grow and Scale users
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
- Requires SK token to access
- Only available to Grow and Scale users
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
- Requires SK token to access
- Billing resets on the first of every month at 00:00:00 UTC
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":"BETA",
"time":1548097469618
}
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
2019-12-09
- Rules Engine: Max number of rules per account changed from 10 to 500. Creating a rule remains free during the beta.
2019-12-05
- Added ExtractAlpha premium data
2019-11-26
- Added
putCallRatio
to the Advanced Stats endpoint
2019-11-25
- Added Bonus Issue corporate actions endpoint
- Added Distribution corporate actions endpoint
- Added Return of Capital corporate actions endpoint
- Added Rights Issue corporate actions endpoint
- Added Right to Purchase corporate actions endpoint
- Added Security Reclassification corporate actions endpoint
- Added Security Swap corporate actions endpoint
- Added Spinoff corporate actions endpoint
- Added Advanced Splits corporate actions endpoint
- Added historical time series data to the Daily Treasury Rates endpoint
- Added historical time series data to the Oil Prices endpoint
- Added historical time series data to the Natural Gas Prices endpoint
- Added historical time series data to the Jet Fuel Prices endpoint
- Added historical time series data to the Diesel Price endpoint
- Added historical time series data to the Propane Prices endpoint
- Added historical time series data to the Gas Prices endpoint
- Added historical time series data to the Unemployment endpoint
- Added historical time series data to the Total Housing Starts endpoint
- Added historical time series data to the Mortgage Rates endpoint
- Added historical time series data to the Real GDP endpoint
2019-11-20
- Rules Engine beta now available to paid plans. Collecting early user feedback.
2019-11-15
- Added
subattribute
anddateField
parameters to Time Series - Added 1 second, 5 second, and 1 minute conflation rates for forex real time streaming
2019-11-14
- Added retail money funds endpoint
- Added institutional money funds endpoint
- Added initial claims endpoint
2019-11-12
- Added Advanced Dividends endpoint. This greatly expands available dividends data and extends history to 12+ years.
2019-11-08
- Added historical news endpoint
- Added Fraud Factors to Premium Data.
- Fraud Factors Similarity Index endpoint
- Fraud Factors Non-Timely Filings endpoint
2019-11-07
2019-11-01
- Added calendar and range functionality to the time series endpoint. Now you can use short hand to query backwards or forward in time.
2019-10-29
- Introduced Premium Data on IEX Cloud
- Added Wall Street Horizon to Premium Data
2019-10-23
- Expanded dividends by 39k symbols and over 500k records
2019-10-14
- Added historical commodities endpoints
2019-10-11
- Added Real-time forex streaming endpoint
- Added Currency conversion endpoint
- Added Latest fx rate endpoint
- Added Historical daily currency rates endpoint
- Added total vehicle sales economic data
- Added US Recession Probabilities economic data
- Added total housing starts economic data
2019-10-10
- Technical Indicators endpoints
2019-10-01
- Cryptocurrency Quote endpoint and SSE streaming for 500+ coins
- Cryptocurrency Events SSE streaming
- Cryptocurrency Book endpoint
- Cryptocurrency Price endpoint
2019-09-20
includeToday
parameter added to historical prices endpointsort
parameter added to historical prices and intraday prices endpointschartIEXWhenNull
parameter added to intraday prices and endpoints
2019-09-09
- Added address information to company endpoint
2019-08-15
- Added
1mm
and5dm
historical price ranges
2019-08-10
- Added
lastTradeTime
to Stock Quote - Added
volume
to Stock Quote - Added
previousVolume
to Stock Quote
2019-07-31
- Docs updated to reflect Nasdaq UTP 15 minute delayed price restrictions
2019-07-18
- Launched Cloud Cache, a fully managed data cache to help efficiently consume messages on IEX Cloud without your own data infrastructure.
2019-07-15
- Changes to 15 minute delayed (intraday) data for Nasdaq listed stocks for Start tier.
2019-07-01
- Added Search endpoint. Search across all symbols. Great for building autocomplete search box.
2019-06-14
- Added Time Series endpoint
- Added 10 years of as reported financials in Time Series
2019-06-03
- Added Tel Aviv Stock Exchange (TAE) EOD prices
- Added Korea Stock Exchange (KRX) EOD prices
2019-05-28
- Added message circuit breaker to Account endpoints to set a cutoff for pay as you go messages. Console will be updated soon with a UI to update message circuit breaker.
- Added ISIN endpoint to convert ISIN to IEX Cloud symbols.
- Added latest-financial-quarterly-report-date to Data Points.
- Added latest-financial-annual-report-date to Data Points.
2019-05-16
- Added Bombay Stock Exchange (BSE Ltd.) EOD prices
2019-05-15
- Updated company descriptions
2019-05-10
- Added symbol search to Console. This feature will expand over time, but initially searches only US stocks.
2019-04-30
- Added Options symbols ref data
- Added new market wide, macro data to Data Points. https://cloud.iexapis.com/stable/data-points/market
- Added 30 year treasury rate
/stable/data-points/market/DGS30
- Added 20 year treasury rate
/stable/data-points/market/DGS20
- Added 10 year treasury rate
/stable/data-points/market/DGS10
- Added 5 year treasury rate
/stable/data-points/market/DGS5
- Added 2 year treasury rate
/stable/data-points/market/DGS2
- Added 1 year treasury rate
/stable/data-points/market/DGS1
- Added 6 month treasury rate
/stable/data-points/market/DGS6MO
- Added 3 month treasury rate
/stable/data-points/market/DGS3MO
- Added 1 month treasury rate
/stable/data-points/market/DGS1MO
- Added mortgage rate 15 year fixed
/stable/data-points/market/MORTGAGE15US
- Added mortgage rate 30 year fixed
/stable/data-points/market/MORTGAGE30US
- Added mortgage rate 5/1 year adjustable
/stable/data-points/market/MORTGAGE5US
- Added federal funds rate
/stable/data-points/market/FEDFUNDS
- Added non-farm payrolls
/stable/data-points/market/PAYEMS
- Added consumer price index
/stable/data-points/market/CPIAUCSL
- Added industrial production index
/stable/data-points/market/INDPRO
- Added real gross domestic product
/stable/data-points/market/A191RL1Q225SBEA
- Added commercial paper outstanding
/stable/data-points/market/COMPOUT
- Added unemployment rate
/stable/data-points/market/UNRATE
- Added CD rate non-jumbo
/stable/data-points/market/MMNRNJ
- Added CD rate jumbo
/stable/data-points/market/MMNRJD
- Added credit card interest rate
/stable/data-points/market/TERMCBCCALLNS
2019-04-26
- Added EOD options data
- Added 15 minute delayed OTC data (Only available to Scale users with permission from OTC Markets)
2019-04-18
- Version 1 is available and new version types are available.
Beta
2019-04-15
- Added Data Points endpoint
- Added
beta
to Key Stats endpoint
2019-04-10
- Added XETRA EOD prices
- Expanded historical dividend data for ETFs and mutual funds
2019-04-09
- Added Advanced Stats endpoint
- Added iexcloud-messages-used header to API responses
2019-03-22
- Added EOD prices for London Stock Exchange
- Added EOD prices for Euronext Brussels
- Added EOD prices for Euronext Paris
- Added EOD prices for Euronext Lisbon
- Added EOD prices for Euronext Dublin
- Added EOD prices for Euronext Amsterdam
2019-03-21
- Added historical sentiment data by minute back to May 2017
2019-03-20
- Added enhanced token security using signed requests
2019-03-18
- Added upcoming events endpoint
2019-03-14
- Added streaming news with SSE
2019-03-13
- Added new Grow tier
- Added historical sentiment data back to May 2017
2019-03-12
- Added international ref data
2019-03-08
- Added social sentiment streaming with SSE
- Added
exDividendDate
to key stats - Added
listLimit
query parameter to list to specify number of items to return
2019-03-07
- Added mutual fund symbols ref data
- Added otc symbols ref data
- Added region and currency to symbols ref data
- Added support for Mexico Exchanges historical prices
- Fixed earnings report date for some after market close symbols that returned the next day
2019-03-06
- Added currency exchange rates
- Added FX Symbols
2019-02-28
- Added Institutional Ownership
- Added Mutual Fund Ownership
- Added Analyst Recommendation Trends
- Added Insider Transactions
- Added Insider Roster
- Added Insider Summary
- Added ability to fetch historical data for a single date. Historical prices with range
date
can use query parameterchartByDay
to return a single day close information.
2019-02-27
- Added international equities. Now supporting EOD Canadian prices.
- Lowered weight of /stock/OHLC endpoint from 2 to 1, and max weight of 500.
- Added
peRatio
to /stock/quote endpoint
2019-02-26
- Added CEO compensation data
ceo-compensation
- Teams You can now invite team members to your account.
2019-02-21
- Introduced a dedicated domain for the sandbox environment.
- /status endpoint updated with version number to track when changes are made.
- Updated /stock/batch endpoint to return data for any valid symbol rather than error out the whole call for one bad symbol.
2019-02-20
- Lowered /stock/stats weight from 20 to 5
- Added
peRatio
nextDividendDate
nextEarningsDate
ttmEPS
ttmDividendRate
dividendYield
to the /stock/stats endpoint
2019-02-19
- Added
employees
to the /stock/company endpoint - Basic CIDR supported added to publishable token domain constraints in the console
- Fixed /stock/book endpoint
2019-02-14
- Introduced test tokens and sandbox for testing
2019-02-12
- Added StockTwits sentiment data
2019-02-07
- Added mutual fund EOD prices
- Added OTC EOD prices
2019-02-01
- Added /stocksUS to SSE
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.
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
/time-series/PREMIUM_WALLSTREETHORIZON_ANALYST_DAY
/time-series/PREMIUM_WALLSTREETHORIZON_ANALYST_DAY/AAPL?range=next-month
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
/time-series/PREMIUM_WALLSTREETHORIZON_BOARD_OF_DIRECTORS_MEETING
/time-series/PREMIUM_WALLSTREETHORIZON_BOARD_OF_DIRECTORS_MEETING?range=next-week
/time-series/PREMIUM_WALLSTREETHORIZON_BOARD_OF_DIRECTORS_MEETING/AAPL?range=next-month
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
/time-series/PREMIUM_WALLSTREETHORIZON_BUSINESS_UPDATE
/time-series/PREMIUM_WALLSTREETHORIZON_BUSINESS_UPDATE/AAPL?range=this-month
/time-series/PREMIUM_WALLSTREETHORIZON_BUSINESS_UPDATE?range=today
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
/time-series/PREMIUM_WALLSTREETHORIZON_BUYBACK
/time-series/PREMIUM_WALLSTREETHORIZON_BUYBACK/AAPL?range=next-quarter
/time-series/PREMIUM_WALLSTREETHORIZON_BUYBACK?range=1y&limit=20
/time-series/PREMIUM_WALLSTREETHORIZON_BUYBACK?range=this-month
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
/time-series/PREMIUM_WALLSTREETHORIZON_COMPANY_TRAVEL
/time-series/PREMIUM_WALLSTREETHORIZON_COMPANY_TRAVEL?range=this-week
/time-series/PREMIUM_WALLSTREETHORIZON_COMPANY_TRAVEL?range=today
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
/time-series/PREMIUM_WALLSTREETHORIZON_INITIAL_PUBLIC_OFFERING
/time-series/PREMIUM_WALLSTREETHORIZON_INITIAL_PUBLIC_OFFERING?range=today
/time-series/PREMIUM_WALLSTREETHORIZON_INITIAL_PUBLIC_OFFERING?range=this-week
/time-series/PREMIUM_WALLSTREETHORIZON_INITIAL_PUBLIC_OFFERING?range=next-month
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 |
Legal Actions
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
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
/time-series/PREMIUM_WALLSTREETHORIZON_MERGER_ACQUISITIONS
/time-series/PREMIUM_WALLSTREETHORIZON_MERGER_ACQUISITIONS?range=last-month
/time-series/PREMIUM_WALLSTREETHORIZON_MERGER_ACQUISITIONS?range=next-month
/time-series/PREMIUM_WALLSTREETHORIZON_MERGER_ACQUISITIONS?range=this-week
Query Parameters
This end point uses all standard time-series query parameters.
Response Attributes
Key | Type | Description |
---|---|---|
eventId | string | Unique WallStreetHorizon event identifier. |
actionType | - | - |
actionStatus | - | - |
acquirerCompanyId | - | - |
acquirerSymbol | - | - |
acquirerName | - | - |
targetCompanyId | - | - |
targetSymbol | - | - |
targetName | - | - |
announceDate | string | Event announcement date, formatted YYYY-MM-DD |
approvalDate | - | - |
closeDate | - | - |
percentInterest | - | - |
pricePerShareCurrency | - | - |
purchasePriceCash | - | - |
purchasePriceCurrency | - | - |
purchasePricePerShare | - | - |
purchasePriceSharesNumber | - | - |
etFlag | - | - |
etDate | - | - |
srFlag | - | - |
srDate | - | - |
secReferences | - | - |
newsReferences | - | - |
actionNotes | - | - |
updated | string | Refers to the machine readable epoch timestamp of when this entry was last updated |
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
/time-series/PREMIUM_WALLSTREETHORIZON_PRODUCT_EVENTS
/time-series/PREMIUM_WALLSTREETHORIZON_PRODUCT_EVENTS/AMC?range=next-month
/time-series/PREMIUM_WALLSTREETHORIZON_PRODUCT_EVENTS?range=this-month
/time-series/PREMIUM_WALLSTREETHORIZON_PRODUCT_EVENTS?range=this-quarter
/time-series/PREMIUM_WALLSTREETHORIZON_PRODUCT_EVENTS?range=1y&calendar=true
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
/time-series/PREMIUM_WALLSTREETHORIZON_SAME_STORE_SALES
/time-series/PREMIUM_WALLSTREETHORIZON_SAME_STORE_SALES?range=today
/time-series/PREMIUM_WALLSTREETHORIZON_SAME_STORE_SALES?range=this-week
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.
Similiarity 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)
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
/time-series/PREMIUM_FRAUD_FACTORS_SIMILARITY_INDEX
/time-series/PREMIUM_FRAUD_FACTORS_SIMILARITY_INDEX/aapl
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)
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
/time-series/PREMIUM_FRAUD_FACTORS_NON_TIMELY_FILINGS
/time-series/PREMIUM_FRAUD_FACTORS_NON_TIMELY_FILINGS/aapl
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)
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)
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)
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)
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)
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)
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)
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)
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)
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)
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)
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)
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)
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 |
Core Data
Stock Prices
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
Primary Partner
Consolidated Tape
Available Methods
GET /stock/{symbol}/book
Examples
Response Attributes
Response includes data from deep
and quote
. Refer to each endpoint for details.
Charts
Price charts can be built using the historical or intraday price endpoints
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)
Primary Partner
Notes
- Only included with paid subscription plans
Available Methods
GET /stock/{symbol}/delayed-quote
Examples
Response Attributes
Key | Type | Description |
---|---|---|
symbol | string | refers to the stock ticker. |
delayedPrice | number | refers to the 15 minute delayed market price. |
delayedSize | number | refers to the 15 minute delayed last trade size. |
delayedPriceTime | number | refers to the time of the delayed market price. |
processedTime | number | refers to when IEX processed the SIP price. |
Extended Hours Quote
Historical Prices
Returns adjusted and unadjusted historical data for up to 15 years. Useful for building charts.
HTTP request
GET /stock/{symbol}/chart/{range}/{date}
JSON response
// .../3m
[
{
"date": "2017-04-03",
"open": 143.1192,
"high": 143.5275,
"low": 142.4619,
"close": 143.1092,
"volume": 19985714,
"uOpen": 143.1192,
"uHigh": 143.5275,
"uLow": 142.4619,
"uClose": 143.1092,
"uVolume": 19985714,
"change": 0.039835,
"changePercent": 0.028,
"label": "Apr 03, 17",
"changeOverTime": -0.0039
} // , { ... }
]
// .../dynamic
{
"range": "1m",
"data": [
{
"date": "2017-04-03",
"open": 143.1192,
"high": 143.5275,
"low": 142.4619,
"close": 143.1092,
"volume": 19985714,
"uOpen": 143.1192,
"uHigh": 143.5275,
"uLow": 142.4619,
"uClose": 143.1092,
"uVolume": 19985714,
"change": 0.039835,
"changePercent": 0.028,
"label": "Apr 03, 17",
"changeOverTime": -0.0039
} // , { ... }
]
}
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)
Primary Partner
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
/stock/twtr/chart
/stock/twtr/chart/max
/stock/twtr/chart/5y
/stock/twtr/chart/2y
/stock/twtr/chart/1y
/stock/twtr/chart/ytd
/stock/twtr/chart/6m
/stock/twtr/chart/3m
/stock/twtr/chart/1m
/stock/twtr/chart/1mm
/stock/twtr/chart/5d
/stock/twtr/chart/5dm
/stock/twtr/chart/date/20190220
/stock/twtr/chart/date/20190109?chartByDay=true
/stock/twtr/chart/dynamic
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, IEX-only 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 |
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
Key | Type | Description |
---|---|---|
date | string | Formatted as YYYY-MM-DD |
high | number | Adjusted data for historical dates. Split adjusted only. |
low | number | Adjusted data for historical dates. Split adjusted only. |
volume | number | Adjusted data for historical dates. Split adjusted only. |
open | number | Adjusted data for historical dates. Split adjusted only. |
close | number | Adjusted data for historical dates. Split adjusted only. |
uHigh | number | Unadjusted data for historical dates. |
uLow | number | Unadjusted data for historical dates. |
uVolume | number | Unadjusted data for historical dates. |
uOpen | number | Unadjusted data for historical dates. |
uClose | number | Unadjusted data for historical dates. |
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. |
change | number | Change from previous trading day. |
changePercent | number | Change percent from previous trading day. |
Intraday Prices
This endpoint will return aggregated intraday prices in one minute buckets
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 data15 minutes delayed
for market data
Data Schedule
9:30-4pm ET Mon-Fri
on regular market trading days9:30-1pm ET
on early close trading days
Data Source(s)
Primary Partner
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. |
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. |
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. |
Open / Close Price
Refer to ohlc
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) |
Previous Day Price
This returns previous day adjusted price data for one or more stocks.
HTTP request
GET /stock/{symbol}/previous
JSON response
{
"date": "2019-03-25",
"open": 191.51,
"close": 188.74,
"high": 191.98,
"low": 186.6,
"volume": 43845293,
"uOpen": 191.51,
"uClose": 188.74,
"uHigh": 191.98,
"uLow": 186.6,
"uVolume": 43845293,
"change": 0,
"changePercent": 0,
"changeOverTime": 0,
"symbol": "AAPL"
}
Data Weighting
2
per symbol
Data Timing
End of day
Data Schedule
Available after 4am ET Tue-Sat
Data Source(s)
Primary Partner
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)
Primary Partner
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
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": "AAPL",
"companyName": "Apple Inc.",
"calculationPrice": "tops",
"open": 154,
"openTime": 1506605400394,
"close": 153.28,
"closeTime": 1506605400394,
"high": 154.80,
"low": 153.25,
"latestPrice": 158.73,
"latestSource": "Previous close",
"latestTime": "September 19, 2017",
"latestUpdate": 1505779200000,
"latestVolume": 20567140,
"volume": 20567140,
"iexRealtimePrice": 158.71,
"iexRealtimeSize": 100,
"iexLastUpdated": 1505851198059,
"delayedPrice": 158.71,
"delayedPriceTime": 1505854782437,
"extendedPrice": 159.21,
"extendedChange": -1.68,
"extendedChangePercent": -0.0125,
"extendedPriceTime": 1527082200361,
"previousClose": 158.73,
"previousVolume": 22268140,
"change": -1.67,
"changePercent": -0.01158,
"iexMarketPercent": 0.00948,
"iexVolume": 82451,
"avgTotalVolume": 29623234,
"iexBidPrice": 153.01,
"iexBidSize": 100,
"iexAskPrice": 158.66,
"iexAskSize": 100,
"marketCap": 751627174400,
"week52High": 159.65,
"week52Low": 93.63,
"ytdChange": 0.3665,
"peRatio": 17.18,
"lastTradeTime": 1505779200000,
"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)
Primary Partner
Investors Exchange
Consolidated Tape
Notes
- All response attributes related to 15 minute delayed market-wide price data are only available to paid subscribers
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 |
---|---|---|
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. |
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. |
latestUpdate | number | Refers to the machine readable epoch timestamp of when latestPrice was last updated. Represented in milliseconds since midnight Jan 1, 1970. |
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. |
calculationPrice | string | Refers to the source of the latest price. Possible values are "tops" , "sip" , "previousclose" or "close" |
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" |
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 |
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 |
close | number | Refers to the official close price from the SIP. 15 minute delayed |
closeTime | number | Refers to the official listing exchange time for the close from the SIP. 15 minute delayed |
previousClose | number | Refers to the previous trading day closing price. |
previousVolume | number | Refers to the previous trading day volume. |
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). |
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). |
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 |
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. |
marketCap | number | is calculated in real time using latestPrice . |
avgTotalVolume | number | Refers to the 30 day average volume. |
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. |
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. |
iexMarketPercent | number | Refers to IEX’s percentage of the market in the stock. |
iexVolume | number | Refers to shares traded in the stock on IEX. |
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. |
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. |
peRatio | number | Refers to the price-to-earnings ratio for the company. |
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
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 |
Stock Profiles
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)
Primary Partner
Examples
Response Attributes
Key | Type | Description |
---|---|---|
symbol | string | |
companyName | string | Name of the company |
employees | number | Number of employees |
exchange | string | |
industry | string | |
website | string | |
description | string | |
CEO | string | |
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 | |
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 of the company if available |
country | string | country of the company if available |
phone | string | phone number of the company if available |
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)
Primary Partner
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": -15,
"reportedTitle": "General Counsel",
"totalBought": 0,
"totalSold": -15
},
]
Data Weighting
5000
per symbol
Data Timing
End of day
Data Schedule
Updates at 5am, 6am ET
every day
Data Source(s)
Primary Partner
Notes
Only included with paid subscription plans
Available Methods
GET /stock/{symbol}/insider-summary
Examples
Response Attributes
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 |
Insider Transactions
Returns insider transactions.
HTTP request
GET /stock/{symbol}/insider-transactions
JSON response
[
{
"effectiveDate": 1522540800000,
"fullName": "Joe Smith",
"reportedTitle": "Vice President",
"tranPrice": 0,
"tranShares": 10000,
"tranValue": 0
}
]
Data Weighting
50
per transaction
Data Timing
End of day
Data Schedule
Updates at UTC
every day
Data Source(s)
Primary Partner
Notes
- Only included with paid subscription plans
- Insider transactions for the last 12 months on a rolling basis
Available Methods
GET /stock/{symbol}/insider-transactions
Examples
Response Attributes
Key | Type | Description |
---|---|---|
effectiveDate | number | Effective date of the transaction. |
fullName | string | Full name of the individual. This field concatenates the individuals First Name, Middle Name, Last Name and Suffix. |
reportedTitle | string | Insiders job title per the sourced filing |
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. |
directIndirect | letter | (D)irect or (I)ndirect |
tranCode | letter | Transaction Codes |
Logo
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 |
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.
Stock Fundamentals
Balance Sheet
Pulls balance sheet data. Available quarterly or annually with the default being the last available quarter.
HTTP request
GET /stock/{symbol}/balance-sheet
JSON response
{
"symbol": "AAPL",
"balancesheet": [
{
"reportDate": "2017-03-31",
"currentCash": 25913000000,
"shortTermInvestments": 40388000000,
"receivables": 23186000000,
"inventory": 3956000000,
"otherCurrentAssets": 12087000000,
"currentAssets": 131339000000,
"longTermInvestments": 170799000000,
"propertyPlantEquipment": 41304000000,
"goodwill": null,
"intangibleAssets": null,
"otherAssets": 22283000000,
"totalAssets": 365725000000,
"accountsPayable": 55888000000,
"currentLongTermDebt": 8784000000,
"otherCurrentLiabilities": 40230000000,
"totalCurrentLiabilities": 116866000000,
"longTermDebt": 93735000000,
"otherLiabilities": 4268000000,
"minorityInterest": 0,
"totalLiabilities": 258578000000,
"commonStock": 40201000000,
"retainedEarnings": 70400000000,
"treasuryStock": null,
"capitalSurplus": null,
"shareholderEquity": 107147000000,
"netTangibleAssets": 107147000000
} // , { ... }
]
}
Data Weighting
3000
per symbol per period
Data Timing
End of day
Data Schedule
Updates at 8am, 9am UTC
daily
Data Source(s)
Primary Partner
Notes
- Only included with paid subscription plans.
- Financial information is limited for some financial firms.
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
Key | Type | Description |
---|---|---|
reportDate | string | The last day of the relevant fiscal period. |
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 | 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 | 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 | 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 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 | 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 |
Cash Flow
Pulls cash flow data. Available quarterly or annually, with the default being the last available quarter.
HTTP request
GET /stock/{symbol}/cash-flow
JSON response
{
"symbol": "AAPL",
"cashflow": [
{
"reportDate": "2018-09-30",
"netIncome": 14125000000,
"depreciation": 2754000000,
"changesInReceivables": -9082000000,
"changesInInventories": 1942000000,
"cashChange": -6058000000,
"cashFlow": 19523000000,
"capitalExpenditures": -3041000000,
"investments": -926000000,
"investingActivityOther": 1566000000,
"totalInvestingCashFlows": -3001000000,
"dividendsPaid": -3530000000,
"netBorrowings": -27000000,
"otherFinancingCashFlows": -260000000,
"cashFlowFinancing": -22580000000,
"exchangeRateEffect": null
} // , { ... }
]
}
Data Weighting
1000
per symbol per period
Data Timing
End of day
Data Schedule
Updates at 8am, 9am UTC
daily
Data Source(s)
Primary Partner
Notes
Only included with paid subscription plans
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
Key | Type | Description |
---|---|---|
reportDate | string | The last day of the relevant fiscal period. |
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 | |
changesInInventories | number | Represents the change in the amount of inventories from one year to the next as reported in the cash flow statement. |
cashChange | number | 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 purchase/sale of investments for the period calculated as the sum of the negative of increase in investments, and decrease in investments |
investingActivityOther | number | 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. |
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) |
dividendsPaid | number | Represents the total common and preferred dividends paid to shareholders of the company. Excludes dividends paid to minority shareholders. |
netBorrowings | number | 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 other financing activities for the period. |
cashFlowFinancing | number | Returns net cash from financing activities for the period. |
exchangeRateEffect | number | Represents the effect of translating from one currency to another on the cash flow of the company. |
Dividends (Basic)
Provides basic dividend data for US equities, ETFs, and Mutual Funds for the last 5 years. For 13+ years of history and comprehensive data, use the Advanced Dividends endpoint.
HTTP request
GET /stock/{symbol}/dividends/{range}
JSON response
[
{
"symbol": "AAPL",
"exDate": "2017-08-10",
"paymentDate": "2017-08-17",
"recordDate": "2017-08-14",
"declaredDate": "2017-08-01",
"amount": 0.63,
"flag": "Dividend income",
"currency": "USD",
"description": "Apple declares dividend of .63",
"frequency": "quarterly"
} // , { ... }
]
Data Weighting
10
per symbol per period returned
Data Timing
End of day
Data Schedule
Updated at 9am UTC
every day
Data Source(s)
Data Partner
Notes
Dividends prior to last reported are only included with paid subscription plans
Available Methods
GET /stock/{symbol}/dividends/{range}
Examples
/stock/aapl/dividends/5y
/stock/aapl/dividends/2y
/stock/aapl/dividends/1y
/stock/aapl/dividends/ytd
/stock/aapl/dividends/6m
/stock/aapl/dividends/3m
/stock/aapl/dividends/1m
/stock/aapl/dividends/next
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
Key | Type | Description |
---|---|---|
exDate | string | refers to the dividend ex-date |
paymentDate | string | refers to the payment date |
recordDate | string | refers to the dividend record date |
declaredDate | string | refers to the dividend declaration date |
amount | number | refers to the payment amount |
flag | string | Type of dividend event |
currency | string | Currency of the dividend |
description | string | Description of the dividend event |
frequency | string | Frequency of the dividend |
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": [
{
"actualEPS": 2.46,
"consensusEPS": 2.36,
"announceTime": "AMC",
"numberOfEstimates": 34,
"EPSSurpriseDollar": 0.1,
"EPSReportDate": "2019-04-30",
"fiscalPeriod": "Q1 2019",
"fiscalEndDate": "2019-03-31",
"yearAgo": 2.73,
"yearAgoChangePercent": -0.0989
},
{
"actualEPS": 4.18,
"consensusEPS": 4.17,
"announceTime": "AMC",
"numberOfEstimates": 35,
"EPSSurpriseDollar": 0.01,
"EPSReportDate": "2019-01-29",
"fiscalPeriod": "Q4 2018",
"fiscalEndDate": "2018-12-31",
"yearAgo": 3.89,
"yearAgoChangePercent": 0.0746
}
]
}
Data Weighting
1000
per symbol per period
Data Timing
End of day
Data Schedule
Updates at 9am, 11am, 12pm UTC
every day
Data Source(s)
Primary Partner
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
/stock/aapl/earnings
/stock/aapl/earnings/2
/stock/aapl/earnings?last=2
/stock/aapl/earnings/1/actualEPS
/stock/aapl/earnings/1?period=annual
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
Key | Type | Description |
---|---|---|
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. |
consensusEPS | number | Consensus EPS estimate trend for the period |
announceTime | string | Time of earnings announcement. BTO (Before open), DMT (During trading), 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 Q# YYYY or the fiscal year FY ending in YYYY the earnings data applies to |
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 . |
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": [
{
"reportDate": "2019-03-31",
"grossProfit": 21648000000,
"costOfRevenue": 36270000000,
"operatingRevenue": 57918000000,
"totalRevenue": 57918000000,
"operatingIncome": 13242000000,
"netIncome": 11561000000,
"researchAndDevelopment": 3948000000,
"operatingExpense": 44676000000,
"currentAssets": 123346000000,
"totalAssets": 341998000000,
"totalLiabilities": 236138000000,
"currentCash": 38329000000,
"currentDebt": 22429000000,
"shortTermDebt": 22429000000,
"longTermDebt": 90201000000,
"totalCash": 80433000000,
"totalDebt": 112630000000,
"shareholderEquity": 105860000000,
"cashChange": -4954000000,
"cashFlow": 11155000000
} // , { ... }
]
}
Data Weighting
5000
per symbol per period
Data Timing
End of day
Data Schedule
Updates at 8am, 9am UTC
daily
Data Source(s)
Primary Partner
Notes
- Financial Firms report financials in a different format than our 3rd party processes therefore our data is limited
- Only included with paid subscription plans
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
Key | Type | Description |
---|---|---|
reportDate | string | The last day of the relevant fiscal period. |
grossProfit | number | |
costOfRevenue | number | |
operatingRevenue | number | |
totalRevenue | number | |
operatingIncome | number | |
netIncome | number | |
researchAndDevelopment | number | |
operatingExpense | number | |
currentAssets | number | |
totalAssets | number | |
totalLiabilities | number | |
currentCash | number | |
currentDebt | number | |
currentDebt | number | |
shortTermDebt | number | |
longTermDebt | number | |
totalCash | number | |
totalDebt | number | |
shareholderEquity | number | |
cashChange | number | |
cashFlow | number | |
operatingGainsLosses | string |
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
/time-series/REPORTED_FINANCIALS/AAPL
/time-series/REPORTED_FINANCIALS/AAPL/10-K
/time-series/REPORTED_FINANCIALS/AAPL/10-Q?last=2
/time-series/REPORTED_FINANCIALS/AAPL/10-Q?first=3
/time-series/REPORTED_FINANCIALS/AAPL/10-Q?from=2018-01-01&to=2019-06-01
/time-series/REPORTED_FINANCIALS/AAPL/10-Q?from=2016-01-01
/time-series/REPORTED_FINANCIALS/AAPL/10-Q?on=2016-01-01
/time-series/REPORTED_FINANCIALS/AAPL/10-Q?from=2010-01-01&interval=2&format=csv
Path Parameters
Option | Value | Description |
---|---|---|
symbol | A valid stock symbol | |
filing | 10-K | Annual report |
10-Q | Quarterly report |
Income Statement
Pulls income statement data. Available quarterly or annually with the default being the last available quarter.
HTTP request
GET /stock/{symbol}/income
JSON response
{
"symbol": "AAPL",
"income": [
{
"reportDate": "2017-03-31",
"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)
Primary Partner
Notes
Only included with paid subscription plans
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
Key | Type | Description |
---|---|---|
reportDate | string | The last day of the relevant fiscal period. |
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) |
SEC Filings
Use the Financials As Reported endpoint for raw SEC filings data.
Splits (Basic)
HTTP request
GET /stock/{symbol}/splits/{range}
JSON response
[
{
"exDate": "2017-08-10",
"declaredDate": "2017-08-01",
"ratio": 0.142857,
"toFactor": 7,
"fromFactor": 1,
"description": "7-for-1 split"
} // , { ... }
]
Data Weighting
10
per symbol per record
Data Timing
End of day
Data Schedule
Updated at 9am UTC
every day
Data Source(s)
Data Partner
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
/stock/aapl/splits/5y
/stock/aapl/splits/2y
/stock/aapl/splits/1y
/stock/aapl/splits/ytd
/stock/aapl/splits/6m
/stock/aapl/splits/3m
/stock/aapl/splits/1m
/stock/aapl/splits/next
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
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. |
Stock Research
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)
Primary Partner
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 amoritzation |
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 expected future 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 |
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
1000
per symbol
Data Timing
End of day
Data Schedule
Updates at 9am, 11am, 12pm UTC
every day
Data Source(s)
Primary Partner
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. |
Estimates
Provides the latest consensus estimate for the next fiscal period
HTTP request
GET /stock/{symbol}/estimates
JSON response
{
"symbol": "AAPL",
"estimates": [
{
"consensusEPS": 2.02,
"numberOfEstimates": 14,
"fiscalPeriod": "Q2 2017",
"fiscalEndDate": "2017-03-31",
"reportDate": "2017-04-15",
}
]
}
Data Weighting
10,000
per symbol per period
Data Timing
End of day
Data Schedule
Updates at 9am, 11am, 12pm UTC
every day
Data Source(s)
Primary Partner
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
Key | Type | Description |
---|---|---|
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 |
numberOfEstimates | number | Number of estimates for the period |
fiscalPeriod | string | The fiscal quarter the earnings data applies to Q# YYYY |
fiscalEndDate | string | Date representing the company fiscal quarter end YYYY-MM-DD |
reportDate | string | Expected report date of next earnings |
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
[
{
"adjHolding": 150,
"adjMv": 87,
"entityProperName": "Random Corporation",
"reportDate": 1490918400000,
"reportedHolding": 100,
"reportedMv": 100
}
]
Data Weighting
10000
per symbol per period
Data Timing
End of day
Data Schedule
Updates at 5am, 6am ET
every day
Data Source(s)
Primary Partner
Notes
Only included with paid subscription plans
Available Methods
GET /stock/{symbol}/fund-ownership
Examples
Response Attributes
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 fund as reported in the source |
reportedMv | number | Market value held by the fund as reported in the source, represented in USD. |
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
[
{
"adjHolding": 10085320,
"adjMv": 59188155,
"entityProperName": "Random Corp.",
"reportDate": 1548892800000,
"reportedHolding": 2085320
}
]
Data Weighting
10000
per symbol per period
Data Timing
End of day
Data Schedule
Updates at 5am, 6am ET
every day
Data Source(s)
Primary Partner
Notes
Only included with paid subscription plans
Available Methods
GET /stock/{symbol}/institutional-ownership
Examples
Response Attributes
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 |
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": 5203997571,
"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 stats1
per call per symbol for single stat filter
Data Timing
End of day
Data Schedule
8am, 9am ET
Data Source(s)
Primary Partner
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 | |
week52low | number | |
week52change | number | Percentage change |
sharesOutstanding | number | Number of shares outstanding as the difference between issued shares and treasury shares. Investopedia |
avg30Volume | number | Average 30 day volume |
avg10Volume | number | Average 10 day volume |
float | number | Returns the annual shares outstanding minus closely held shares. |
employees | number | |
ttmEPS | number | Trailing twelve month earnings per share. Investopedia |
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 |
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 | |
day50MovingAvg | number | |
maxChangePercent | number | |
year5ChangePercent | number | |
year2ChangePercent | number | |
year1ChangePercent | number | |
ytdChangePercent | number | |
month6ChangePercent | number | |
month3ChangePercent | number | |
month1ChangePercent | number | |
day30ChangePercent | number | |
day5ChangePercent | number |
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
}
Data Weighting
500
per symbol
Data Timing
End of day
Data Schedule
Updates at 10am, 11am, 12pm UTC
every day
Data Source(s)
Primary Partner
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 |
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
Primary Partner
Notes
Only inlcuded 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 |
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)
Data Partner
Notes
Only available to paid plans.
Available Methods
GET /time-series/advanced_bonus/{symbol?}/{refid?}
Examples
/time-series/advanced_bonus?range=last-week
/time-series/advanced_bonus?range=next-month&calendar=true
/time-series/advanced_bonus/AAPL?last=4
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. 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. YYYY-MM-DD |
paymentDate | string | The date when the dividend is actually paid to eligible shareholders. 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. 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. 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)
Data Partner
Notes
Only available to paid plans.
Available Methods
GET /time-series/advanced_distribution/{symbol?}/{refid?}
Examples
/time-series/advanced_distribution?range=last-week
/time-series/advanced_distribution?range=next-month&calendar=true
/time-series/advanced_distribution/AAPL?last=4
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. 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. YYYY-MM-DD |
paymentDate | string | The date paid to eligible shareholders. YYYY-MM-DD |
announceDate | string | This is the date on which the company announces a future issue. 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. 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. 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, 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)
Data Partner
Notes
Only available to paid plans.
Available Methods
GET /time-series/advanced_dividends/{symbol?}/{refid?}
Examples
/time-series/advanced_dividends?range=last-week
/time-series/advanced_dividends?range=next-month&calendar=true
/time-series/advanced_dividends/AAPL?last=4
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.. 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.. YYYY-MM-DD |
paymentDate | string | The date when the dividend is actually paid to eligible shareholders. YYYY-MM-DD |
announceDate | string | This is the date on which the company announces that it will be issuing a dividend in the future. . 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. 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. YYYY-MM-DD |
secondPaymentDate | string | Second payment date. YYYY-MM-DD |
secondExDate | string | Second ex date. YYYY-MM-DD |
fiscalYearEndDate | string | Fiscal year end date. YYYY-MM-DD |
periodEndDate | string | Period end date. YYYY-MM-DD |
optionalElectionDate | string | Optional election date. YYYY-MM-DD |
toDate | string | To Date. YYYY-MM-DD |
registrationDate | string | Registration date. YYYY-MM-DD |
installmentPayDate | string | Installment payment date. YYYY-MM-DD |
declaredDate | string | This is the date on which the company announces that it will be issuing a dividend in the future. YYYY-MM-DD |
refid | string | Unique id representing the dividend record |
created | string | Date the dividend record was created. 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)
Data Partner
Notes
Only available to paid plans.
Available Methods
GET /time-series/advanced_return_of_capital/{symbol?}/{refid?}
Examples
/time-series/advanced_return_of_capital?range=last-week
/time-series/advanced_return_of_capital?range=next-month&calendar=true
/time-series/advanced_return_of_capital/AAPL?last=4
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. 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. YYYY-MM-DD |
paymentDate | string | The date paid to eligible shareholders. 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. 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. 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)
Data Partner
Notes
Only available to paid plans.
Available Methods
GET /time-series/advanced_rights/{symbol?}/{refid?}
Examples
/time-series/advanced_rights?range=last-week
/time-series/advanced_rights?range=next-month&calendar=true
/time-series/advanced_rights/AAPL?last=4
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. 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. YYYY-MM-DD |
paymentDate | string | The date paid to eligible shareholders. 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. 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. 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)
Data Partner
Notes
Only available to paid plans.
Available Methods
GET /time-series/advanced_right_to_purchase/{symbol?}/{refid?}
Examples
/time-series/advanced_right_to_purchase?range=last-week
/time-series/advanced_right_to_purchase?range=next-month&calendar=true
/time-series/advanced_right_to_purchase/AAPL?last=4
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. 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. YYYY-MM-DD |
paymentDate | string | The date paid to eligible shareholders. 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. 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. 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)
Data Partner
Notes
Only available to paid plans.
Available Methods
GET /time-series/advanced_security_reclassification/{symbol?}/{refid?}
Examples
/time-series/advanced_security_reclassification?range=last-week
/time-series/advanced_security_reclassification?range=next-month&calendar=true
/time-series/advanced_security_reclassification/AAPL?last=4
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. 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. 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. 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)
Data Partner
Notes
Only available to paid plans.
Available Methods
GET /time-series/advanced_security_swap/{symbol?}/{refid?}
Examples
/time-series/advanced_security_swap?range=last-week
/time-series/advanced_security_swap?range=next-month&calendar=true
/time-series/advanced_security_swap/AAPL?last=4
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. 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. YYYY-MM-DD |
paymentDate | string | The date paid to eligible shareholders. 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. 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. 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)
Data Partner
Notes
Only available to paid plans.
Available Methods
GET /time-series/advanced_spinoff/{symbol?}/{refid?}
Examples
/time-series/advanced_spinoff?range=last-week
/time-series/advanced_spinoff?range=next-month&calendar=true
/time-series/advanced_spinoff/AAPL?last=4
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. 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. YYYY-MM-DD |
paymentDate | string | The date paid to eligible shareholders. 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. 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. 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><BR>It is intended that 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)
Data Partner
Notes
Only available to paid plans.
Available Methods
GET /time-series/advanced_splits/{symbol?}/{refid?}
Examples
/time-series/advanced_splits?range=last-week
/time-series/advanced_splits?range=next-month&calendar=true
/time-series/advanced_splits/AAPL?last=4
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. 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. YYYY-MM-DD |
paymentDate | string | The date paid to eligible shareholders. 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. 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. 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
/stock/market/collection/sector?collectionName=Technology
/stock/market/collection/tag?collectionName=Airlines
/stock/market/collection/list?collectionName=mostactive
Query String Parameters
Option | Details |
---|---|
collectionName |
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)
Primary Partner
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 |
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 Central Index Key assigned by the SEC to identify filings. |
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.
HTTP request
GET /stock/market/list/{list-type}
JSON response
[
// Array of quotes
]
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
/stock/market/list/mostactive
/stock/market/list/gainers
/stock/market/list/losers
/stock/market/list/iexvolume
/stock/market/list/iexpercent
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 | • Parameter is 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)
Primary Partner
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)
Primary Partner
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
/stock/market/upcoming-events
/stock/market/upcoming-earnings
/stock/market/upcoming-dividends
/stock/market/upcoming-splits
/stock/market/upcoming-ipos
/stock/aapl/upcoming-events
/stock/aapl/upcoming-earnings
/stock/aapl/upcoming-dividends
/stock/aapl/upcoming-splits
/stock/aapl/upcoming-ipos
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 or any of the following topics: crypto oil us-market etfs bonds funding fx capital-raise |
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 | A stock symbol or any of the following topics: crypto oil us-market etfs bonds funding fx capital-raise |
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. A stock symbol or any of the following topics: crypto oil us-market etfs bonds funding fx capital-raise |
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 |