Documentation | Intrinio

Documentation

Intrinio offers a variety of ways to access financial data. Choose your preferred access method below:

Screener

API Documentation

There are two versions of our API. We recommend "v2". To learn which one may be right for you, click here.
API v1
API v2

{{ docSectionTitle }} Documentation

Using the Intrinio Screener API entails constructing conditions and optional logic to arrive at your desired list of securities. The usage of the conditions and logic parameters will allow you to construct complex screening queries.

Screener API Endpoint: https://api.intrinio.com/securities/search

Conditions

The conditions parameter consists of a comma-separated list of conditions. Each condition consists three or four elements separated by tildes ~

  1. A data tag
  2. An operator
    • Equal to: eq
    • Greater than: gt
    • Greater than or equal to: gte
    • Less than: lt
    • Less than or equal to: lte
    • Contains text: contains
  3. A value
  4. A label (optional)

Examples of Valid Conditions

  • pricetoearnings~gt~15
  • pricetoearnings~gte~10,open_price~lte~10.50
  • long_description~contains~aero,state~eq~Colorado

Examples of Invalid Conditions

  • pricetoearnings,gt,15 - condition elements must be separated by ~
  • pricetoearnings~gte~10&open_price~lte~10.50 - conditions must be separated by ,
  • pricetoearnings~>~15 - invalid operator used

Logic

By default, every condition is applied to the dataset with an AND operator. For example, if you have three conditions , volume > 1000 , pricetoearnings < 10 , percent_change > 0.1 , the corresponding query will be volume > 1000 AND pricetoearnings < 10 AND percent_change > 0.1

However, you can use the logic parameter to specify how the conditions are applied. For example, you might want to do volume > 1000 AND (pricetoearnings < 10 OR percent_change > 0.1) , which produces a different result. This is possible using the logic parameter.

To use the logic parameter, first make sure each condition has a label field that is made up of characters a-z, A-Z, 0-9, or _. Valid labels look like high_volume , interesting_pe , or mover . Invalid labels look like Stuff I like , watchthis! , or @!01@(!)

Here is an example of a labeled condition: pricetoearnings~gt~15~high_pe , where high_pe is the label to be used in the logic.

Acceptable Logic Components

  • Labels of conditions
  • Operators , AND , OR NOT (mind proper spacing and capitalization)
  • Parentheses groups ((condition1 OR condition2) AND condition3)

Examples of Valid Logic

  • high_volume AND (interesting_pe OR mover)
  • high_profits AND (tech OR healthcare) AND low_debt_ratio
  • NOT (california_hq OR high_debt_service) AND high_dividend_yield

Examples of Invalid Logic

  • high_volume AND(interesting_pe OR mover) - needs proper space after AND
  • (high_profits AND (tech OR healthcare) AND low_debt_ratio - unbalanced parantheses groups
  • NOT (california_hq OR high_debt_service) AND high_dividend_yield - too many spaces between labels and operators
  • pe * 2 > ebitda - math and comparisons not supported yet

NOTE: Make sure to properly encode URL parameters before making the request, such as replacing spaces with %20 and parenthesis with %28 , %29 logic=high_volume%20AND%20%28interesting_pe%20OR%20mover%29

Complete Examples

Below are several complete examples demonstraing the usage of the condition and logic parameters for screening securities.

Example 1: Securities with low PE and high ROI

Goal:
Return securities with a PE ratio <= 5 and a return-on-equity >= to 20%.
Conditions:
pricetoearnings~lte~5,roe~gte~0.2
API Endpoint:
https://api.intrinio.com/securities/search?conditions=pricetoearnings~lte~5,roe~gte~0.2

Example 2: Securities with more than $10b cash or $100b market cap

Goal:
Return securities with cash >= 10,000,000,000 or market cap >= 100,000,000,000
Conditions:
cashandequivalents~gte~10000000000~cash,marketcap~gte~100000000000~mktcap
Logic:
cash OR mktcap
API Endpoint
https://api.intrinio.com/securities/search?conditions=cashandequivalents~gte~10000000000~cash,marketcap~gte~100000000000~mktcap&logic=cash%20OR%20mktcap

If you need additional help, chat with us.

Returns the most recent data point for a selected identifier (ticker symbol, stock market index symbol, CIK ID, etc.) for a selected tag. Income statement, cash flow statement, and ratios are returned as trailing twelve months values. All other data points are returned as their most recent value, either as of the last release financial statement or the most recent reported value.

Endpoint:

Parameters

expand collapse
Name Description Example
identifier
* required
An identifier, which can be a security ticker, SEC CIK ID, FRED Series ID, etc. AAPL
item
* required
An item, which can be a data tag or a special code. marketcap
hide_paging
* required
Hide first row of paging information.
Options:
true
-

Output Fields

expand collapse
Name Description Type Example
identifier the ticker or identifier for the data point string AAPL
item the requested standardized tag or series ID string name

Historical Data

Returns the historical data for for a selected identifier (ticker symbol or index symbol) for a selected tag. Income statement, cash flow statement, and ratios are returned as trailing twelve months values by default, but can be changed with the type parameter. All other historical data points are returned as their value on a certain day based on filings reported as of that date.

Parameters

expand collapse
Name Description Example
identifier
* required
An identifier, which can be a security ticker, SEC CIK ID, FRED Series ID, etc. AAPL
item
* required
An item, which can be a data tag or a special code. marketcap
start_date
* required
The earliest date for which to return data. 2018-04-02
end_date
* required
The latest date for which to return data. 2018-5-03
frequency
* required
The frequency of the historical prices & valuation data.
Options:
daily
weekly
monthly
quarterly
yearly
yearly
type
* required
The type of historical data to fetch. For financial statements, the type reflects the type of financial statement. For Sector data, the type reflect the aggretation (mean, median, max, min) type of the data.
Options:
FY
QTR
TTM
YTD
count
sum
max
75thpctl
mean
median
25thpctl
min
FY
sequence
* required
An integer 0 or greater for calling a single historical data point from the first entry, based on sort order. 0
show_date
* required
If true, the function will return the date value, and if false the function will return the data point value for a given query.
Options:
Yes
Yes
page_number
* required
An integer greater than or equal to 1 for specifying the page number for the return values. 4
page_size
* required
An integer greater than or equal to 1 for specifying the number of results on each page. 10
hide_paging
* required
Hide first row of paging information.
Options:
true
true

Output Fields

expand collapse
Name Description Type Example
identifier the ticker or identifier for the data point - AAPL
item the requested standardized tag or series ID - marketcap
date the date associated with the value of the data tag - 2016-12-31
value the value of the Intrinio tag of the financial data point - 45936

Returns security list and information for all securities covered by Intrinio.

Endpoint:

Parameters

expand collapse
Name Description Example
query
* required
A string query search of security name or ticker symbol with the returned results being the relevant securities in compacted list format. AAPL
identifier
* required
The identifier for the legal entity or a security associated with the security. A
exch_symbol
* required
The Intrinio Stock Market Symbol, to specify the exchange for the list of securities. NYSE
last_crsp_adj_date
* required
A date value that returns the list of securities that have had adjusted stock prices due to a corporate event after this date. 2017-12-29
us_only
* required
Return only US-based securities.
Options:
Yes
Yes
page_number
* required
An integer greater than or equal to 1 for specifying the page number for the return values. 3
page_size
* required
An integer greater than or equal to 1 for specifying the number of results on each page. 15
hide_paging
* required
Hide first row of paging information.
Options:
true
-

Output Fields

expand collapse
Name Description Type Example
ticker the stock market ticker symbol associated with the companies common stock securities string A
figi_ticker the OpenFIGI ticker symbol string A:UN
figi the OpenFIGI identifier string BBG000C2V541
composite_figi the OpenFIGI composite-level identifier string BBG000C2V3D6
composite_figi_ticker the OpenFIGI composite-level ticker string BBG00B3T3HD3
security_name the security description as provided by the exchange string Alcoa Corp
market_sector the type of market for the security string Equity
security_type the type of security, such as Common Stock, Preferred Stock, Warrants, Limited Partnership Interests, etc. string Ordinary Shares
stock_exchange the Stock Exchange (and market category) where the company’s common stock is primarily traded string NYSE
last_crsp_adj_date the last recorded date (“YYYY-MM-DD”) of an CRSP adjustment made to prior prices due to a stock split or dividend event. date 2017-12-29
figi_uniqueid the security’s unique FIGI identifier string EQ0000000045469815
share_class_figi the security’s share class FIGI identifier string BBG00B3T3HF1
figi_exch_cntry the security’s FIGI country of the exchange string US
currency the security’s traded currency on the listed exchange string USD
mic the Market Identification Code for the Stock Exchange where the security is listed. string XNYS
exch_symbol the Intrinio Stock Exchange Symbol used as an identifier on the Intrinio API. string ^XNYS
etf a boolean to represent whether the security is an ETF or otherwise boolean false
delisted_security if the security is no longer traded on public exchanges, the security will be considered delisted and the security no longer will report pricing data. boolean false
primary_listing a boolean to represent whether the security is the primary issue or a secondary issue of the security on a different stock exchange. boolean true
previous_tickers An array of ticker symbols that this security previously traded under array -

Sample Data

expand collapse

Security Master

Not available for this access method

Security Lookup

Not available for this access method

Stock Exchanges

Returns stock exchange list and information for all stock exchanges covered by Intrinio.

Parameters

expand collapse
Name Description Example
identifier
* required
An identifer for a stock exchange, which can be the MIC, symbol, or acronym. XLON
query
* required
A string query search of stock exchange name or MIC with the returned results being the relevant stock exchanges in compacted list format. London
page_number
* required
An integer greater than or equal to 1 for specifying the page number for the return values. 2
page_size
* required
An integer greater than or equal to 1 for specifying the number of results on each page. 10
hide_paging
* required
Hide first row of paging information.
Options:
true
true

Output Fields

expand collapse
Name Description Type Example
symbol the Intrinio symbol associated with the stock exchange string ^BMEX
mic the MIC identifier for the stock exchange string BMEX
institution_name the name of the stock exchange string BME - BOLSAS Y MERCADOS ESPANOLES
acronym the stock exchanges short form identifier string BME
city the city where the stock exchange is located string MADRID
country the country where the stock exchange is located string SPAIN
country_code the country code for the country where the stock exchange is located string ES
website the website for the stock exchange string HTTP://WWW.BOLSASYMERCADOS.ES

Sample Data

expand collapse

Stock Exchange Master

Not available for this access method

Returns professional-grade historical stock prices for a security or stock market index. Historical prices are available back to 1996 or the IPO date, with some companies with data back to the 1970s. Stock market index historical price data is available back to the 1950s at the earliest.

Endpoint:

Parameters

expand collapse
Name Description Example
identifier
* required
The stock market ticker symbol associated with the companies common stock securities or the stock market index. AAPL
item
* required
The selected observation of the historical prices.
Options:
date
open
high
low
close
volume
ex_dividend
split_ratio
adj_open
adj_high
adj_low
adj_close
adj_volume
close
start_date
* required
The first date in which historical stock prices are delivered- historical daily prices go back to 1996 for most companies, but some go back further to the 1970s or to the date of the IPO. 2014-09-28
end_date
* required
The last date in which historical stock prices are delivered- end of day prices are available around 5 p.m. EST and real-time prices are updated every minute throughout the trading day. 2015-09-28
frequency
* required
The frequency of the historical prices.
Options:
daily
weekly
monthly
quarterly
yearly
daily
sequence
* required
An integer 0 or greater for calling a single historical data point from the first entry, based on sort order. 0
bulk
* required
When true, returns all available prices in the same response. Cannot be used with any other parameters besides ticker/identifier.
Options:
true
true
page_number
* required
An integer greater than or equal to 1 for specifying the page number for the return values. 3
page_size
* required
An integer greater than or equal to 1 for specifying the number of results on each page. 20
sort_order
* required
The order of the historical stock price dates.
Options:
asc
desc
asc
hide_paging
* required
Hide first row of paging information.
Options:
true
true

Output Fields

expand collapse
Name Description Type Example
date the date of the stock price historical data date 2016-09-23
open the actual observed first traded stock price on the trading date number 114.42
high the actual observed highest traded stock price on the trading date number 114.79
low the actual observed lowest traded stock price on the trading date number 111.55
close the actual observed last trade stock price on the trading date number 112.71
volume the actual observed number of shares of stock traded between market participants on the trading date number 52481151.0
ex_dividend the nonsplit adjusted dividend per share on the ex-dividend date; not available on index historical prices number 0.0
split_ratio the split factor on the split date - not available on index historical prices number 1.0
adj_open the dividend and split adjusted open price; not available on index historical prices number 114.42
adj_high the dividend and split adjusted high price; not available on index historical prices number 114.79
adj_low the dividend and split adjusted low price; not available on index historical prices number 111.55
adj_close the dividend and split adjusted close price; not available on index historical prices number 112.71
adj_volume the dividend and split adjusted volume; not available on index historical prices number 52481151.0

Price Adjustments

Returns adjustments to stock prices, derived from dividends and splits.

Parameters

expand collapse
Name Description Example
identifier
* required
The stock market ticker symbol associated with the company's common stock. AAPL
start_date
* required
The earliest date for which to return adjustments. 2014-09-28
end_date
* required
The latest date for which to return adjustments. 2015-09-28
page_number
* required
An integer greater than or equal to 1 for specifying the page number for the return values. 3
page_size
* required
An integer greater than or equal to 1 for specifying the number of results on each page. 20
hide_paging
* required
Hide first row of paging information.
Options:
true
true

Output Fields

expand collapse
Name Description Type Example
date the date of the stock price adjustment date 2016-09-23
factor the total adjustment factor by which earlier prices should be divided, including both dividends and splits number 0.5
dividend the non-split-adjusted dividend per share on the ex-dividend date number 0.3
dividend_currency the currency that the dividend was paid in number USD
split_ratio the factor by which shares were divided number 0.5

Sample Data

expand collapse

Price Adjsutments

Not available for this access method

Exchange Prices

Returns professional-grade historical stock prices for all securities traded on a stock exchange for a single specified day. Historical prices are available back to 1996 or the IPO date, with some companies with data back to the 1970s.

Please note: Specifying XNAS (NASDAQ) or XNYS (New York Stock Exchange) identifiers will return all securities listed on US exchanges (USCOMP).

Parameters

expand collapse
Name Description Example
identifier
* required
The stock market ticker symbol associated with the companies common stock securities or the stock market index. USCOMP
price_date
* required
The specified date in which historical stock prices are returned for a stock exchange. 2016-12-30
page_number
* required
An integer greater than or equal to 1 for specifying the page number for the return values. 3
page_size
* required
An integer greater than or equal to 1 for specifying the number of results on each page. 10
hide_paging
* required
Hide first row of paging information.
Options:
true
true

Output Fields

expand collapse
Name Description Type Example
ticker the stock exchange ticker symbol as listed on the stock exchange string AAB
figi_ticker the OpenFIGI Ticker Symbol string AAB:CT
figi the FIGI identifier string BBG000D2T2D0
date the date of the stock price historical data date 2016-12-30
open the actual observed first traded stock price on the trading date number 0.16
high the actual observed highest traded stock price on the trading date number 0.16
low the actual observed lowest traded stock price on the trading date number 0.155
close the actual observed last trade stock price on the trading date number 0.155
volume the actual observed number of shares of stock traded between market participants on the trading date number 39000
ex_dividend the non-split adjusted dividend per share on the ex-dividend date number 0
split_ratio the split factor on the split date number 1
adj_open the dividend and split adjusted open price number 0.16
adj_high the dividend and split adjusted high price number 0.16
adj_low the dividend and split adjusted low price number 0.155
adj_close the dividend and split adjusted close price number 0.155

Securities Search/Screener

Returns security list and information all securities that match the given conditions. The API call credits required for each call is equal to the number of conditions specified.

Parameters

expand collapse
Name Description Example
screener_conditions
* required
A list of conditions used to filter the resulting securities. See screener documentation for details on how to construct conditions. pricetoearnings~lt~15
logic
* required
The logic of how the conditions are applied. See screener documentation for details on how to use logic with conditions. low_pe AND high_roi
order_column
* required
A data tag by which to order the results. -
order_direction
* required
The direction in which to order the results (“asc” for Ascending or “desc” for descending).
Options:
asc
desc
asc
primary_only
* required
Return only primary securities (excluding special securities such as preferred shares)
Options:
true
true
actively_traded
* required
Return only securities that have a stock price in the past 7 days
Options:
true
true
page_number
* required
An integer greater than or equal to 1 for specifying the page number for the return values. 3
page_size
* required
An integer greater than or equal to 1 for specifying the number of results on each page. 20
hide_paging
* required
Hide first row of paging information.
Options:
true
true

Standardized Financials

Returns professional-grade historical financial data. This data is standardized, cleansed and verified to ensure the highest quality data sourced directly from the XBRL financial statements. The primary purpose of standardized financials are to facilitate comparability across a single company’s fundamentals and across all companiesfundamentals. For example, it is possible to compare total revenues between two companies as of a certain point in time, or within a single company across multiple time periods. This is not possible using the as reported financial statements because of the inherent complexity of reporting standards.

Parameters

expand collapse
Name Description Example
identifier
* required
The stock market ticker symbol associated with the companies common stock securities. AAPL
statement
* required
The financial statement requested, options include the income statement, balance sheet, statement of cash flows and calculated metrics and ratios.
Options:
income_statement
balance_sheet
cash_flow_statement
calculations
income_statement
type
* required
The type of periods requested - includes fiscal years for annual data, quarters for quarterly data and trailing twelve months for annual data on a quarterly basis.
Options:
FY
QTR
TTM
YTD
FY
fiscal_year
* required
The fiscal year associated with the fundamental. 2017
fiscal_period
* required
The fiscal period associated with the fundamental.
Options:
FY
Q1
Q2
Q3
Q4
Q1TTM
Q2TTM
Q3TTM
Q2YTD
Q3YTD
Q2
date
* required
The first fundamental will be the latest as of this specified date. 2018-01-01
tag
* required
The specified standardized tag. operatingrevenue
sequence
* required
The sequence of the requested fundamental (i.e. 0 is the first available fundamental associated with the fiscal period type. 0
rounding
* required
Round the returned value (actuals, thousands, millions, billions).
Options:
A
K
M
B
A
page_number
* required
An integer greater than or equal to 1 for specifying the page number for the return values. -
page_size
* required
An integer greater than or equal to 1 for specifying the number of results on each page. 20
hide_paging
* required
Hide first row of paging information.
Options:
true
true

Output Fields

expand collapse
Name Description Type Example
tag the Intrinio standardized tag of the financial data point string operatingrevenue
value the value of the Intrinio tag of the financial data point number 233715000000.0

Standardized Fundamentals

Returns a list of available standardized fundamentals (fiscal year and fiscal period) for a given ticker and statement.

Parameters

expand collapse
Name Description Example
identifier
* required
The stock market ticker symbol associated with the companies common stock ecurities. AAPL
statement
* required
The financial statement requested, options include the income statement, balance sheet, statement of cash flows and calculated metrics and ratios.
Options:
income_statement
balance_sheet
cash_flow_statement
calculations
income_statement
type
* required
The type of periods requested - includes fiscal years for annual data, quarters for quarterly data and trailing twelve months for annual data on a quarterly basis.
Options:
FY
QTR
TTM
YTD
FY
date
* required
The first fundamental will be the latest as of this specified date. 2017-03-02
item
* required
The return value for the fundamental.
Options:
fiscal_year
end_date
start_date
fiscal_period
filing_date
fiscal_year
sequence
* required
An integer 0 or greater for calling a single fundamental from the first entry, most recent first. 0
page_number
* required
An integer greater than or equal to 1 for specifying the page number for the return values. -
page_size
* required
An integer greater than or equal to 1 for specifying the number of results on each page. 10
hide_paging
* required
Hide first row of paging information.
Options:
true
true

Output Fields

expand collapse
Name Description Type Example
fiscal_year the fiscal year of the fundamental number 2018
fiscal_period the fiscal period of the fundamental string Q1
end_date the last date of the fundamental date 2018-07-30
start_date the first date of the fundamental (not available for balance sheets) date 2018-09-01

Standardized Tags

Returns the standardized tags and labels for a given ticker, statement, and date or fiscal year/fiscal quarter.

Parameters

expand collapse
Name Description Example
statement
* required
The financial statement requested, options include the income statement, balance sheet, statement of cash flows, calculated metrics and ratios, and current data points.
Options:
income_statement
balance_sheet
cash_flow_statement
calculations
current
income_statement
template
* required
The financial statement tag template.
Options:
industrial
financial
industrial
identifier
* required
The stock market ticker symbol associated with the companies common stock securities. AAPL
item
* required
The return value for the tag.
Options:
name
tag
parent
factor
balance
type
units
name
sequence
* required
An integer 0 or greater for calling a single tag from the first entry, based on order. 0
page_number
* required
An integer greater than or equal to 1 for specifying the page number for the return values. -
page_size
* required
An integer greater than or equal to 1 for specifying the number of results on each page. 20
hide_paging
* required
Hide first row of paging information.
Options:
true
true

Output Fields

expand collapse
Name Description Type Example
name the readable name of the tag string Operating Revenue
tag the Intrinio standardized tag string operatingrevenue
parent the parent Intrinio standardized tag forming the statement relationship with the factor. number totalrevenue
factor the operator forming the statement relationship between the child tag (or tags) and the parent. string +
balance the accounting balance (debit or credit) of the tag amount credit
type the nature of the tag, operating or nonoperating string operating
units the unit of the tag string usd

Reported Financials

Returns the As Reported Financials directly from the financial statements of the XBRL filings from the company.

Parameters

expand collapse
Name Description Example
identifier
* required
The stock market ticker symbol associated with the companies common stock securities. AAPL
statement
* required
The financial statement requested, options include the income statement, balance sheet, statement of cash flows and calculated metrics and ratios.
Options:
income_statement
balance_sheet
cash_flow_statement
calculations
income_statement
type
* required
The type of periods requested - includes fiscal years for annual data, quarters for quarterly data and trailing twelve months for annual data on a quarterly basis.
Options:
FY
QTR
TTM
YTD
FY
xbrl_tag
* required
The specified XBRL tag. SalesRevenueNet
domain_tag
* required
The specified domain XBRL tag, associated with certain data points on the financial statements that have a dimension associated with the data point. excel
fiscal_year
* required
The fiscal year associated with the fundamental. 2015
fiscal_period
* required
The fiscal period associated with the fundamental.
Options:
FY
Q1
Q2
Q3
Q4
Q1TTM
Q2TTM
Q3TTM
Q2YTD
Q3YTD
FY
date
* required
The first fundamental will be the latest as of this specified date. 2017-03-02
sequence
* required
An integer 0 or greater for calling a single price from the first entry, based on sort order. 0
page_number
* required
An integer greater than or equal to 1 for specifying the page number for the return values. -
page_size
* required
An integer greater than or equal to 1 for specifying the number of results on each page. 10
hide_paging
* required
Hide first row of paging information.
Options:
true
true

Output Fields

expand collapse
Name Description Type Example
xbrl_tag the reported XBRL tag of the financial data point string -
domain_tag the reported domain XBRL tag string -
value the value of the XBRL tag of the financial data point number -

Reported Fundamentals

Returns a list of available as reported fundamentals (fiscal year, fiscal period, start date, and end date) for a given ticker and statement.

Parameters

expand collapse
Name Description Example
identifier
* required
The stock market ticker symbol associated with the companies common stock securities. AAPL
statement
* required
The financial statement requested, options include the income statement, balance sheet and statement of cash flows.
Options:
income_statement
balance_sheet
cash_flow_statement
income_statement
type
* required
The type of periods requested - includes fiscal years for annual data, quarters for quarterly data.
Options:
FY
QTR
FY
date
* required
The first fundamental will be the latest as of this specified date. 2014-09-28
item
* required
The return value for the fundamental.
Options:
fiscal_year
end_date
start_date
fiscal_period
filing_date
fiscal_year
sequence
* required
An integer 0 or greater for calling a single fundamental from the first entry. 0
page_number
* required
An integer greater than or equal to 1 for specifying the page number for the return values. -
page_size
* required
An integer greater than or equal to 1 for specifying the number of results on each page. 10
hide_paging
* required
Hide first row of paging information.
Options:
true
true

Output Fields

expand collapse
Name Description Type Example
fiscal_year the fiscal year of the fundamental nuber 2017
end_date the last date of the fundamental date 2018-07-15
start_date (not available on the balance sheet) the first date of the fundamental date 2011-09-15
fiscal_period the fiscal period of the fundamental string FY
filing_date datetime 2017-11-03 08:01:37 +0000

Reported XBRL Tags

Returns the As Reported XBRL tags and labels for a given ticker, statement, and date or fiscal year/fiscal quarter.

Endpoint:

Parameters

expand collapse
Name Description Example
identifier
* required
The stock market ticker symbol associated with the companies common stock securities. AAPL
statement
* required
The financial statement requested.
Options:
income_statement
balance_sheet
cash_flow_statement
income_statement
type
* required
The type of periods requested - includes fiscal years for annual data, quarters for quarterly data and trailing twelve months for annual data on a quarterly basis.
Options:
FY
QTR
FY
fiscal_year
* required
The fiscal year associated with the fundamental. 2016
fiscal_period
* required
The fiscal period associated with the fundamental.
Options:
FY
Q1
Q2
Q3
FY
date
* required
The first fundamental will be the latest as of this specified date. 2018-03-03
item
* required
The return value for the tag.
Options:
name
tag
balance
unit
domain_tag
abstract
sequence
depth
factor
name
sequence
* required
An integer 0 or greater for calling a single tag from the first entry, based on order. 0
page_number
* required
An integer greater than or equal to 1 for specifying the page number for the return values. -
page_size
* required
An integer greater than or equal to 1 for specifying the number of results on each page. 10
hide_paging
* required
Hide first row of paging information.
Options:
true
-

Output Fields

expand collapse
Name Description Type Example
name the label of the XBRL tag as reported of the financial statement string Net sales
tag the XBRL tag of the associated financial data point string SalesRevenueNet
balance the accounting balance (debit or credit) of the tag string credit
unit the unit type of the XBRL tag string usd
domain_tag the specified domain XBRL tag, associated with certain data points on the financial statements that have a dimension associated with the data point string -
abstract the type of value; true indicates that the value is a header label and has no associated data value, whereas false indicates that the XBRL tag has an associated value. boolean -
sequence an integer 0 or greater indicating the presentation order of the XBRL tag and label in the financial statement number 0
depth an integer 0 or greater indicating the presentation indentation depth of the XBRL tag and label in the financial statement number 1

Returns company list and information for all companies covered by Intrinio.

Endpoint:

Parameters

expand collapse
Name Description Example
query
* required
Used to search for a ticker or bank name to return relevant banks. Apple
identifier
* required
The stock market ticker symbol associated with the company’s common stock. If the company is foreign, use the stock exchange code, followed by a colon, then the ticker. AAPL
latest_filing_date
* required
a date value that returns the list of companies whose latest SEC filing was filed on or after this date 2011-07-15
page_number
* required
An integer greater than or equal to 1 for specifying the page number for the return values. 3
page_size
* required
An integer greater than or equal to 1 for specifying the number of results on each page. 10
hide_paging
* required
Hide first row of paging information.
Options:
true
-

Output Fields

expand collapse
Name Description Type Example
ticker the stock market ticker symbol associated with the companies common stock securities string AAPL
cik the Central Index Key issued by the SEC, which is the unique identifier all company filings are issued under string 0000004281
name the company name in shorter form string Alcoa Inc
legal_name the company’s official legal name string Alcoa Inc.
lei the Legal Entity Identifier for the company string ABPN11VOHLHX6QR7XQ48
hq_address1 the company’s headquarters address line 1 string 390 Park Avenue
hq_address2 the company’s headquarters address line 2 string Suite 200
hq_address_city the company’s headquarters city string New York
hq_address_postal_code the company’s headquarters postal code string 10022
entity_legal_form the company’s legal organization form string INCORPORATED
inc_state the state (US & Canada Only) where the company is incorporated string Pennsylvania
inc_country the country where the company is incorporated string United States of America
sic the Standard Industrial Classification (SIC) determined by the company filed with the SEC number 3350
stock_exchange the Stock Exchange where the company’s common stock is primarily traded string NYSE
template the financial statement template used by Intrinio to standardize the as reported data string industrial
short_description a one or two sentence description of the company’s operations string Alcoa Inc. engages in engineering and manufacturing lightweight metals worldwide.
long_description a one paragraph description of the company’s operations and other corporate actions string -
ceo the Chief Executive Officer of the company string Klaus-Christian Kleinfeld
company_url the url to the company’s primary corporate website or primary internet property string http://www.alcoa.com
business_address the company’s headquarters address string 390 PARK AVENUE, NEW YORK, NY 10022-4608
mailing_address the mailing address reported by the company string 390 PARK AVENUE, NEW YORK, NY 10022-4608
business_phone_no the phone number reported by the company string 2128362732
employees the number of employees working for the company number 60000
sector the company’s operating sector string Basic Materials
industry_category the company’s operating industry category string Metals & Mining
industry_group the company’s operating industry group string Aluminum
standardized_active if true, the company has standardized and as reported fundamental data via the Intrinio API; if false, the company has as reported data only. boolean true
securities the securities belonging to this company array -

Sample Data

expand collapse

Companies Master

Not available for this access method

Company Lookup

Not available for this access method

Company News

Returns the most recent news stories for a company.

Endpoint:

Parameters

expand collapse
Name Description Example
identifier
* required
The stock market ticker symbol associated with the company’s common stock. If the company is foreign, use the stock exchange code, followed by a colon, then the ticker. You may request up to 10 tickers at once by separating them with a comma. AAPL
item
* required
The return value for the row.
Options:
ticker
figi_ticker
figi
title
publication_date
summary
url
title
page_number
* required
An integer greater than or equal to 1 for specifying the page number for the return values. Note: using a page number is only allowed when specifying an identifier. If no identifier is specified, use start_date and end_date instead. -
page_size
* required
An integer greater than or equal to 1 for specifying the number of results on each page. -
start_date
* required
The earliest publication date of the news reports. 2015-12-31
start_time
* required
Return quotes at or after this time (24-hour, UTC). 09:30:00
end_date
* required
The latest publication date of the news reports. 2015-12-1
end_time
* required
Return quotes at or before this time (24-hour, UTC). 17:00:00
sequence
* required
An integer 0 or greater for calling a single news article from the first entry, most recent first. 0
hide_paging
* required
Hide first row of paging information.
Options:
true
true

Output Fields

expand collapse
Name Description Type Example
ticker the stock market ticker symbol associated with the companies common stock securities string AAPL
figi_ticker The OpenFIGI Ticker Symbol string ABC:CN
figi The FIGI identifier string BBG000C961K5
title the title of the article string How will Twitter's suitors reap its value?
publication_date the date the article was published timestamp 2016-09-25 12:12:33 +0000
url the hyperlink to the article string http://www.ft.com/cms/s/8d81a6da-82e6-11e6-8897-2359a58ac7a5,s01=1.html?ftcamp=traffic/partner/feed_headline/us_yahoo/auddev
summary a brief summary of the article string Twitter may finally be running out of time. News at the end of last week that Google and cloud software company Salesforce have both held preliminary discussions about a possible acquisition have underlined ...

Sample Data

expand collapse

Company News Lookup

Not available for this access method

Company SEC Filings

Returns the complete list of SEC filings for a company.

Parameters

expand collapse
Name Description Example
identifier
* required
The stock market ticker symbol associated with the company’s common stock. If the company is foreign, use the stock exchange code, followed by a colon, then the ticker. AAPL
report_type
* required
The report type of the filing requested. 8-K
start_date
* required
The earliest filing date for which to return filings, in the format. 2017-04-20
end_date
* required
The last filing date for which to return filings, in the format. 2017-07-20
page_number
* required
An integer greater than or equal to 1 for specifying the page number for the return values. -
page_size
* required
An integer greater than or equal to 1 for specifying the number of results on each page. 10
hide_paging
* required
Hide first row of paging information.
Options:
true
true

Output Fields

expand collapse
Name Description Type Example
filing_date the date the filing was submitted to the SEC by the company date 2016-09-23
accepted_date the date and time when the filing was submitted to the SEC by the company timestamp 2016-09-23 18:33:57 +0000
period_ended the date of the period end for the filing date 2016-09-21
accno the SEC unique number for the filing string 0001628280-16-019756
report_type the filing report type string 4
filing_url the URL to the filing page on the SEC site string https://www.sec.gov/Archives/edgar/data/320193/000162828016019756/0001628280-16-019756-index.htm
report_url the URL to the actual report on the SEC site string https://www.sec.gov/Archives/edgar/data/320193/000162828016019756/xslF345X03/wf-form4_147467002403491.xml
instance_url the URL for the XBRL filing for the report string -

Sample Data

expand collapse

Company SEC Filings Lookup

Not available for this access method

Latest SEC Filings

Returns a list of all SEC filings recorded within the past 30 days.

Endpoint:

Parameters

expand collapse
Name Description Example
page_number
* required
An integer greater than or equal to 1 for specifying the page number for the return values. 4
page_size
* required
An integer greater than or equal to 1 for specifying the number of results on each page. 100
hide_paging
* required
Hide first row of paging information.
Options:
true
true

Output Fields

expand collapse
Name Description Type Example
filing_date the date the filing was submitted to the SEC by the company date 2017-04-20
accepted_date the date and time when the filing was submitted to the SEC by the company timestamp 2017-04-20 18:24:23 -0700
period_ended the date of the period end for the filing date 2017-04-19
accno the SEC unique number for the filing string 0001077771-17-000077
report_type the filing report type string 4
filing_url the URL to the filing page on the SEC site string https://www.sec.gov/Archives/edgar/data/1077771/000107777117000077/0001077771-17-000077-index.htm
report_url the URL to the actual report on the SEC site string https://www.sec.gov/Archives/edgar/data/1077771/000107777117000077/xslF345X03/edgardoc.xml
instance_url the URL for the XBRL filing for the report string -
ticker the stock market ticker symbol associated with the company’s common stock securities string UMPQ
lei the Legal Entity Identifier for the company string 549300QGC3EY3EV0NS72
cik the Central Index Key issued by the SEC, which is the unique identifier all company filings are issued under string 0000811589

Sample Data

expand collapse

Latest SEC Filings Master

Not available for this access method

Bank Branches

Returns a list of bank branches covered by Intrinio.

Parameters

expand collapse
Name Description Example
ticker
* required
The stock market ticker symbol associated with the companies common stock securities. AAPL
rssd_id
* required
The bank/bank holding company RSSD ID issued by the Federal Reserve. 480228
uninumber
* required
The uninumber is the unique identifier for each bank branch office assigned by the Federal Reserve & the FDIC. 3
page_number
* required
An integer greater than or equal to 1 for specifying the page number for the return values. 2
page_size
* required
An integer greater than or equal to 1 for specifying the number of results on each page. 100
hide_paging
* required
Hide first row of paging information.
Options:
true
-

Output Fields

expand collapse
Name Description Type Example
rssd_id The unique number assigned by the Federal Reserve Board (FRB) to the institution. number 480228
bank_name Institution name string Bank of America, National Association
uninumber The unique number associated with a specific physical location of a branch. This number remains with this location over time, regardless of ownership. number 3
branch_number Numerical reference to identify a branch office within one institution number 7636
branch_name Branch name string Southington Main Branch
address Physical location of the branch string 100 5th Street South
city Reported city in which the branch is located string Saint Petersburg"
state The state abbreviation of the location in which the branch is physically located. string FL
zip_code The ZIP code associated with the physical address of the branch. string 33701
county County name in which the branch is located. string United States
state_no The FIPS number of the state in which the branch is physically located. number 12
state_and_county_no The state and county FIPS code associated with the specific branch location. number 103
central_city Central city based on the reported ZIP code of the branch string Saint Petersburg
latitude The lattitude of the branch’s physical location. number 27.770275932
longitude The longitude of the branch’s physical location number -82.64009368
location_quality The quality of the match of the branch’s physical location to a latitude and longitude with a given projection. string M
location_method The method used to arrive at the latitude and longitude of the branch’s physical location. string US_Streets
place_num The FIPS MCD (Minor Civil Division) code refers to a subsection of the U.S. Census county subdivision statistics. The county subdivision FIPS includes census data for county divisions, census subareas, minor civil divisions, unorganized territories, and incorporated areas number 93042
branch_service_type Code that defines the type of service the branch office provides number 11
main_office Main office / branch identifier; true=Main office, false=branch boolean true
msa_no The Metropolitan Statistical Areas (MSABR) are based on the 2010 Census - these areas correspond to the state/county/CBSA relationships as defined by the Census Bureau number 45300
msa The Metropolitan Statistical Area name in which the branch is physically located string Tampa-St. Petersburg-Clearwater, FL
csa_no The identifying code of a geographic entity consisting of two or more adjacent Core Based Statistical Areas (CBSAs) with employment interchange measures of at least 15 number 198
csa The name of a geographic entity consisting of two or more adjacent Core Based Statistical Areas (CBSAs) with employment interchange measures of at least 15 string -
cbsa_division_no A county or group of counties within a Core Based Statistical Area that contains a core with a population of at least 2.5 million number -
cbsa_division The name that corresponds to a code for a county or group of counties within a Core Based Statistical Area that contains a core with a population of at least 2.5 million string -
established_on The date that the branch location was established. string 1995-11-17
acquired_on The date that a branch was last acquired by another institution string -
reported_date The date the bank reported deposits for this branch string 2015-06-30
year The year the bank reported deposits for this branch number 2015
total_deposits Branch office deposits for the reported date number 390047000.0
deposits All recorded deposits for this bank branch array -

Sample Data

expand collapse

Bank Branches Master

Not available for this access method

Bank Branches Lookup by RSSD ID

Not available for this access method

Bank Financials

Returns the Bank Financials directly from the financial statements of the call report, UBPR report, and Y-9C XBRL filings from the bank issued with the FDIC.

Parameters

expand collapse
Name Description Example
identifier
* required
The stock market ticker symbol associated with the companies common stock securities, or the bank/bank holding company RSSD ID issued by the Federal Reserve. 2362074
statement
* required
The financial statement requested from the call report, the UBPR report, or the Y-9C report, which can be found from the bank fundamentals end point. RI
date
* required
The first fundamental will be the latest as of this specified date. 2018-01-01
sequence
* required
The sequence of the requested fundamental (i.e. 0 is the first available fundamental associated with the fiscal period type. 0
type
* required
The type of periods requested - includes fiscal years for annual data, quarters for quarterly data and trailing twelve months for annual data on a quarterly basis.
Options:
FY
QTR
TTM
YTD
FY
tag
* required
The specified bank call report, UBPR report, or Y-9C report XBRL tag. RIADA518
fiscal_year
* required
The fiscal year associated with the fundamental. 2018
fiscal_period
* required
The fiscal period associated with the fundamental.
Options:
FY
Q1
Q2
Q3
Q4
Q1TTM
Q2TTM
Q3TTM
Q2YTD
Q3YTD
Q4
rounding
* required
Round the returned value (actuals, thousands, millions, billions).
Options:
A
K
M
B
A
page_number
* required
An integer greater than or equal to 1 for specifying the page number for the return values. 22
page_size
* required
An integer greater than or equal to 1 for specifying the number of results on each page. 58
hide_paging
* required
Hide first row of paging information.
Options:
true
true

Output Fields

expand collapse
Name Description Type Example
tag the bank call report, UBPR report, or Y-9C report XBRL tag of the financial data point string RIAD4056
value the value of the XBRL tag of the financial data point number 1503000.0

Bank Fundamentals

Returns a list of available bank fundamentals (fiscal year, fiscal period, start date, and end date) for a given ticker/rssd_id and statement. Statements are from the bank call reports, UBPR reports, and Y-9C reports filed with the FDIC & Federal Reserve.

Parameters

expand collapse
Name Description Example
identifier
* required
The stock market ticker symbol associated with the companies common stock securities, or the bank/bank holding company RSSD ID issued by the Federal Reserve. 2362074
statement
* required
The call report/UBPR/Y-9C financial statement requested. RI
type
* required
The type of periods requested - includes fiscal years for annual data, quarters for quarterly data.
Options:
FY
QTR
YTD
FY
report
* required
Select report for all fundamentals.
Options:
call_report
ubpr
Y9C
Y9C
date
* required
The first fundamental will be the latest as of this specified date. 2014-12-31
item
* required
The return value for the fundamental.
Options:
statement_code
end_date
start_date
months
fiscal_year
fiscal_period
report
fiscal_year
sequence
* required
An integer 0 or greater for calling a single fundamental from the first entry. 0
page_number
* required
An integer greater than or equal to 1 for specifying the page number for the return values. -
page_size
* required
An integer greater than or equal to 1 for specifying the number of results on each page. 10
hide_paging
* required
Hide first row of paging information.
Options:
true
true

Output Fields

expand collapse
Name Description Type Example
statement_code the statement code for the financial statement from the report string RI
fiscal_year the fiscal year of the fundamental date 2015
fiscal_period the fiscal period of the fundamental date FY
end_date the last date of the fundamental date 2015-12-1
start_date (not available on the balance sheet) the first date of the fundamental date 2015-12-31
report the report the financial statement is sourced from, corresponding with the statement_code string call_report

Bank Holding Companies

Returns a list of bank holding companies covered by Intrinio.

Parameters

expand collapse
Name Description Example
query
* required
Used to search for a ticker or bank name to return relevant banks. Morgan
ticker
* required
The stock market ticker symbol associated with the companies common stock securities. TSLA
rssd_id
* required
The bank/bank holding company RSSD ID issued by the Federal Reserve. 1139523
page_number
* required
An integer greater than or equal to 1 for specifying the page number for the return values. 1
page_size
* required
An integer greater than or equal to 1 for specifying the number of results on each page. 10
hide_paging
* required
Hide first row of paging information.
Options:
true
true

Output Fields

expand collapse
Name Description Type Example
rssd_id High Regulatory Holder, The unique number assigned by the Federal Reserve Board to the regulatory high holding company of the institution. number 1139523
name Bank Holding Company (Regulatory Top Holder), Regulatory top holder is assigned by the Federal Reserve Board based on ownership and control percentages. string JP Morgan Chase & Co.
city City of High Holder, City in which the headquarters of the institution’s regulatory high holder are physically located. string New York
state Regulatory holding company state location, State location of the regulatory high holding company (either direct or indirect owner). string NY
banks List of banks under this holding company. array -

Sample Data

expand collapse

Bank Holding Companies Master

Not available for this access method

Bank Holding Companies Lookup

Not available for this access method

Bank XBRL Tags

Returns the Bank XBRL tags and labels for a given ticker/RSSD ID, statement, and date or fiscal year/fiscal quarter.

Endpoint:

Parameters

expand collapse
Name Description Example
identifier
* required
The stock market ticker symbol associated with the companies common stock securities, or the bank/bank holding company RSSD ID issued by the Federal Reserve. 2362074
statement
* required
The financial statement requested from the call report, the UBPR report or Y-9C report, which can be found from the bank fundamentals end point. RI
fiscal_year
* required
The fiscal year associated with the fundamental. 2015
fiscal_period
* required
The fiscal period associated with the fundamental.
Options:
FY
Q1
Q2
Q3
Q4
Q1TTM
Q2TTM
Q3TTM
Q2YTD
Q3YTD
FY
item
* required
The return value for the tag.
Options:
name
tag
unit
sequence
depth
abstract
name
sequence
* required
An integer 0 or greater for calling a single tag from the first entry. 0
page_number
* required
An integer greater than or equal to 1 for specifying the page number or the return values. 1
page_size
* required
An integer greater than or equal to 1 for specifying the number of results on each page. 10
hide_paging
* required
Hide first row of paging information.
Options:
true
true

Output Fields

expand collapse
Name Description Type Example
name the label of the XBRL tag as reported of the financial statement string Schedule RI - Income Statement
tag the XBRL tag of the associated financial data point string RI
unit the unit type of the XBRL tag string String
abstract the type of value - true indicates that the value is a header label and has no associated data value, whereas false indicates that the XBRL tag has an associated value. boolean true
sequence an integer 0 or greater indicating the presentation order of the XBRL tag and label in the financial statement number 1
depth an integer 0 or greater indicating the presentation indentation depth of the XBRL tag and label in the financial statement number 1

Returns a list of banks covered by Intrinio.

Endpoint:

Parameters

expand collapse
Name Description Example
query
* required
Used to search for a ticker or bank name to return relevant banks. Morgan
ticker
* required
The stock market ticker symbol associated with the companies common stock securities. TSLA
rssd_id
* required
The bank/bank holding company RSSD ID issued by the Federal Reserve. -
page_number
* required
An integer greater than or equal to 1 for specifying the page number for the return values. -
page_size
* required
An integer greater than or equal to 1 for specifying the number of results on each page. 10
hide_paging
* required
Hide first row of paging information.
Options:
true
true

Output Fields

expand collapse
Name Description Type Example
rssd_id Federal Reserve ID Number, A unique number assigned by the Federal Reserve board as the entity’s unique identifier - 480228
name Institution name, The legal name of the institution number C1 Bank
fdic_certificate_number FDIC Certificate Number, A unique NUMBER assigned by the FDIC used to identify institutions and for the issuance of insurance certificates number 34092
form31_filer FFIEC Call Report 31 Filer, A flag (true,false) that indicates whether and institution filed an FFIEC 031 Call Report. Commercial banks with domestic and foreign offices are required to file such a report. boolean true
address Physical Street Address, Street address at which the institution or one of its branches is physically located string 1111 Polaris Parkway
city City, City in which an institution’s headquarters or one of its branches is physically located. Either the entire name or part of the name of a specific city may be entered to produce an Institution List string Columbus
state State Name, State in which the the institution is physically located. The FDIC Act defines state as any State of the United States, the District of Columbia, and any territory of the United States, Puerto Rico, Guam, American Samoa, the Trust Territory of the Pacific Islands, the Virgin Island, and the Northern Mariana Islands string Ohio
zip_code Zip Code,The first three, four, or five digits of the full postal zip code representing physical location of the institution or its branch office string 43240
county County, County where the institution is physically located (abbreviated if the county name exceeds 16 characters) string Delaware
state_and_county_no State and county number, A five digit number representing the state and county in which the institution is physically located. The first two digits represent the FIPS state numeric code and the last three digits represent the FIPS county numeric code number 39041
state_no State Alpha code, State in which the the headquarters are physically located. number 39
url Primary Internet Web Address, The primary internet web address is the public internet site obtained from the most recent FFIEC Call Report string http://www.jpmorganchase.com
total_branches Offices, A branch/office is any location, or facility, of a financial institution, including its main office, where deposit accounts are opened, deposits are accepted, checks paid, and loans granted number 5446
domestic_branches Number of Domestic Offices, The number of domestic offices (including headquarters) operated by active institutions in the 50 states of the U.S.A. number 5344
foreign_branches Number of Foreign Offices, The number of foreign offices (outside the U.S.) operated by the institution. number 197
asset_concentration Name associated with the numeric indicator (SPECGRP) of an institution’s primary specialization in terms of asset concentration string International Specialization
asset_concentration_no Asset Concentration Hierarchy, An indicator of an institution’s primary specialization in terms of asset concentration number 3
occ_charter_number OCC Charter Number, A unique number assigned by the Office of the Comptroller of the Currency (OCC) used to identify institutions that it has chartered and regulates (i.e. national banks). number 8
fdic_geo_region_no FDIC Geographic Region, The FDIC Office assigned to the geographic area. number 9
fdic_supervisory_region FDIC Supervisory Region, The supervisory FDIC office assigned to the institution. string Chicago
fdic_supervisory_region_no A numeric value associated with the name of an FDIC supervisory region number 16
frb_district FDICSUPV, Federal Reserve District, “The supervisory FDIC office assigned to the institution. There are twelve Federal Reserve Districts, with two Districts serving one state in some instances. string 4
frb_district_no Federal Reserve ID Number, A number used to identify the Federal Reserve district in which the institution is located. number 3
ots_district_no OTS District, Office of Thrift Supervision (OTS) District number 3
ots_district Office of Thrift Supervision Region, Prior to 7/21/11, the Office of Thrift Supervision (OTS) Region in which the institution is physically located. string Washington
occ_district_no Office of the Comptroller, The Office of the Comptroller of the Currency (OCC) District in which the institution is physically located. number 3
regulator Regulator, There are three Federal regulators of banks and savings and loan institutions- FDI, FRB, OCC string OCC
state_charter State Charter, A flag (true;false) that indicates if an institution is state chartered. boolean -
federal_charter Federal charter flag, A flag used to indicate whether the institution is chartered by an agent of the federal government. boolean true
fdic_field_office FDIC Field Office, The FDIC Field Office where an institution is physically located. string Columbus
bank_class Bank Charter Class, A classification code assigned by the FDIC based on the institution’s charter type (commercial bank or savings institution), charter agent (state or federal), Federal Reserve membership status (Fed member, Fed nonmember) and its primary federal regulator (state chartered institutions are subject to both federal and state supervision) string N
chartering_agency Chartering Agency, All Chartering Agencies - State and Federal Comptroller of the Currency. string OCC
conservatorship CONSERVE, Conservatorship, A flag (1=yes;0=no) that indicates if an institution is being operated in government conservatorship. boolean -
interstate_branches Interstate Branches, A “yes” indicates that an institution has branches that can accept FDIC-insured deposits in more than one state. The FDIC Act defines state as any State of the United States, the District of Columbia, and any territory of the United States, Puerto Rico, Guam, American Samoa, the Trust Territory of the Pacific Islands, the Virgin Island, and the Northern Mariana Islands. boolean true
s_corp Subchapter S Corporations, Banks are required to indicate on the Call Report whether there is currently in effect an election to file under Subchapter S. boolean -
trust_fiduciary_services Trust Powers, A flag used to indicate an institution’s Trust Powers Granted status. False = No Trust Power Granted True = Trust Power Granted boolean true
community_bank FDIC community banks are identified based on criteria defined in the FDIC Community Banking Study boolean -
cmsa_no Consolidated Metropolitan Statistical Division Number, The numeric code given by the US Census Bureau office of Management and Budget number -
cmsa Consolidated Metropolitan Statistical Area, The Federal Information Processing Standards (FIPS) Consolidated Metropolitan Statistical Area (CMSA) code is a number representing the institution location string -
msa_no Metropolitan Statistical Area Number, The Metropolitan Statistical Area Number (MSA_NO) in which the institution is physically located number 1840
msa Metropolitan Statistical Area (MSA), The Metropolitan Statistical Areas based on Census Bureau data, as defined by the US Office of Management (OMB) prior to the year 2000 string Columbus, OH
csa_no Numeric Code for the Combined Statistical Area, The numeric code that the U.S. Census Bureau Office of Management and Budget assigns for the combined statistical area (CSA) per the 2000 standards number 198
csa Name of the Combined Statistical Area, The name associated with the numeric code that the U.S. Census Bureau Office of Management and Budget assigns for the combined statistical area (CSA) per the 2000 standards string Columbus-Marion-Zanesville, OH
cbsa_no Numeric Code for the Core Based Statistical Area, The numeric code that the U.S. Census Bureaus Office of Management and Budget assigns for the CBSA number 18140
cbsa Name of the Core Based Statistical Area, The name associated with the numeric code that the U.S. Census Bureau Office of Management and Budget assigns for the CBSA string Columbus, OH
cbsa_metro_no Numeric code assigned by the U.S. Census Bureau’s Office of Management and Budget for a metropolitan area within a CBSA number 18140
cbsa_metro Name associated with the numeric code that the U.S. Census Bureau’s Office of Management and Budget assigns for the metropolitan areas within a CBSA; are now also the basis for Metropolitan Statistical Areas (MSAs) string Columbus, OH
cbsa_division_no Core Based Statistical Division Number, The numeric code given by the US Census Bureau office of Management and Budget number -
cbsa_division Name of the Core Based Statistical Division, The name associated with the numeric code given by the US Census Bureau office of Management and Budget (2000 standards) that represents the core based statistical division (CBSADIV) string -
last_update Last update, The date of the last data update date 2015-09-24
last_structural_change Last Structure Change Process Date, A date field indicating the date that a change to this record was processed date 2015-08-31
established_on Established Date, The date on which the institution began operations date 1824-01-01
deposit_insurance_date Date of Deposit Insurance, The date that an institution obtained federal deposit insurance date 1934-01-01
active Active, True=Institutions who remain open currently, False=Institutions that are currently closed but were once insured by the FDIC boolean true

Sample Data

expand collapse
URL:

Banks Master

Not available for this access method

Banks Lookup

Not available for this access method

Security Corporate Actions

Returns all corporate actions for a security. Events 45+ types of corporate actions such as: Announcements and Annual Shareholder Meetings, Ex-date, Dividend pay date, Splits, Buy Backs, M&A and Takeovers, Bankruptcies and much more.

For in-depth documentation of each corporate action event-type please refer to the:

Corporate Action Events Reference

Parameters

expand collapse
Name Description Example
identifier
* required
The identifier for the specified security. AAPL
page_number
* required
An integer greater than or equal to 1 for specifying the page number for the return values. 3
page_size
* required
An integer greater than or equal to 1 for specifying the number of results on each page. 10

Output Fields

expand collapse
Name Description Type Example
event_id A unique event identifier string 1030388
event_code The event code string DIV
data_data Dynamic values relating to dates in the event object -
rate_date Dynamic values relating to rates in the event object -
field_data Dynamic values relating to fields in the event object -

Sample Data

expand collapse

Security Corporate Actions Lookup

Not available for this access method

Stock Exchange Corporate Actions

Returns all corporate actions for all securities listed on a specified stock exchange. A subscription to the EDI Corporate Actions Data Feed for a specific country will permit access to all stock exchanges in that country (ie, US includes NASDAQ, NYSE, BATS). Events 45+ types of corporate actions such as: Announcements and Annual Shareholder Meetings, Ex-date, Dividend pay date, Splits, Buy Backs, M&A and Takeovers, Bankruptcies and much more.

For in-depth documentation of each corporate action event-type please refer to the:

Corporate Action Events Reference

Parameters

expand collapse
Name Description Example
identifier
* required
The stock market ticker symbol associated with the companies common stock securities or the stock market index. ^XNYS
page_number
* required
An integer greater than or equal to 1 for specifying the page number for the return values. 3
page_size
* required
An integer greater than or equal to 1 for specifying the number of results on each page. 5

Output Fields

expand collapse
Name Description Type Example
ticker The stock exchange ticker symbol as listed on the stock exchange string TSLA
figi_ticker The OpenFIGI Ticker Symbol string ABC:CN
figi The FIGI identifier string BBG000C961K5
event_id A unique event identifier string 1030388
event_code The event code string DIV
data_data Dynamic values relating to dates in the event object -
rate_date Dynamic values relating to rates in the event object -
field_data Dynamic values relating to fields in the event object -

Sample Data

expand collapse

Stock Exchange Corporate Actions

Not available for this access method

Crypto Book

Returns the book (bid/ask prices and size) for a given currency pair and exchange.

Endpoint:

Parameters

expand collapse
Name Description Example
levels
* required
The number of prices/levels to return on each side. For example, the max of 50 levels will return up to 50 bid prices and 50 ask prices. 50
exchange
* required
The crypto exchange code. gemini
currency
* required
The crypto currency symbol. BTC
pair
* required
The crypto currency pair code. btcusd

Output Fields

expand collapse
Name Description Type Example
pair
Data for the provided crypto currency pair. object -
name
Crypto currency pair name. string BTCUSD
code
Crypto currency pair code. string btcusd
exchange
Data for the provided crypto exchange. object -
name
Crypto exchange name. string Binance
code
Crypto exchange code. string binance
last_updated UTC timestamp of when the prices were last updated. string 2018-07-19 21:00:00 UTC
bids
The bid prices and their respective sizes, in descending order of price. array -
price
The bid price of the book entry. float 6539.58
size
The size for the bid price of the book entry. float 0.03777
asks
The ask prices and their respective sizes, in ascending order of price. array -
price
The ask price of the book entry. float 6492.88
size
The size for the ask price of the book entry. float 1

Crypto Currencies

Returns a list of crypto currencies for which data is available.

Parameters

expand collapse
Name Description Example
exchange
* required
The crypto exchange code. gemini
hide_paging
* required
Hide first row of paging information.
Options:
true
true

Output Fields

expand collapse
Name Description Type Example
currencies
A list of crypto currencies for the given crypto exchange sorted by alphabetically by symbol. array -
name
Crypto currency name string Bitcoin
code
Crypto currency code string bitcoin
symbol
Crypto currency symbol string BTC
first_price_date
The earliest date that daily historical pricing is available for. string 2017-01-01
last_price_date
The most recent date that daily historical pricing is available for. string 2018-08-30

Sample Data

expand collapse

Crypto Currencies

Not available for this access method

Crypto Currency Pairs

Returns a list of crypto currency pairs for which data is available.

Endpoint:

Parameters

expand collapse
Name Description Example
exchange
* required
The crypto exchange code. gdax
currency
* required
The crypto currency symbol. BTC
hide_paging
* required
Hide first row of paging information.
Options:
true
true

Output Fields

expand collapse
Name Description Type Example
currency_pairs
A list of crypto currency pairs for the given crypto exchange and crypto currency sorted alphabetically by code. array -
name
Crypto currency pair name. string BTCUSD
code
Crypto currency pair code. string btcusd
first_price_date
The earliest date that daily historical pricing is available for. string 2017-01-01
last_price_date
The most recent date that daily historical pricing is available for. string 2018-08-30
book_depth_available
a boolean, representing whether this pair has book depth data available or not. boolean true
history_available
a boolean, representing whether this pair has historical price data available or not. boolean true
snapshot_available
a boolean, representing whether this pair has snapshot data available or not. boolean true
trades_available
a boolean, representing whether this pair has trade data available or not. boolean false
currencies
List of crypto currency symbols, sorted alphabetically, that are in this pair. array
exchanges
List of crypto exchange codes, sorted alphabetically, that this pair trades on. array

Sample Data

expand collapse

Crypto Currency Pairs

Not available for this access method

Crypto Currency Prices

Returns a list of crypto currency prices for which data is available.

Endpoint:

Parameters

expand collapse
Name Description Example
currency
* required
The crypto currency symbol. BTC
pair
* required
The crypto currency pair code. btcusd
exchange
* required
The crypto exchange code. binance
timeframe
* required
The time interval for the prices.
Options:
d1
h8
h6
h4
h3
h2
h1
m30
m15
m5
m1
h1
timezone
* required
Return price date/times in this timezone, also interpret start/end date/time parameters in this timezone
Options:
Africa/Algiers
Africa/Cairo
Africa/Casablanca
Africa/Harare
Africa/Johannesburg
Africa/Monrovia
Africa/Nairobi
America/Argentina/Buenos_Aires
America/Bogota
America/Caracas
America/Chicago
America/Chihuahua
America/Denver
America/Godthab
America/Guatemala
America/Guyana
America/Halifax
America/Indiana/Indianapolis
America/Juneau
America/La_Paz
America/Lima
America/Lima
America/Los_Angeles
America/Mazatlan
America/Mexico_City
America/Mexico_City
America/Monterrey
America/Montevideo
America/New_York
America/Phoenix
America/Regina
America/Santiago
America/Sao_Paulo
America/St_Johns
America/Tijuana
Asia/Almaty
Asia/Baghdad
Asia/Baku
Asia/Bangkok
Asia/Bangkok
Asia/Chongqing
Asia/Colombo
Asia/Dhaka
Asia/Dhaka
Asia/Hong_Kong
Asia/Irkutsk
Asia/Jakarta
Asia/Jerusalem
Asia/Kabul
Asia/Kamchatka
Asia/Karachi
Asia/Karachi
Asia/Kathmandu
Asia/Kolkata
Asia/Kolkata
Asia/Kolkata
Asia/Kolkata
Asia/Krasnoyarsk
Asia/Kuala_Lumpur
Asia/Kuwait
Asia/Magadan
Asia/Muscat
Asia/Muscat
Asia/Novosibirsk
Asia/Rangoon
Asia/Riyadh
Asia/Seoul
Asia/Shanghai
Asia/Singapore
Asia/Srednekolymsk
Asia/Taipei
Asia/Tashkent
Asia/Tbilisi
Asia/Tehran
Asia/Tokyo
Asia/Tokyo
Asia/Tokyo
Asia/Ulaanbaatar
Asia/Urumqi
Asia/Vladivostok
Asia/Yakutsk
Asia/Yekaterinburg
Asia/Yerevan
Atlantic/Azores
Atlantic/Cape_Verde
Atlantic/South_Georgia
Australia/Adelaide
Australia/Brisbane
Australia/Darwin
Australia/Hobart
Australia/Melbourne
Australia/Melbourne
Australia/Perth
Australia/Sydney
Etc/UTC
UTC
Europe/Amsterdam
Europe/Athens
Europe/Belgrade
Europe/Berlin
Europe/Berlin
Europe/Bratislava
Europe/Brussels
Europe/Bucharest
Europe/Budapest
Europe/Copenhagen
Europe/Dublin
Europe/Helsinki
Europe/Istanbul
Europe/Kaliningrad
Europe/Kiev
Europe/Lisbon
Europe/Ljubljana
Europe/London
Europe/London
Europe/Madrid
Europe/Minsk
Europe/Moscow
Europe/Moscow
Europe/Paris
Europe/Prague
Europe/Riga
Europe/Rome
Europe/Samara
Europe/Sarajevo
Europe/Skopje
Europe/Sofia
Europe/Stockholm
Europe/Tallinn
Europe/Vienna
Europe/Vilnius
Europe/Volgograd
Europe/Warsaw
Europe/Zagreb
Pacific/Apia
Pacific/Auckland
Pacific/Auckland
Pacific/Chatham
Pacific/Fakaofo
Pacific/Fiji
Pacific/Guadalcanal
Pacific/Guam
Pacific/Honolulu
Pacific/Majuro
Pacific/Midway
Pacific/Midway
Pacific/Noumea
Pacific/Pago_Pago
Pacific/Port_Moresby
Pacific/Tongatapu
Etc/UTC
start_date
* required
Return prices on or after this date. 2017-06-01
start_time
* required
Return prices at or after this time (24-hour, UTC). 14:20:00
end_date
* required
Return prices on or before this date. 2017-06-30
end_time
* required
Return prices at or before this time (24-hour, UTC). 23:01:21
sort_order
* required
The order of the price quotes.
Options:
asc
desc
asc
page_number
* required
An integer greater than or equal to 1 for specifying the page number for the return values. 3
page_size
* required
An integer greater than or equal to 1 for specifying the number of results on each page. 10
hide_paging
* required
Hide first row of paging information.
Options:
true
true

Output Fields

expand collapse
Name Description Type Example
pair
Data for the provided crypto currency pair. object -
name
Crypto currency pair name. string BTCUSD
code
Crypto currency pair code. string btcusd
exchange
Data for the provided crypto exchange. object -
name
Crypto exchange name. string Binance
code
Crypto exchange code. string binance
timeframe The time interval for the crypto currency prices. string h1
prices
All the BAR prices, time, and volume. array -
time
The date and time of the beginning of the timeframe (in UTC). The open prices would be at this time, while close prices would be at this time plus the timeframe. timestamp 2018-07-19 21:00:00 UTC
open
Open number 6497.87
high
High number 6529.99
low
Low number 6228.3
close
Close number 6310.23
volume
Volume number 1985.1821584057

Crypto Exchanges

Returns a list of crypto exchanges for which data is available.

Parameters

expand collapse
Name Description Example
pair
* required
The crypto currency pair code. btcusd
hide_paging
* required
Hide first row of paging information.
Options:
true
true

Output Fields

expand collapse
Name Description Type Example
exchanges
A list of exchanges for the given crypto currency pair sorted alphabetically by code. array -
name
Crypto exchange name. string Binance
code
Crypto exchange code. string binance
history_available
A boolean, representing whether historical data is provided by this exchange or not. boolean true
book_depth_available
A boolean, representing whether book depth data is provided by this exchange or not. boolean true
trades_available
A boolean, representing whether trade data is provided by this exchange or not. boolean true
snapshot_available
A boolean, representing whether snpashot data is provided by this exchange or not. boolean true
pairs
List of crypto currency pair codes, sorted alphabetically, that trade on this exchange. array

Sample Data

expand collapse

Crypto Exchanges

Not available for this access method

Crypto Snapshot

Returns a market snapshot over that last 24 hours for the given currency pair and exchange.

Parameters

expand collapse
Name Description Example
exchange
* required
The crypto exchange code. gemini
currency
* required
The crypto currency symbol. BTC
pair
* required
The crypto currency pair code. btcusd

Output Fields

expand collapse
Name Description Type Example
pair
Data for the provided crypto currency pair. object -
name
Crypto currency pair name. string BTCUSD
code
Crypto currency pair code. string btcusd
exchange
Data for the provided crypto exchange. object -
name
Crypto exchange name. string Binance
code
Crypto exchange code. string binance
snapshot
The data from the snapshot of the market. object -
last_updated
UTC timestamp of when the snapshot was last updated string 2018-07-19 21:00:00 UTC
bid
The bid for the currency pair on the exchange. float 6539.58
bid_size
The size of the bid for the currency pair on the exchange. float 0.03777
ask
The ask for the currency pair on the exchange. float 6492.88
ask_size
The size of the ask for the currency pair on the exchange. float 1
change
The notional change in price over the last 24 hours. float -39.4649999900003
change_percent
The percent change in price over the last 24 hours. float -0.590351533133886
volume
The volume of the currency pair on the exchange. float 35.20315282
open
The opening price of the currency on the exchange. float 6685
high
The highest price of the currency on the exchange for the last 24 hours. float 6685
low
The lowest price of the currency on the exchange for the last 24 hours. float 6645.535
market_cap_usd
The market cap of the currency pair in USD. float 114505512488
available_supply
The available supply of the currency pair on the exchange. float 17312950
total_supply
The total supply of the currency pair on the exchange. float 17312950
max_supply
The maxmium supply of coins available to mine. float 21000000
last_trade_side
The side of the last trade, either buy or sell. string buy
last_trade_time
UTC timestamp of the last trade for the currency pair on the exchange. string 2018-07-19 21:00:00 UTC
last_trade_price
The price of the last trade for the currency pair on the exchange. float 6492.88
last_trade_size
The size of the last trade for the currency pair on the exchange. float 0.3455

Forex Currencies

Returns a list of forex currencies for which prices are available.

Endpoint:

Parameters

expand collapse
Name Description Example
hide_paging
* required
Hide first row of paging information.
Options:
true
true

Output Fields

expand collapse
Name Description Type Example
code ISO 4217 currency code string AUD
name Currency name string Dollar
country Country in which currency is used string Australia

Sample Data

expand collapse

Currency Master

Not available for this access method

Forex Currency Pairs

Returns a list of currency pairs used to request foreign exchange (forex) market price data. The currency that is used as the reference is called quote currency and the currency that is quoted in relation is called the base currency. For example, in the pair code “EURGBP” with a price of 0.88, one Euro (base currency) can be exchanged for 0.88 British Pounds (quote currency).

Parameters

expand collapse
Name Description Example
hide_paging
* required
Hide first row of paging information.
Options:
true
true

Output Fields

expand collapse
Name Description Type Example
code The code of the currency pair used for the currency_prices endpoint string EURUSD
base_currency ISO 4217 currency code of the base currency string EUR
quote_currency ISO 4217 currency code of the quote currency string USD

Sample Data

expand collapse

Currency Pairs Master

Not available for this access method

Forex Currency Prices

Provides a list of forex price quotes for a given forex currency pair and timeframe.

Parameters

expand collapse
Name Description Example
pair
* required
The currency trading pair. EURUSD
timeframe
* required
The time interval for the quotes.
Options:
m1
m5
m15
m30
H1
H2
H3
H4
H6
H8
D1
W1
M1
D1
timezone
* required
Return price date/times in this timezone, also interpret start/end date/time parameters in this timezone
Options:
Africa/Algiers
Africa/Cairo
Africa/Casablanca
Africa/Harare
Africa/Johannesburg
Africa/Monrovia
Africa/Nairobi
America/Argentina/Buenos_Aires
America/Bogota
America/Caracas
America/Chicago
America/Chihuahua
America/Denver
America/Godthab
America/Guatemala
America/Guyana
America/Halifax
America/Indiana/Indianapolis
America/Juneau
America/La_Paz
America/Lima
America/Lima
America/Los_Angeles
America/Mazatlan
America/Mexico_City
America/Mexico_City
America/Monterrey
America/Montevideo
America/New_York
America/Phoenix
America/Regina
America/Santiago
America/Sao_Paulo
America/St_Johns
America/Tijuana
Asia/Almaty
Asia/Baghdad
Asia/Baku
Asia/Bangkok
Asia/Bangkok
Asia/Chongqing
Asia/Colombo
Asia/Dhaka
Asia/Dhaka
Asia/Hong_Kong
Asia/Irkutsk
Asia/Jakarta
Asia/Jerusalem
Asia/Kabul
Asia/Kamchatka
Asia/Karachi
Asia/Karachi
Asia/Kathmandu
Asia/Kolkata
Asia/Kolkata
Asia/Kolkata
Asia/Kolkata
Asia/Krasnoyarsk
Asia/Kuala_Lumpur
Asia/Kuwait
Asia/Magadan
Asia/Muscat
Asia/Muscat
Asia/Novosibirsk
Asia/Rangoon
Asia/Riyadh
Asia/Seoul
Asia/Shanghai
Asia/Singapore
Asia/Srednekolymsk
Asia/Taipei
Asia/Tashkent
Asia/Tbilisi
Asia/Tehran
Asia/Tokyo
Asia/Tokyo
Asia/Tokyo
Asia/Ulaanbaatar
Asia/Urumqi
Asia/Vladivostok
Asia/Yakutsk
Asia/Yekaterinburg
Asia/Yerevan
Atlantic/Azores
Atlantic/Cape_Verde
Atlantic/South_Georgia
Australia/Adelaide
Australia/Brisbane
Australia/Darwin
Australia/Hobart
Australia/Melbourne
Australia/Melbourne
Australia/Perth
Australia/Sydney
Etc/UTC
UTC
Europe/Amsterdam
Europe/Athens
Europe/Belgrade
Europe/Berlin
Europe/Berlin
Europe/Bratislava
Europe/Brussels
Europe/Bucharest
Europe/Budapest
Europe/Copenhagen
Europe/Dublin
Europe/Helsinki
Europe/Istanbul
Europe/Kaliningrad
Europe/Kiev
Europe/Lisbon
Europe/Ljubljana
Europe/London
Europe/London
Europe/Madrid
Europe/Minsk
Europe/Moscow
Europe/Moscow
Europe/Paris
Europe/Prague
Europe/Riga
Europe/Rome
Europe/Samara
Europe/Sarajevo
Europe/Skopje
Europe/Sofia
Europe/Stockholm
Europe/Tallinn
Europe/Vienna
Europe/Vilnius
Europe/Volgograd
Europe/Warsaw
Europe/Zagreb
Pacific/Apia
Pacific/Auckland
Pacific/Auckland
Pacific/Chatham
Pacific/Fakaofo
Pacific/Fiji
Pacific/Guadalcanal
Pacific/Guam
Pacific/Honolulu
Pacific/Majuro
Pacific/Midway
Pacific/Midway
Pacific/Noumea
Pacific/Pago_Pago
Pacific/Port_Moresby
Pacific/Tongatapu
Etc/UTC
start_date
* required
Return quotes on or after this date. 2017-06-01
start_time
* required
Return quotes at or after this time (24-hour, UTC). -
end_date
* required
Return quotes on or before this date. 2017-06-30
end_time
* required
Return quotes at or before this time (24-hour, UTC). -
page_number
* required
An integer greater than or equal to 1 for specifying the page number for the return values. 3
page_size
* required
An integer greater than or equal to 1 for specifying the number of results on each page. 10
sort_order
* required
The order of the price quotes.
Options:
asc
desc
asc
hide_paging
* required
Hide first row of paging information.
Options:
true
true

Output Fields

expand collapse
Name Description Type Example
date The date and time of the beginning of the timeframe (in UTC). The open prices would be at this time, while close prices would be at this time plus the timeframe. timestamp 2018-07-19 21:00:00 UTC
open_bid Open bid number 0.87962
high_bid High bid number 0.88137
low_bid Low bid number 0.87582
close_bid Close bid number 0.87591
open_ask Open Ask number 0.87972
high_ask High Ask number 0.88151
low_ask Low Ask number 0.87646
close_ask Close Ask number 0.87733
total_ticks Total Ticks number 199438

Sample Data

expand collapse

Crypto Currency Stats

Returns a list of crypto currencies and stats for which data is available.

Parameters

expand collapse
Name Description Example
exchange
* required
The crypto exchange code. gemini
currency
* required
The crypto currency symbol. BTC
hide_paging
* required
Hide first row of paging information.
Options:
true
true

Output Fields

expand collapse
Name Description Type Example
currencies
A list of crypto currencies and their stats. array -
name
Crypto currency name string Bitcoin
code
Crypto currency code string bitcoin
symbol
Crypto currency symbol string BTC
market_cap_usd
The market cap of the crypto currency in USD. float 113600514804
available_supply
The available supply of the crypto currency. float 17314825
total_supply
The total supply of the crypto currency. float 17314825
max_supply
The maxmium supply of coins available to mine. float 117314825
last_updated
UTC timestamp of when the data was last updated. string 2018-07-19 21:00:00 UTC

Sample Data

expand collapse

Crypto Currency Stats

Not available for this access method

EPS Surprises

Returns earnings surprise data for a given security or for all securities an earnings report date.

Parameters

expand collapse
Name Description Example
identifier
* required
An identifier for the company or security, including the ticker symbol, FIGI, SEC CIK ID. AAPL
earnings_date
* required
A specified date to return earnings for all securities on that date. 2017-02-12
page_number
* required
An integer greater than or equal to 1 for specifying the page number for the return values. 1
page_size
* required
An integer greater than or equal to 1 for specifying the number of results on each page. 5
hide_paging
* required
Hide first row of paging information.
Options:
true
true

Output Fields

expand collapse
Name Description Type Example
ticker the stock market ticker symbol associated with the companies common stock securities string A
figi_ticker the OpenFIGI ticker symbol string A:UN
figi the OpenFIGI identifier string BBG000C2V541
fiscal_year the company’s fiscal year for the reported period date 2015
fiscal_quarter the company’s fiscal quarter for the reported period string Q4
calendar_year the closest calendar year for the company’s fiscal year date 2015
calendar_quarter the closest calendar quarter for the company’s fiscal year string Q4
actual_reported_date actual report date for the earnings release date 2017-01-31
actual_reported_time actual report time for the earnings release string 59400
actual_reported_code the code cooresponding to the earnings release BTO = BEFORE THE OPEN | DTM = DURING THE MARKET | AMC = AFTER MARKET CLOSE string AMC
actual_reported_desc the description for the type of earnings release string AFTER
eps_actual the actual Non-GAAP EPS figure released by the company, interpreted by Zacks. number 3.36
eps_actual_zacks_adj the adjustments Zacks made to get to Non-GAAP EPS to reconcile with GAAP EPS. number 0
eps_mean_estimate the pre-earnings release mean EPS estimate for the company number 3.22
eps_count_estimate the pre-earnings release number of estimates by analysts number 15
eps_std_dev_estimate the pre-earnings release standard deviation of EPS estimates number 0.08
eps_amount_diff EPS surprise amount difference number 0.14
eps_percent_diff EPS surprise percent difference number 0.0435

Sample Data

expand collapse

ETF Current Holdings

Return the current holdings of an exchange traded fund.

Parameters

expand collapse
Name Description Example
identifier
* required
The identifier of an exchange traded fund (ticker, CUSIP, ISIN, RIC). IGM

Output Fields

expand collapse
Name Description Type Example
as_of_date As Of Date date 2018-04-05
etf_name ETF Name string iShares North American Tech ETF
etf_ticker ETF Ticker string IGM
name Constituent Name string MARATHON PETROLEUM CORP
type Constituent Type string EQUI
ticker Constituent Ticker string MPC
figi_ticker the OpenFIGI ticker string MPC:US
composite_figi the OpenFIGI composite identifier string BBG001DCCGR8
cusip CUSIP is an acronym that refers to Committee on Uniform Security Identification Procedures and the nine-digit, alphanumeric CUSIP numbers that are used to identify securities, including municipal bonds. A CUSIP number, similar to a serial number, is assigned to each maturity of a municipal security issue. string 56585A102
isin International Securities Identification Number