Introduction
# API Endpoint
https://api.intrinio.com
Welcome to the Intrinio API! Through our Intrinio Data Marketplace, we offer a wide selection of financial data feeds sourced by our own proprietary processes as well as from many data vendors. The primary application of the Intrinio API is for use in third-party applications and integrations or for end-users utilizing the Excel add-in and Google Sheets add-on.
The Intrinio API uses HTTPS verbs and a RESTful endpoint structure, which makes it easy to request data from Intrinio. Basic Authentication is administered over HTTPS. Responses are delivered in JSON format.
If you need additional help in using the API, send us a message by clicking the Help widget in the bottom right corner at anytime.
Authentication
To authorize your access to the Intrinio API:
// With shell, you must include the username and
// password header
curl "https://api.intrinio.com/data_point?identifier=AAPL&item=close_price"
-u "API_USERNAME:API_PASSWORD"
// With the '-u' option in curl, it will automatically
// convert the username and password into the
// appropriate header. If you do not use this
// option or it is not available to you, you must
// include a header with the basic auth credentials
// included as base64 encoded.
curl "https://api.intrinio.com/data_point?identifier=AAPL&item=close_price"
-H "Authorization: Basic $BASE64_ENCODED(USERNAME:PASSWORD)"
// When prompted by the Intrinio Excel add-in, either
// by selecting the API Keys button on the ribbon or
// when prompted, enter your API Username and API
// Password.
// When prompted by the Intrinio Google Sheets add-on
// on the side bar, enter your API Username and API
// Password.
The Intrinio API uses Basic Authentication over HTTPS.
You can find your API Username and API Password on your User Admin Dashboard of the site. You must include your credentials with every request in order to receive access to the API.
If your API Keys cannot be authorized, a status code of 401 will be returned.
Response Codes
// Each API Error Response will include a response
// code, a readable response code, and a message.
// These Error Responses will give you enough
// information to diagnosis any potential issues
// with your access to the Intrinio API.
// There are three errors typically seen in the
// Excel add-in. You will see these errors as
// responses to Intrinio Functions in cells.
// "Invalid API Keys"
// -- HTTP Response Code 401
// -- You User/Password API Keys are incorrect
// "Visit Intrinio.com to Subscribe"
// -- HTTP Response Code 403
// -- You are not subscribed to the data feed requested
// "Plan Limit Reached"
// -- HTTP Response Code 429
// -- You have hit your 10-minute throttled limit or your
// daily limit for the subscription
// Intrinio API Response Codes are not utilized in the
// Intrinio Google Sheets add-on. However, you may see
// various errors associated with Google Apps, such as:
// "Service invoked too many times in a short time:
// Properties. Try Utilities.sleep(1000) between calls."
// -- You have made too many calls via the Google Apps
// system too quickly and Google has throttled your
// service.
// "Service using too much computer time for one day."
// -- You have made too many calls for the day and
// your access has been cut off for the remainder
// of the day.
Intrinio uses normal HTTP response codes to indicate the success or failure of an API request. A response code of 200 indicates success and codes in the 4xx range indicate an error that failed given the information provided, and codes in the 5xx range indicate an error with Intrinio’s servers (these are rare).
The Intrinio API uses the following error codes:
| Error Code | Meaning |
|---|---|
| 200 | OK – Everything worked as expected |
| 401 | Unauthorized – Your User/Password API Keys are incorrect |
| 403 | Forbidden – You are not subscribed to the data feed requested |
| 404 | Not Found – The end point requested is not available |
| 429 | Too Many Requests – You have hit a limit. See Limits |
| 500 | Internal Server Error – We had a problem with our server. Try again later. |
| 503 | Service Unavailable – You have hit your throttle limit or Intrinio may be experiencing difficulties. |
Paging
{
"result_count": 8155,
"page_size": 250,
"current_page": 1,
"total_pages": 33
}
Often there is too much information in our system to serve in a single request of reasonable size. Therefore we limit results to a certain number per request and provide you with paging information which can be used to retrieve the remaining pages of data.
In the Web API, you will notice that most requests contain paging information.
File Downloads may have paging information as well, listed in the first row.
In order to request the next page of data, append a page_number parameter to your request:
https://api.intrinio.com/companies
https://api.intrinio.com/companies?page_number=2
https://api.intrinio.com/companies?page_number=3
Limits
Overview
The Intrinio API employs several reasonable limits to ensure that stable, reliable service is provided to all users. These limits can vary based on which data feeds you are subscribed to, as well as which API call you are making. The limits are grouped as: daily calls, 10-minute calls, paging, throttling, and timeouts. If you hit an API limit, the response will contain a 429 code and an explanation of the limit.
Daily Call Limits
Most data feed subscriptions have limited daily usage. This means that you can make up to a certain number of API calls in a 24-hour period (resetting at midnight Eastern). To view the limits for a data feed subscription, go to your Account page and click on Limits next to the data feed subscription in question.
10-Minute Call Limits
Some data feed subscriptions have limited 10-minute usage. This means that you can make up to a certain number of API calls in a 10-minute period. To view the limits for a data feed subscription, go to your Account page and click on Limits next to the data feed subscription in question.
Paging Limits
API endpoints that employ paging are limited by the maximum page size that you may request. This varies by endpoint:
| Endpoint | Maximum Page Size |
|---|---|
| /historical_data | 1,000 |
| File Download (CSV) | 10,000 |
| All others | 100 |
Throttle Limits
Users enjoying free data feed subscriptions only are limited to 100 requests-per-second.
File Download (CSV)
File Downloads are limited to one request per second and a maximum of 10,000 results per page.
Timeout Limits
Each request must be fulfilled within 25 seconds, otherwise it will be dropped with a 503 error. Given the flexibility of our endpoints and the complexity of potential API calls, we leave it to the users to fashion requests which can be satisfied in a reasonable time.
Usage
The following endpoints will help you to check your API access, limits, and usage.
Note: this is limited to data feeds with daily API call limits.
Access & Limits
// API URI: https://api.intrinio.com
// GET: /usage/access
// FULL URL: https://api.intrinio.com/usage/access
{
{
"access_code": "com_fin_data",
"daily_limit": 3000
},
{
"access_code": "com_sec_master_data",
"daily_limit": 10000
},
{
"access_code": "econ_data",
"daily_limit": 3000
},
...
}
Function not available
Function not available
Returns a list of your authorized access codes and their daily limits.
Endpoint
https://api.intrinio.com/usage/access
Return Values
- access_code - the access code
- daily_linit - your daily API call limit for the access code
Access Codes
Access codes represent the data you are allowed to access. Each API call counts against a particular access code. The access codes correspond to data feeds:
- com_sec_master_data - Global Public Company Security Master Data Feed
- com_fin_data - US Public Company Financials Data Feed
- industry_data - US Sector & Industry Data Feed
- fdic_data - US Bank & Bank Holding Company Data Feed
- econ_data - US & Global Economic Data Feed
- insider_trans - US Insider Transactions & Ownership Data Feed
- inst_hold - US Institutional Holdings Data Feed
There are also many third-party data feeds that have their own access codes.
Current
// API URI: https://api.intrinio.com
// GET: /usage/current?access_code=com_fin_data
// FULL URL: https://api.intrinio.com/usage/current?access_code=com_fin_data
{
"access_code": "com_fin_data",
"current": 780,
"limit": 3000,
"percent": 126
}
=IntrinioDataPoint("com_fin_data","api_usage")
=IntrinioDataPoint("com_fin_data","api_usage")
Return today’s current usage and limit information for the given access code.
Endpoint
https://api.intrinio.com/usage/current?access_code={access_code}
Parameters
- access_code - the access code
Return Values
- access_code - the access code
- current - your current API call count
- limit - your daily API call limit
- percent - the percentage of your API call limit that you have used today
Historical
// API URI: https://api.intrinio.com
// GET: /usage/historical?access_code=com_fin_data
// FULL URL: https://api.intrinio.com/usage/historical?access_code=com_fin_data
{
"result_count": 117,
"page_size": 250,
"current_page": 1,
"total_pages": 1,
"data": [
{
"date": "2017-03-16",
"calls": 58
},
{
"date": "2017-03-15",
"calls": 1115
},
{
"date": "2017-03-14",
"calls": 93
},
...
]
}
=IntrinioHistoricalData("com_fin_data","api_usage",0)
=IntrinioHistoricalData("com_fin_data","api_usage",0)
Return today’s current usage and limit information for the given access code.
Endpoint
https://api.intrinio.com/usage/historical?access_code={access_code}
Parameters
- access_code - the access code
Return Values
- date - the date
- calls - the number of calls made that day, for the access code
Coverage
Companies & Securities
U.S. Public Company Securities
Our coverage space includes all publicly traded companies in the United States. We cover all companies who are listed on the NYSE, NASDAQ and BATS Stock Exchanges. Our coverage for these companies is comprehensive, which includes historical pricing data for every publicly traded security, including non-common stock securities.
In addition, this coverage includes exchange traded funds (ETFs), various classes of common stock, American Depositary Shares (ADRs), preferred stock, warrants and much more, totaling over 9,000 securities.
International Securities
We recently added coverage for over 100,000 global publicly traded securities. This includes both active and de-listed securities. We have integrated substantially with OpenFIGI to have a unified standard securities master at the core of our architecture. With OpenFIGI, you can utilize a whole host of identifiers to query the OpenFIGI API, which will map those identifiers, to the FIGI identifier, and allow us to retrieve the correct data requested.
You can learn more about OpenFIGI here.
To access the Company Master via API, use the /companies end point in the Intrinio Master Data Feed
To access the Security Master via API, use the /securities end point in the Intrinio Master Data Feed
Indices
We offer access to hundreds of thousands of indices that cover three primary areas: stock market indices, SIC (sector/industry) indices, and economic indices.
To access the Index Master via API, use the /indices end point in the Intrinio Master Data Feed
Stock Market Indices
We have historical end-of-day values for 13 stock market indices, back to the 1950s at the earliest. The values include the daily/weekly/monthly/quarterly/yearly high, low, open, close (last price), and volume.
You can view the Stock Market Indices Master here.
SIC Indices
We offer aggregated sector and industry data based on company reported Standard Industrial Classification numbers. These indices are updated monthly, reflecting all newly reported filings. An Intrinio SIC Index is created with the following format: $SIC.XXXX.
You can view the SIC Indices Master here.
Economic Indices
We provide access to over 200,000 economic data series. Below is a list of the 1,000 most popular economic data series. However, you can access all the data series by querying the Intrinio API Indices or by going to the Federal Reserve Economic Data website. The index symbol is the same as the Series ID on FRED, however you put place a “$” before the series ID for the Intrinio API to recognize that it is an index.
You can view the Economic Indices Master here.
Damodaran Equity Risk Premiums
We offer access to Aswath Damodaran’s Equity Risk Premiums provided through his website at NYU. This data is helpful for the valuation community looking for a monthly updated ERP, calculated by one of the main authorities on valuation. This data updates each month with the latest calculation after it is published to Damodaran’s site.
You can learn more about the Damodaran ERP here.
Owners
We aggregate insider transactions and institutional holdings data to create a unified Owner Master. These are either individual or companies who own securities and must report this ownership to the SEC.
To access the Owner Master via API, use the /owners end point in the Intrinio Master Data Feed
Insider Owners
All directors, officers, 10%+ owners, and other related owners must report all insider transactions in the company when buying or selling securities. This includes open market purchases, sales, stock option grants, conversions, gifts and many other transactions. These transactions are reported in Form 3, 4 & 5 filed by the owner with the SEC.
We aggregate all direct and indirect ownership interests for each owner in related companies to provide a snapshot as to the value of the interests these insider owners control in the company.
Institutional Owners
Each quarter, firms who are institutional owners of securities must report their holdings to the SEC with form 13F. We offer access to the reported holdings data via API.
File Downloads (CSV)
All of our data is available for download in the CSV (comma-separated values) format.
To make use of this feature, simply append .csv to the web address file name of the request:
https://api.intrinio.com/indices?type=economic
https://api.intrinio.com/indices.csv?type=economic
Some requests may require paging (see Paging for details).
See the File Download Tutorial for instructions on how to get started, along with a helpful list of download links.
See the Download Link Maker for a tool to easily create download links.
Spreadsheet Add-ins
Intrinio Excel Add-in
Intrinio offers an Excel add-in in the Intrinio App Marketplace, which extends the functionality of Microsoft Excel by enabling you to access the Intrinio API without any programming experience. This Excel Add-in works on both Mac OS X and Microsoft Windows versions of Excel.
Examples of how to access the API end points via the Excel add-in can be viewed by selecting the Excel option in the code examples of this documentation. We also have dedicated Intrinio Excel Add-in Documentation.
Intrinio App Marketplace
Windows
For all versions of Windows running Excel 2010 or newer. Download Intrinio_Excel_Addin.exe
Mac OS X (64-bit)
For users running OS X and the latest version of 64-bit Excel 2016 Download Intrinio_Excel_Addin.zip
Mac OS X (32-bit)
For users running OS X and older versions of 32-bit Excel 2016 and Excel 2011 Download Intrinio_Excel_Addin.zip
Github
Intrinio Screener for Excel
Intrinio has built a screener in Excel, proving an interface to the Intrinio Securities Search API end point. The Intrinio Screener for Excel allows users to screen based on up to 500 daily parameters for free without leaving Excel Online. Users can filter based on familiar parameters such as P/E ratios and dividend yield as well as hundreds of unique items from company balance sheets and income statements. The resulting list of tickers includes the datapoints used in the screen in a nice, neat table in Excel that integrates with the Intrinio Excel add-on for further analysis.
Intrinio App Marketplace
Microsoft Office App Store
Intrinio Google Sheets add-on
Intrinio also has a Google Sheets add-on available through the Intrinio App Marketplace, which extends the functionality of Google Sheets by enabling you to access the Intrinio API on most mobile devices. This Google Sheets add-on works on all devices that support Google Sheets - smart phone, tablet, Chrome OS, Mac OS, Windows OS, etc. With the power of Google Sheets, Intrinio offers the most flexible access to financial data - anywhere, anytime.
Examples of how to access the API end points via the Google Sheets add-on can be viewed by selecting the Sheets option in the code examples of this documentation. We also have dedicated Intrinio Google Sheets add-on Documentation
Intrinio App Marketplace
Chrome Store
GitHub
SDKs
We are open to working with developers in the open source community to build and maintain unofficial SDKs that simplify the usage of the Intrinio API in various programming languages. In the future, we plan on supporting Ruby, Java, Node.js, Python, PHP, .Net, and Javascript.
Node.js (Unofficial Release)
Other SDKs
In the future, we plan on supporting Ruby, R, Java, Node.js, Python, PHP, .Net, and Javascript. We are open to working with developers in the open source community to build and maintain unofficial SDKs that simplify the usage of the Intrinio API in various programming languages.
Master Data Feed
Company Master
// API URI: https://api.intrinio.com
// GET: /companies
// FULL URL: https://api.intrinio.com/companies
{
"result_count": 8155,
"page_size": 250,
"current_page": 1,
"total_pages": 33,
"api_call_credits": 1,
"data": [
{
"ticker": "A",
"name": "Agilent Technologies Inc",
"lei": "QUIX8Y7A2WP0XRMW7G29",
"cik": "0001090872",
"latest_filing_date": "2017-02-06"
},
{
"ticker": "AA",
"name": "Alcoa Inc",
"lei": "ABPN11VOHLHX6QR7XQ48",
"cik": "0000004281",
"latest_filing_date": "2017-02-06"
},
...
]
}
Function not available
Function not available
Returns the master list of all companies covered by the Intrinio Data Marketplace. You can view the Company/Security Master here.
Endpoint
https://api.intrinio.com/companies
https://api.intrinio.com/companies?query={query-string}
Parameters
- query (optional, returns full list of companies with compacted response values, if no query specified) - a string query search of company name or ticker symbol with the returned results being the relevant companies in compacted list format.
- latest_filing_date (optional) - a date value that returns the list of companies whose latest SEC filing was filed on or after this date: YYYY-MM-DD
- page_size (optional, default page size is 100) - an integer greater than 1 for specifying the number of results on each page.
- page_number (optional, default page number is 1) - an integer greater than or equal to 1 for specifying the page number for the return values.
Return Values
- ticker - the stock market ticker symbol associated with the companies common stock securities
- cik - the Central Index Key issued by the SEC, which is the unique identifier all company filings are issued under
- lei - the Legal Entity Identifier for the company
- name - the company name in shorter form
- latest_filing_date - the filing date of the latest available SEC filing for the company
Security Master
// API URI: https://api.intrinio.com
// GET: /securities
// FULL URL: https://api.intrinio.com/securities
{
"result_count": 55636,
"page_size": 250,
"current_page": 1,
"total_pages": 223,
"api_call_credits": 1,
"data": [
{
"ticker": "000001",
"figi_ticker": "000001:CH",
"figi": "BBG000BZDPV5",
"security_name": "PING AN BANK CO LTD-A",
"market_sector": "Equity",
"security_type": "Common Stock",
"stock_exchange": "SHE",
"last_crsp_adj_date": null
},
{
"ticker": "000002",
"figi_ticker": "000002:CH",
"figi": "BBG000BZ9Z48",
"security_name": "CHINA VANKE CO LTD -A",
"market_sector": "Equity",
"security_type": "Common Stock",
"stock_exchange": "SHE",
"last_crsp_adj_date": null
},
...
]
}
Function not available
Function not available
Returns the master list of all securities covered by the Intrinio Data Marketplace. You can view the Company/Security Master here.
Endpoint
https://api.intrinio.com/securities
https://api.intrinio.com/securities?identifier={symbol}
https://api.intrinio.com/securities?query={query-string}
https://api.intrinio.com/securities?exch_symbol={stock-exchange-symbol}
Parameters
- identifier (optional, returns list of securities with compacted response values, if no identifier specified) - the identifier for the legal entity or a security associated with the company: TICKER SYMBOL | FIGI | OTHER IDENTIFIER
- query (optional, returns list of securities with compacted response values, if no query specified) - a string query search of security name or ticker symbol with the returned results being the relevant securities in compacted list format.
- exch_symbol (optional, returns list of all securities with compacted response values, if no query specified) - the Intrinio Stock Market Symbol, to specify the exchange for the list of securities: STOCK EXCHANGE IDENTIFIER
- us_only (optional, returns list of all US securities if
true) - page_size (optional, default page size is 100) - an integer greater than 1 for specifying the number of results on each page.
- page_number (optional, default page number is 1) - an integer greater than or equal to 1 for specifying the page number for the return values.
Return Values
- ticker - the stock market ticker symbol associated with the companies common stock securities
- figi_ticker - the OpenFIGI ticker symbol
- figi - the OpenFIGI identifier
- security_name - the security description as provided by the exchange
- market_sector - the type of market for the security
- security_type - the type of security, such as Common Stock, Preferred Stock, Warrants, Limited Partnership Interests, etc.
- stock_exchange - the Stock Exchange (and market category) where the company’s common stock is primarily traded
- 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.
Index Master
// API URI: https://api.intrinio.com
// GET: /indices
// FULL URL: https://api.intrinio.com/indices
{
"result_count": 295283,
"page_size": 250,
"current_page": 1,
"total_pages": 1182,
"api_call_credits": 1,
"data": [
{
"symbol": "$00XALCATM086NEST",
"index_name": "Harmonized Index of Consumer Prices: Overall Index Excluding Alcohol and Tobacco for Austria©"
},
{
"symbol": "$00XALCBEM086NEST",
"index_name": "Harmonized Index of Consumer Prices: Overall Index Excluding Alcohol and Tobacco for Belgium©"
},
...
]
}
Function not available
Function not available
Returns indices list and information for all indices covered by Intrinio. There are three distinct types of indices: Stock Market, SIC (Sector & Industry), and Economic. You can view the Stock Market Indices Master, SIC Indices Master, and the Economic Indices Master.
Endpoint
https://api.intrinio.com/indices
https://api.intrinio.com/indices?identifier={symbol}
https://api.intrinio.com/indices?query={query-string}
Parameters
- identifier (optional, returns full list of indices with compacted response values if no symbol or identifier specified) - the Intrinio symbol associated with the index: STOCK MARKET INDICES
- query (optional, returns list of indices with compacted response values, if no query specified) - a string query search of index name or symbol with the returned results being the relevant securities in compacted list format.
- type (optional, returns full list of indices otherwise) - the type of indices specified:
stock_market | economic | sic - order (optional) - returns the results in the given order:
popularity | symbol - page_size (optional, default page size is 100) - an integer greater than 1 for specifying the number of results on each page.
- page_number (optional, default page number is 1) - an integer greater than or equal to 1 for specifying the page number for the return values.
Return Values
- symbol - the Intrinio symbol associated with the index
- index_name - the index name
Owner Master
// API URI: https://api.intrinio.com
// GET: /owners
// FULL URL: https://api.intrinio.com/owners
{
"result_count": 47240,
"page_size": 250,
"current_page": 1,
"total_pages": 189,
"api_call_credits": 1,
"data": [
{
"owner_cik": "0000001800",
"owner_name": "ABBOTT LABORATORIES"
},
{
"owner_cik": "0000002110",
"owner_name": "COLUMBIA ACORN TRUST"
},
...
]
}
Function not available
Function not available
Returns owners list and information for all insider and institutional owners of securities covered by Intrinio.
Endpoint
https://api.intrinio.com/owners
https://api.intrinio.com/owners?institutional={true|false}
https://api.intrinio.com/owners?query={query-string}
https://api.intrinio.com/owners?identifier={owner_cik}
Parameters
- identifier (optional, returns full list of owners with compacted response values, if no identifier specified) - the Central Index Key issued by the SEC, which is the unique identifier all owner filings are issued under: CENTRAL INDEX KEY
- institutional (optional, returns all owners otherwise) - (false) - a boolean to include only insider owners who have filed forms 3, 4, or 5 with the SEC
- query (optional, returns full list of owners with compacted response values, if no query specified) - a string query search of owner name or cik id with the returned results being the relevant owners in compacted list format.
- page_size (optional, default page size is 100) - an integer greater than 1 for specifying the number of results on each page.
- page_number (optional, default page number is 1) - an integer greater than or equal to 1 for specifying the page number for the return values.
Return Values
- owner_cik - the Central Index Key issued by the SEC, which is the unique identifier all owner filings
- owner_name - the name of the owner, either an institutional owner or an insider owner
Stock Exchange Master
// API URI: https://api.intrinio.com
// GET: /stock_exchanges
// FULL URL: https://api.intrinio.com/stock_exchanges
{
"result_count": 29,
"page_size": 250,
"current_page": 1,
"total_pages": 1,
"api_call_credits": 1,
"data": [
{
"symbol": "^BMEX",
"mic": "BMEX",
"institution_name": "BME - BOLSAS Y MERCADOS ESPANOLES",
"acronym": "BME",
"city": "MADRID",
"country": "SPAIN",
"country_code": "ES",
"website": "HTTP://WWW.BOLSASYMERCADOS.ES"
},
{
"symbol": "^BVMF",
"mic": "BVMF",
"institution_name": "BM&FBOVESPA S.A. - BOLSA DE VALORES, MERCADORIAS E FUTUROS",
"acronym": null,
"city": "SAO PAULO",
"country": "BRAZIL",
"country_code": "BR",
"website": "HTTP://WWW.BMFBOVESPA.COM.BR"
},
...
]
}
Function not available
Function not available
Returns stock exchange list and information for all stock exchanges covered by Intrinio.
Endpoint
https://api.intrinio.com/stock_exchanges
https://api.intrinio.com/stock_exchanges?query={query-string}
Parameters
- query (optional, returns full list of stock exchanges with compacted response values, if no query specified) - a string query search of stock exchange name or MIC with the returned results being the relevant stock exchanges in compacted list format.
- page_size (optional, default page size is 100) - an integer greater than 1 for specifying the number of results on each page.
- page_number (optional, default page number is 1) - an integer greater than or equal to 1 for specifying the page number for the return values.
Return Values
- symbol - the Intrinio symbol associated with the stock exchange
- mic - the MIC identifier for the stock exchange
- institution_name - the name of the stock exchange
- acronym - the stock exchanges short form identifier
- city - the city where the stock exchange is located
- country - the country where the stock exchange is located
- country_code - the country code for the country where the stock exchange is located
- website - the website for the stock exchange
U.S. Public Company Data Feed
Companies
// API URI: https://api.intrinio.com
// GET: /companies
// FULL URL: https://api.intrinio.com/companies
{
"result_count": 8132,
"page_size": 250,
"current_page": 1,
"total_pages": 33,
"api_call_credits": 1,
"data": [
{
"ticker": "A",
"name": "Agilent Technologies Inc",
"lei": "QUIX8Y7A2WP0XRMW7G29",
"cik": "0001090872",
"latest_filing_date": "2017-02-06"
},
{
"ticker": "AA",
"name": "Alcoa Inc",
"lei": "ABPN11VOHLHX6QR7XQ48",
"cik": "0000004281",
"latest_filing_date": "2017-02-06"
},
...
]
}
// API URI: https://api.intrinio.com
// GET: /companies?identifier=AA
// FULL URL: https://api.intrinio.com/companies?identifier=AA
{
"ticker": "AA",
"name": "Alcoa Inc",
"lei": "ABPN11VOHLHX6QR7XQ48",
"legal_name": "Alcoa Inc.",
"stock_exchange": "NYSE",
"sic": 3350,
"short_description": "Alcoa Inc. engages in engineering and manufacturing lightweight metals worldwide. The company operates through five segments: Alumina, Primary Metals, Global Rolled Products, Engineered Products and Solutions, and Transport and Construction Soluti...",
"long_description": "Alcoa Inc. engages in engineering and manufacturing lightweight metals worldwide. The company operates through five segments: Alumina, Primary Metals, Global Rolled Products, Engineered Products and Solutions, and Transport and Construction Solutions. The Alumina segment mines for bauxite, refines it for producing alumina, and sells alumina directly to external smelter customers, or to customers who process it into industrial chemical products. The Primary Metals segment produces and sells primary aluminum to external customers and traders. This segment also sells aluminum powder, scrap, and excess energy, as well as purchases and resells metals. The Global Rolled Products segment produces and sells aluminum sheets and plates to the packaging end market for the production of aluminum cans, as well as to the aerospace, automotive, commercial transportation, building and construction, and industrial products end markets. This segment also produces aseptic foils for the packaging end market. The Engineered Products and Solutions segment offers fastening systems, including titanium, steel, and nickel alloys; seamless rolled rings, such as nickel alloys; investment castings, including airfoils and forged jet engine components; and various forging and extrusion metal products. This segment serves aerospace, commercial transportation, power generation, oil and gas, industrial products, automotive, and land and sea defense end markets. The Transport and Construction Solutions segment provides integrated aluminum structural systems, architectural extrusions, and forged aluminum commercial vehicle wheels, as well as aluminum products. The segment serves nonresidential building and construction, commercial transportation, and industrial products end markets. The company sells its products directly to customers, as well as through distributors, agents, and alumina traders. Alcoa Inc. was founded in 1888 and is based in New York, New York.",
"ceo": "Klaus-Christian Kleinfeld",
"company_url": "http://www.alcoa.com",
"business_address": "390 PARK AVENUE, NEW YORK, NY 10022-4608",
"mailing_address": "390 PARK AVENUE, NEW YORK, NY 10022-4608",
"business_phone_no": "2128362732",
"hq_address1": "390 Park Avenue",
"hq_address2": null,
"hq_address_city": "New York",
"hq_address_postal_code": "10022",
"entity_legal_form": "INCORPORATED",
"securities": [
{
"ticker": "AA",
"figi_ticker": "AA:US",
"figi": "BBG000B9WH86",
"security_name": "ALCOA INC",
"market_sector": "Equity",
"security_type": "Common Stock",
"stock_exchange": "NYSE",
"last_crsp_adj_date": "2016-10-06",
"composite_figi": "BBG000B9WH86",
"figi_uniqueid": "EQ0010004600001000",
"share_class_figi": "BBG001S5C3C2",
"figi_exch_cntry": "US",
"currency": "USD",
"mic": "XNYS",
"exch_symbol": "^XNYS",
"etf": false,
"delisted_security": false,
"primary_listing": true
},
...
],
"cik": "0000004281",
"latest_filing_date": "2017-02-06",
"hq_state": "New York",
"hq_country": "United States of America",
"inc_state": "Pennsylvania",
"inc_country": "United States of America",
"employees": 60000,
"entity_status": "ACTIVE",
"sector": "Basic Materials",
"industry_category": "Metals & Mining",
"industry_group": "Aluminum",
"template": "industrial",
"standardized_active": true
}
Function not available
Function not available
Returns company list and information for all companies covered by Intrinio.
Endpoint
https://api.intrinio.com/companies
https://api.intrinio.com/companies?identifier={symbol}
https://api.intrinio.com/companies?query={query-string}
Parameters
- identifier (optional, returns full list of companies with compacted response values, if no identifier specified) - the identifier for the legal entity or a security associated with the company: TICKER SYMBOL | FIGI | OTHER IDENTIFIER
- query (optional, returns full list of companies with compacted response values, if no query specified) - a string query search of company name or ticker symbol with the returned results being the relevant companies in compacted list format.
- latest_filing_date (optional) - a date value that returns the list of companies whose latest SEC filing was filed on or after this date: YYYY-MM-DD
- page_size (optional, default page size is 100) - an integer greater than 1 for specifying the number of results on each page.
- page_number (optional, default page number is 1) - an integer greater than or equal to 1 for specifying the page number for the return values.
Return Values
- ticker - the stock market ticker symbol associated with the companies common stock securities
- cik - the Central Index Key issued by the SEC, which is the unique identifier all company filings are issued under
- name - the company name in shorter form
- legal_name - the company’s official legal name
- lei - the Legal Entity Identifier for the company
- hq_address1 - the company’s headquarters address line 1
- hq_address2 - the company’s headquarters address line 2
- hq_address_city - the company’s headquarters city
- hq_address_postal_code - the company’s headquarters postal code
- entity_legal_form - the company’s legal organization form
- state - the state (US & Canada Only) where the company headquarters is located
- country - the country where the company headquarters is located
- inc_state - the state (US & Canada Only) where the company is incorporated
- inc_country - the country where the company is incorporated
- sic - the Standard Industrial Classification (SIC) determined by the company filed with the SEC
- stock_exchange - the Stock Exchange where the company’s common stock is primarily traded
- template - the financial statement template used by Intrinio to standardize the as reported data
- short_description - a one or two sentence description of the company’s operations
- long_description - a one paragraph description of the company’s operations and other corporate actions
- ceo - the Chief Executive Officer of the company
- company_url - the url to the company’s primary corporate website or primary internet property
- business_address - the company’s headquarters address
- mailing_address - the mailing address reported by the company
- business_phone_no - the phone number reported by the company
- employees - the number of employees working for the company
- sector - the company’s operating sector
- industry_category - the company’s operating industry category
- industry_group - the company’s operating industry group
- 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.
Securities
// API URI: https://api.intrinio.com
// GET: /securities
// FULL URL: https://api.intrinio.com/securities
{
"result_count": 55636,
"page_size": 250,
"current_page": 1,
"total_pages": 223,
"api_call_credits": 1,
"data": [
{
"ticker": "000001",
"figi_ticker": "000001:CH",
"figi": "BBG000BZDPV5",
"security_name": "PING AN BANK CO LTD-A",
"market_sector": "Equity",
"security_type": "Common Stock",
"stock_exchange": "SHE",
"last_crsp_adj_date": null
},
{
"ticker": "000002",
"figi_ticker": "000002:CH",
"figi": "BBG000BZ9Z48",
"security_name": "CHINA VANKE CO LTD -A",
"market_sector": "Equity",
"security_type": "Common Stock",
"stock_exchange": "SHE",
"last_crsp_adj_date": null
},
...
]
}
// API URI: https://api.intrinio.com
// GET: /securities?identifier=AA
// FULL URL: https://api.intrinio.com/securities?identifier=AA
{
"ticker": "AA",
"figi_ticker": "AA:US",
"figi": "BBG000B9WH86",
"security_name": "ALCOA INC",
"market_sector": "Equity",
"security_type": "Common Stock",
"stock_exchange": "NYSE",
"last_crsp_adj_date": "2016-10-06",
"composite_figi": "BBG000B9WH86",
"figi_uniqueid": "EQ0010004600001000",
"share_class_figi": "BBG001S5C3C2",
"figi_exch_cntry": "US",
"currency": "USD",
"mic": "XNYS",
"exch_symbol": "^XNYS",
"etf": false,
"delisted_security": false,
"primary_listing": true
}
Function not available
Function not available
Returns security list and information for all securities covered by Intrinio.
Endpoint
https://api.intrinio.com/securities
https://api.intrinio.com/securities?identifier={symbol}
https://api.intrinio.com/securities?query={query-string}
https://api.intrinio.com/securities?exch_symbol={stock-exchange-symbol}
Parameters
- identifier (optional, returns list of securities with compacted response values, if no identifier specified) - the identifier for the legal entity or a security associated with the company: TICKER SYMBOL | FIGI | OTHER IDENTIFIER
- query (optional, returns list of securities with compacted response values, if no query specified) - a string query search of security name or ticker symbol with the returned results being the relevant securities in compacted list format.
- exch_symbol (optional, returns list of all securities with compacted response values, if no query specified) - the Intrinio Stock Market Symbol, to specify the exchange for the list of securities: STOCK EXCHANGE IDENTIFIER
- last_crsp_adj_date (optional) - a date value that returns the list of securities that have had adjusted stock prices due to a corporate event after this date: YYYY-MM-DD
- page_size (optional, default page size is 100) - an integer greater than 1 for specifying the number of results on each page.
- page_number (optional, default page number is 1) - an integer greater than or equal to 1 for specifying the page number for the return values.
Return Values
- ticker - the stock market ticker symbol associated with the companies common stock securities
- figi_ticker - the OpenFIGI ticker symbol
- figi - the OpenFIGI identifier
- security_name - the security description as provided by the exchange
- market_sector - the type of market for the security
- security_type - the type of security, such as Common Stock, Preferred Stock, Warrants, Limited Partnership Interests, etc.
- stock_exchange - the Stock Exchange (and market category) where the company’s common stock is primarily traded
- 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.
- composite_figi - the security’s composite FIGI identifier
- figi_uniqueid - the security’s unique FIGI identifier
- share_class_figi - the security’s share class FIGI identifier
- figi_exch_cntry - the security’s FIGI country of the exchange
- currency - the security’s traded currency on the listed exchange
- mic - the Market Identification Code for the Stock Exchange where the security is listed.
- exch_symbol - the Intrinio Stock Exchange Symbol used as an identifier on the Intrinio API.
- etf - a boolean to represent whether the security is an ETF or otherwise
- 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.
- 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.
Indices
// API URI: https://api.intrinio.com
// GET: /indices
// FULL URL: https://api.intrinio.com/indices
{
"result_count": 295283,
"page_size": 250,
"current_page": 1,
"total_pages": 1182,
"api_call_credits": 1,
"data": [
{
"symbol": "$SPX",
"index_name": "S&P 500 Index",
"continent": "North America",
"country": "United States of America"
},
{
"symbol": "$SSEC",
"index_name": "Shanghai Composite Index",
"continent": "Asia",
"country": "China"
},
...
]
}
// API URI: https://api.intrinio.com
// GET: /indices?identifier=$SPX
// FULL URL: https://api.intrinio.com/indices?identifier=$SPX
{
"symbol": "$SPX",
"index_name": "S&P 500 Index",
"continent": "North America",
"country": "United States of America",
"index_type": "stock_market"
}
Function not available
Function not available
Returns indices list and information for all indices covered by Intrinio.
Endpoint
https://api.intrinio.com/indices
https://api.intrinio.com/indices?identifier={symbol}
https://api.intrinio.com/indices?query={query-string}
Parameters
- identifier (optional, returns full list of indices with compacted response values if no symbol or identifier specified) - the Intrinio symbol associated with the index: STOCK MARKET INDICES
- query (optional, returns list of indices with compacted response values, if no query specified) - a string query search of index name or symbol with the returned results being the relevant securities in compacted list format.
- type (optional, returns full list of indices otherwise) - the type of indices specified:
stock_market - page_size (optional, default page size is 100) - an integer greater than 1 for specifying the number of results on each page.
- page_number (optional, default page number is 1) - an integer greater than or equal to 1 for specifying the page number for the return values.
Return Values
- symbol - the Intrinio symbol associated with the index
- index_name - the index name
- country - the country of focus for the index
- continent - the continent of the country of focus for the index
- index_type - the index type, either stock_market, economic or sector
Securities Search/Screener
// API URI: https://api.intrinio.com
// GET: /securities/search?conditions=open_price~gt~10.50,pricetoearnings~gt~10
// FULL URL: https://api.intrinio.com/securities/search?conditions=open_price~gt~10.50,pricetoearnings~gt~10
{
"result_count": 2523,
"page_size": 250,
"current_page": 1,
"total_pages": 11,
"api_call_credits": 2,
"data": [
{
"ticker": "A",
"open_price": 46.43,
"pricetoearnings": "0.319834E2"
},
{
"ticker": "AAC",
"open_price": 17.84,
"pricetoearnings": "0.891935E2"
},
...
]
}
Function not available
The Screener API can be accessed through the Intrinio Screener for Excel
Function not available
Returns a list of all securities that match the given conditions. The API call credits required for each call is equal to the number of conditions specified.
Endpoint
https://api.intrinio.com/securities/search?conditions={conditions}
Intrinio Screener for Excel
Parameters
- conditions - A comma-separated list of conditions. Each condition consists three elements separated by tildes (~):
- A data tag INTRINIO SCREENER TAGS
- 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”
- A value
- order_column - A data tag by which to order the results INTRINIO SCREENER TAGS
- order_direction - The direction in which to order the results (“asc” for Ascending or “desc” for descending)
- page_size - (optional, default page size is 100) - an integer greater than 1 for specifying the number of results on each page (up to 100)
- page_number - (optional, default page number is 1) - an integer greater than 1 for specifying the page number for the return values
Return Values
The return values will correspond to the data tags in the conditions. Ticker will always be included.
Data Point
// API URI: https://api.intrinio.com
// GET: /data_point?identifier=AAPL&item=name
// FULL URL: https://api.intrinio.com/data_point?identifier=AAPL&item=name
{
"identifier": "AAPL",
"item": "name",
"value": "Apple Inc."
}
// API URI: https://api.intrinio.com
// GET: /data_point?identifier=0000320193&item=ticker
// FULL URL: https://api.intrinio.com/data_point?identifier=0000320193&item=ticker
{
"identifier": "0000320193",
"item": "ticker",
"value": "AAPL"
}
// API URI: https://api.intrinio.com
// GET: /data_point?identifier=AAPL&item=pricetoearnings
// FULL URL: https://api.intrinio.com/data_point?identifier=AAPL&item=pricetoearnings
{
"identifier": "AAPL",
"item": "pricetoearnings",
"value": 17.8763
}
// API URI: https://api.intrinio.com
// GET: /data_point?identifier=AAPL&item=totalrevenue
// FULL URL: https://api.intrinio.com/data_point?identifier=AAPL&item=totalrevenue
{
"identifier": "AAPL",
"item": "totalrevenue",
"value": 199800000000.0
}
// API URI: https://api.intrinio.com
// GET: /data_point?identifier=GOOGL&item=price_date,close_price,percent_change
// FULL URL: https://api.intrinio.com/data_point?identifier=GOOGL&item=price_date,close_price,percent_change
// NOTE: While this is a single API Call, it is considered
// a Dimensional Call, which counts as 3 API Calls against
// the subscription plan.
{
"result_count": 3,
"api_call_credits": 3,
"data": [
{
"identifier": "GOOGL",
"item": "price_date",
"value": "2015-10-30"
},
{
"identifier": "GOOGL",
"item": "close_price",
"value": 737.39
},
{
"identifier": "GOOGL",
"item": "percent_change",
"value": -0.01
}
]
}
// API URI: https://api.intrinio.com
// GET: /data_point?identifier=GOOGL,AAPL&item=price_date,close_price,percent_change
// FULL URL: https://api.intrinio.com/data_point?identifier=GOOGL,AAPL&item=price_date,close_price,percent_change
// NOTE: While this is a single API Call, it is considered
// a Dimensional Call, which counts as 6 API Calls against
// the subscription plan.
{
"result_count": 6,
"api_call_credits": 6,
"data": [
{
"identifier": "GOOGL",
"item": "price_date",
"value": "2015-10-30"
},
{
"identifier": "GOOGL",
"item": "close_price",
"value": 737.39
},
{
"identifier": "GOOGL",
"item": "percent_change",
"value": -0.01
}
{
"identifier": "AAPL",
"item": "price_date",
"value": "2015-10-30"
},
{
"identifier": "AAPL",
"item": "close_price",
"value": 119.5
},
{
"identifier": "AAPL",
"item": "percent_change",
"value": -0.0085
}
]
}
// API URI: https://api.intrinio.com
// GET: /data_point?identifier=$SPX&item=close_price
// FULL URL: https://api.intrinio.com/data_point?identifier=$SPX&item=close_price
{
"identifier": "$SPX",
"item": "close_price",
"value": 1884.09
}
=IntrinioDataPoint("AAPL","name")
Apple Inc.
=IntrinioDataPoint("0000320193","ticker")
AAPL
=IntrinioDataPoint("AAPL","pricetoearnings")
17.8763
=IntrinioDataPoint("AAPL","totalrevenue")
199800000000.0
=IntrinioDataPoint("$GDP","value")
18,034.8
=IntrinioDataPoint("DMD.ERP","ttm_erp")
0.0612
=IntrinioDataPoint("AAPL","name")
Apple Inc.
=IntrinioDataPoint("0000320193","ticker")
AAPL
=IntrinioDataPoint("AAPL","pricetoearnings")
17.8763
=IntrinioDataPoint("AAPL","totalrevenue")
199800000000.0
=IntrinioDataPoint("$GDP","value")
18,034.8
=IntrinioDataPoint("DMD.ERP","ttm_erp")
0.0612
Returns the most recent data point for a selected identifier (ticker symbol, stock market index symbol, CIK ID, etc.) for a selected tag. The complete list of tags available through this function are available here. 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
https://api.intrinio.com/data_point?identifier={symbol}&item={tag}
https://api.intrinio.com/data_point?identifier={symbol1,symbol2}&item={tag1,tag2}
Excel Function
=IntrinioDataPoint(identifier, item)
Sheets Function
=IntrinioDataPoint(identifier, item)
Parameters
- identifier - an identifier for the company or data point, including the SEC CIK ID, FRED Series ID, or Damodaran equity risk premium (ERP): TICKER SYMBOL | STOCK MARKET INDICES | CENTRAL INDEX KEY | DAMODARAN ERP
- item - the specified standardized tag or series ID requested: INTRINIO DATA POINT TAGS | DAMODARAN ERP
Limits
You may request up to 150 identifier/item combinations at a time. For example, you may request 1 identifier and 150 items, or 150 identifiers and 1 item, or 12 identifiers and 12 items (144 combinations), or anywhere in between.
Return Values
- identifier - the ticker or identifier for the data point
- item - the requested standardized tag or series ID
- value - the value of the Intrinio tag of the financial data point
- “nm” - No meaning: the value is not meaningful, such as a negative P/E ratio
- “na” - Not applicable: there is no value for the given item/identifier combo, or the user does not have the proper access
Historical Data
// API URI: https://api.intrinio.com
// GET: /historical_data?identifier=AAPL&item=totalrevenue
// FULL URL: https://api.intrinio.com/historical_data?identifier=AAPL&item=totalrevenue
{
"identifier": "AAPL",
"item": "totalrevenue",
"result_count": 30,
"page_size": 50000,
"current_page": 1,
"total_pages": 1,
"api_call_credits": 1,
"data": [
{
"date": "2016-06-25",
"value": 220288000000.0
},
{
"date": "2016-03-26",
"value": 227535000000.0
},
...
]
}
// API URI: https://api.intrinio.com
// GET: /historical_data?identifier=AAPL&item=totalrevenue&type=QTR
// FULL URL: https://api.intrinio.com/historical_data?identifier=AAPL&item=totalrevenue&type=QTR
{
"identifier": "AAPL",
"item": "totalrevenue",
"result_count": 32,
"page_size": 50000,
"current_page": 1,
"total_pages": 1,
"api_call_credits": 1,
"data": [
{
"date": "2016-06-25",
"value": 42358000000.0
},
{
"date": "2016-03-26",
"value": 50557000000.0
},
...
]
}
// API URI: https://api.intrinio.com
// GET: /historical_data?identifier=AAPL&item=pricetoearnings&start_date=2014-01-01&end_date=2015-01-01
// FULL URL: https://api.intrinio.com/historical_data?identifier=AAPL&item=pricetoearnings&start_date=2014-01-01&end_date=2015-01-01
{
"identifier": "AAPL",
"item": "pricetoearnings",
"result_count": 252,
"page_size": 50000,
"current_page": 1,
"total_pages": 1,
"api_call_credits": 1,
"data": [
{
"date": "2014-12-31",
"value": 14.602
},
{
"date": "2014-12-30",
"value": 14.8851
},
...
]
}
// API URI: https://api.intrinio.com
// GET: /historical_data?identifier=$SPX&item=close_price&start_date=2010-01-01&end_date=2010-01-30
// FULL URL: https://api.intrinio.com/historical_data?identifier=$SPX&item=close_price&start_date=2010-01-01&end_date=2010-01-30
{
"identifier": "$SPX",
"item": "close_price",
"result_count": 19,
"page_size": 50000,
"current_page": 1,
"total_pages": 1,
"api_call_credits": 1,
"data": [
{
"date": "2010-01-29",
"value": 1073.869995
},
{
"date": "2010-01-28",
"value": 1084.530029
},
...
]
}
=IntrinioHistoricalData("AAPL","open_price",0)
121.85
=IntrinioHistoricalData("AAPL","adj_close_price",0,"2012-01-01","2012-12-31")
71.43
=IntrinioHistoricalData("AAPL","close_price",0,,,"yearly")
110.38
Function not available
Returns the historical data for for a selected identifier (ticker symbol or index symbol) for a selected tag. The complete list of tags available through this function are available here. 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.
Endpoint
https://api.intrinio.com/historical_data?identifier={symbol}&item={tag}
Excel Function
=IntrinioHistoricalData(identifier, item, sequence, start_date, end_date, frequency, type, show_date)
Parameters
- identifier - the stock market ticker symbol associated with the company’s common stock or index. If the company is foreign, use the stock exchange code, followed by a colon, then the ticker: TICKER SYMBOL | INDEX SYMBOL
- item - the specified standardized tag requested. INTRINIO TAGS
- sequence (required, only in Excel add-in function) - an integer 0 or greater for calling a single historical data point from the first entry, based on sort order:
0..last available - start_date (optional) - the earliest date for which to return data:
YYYY-MM-DD - end_date (optional, default=today) - the latest date for which to return data:
YYYY-MM-DD - frequency (optional, returns daily historical price data otherwise) - the frequency of the historical prices & valuation data:
daily | weekly | monthly | quarterly | yearly - type (optional, returns trailing twelve months (TTM) for the income statement, cash flow statement and calculations, and quarterly (QTR) for balance sheet) - 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:
FY | QTR | TTM | YTD - show_date (optional, only in Excel add-in, false by default) if true, the function will return the date value, and if false the function will return the data point value for a given query:
true | false - sort_order (optional, default=desc) - the order of the historical stock price dates:
asc | desc - page_size (optional, default page size is 1000) - an integer greater than 1 for specifying the number of results on each page
- page_number (optional, default page number is 1) - an integer greater than or equal to 1 for specifying the page number for the return values
Return Values
- identifier - the ticker or identifier for the data point
- item - the requested standardized tag or series ID
- date - the date associated with the value of the data tag
- value - the value of the Intrinio tag of the financial data point
Prices
// API URI: https://api.intrinio.com
// GET: /prices?identifier=AAPL
// FULL URL: https://api.intrinio.com/prices?identifier=AAPL
{
"result_count": 9024,
"page_size": 50000,
"current_page": 1,
"total_pages": 1,
"api_call_credits": 1,
"data": [
{
"date": "2016-09-23",
"open": 114.42,
"high": 114.79,
"low": 111.55,
"close": 112.71,
"volume": 52481151.0,
"ex_dividend": 0.0,
"split_ratio": 1.0,
"adj_open": 114.42,
"adj_high": 114.79,
"adj_low": 111.55,
"adj_close": 112.71,
"adj_volume": 52481151.0
},
{
"date": "2016-09-22",
"open": 114.35,
"high": 114.94,
"low": 114.0,
"close": 114.62,
"volume": 31073984.0,
"ex_dividend": 0.0,
"split_ratio": 1.0,
"adj_open": 114.35,
"adj_high": 114.94,
"adj_low": 114.0,
"adj_close": 114.62,
"adj_volume": 31073984.0
}
...
]
}
=IntrinioHistoricalPrices("AAPL","open",0)
107.39
=IntrinioHistoricalPrices("AAPL","date",0,"2012-01-01","2012-12-31")
2012-12-31
=IntrinioHistoricalPrices("AAPL","adj_close",0,"2012-01-01","2012-12-31")
71.43
=IntrinioHistoricalPrices("AAPL","date",0,,,"yearly")
2014-12-31
=IntrinioHistoricalPrices("AAPL","close",0,,,"yearly")
107.57
Function not available
Returns professional-grade historical stock prices for a security or stock market index. New EOD prices are available at 5p.m. EST and intraday prices are updated every minute during the trading day from IEX. 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. Data from Quandl, QuoteMedia and the Federal Reserve Economic Data.
Endpoint
https://api.intrinio.com/prices?identifier={symbol}
Excel Function
=IntrinioHistoricalPrices(identifier, item, sequence, start_date, end_date, frequency)
Parameters
- identifier - the stock market ticker symbol associated with the companies common stock securities or the stock market index: TICKER SYMBOL | INDEX SYMBOL
- item (required, only in Excel add-in function) - the selected observation of the historical prices:
date | open | high | low | close | volume | ex_dividend | split_ratio | adj_open | adj_high | adj_low | adj_close | adj_volume - sequence (required, only in Excel add-in function) - an integer 0 or greater for calling a single historical data point from the first entry, based on sort order:
0..last available - start_date (optional) - 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:
YYYY-MM-DD - end_date (optional, default is today) - 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:
YYYY-MM-DD - frequency (optional, returns daily historical price data otherwise) - the frequency of the historical prices:
daily | weekly | monthly | quarterly | yearly - sort_order - (optional, default=desc) - the order of the historical stock price dates:
asc | desc - page_size (optional, default page size is 100) - an integer greater than 1 for specifying the number of results on each page
- page_number (optional, default page number is 1) - an integer greater than or equal to 1 for specifying the page number for the return values
Return Values
- date - the date of the stock price historical data
- open - the actual observed first traded stock price on the trading date
- high - the actual observed highest traded stock price on the trading date
- low - the actual observed lowest traded stock price on the trading date
- close - the actual observed last trade stock price on the trading date
- volume - the actual observed number of shares of stock traded between market participants on the trading date
- ex_dividend - the non-split adjusted dividend per share on the ex-dividend date - not available on index historical prices
- split_ratio - the split factor on the split date - not available on index historical prices
- adj_open - the dividend and split adjusted open price - not available on index historical prices
- adj_high - the dividend and split adjusted high price - not available on index historical prices
- adj_low - the dividend and split adjusted low price - not available on index historical prices
- adj_close - the dividend and split adjusted close price - not available on index historical prices
- adj_volume - the dividend and split adjusted volume - not available on index historical prices
Exchange Prices
// API URI: https://api.intrinio.com
// GET: /prices/exchange?identifier=^XNAS&price_date=2016-12-05
// FULL URL: https://api.intrinio.com/prices/exchange?identifier=^XNAS&price_date=2016-12-05
{
"result_count": 3043,
"page_size": 250,
"current_page": 1,
"total_pages": 13,
"api_call_credits": 1,
"data": [
{
"ticker": "AAAP",
"figi_ticker": "AAAP:US",
"figi": "BBG007K5CTL0",
"date": "2016-12-05",
"open": 29.6,
"high": 30.21,
"low": 29.4,
"close": 29.5,
"volume": 100519.0,
"ex_dividend": 0.0,
"split_ratio": 1.0,
"adj_open": 29.6,
"adj_high": 30.21,
"adj_low": 29.4,
"adj_close": 29.5,
"adj_volume": 100519.0
},
{
"ticker": "AAL",
"figi_ticker": "AAL:US",
"figi": "BBG005P7Q881",
"date": "2016-12-05",
"open": 46.45,
"high": 46.5401,
"low": 45.58,
"close": 45.72,
"volume": 5199774.0,
"ex_dividend": 0.0,
"split_ratio": 1.0,
"adj_open": 46.45,
"adj_high": 46.5401,
"adj_low": 45.58,
"adj_close": 45.72,
"adj_volume": 5199774.0
},
...
]
}
Function not available
Function not available
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.
Endpoint
https://api.intrinio.com/prices/exchange?identifier={stock-exchange-symbol}&price_date{YYYY-MM-DD}
Parameters
- identifier - the stock market ticker symbol associated with the companies common stock securities or the stock market index: STOCK EXCHANGE SYMBOL
- price_date - the specified date in which historical stock prices are returned for a stock exchange -
YYYY-MM-DD - page_size (optional, returns the maximum of 250 without a page size & number) - an integer greater than 1 for specifying the number of results on each page.
- page_number (optional, returns the first page without a page size & number) - an integer greater than or equal to 1 for specifying the page number for the return values.
Return Values
- ticker - the stock exchange ticker symbol as listed on the stock exchange
- figi_ticker - the OpenFIGI Ticker Symbol
- figi - the FIGI identifier
- date - the date of the stock price historical data
- open - the actual observed first traded stock price on the trading date
- high - the actual observed highest traded stock price on the trading date
- low - the actual observed lowest traded stock price on the trading date
- close - the actual observed last trade stock price on the trading date
- volume - the actual observed number of shares of stock traded between market participants on the trading date
- ex_dividend - the non-split adjusted dividend per share on the ex-dividend date - not available on index historical prices
- split_ratio - the split factor on the split date - not available on index historical prices
- adj_open - the dividend and split adjusted open price - not available on index historical prices
- adj_high - the dividend and split adjusted high price - not available on index historical prices
- adj_low - the dividend and split adjusted low price - not available on index historical prices
- adj_close - the dividend and split adjusted close price - not available on index historical prices
- adj_volume - the dividend and split adjusted volume - not available on index historical prices
Latest SEC Filings
// API URI: https://api.intrinio.com
// GET: /filings
// FULL URL: https://api.intrinio.com/filings
{
"result_count": 17697,
"page_size": 100,
"current_page": 1,
"total_pages": 177,
"api_call_credits": 1
"data": [
{
"filing_date": "2017-04-20",
"accepted_date": "2017-04-20 18:24:23 -0700",
"period_ended": "2017-04-19",
"accno": "0001077771-17-000077",
"report_type": "4",
"filing_url": "https://www.sec.gov/Archives/edgar/data/1077771/000107777117000077/0001077771-17-000077-index.htm",
"report_url": "https://www.sec.gov/Archives/edgar/data/1077771/000107777117000077/xslF345X03/edgardoc.xml",
"instance_url": null,
"ticker": "UMPQ",
"lei": null,
"cik": "0001077771"
},
{
"filing_date": "2017-04-20",
"accepted_date": "2017-04-20 18:21:02 -0700",
"period_ended": "2017-04-18",
"accno": "0001127602-17-015199",
"report_type": "4",
"filing_url": "https://www.sec.gov/Archives/edgar/data/811589/000112760217015199/0001127602-17-015199-index.htm",
"report_url": "https://www.sec.gov/Archives/edgar/data/811589/000112760217015199/xslF345X03/form4.xml",
"instance_url": null,
"ticker": "FBNC",
"lei": "549300QGC3EY3EV0NS72",
"cik": "0000811589"
},
...
]
}
Function not available
Function not available
Returns a list of all SEC filings recorded within the past 30 days.
Endpoint
https://api.intrinio.com/filings
Parameters
- page_size (optional, default page size is 100) - an integer greater than 1 for specifying the number of results on each page.
- page_number (optional, default page number is 1) - an integer greater than or equal to 1 for specifying the page number for the return values.
Return Values
- filing_date - the date the filing was submitted to the SEC by the company
- accepted_date - the date and time when the filing was submitted to the SEC by the company
- period_ended - the date of the period end for the filing
- accno - the SEC unique number for the filing
- report_type - the filing report type
- filing_url - the URL to the filing page on the SEC site
- report_url - the URL to the actual report on the SEC site
- instance_url - the URL for the XBRL filing for the report
- ticker - the stock market ticker symbol associated with the company’s common stock securities
- lei - the Legal Entity Identifier for the company
- cik - the Central Index Key issued by the SEC, which is the unique identifier all company filings are issued under
Company SEC Filings
// API URI: https://api.intrinio.com
// GET: /companies/filings?identifier=AAPL
// FULL URL: https://api.intrinio.com/companies/filings?identifier=AAPL
{
"result_count": 1015,
"page_size": 250,
"current_page": 1,
"total_pages": 5,
"api_call_credits": 1,
"data": [
{
"filing_date": "2016-09-23",
"accepted_date": "2016-09-23 18:33:57 +0000",
"period_ended": "2016-09-21",
"accno": "0001628280-16-019756",
"report_type": "4",
"filing_url": "https://www.sec.gov/Archives/edgar/data/320193/000162828016019756/0001628280-16-019756-index.htm",
"report_url": "https://www.sec.gov/Archives/edgar/data/320193/000162828016019756/xslF345X03/wf-form4_147467002403491.xml",
"instance_url": null
},
{
"filing_date": "2016-09-23",
"accepted_date": "2016-09-23 18:35:58 +0000",
"period_ended": "2016-09-21",
"accno": "0001628280-16-019757",
"report_type": "4",
"filing_url": "https://www.sec.gov/Archives/edgar/data/320193/000162828016019757/0001628280-16-019757-index.htm",
"report_url": "https://www.sec.gov/Archives/edgar/data/320193/000162828016019757/xslF345X03/wf-form4_147467014510458.xml",
"instance_url": null
},
...
]
}
Function not available
Function not available
Returns the complete list of SEC filings for a company.
Endpoint
https://api.intrinio.com/companies/filings?identifier={symbol}
Parameters
- identifier - 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: TICKER SYMBOL
- report_type - the report type of the filing requested:
10-K | 10-Q | 8-K | 4 | etc- REPORT TYPES - start_date (optional) - the earliest filing date for which to return filings, in the format:
YYYY-MM-DD - end_date (optional, default=today) - the last filing date for which to return filings, in the format:
YYYY-MM-DD - page_size (optional, default page size is 100) - an integer greater than 1 for specifying the number of results on each page.
- page_number (optional, default page number is 1) - an integer greater than or equal to 1 for specifying the page number for the return values.
Return Values
- filing_date - the date the filing was submitted to the SEC by the company
- accepted_date - the date and time when the filing was submitted to the SEC by the company
- period_ended - the date of the period end for the filing
- accno - the SEC unique number for the filing
- report_type - the filing report type
- filing_url - the URL to the filing page on the SEC site
- report_url - the URL to the actual report on the SEC site
- instance_url - the URL for the XBRL filing for the report
Company News
// API URI: https://api.intrinio.com
// GET: /news?identifier=AAPL
// FULL URL: https://api.intrinio.com/news?identifier=AAPL
{
"result_count": 250,
"page_size": 250,
"current_page": 1,
"total_pages": 14,
"api_call_credits": 1,
"data": [
{
"title": "[$$] How will Twitter's suitors reap its value?",
"publication_date": "2016-09-25 12:12:33 +0000",
"url": "http://www.ft.com/cms/s/8d81a6da-82e6-11e6-8897-2359a58ac7a5,s01=1.html?ftcamp=traffic/partner/feed_headline/us_yahoo/auddev",
"summary": "[at Financial Times] - 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 ..."
},
{
"title": "If Apple built a car, here are the companies it would probably work with",
"publication_date": "2016-09-25 12:00:00 +0000",
"url": "http://finance.yahoo.com/news/apple-built-car-companies-probably-120000342.html",
"summary": "If Apple built a car, here are the companies it would probably work with"
},
...
]
}
=IntrinioNews("AAPL","title",0)
Google challenges Apple's Siri by opening digital assistant to iPhone
=IntrinioNews("AAPL","publication_date",0)
2017-05-17 18:23:55 +0000
Function not available
Returns the most recent news stories for a company.
Endpoint
https://api.intrinio.com/news
Excel Function
=IntrinioNews(identifier, item, sequence)
Parameters
- identifier - 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: TICKER SYMBOL
- item (Excel only) - the attribute of the news article:
title | publication_date | summary | url - sequence (Excel only) - an integer 0 or greater for calling a single news article from the first entry, based on sort order:
0..last available - page_size (optional, default page size is 100) - an integer greater than 1 for specifying the number of results on each page.
- page_number (optional, default page number is 1) - an integer greater than or equal to 1 for specifying the page number for the return values.
Return Values
- title - the title of the article
- publication_date - the date the article was published
- url - the hyperlink to the article
- summary - a brief summary of the article
Standardized Fundamentals
// API URI: https://api.intrinio.com
// GET: /fundamentals/standardized?identifier=AAPL&statement=income_statement&type=FY
// FULL URL: https://api.intrinio.com/fundamentals/standardized?identifier=AAPL&statement=income_statement&type=FY
{
"result_count": 9,
"page_size": 250,
"current_page": 1,
"total_pages": 1,
"api_call_credits": 1,
"data": [
{
"fiscal_year": 2015,
"end_date": "2015-09-26",
"start_date": "2014-09-28",
"fiscal_period": "FY",
"filing_date": "2015-10-28 16:31:09 +0000"
},
{
"fiscal_year": 2014,
"end_date": "2014-09-27",
"start_date": "2013-09-29",
"fiscal_period": "FY",
"filing_date": "2015-10-28 16:31:09 +0000"
},
...
]
}
=IntrinioFundamentals("AAPL","income_statement","FY",0,"end_date")
2014-09-27
=IntrinioFundamentals("AAPL","balance_sheet","QTR",0,"fiscal_period")
Q3
=IntrinioFundamentals("AAPL","balance_sheet","QTR",0,"fiscal_year")
2015
=IntrinioFundamentals("AAPL","income_statement","FY",0,"end_date")
2014-09-27
=IntrinioFundamentals("AAPL","balance_sheet","QTR",0,"fiscal_period")
Q3
=IntrinioFundamentals("AAPL","balance_sheet","QTR",0,"fiscal_year")
2015
Returns a list of available standardized fundamentals (fiscal year and fiscal period) for a given ticker and statement. Also, you may add a date and type parameter to specify the fundamentals you wish to be returned in the response.
Endpoint
https://api.intrinio.com/fundamentals/standardized?identifier={symbol}&statement={statement}
Excel Function
=IntrinioFundamentals(identifier, statement, type, sequence, item)
Sheets Function
=IntrinioFundamentals(identifier, statement, type, sequence, item)
Parameters
- identifier - the stock market ticker symbol associated with the companies common stock securities: TICKER SYMBOL
- statement - the financial statement requested, options include the income statement, balance sheet, statement of cash flows and calculated metrics and ratios:
income_statement | balance_sheet | cash_flow_statement | calculations - type (optional, returns all available fundamentals) - 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:
FY | QTR | TTM | YTD - sequence (required, only in Excel add-in function) - an integer 0 or greater for calling a single fundamental from the first entry, most recent first:
0..last available - item (required, only in Excel add-in function) - the return value for the fundamental:
fiscal_year | fiscal_period | end_date | start_date - date (optional, default is today) - the first fundamental will be the latest as of this specified date:
YYYY-MM-DD - page_size (optional, default page size is 100) - an integer greater than 1 for specifying the number of results on each page.
- page_number (optional, default page number is 1) - an integer greater than or equal to 1 for specifying the page number for the return values.
Return Values
- fiscal_year - the fiscal year of the fundamental
- fiscal_period - the fiscal period of the fundamental
- end_date - the last date of the fundamental
- start_date - (not available on the balance sheet) the first date of the fundamental
Standardized Tags and Labels
// API URI: https://api.intrinio.com
// GET: /tags/standardized?identifier=AAPL&statement=income_statement
// FULL URL: https://api.intrinio.com/tags/standardized?identifier=AAPL&statement=income_statement
{
"result_count": 43,
"page_size": 5000,
"current_page": 1,
"total_pages": 1,
"api_call_credits": 1,
"data": [
{
"name": "Operating Revenue",
"tag": "operatingrevenue",
"parent": "totalrevenue",
"factor": "+",
"balance": "credit",
"type": "operating",
"units": "usd"
},
{
"name": "Other Revenue",
"tag": "otherrevenue",
"parent": "totalrevenue",
"factor": "+",
"balance": "credit",
"type": "operating",
"units": "usd"
},
...
]
}
=IntrinioTags("AAPL","income_statement",0,"tag")
operatingrevenue
=IntrinioTags("AAPL","balance_sheet",3,"name")
Short-Term Investments
Function not available
Returns the standardized tags and labels for a given ticker, statement, and date or fiscal year/fiscal quarter.
Endpoint
https://api.intrinio.com/tags/standardized?identifier={symbol}&statement={statement}
Excel Function
=IntrinioTags(identifier, statement, sequence, item)
A basic list of all industrial standardized tags can be found here. A basic list of all financial standardized tags can be found here.
Parameters
- statement - the financial statement requested, options include the income statement, balance sheet, statement of cash flows, calculated metrics and ratios, and current data points :
income_statement | balance_sheet | cash_flow_statement | calculations | current - template (optional, must include a ticker if not specified) - the financial statement tag template:
industrial | financial - identifier (optional, must include a template if not specified) - the stock market ticker symbol associated with the companies common stock securities: TICKER SYMBOL
- sequence (optional, returns full list without a sequence number) - an integer 0 or greater for calling a single tag from the first entry, based on order
- item (required, only in Excel add-in function) - the return value for the tag:
name | tag | parent | factor | balance | type | units - page_size (optional, default page size is 100) - an integer greater than 1 for specifying the number of results on each page
- page_number (optional, default page number is 1) - an integer greater than or equal to 1 for specifying the page number for the return values
Return Values
- name - the readable name of the tag
- tag - the Intrinio standardized tag
- parent - the parent Intrinio standardized tag forming the statement relationship with the factor.
- factor - the operator forming the statement relationship between the child tag (or tags) and the parent.
- balance - the accounting balance (debit or credit) of the tag
- type - the nature of the tag, operating or nonoperating
- units - the unit of the tag
Standardized Financials
// API URI: https://api.intrinio.com
// GET: /financials/standardized?identifier=AAPL&statement=income_statement&fiscal_year=2015&fiscal_period=FY
// FULL URL: https://api.intrinio.com/financials/standardized?identifier=AAPL&statement=income_statement&fiscal_year=2015&fiscal_period=FY
{
"result_count": 23,
"page_size": 5000,
"current_page": 1,
"total_pages": 1,
"api_call_credits": 1,
"data": [
{
"tag": "operatingrevenue",
"value": 233715000000.0
},
{
"tag": "totalrevenue",
"value": 233715000000.0
},
...
]
}
=IntrinioFinancials("AAPL","income_statement",2015,"FY","operatingrevenue","A")
233,715,000,000
=IntrinioFinancials("AAPL","balance_sheet",2,"QTR","totalequity","B")
123.328
=IntrinioFinancials("AAPL","income_statement",7,"TTM","netincometocommon","M")
37,037
=IntrinioFinancials("AAPL","income_statement",2015,"FY","operatingrevenue","A")
233,715,000,000
=IntrinioFinancials("AAPL","balance_sheet",2,"QTR","totalequity","B")
123.328
=IntrinioFinancials("AAPL","income_statement",7,"TTM","netincometocommon","M")
37,037
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 companies fundamentals.
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.
Endpoint
https://api.intrinio.com/financials/standardized?identifier={symbol}&statement={statement}&fiscal_year={fiscal_year}&fiscal_period={fiscal_period}
Excel Function
=IntrinioFinancials(identifier, statement, fiscal_year, fiscal_period, tag, rounding)
OR
=IntrinioFinancials(identifier, statement, sequence, type, tag, rounding)
Sheets Function
=IntrinioFinancials(identifier, statement, fiscal_year, fiscal_period, tag, rounding)
OR
=IntrinioFinancials(identifier, statement, sequence, type, tag, rounding)
Parameters
- identifier - the stock market ticker symbol associated with the companies common stock securities: TICKER SYMBOL
- statement - the financial statement requested, options include the income statement, balance sheet, statement of cash flows and calculated metrics and ratios:
income_statement | balance_sheet | cash_flow_statement | calculations - fiscal_year (optional, otherwise, must specify a date) - the fiscal year associated with the fundamental:
YYYY - fiscal_period (optional, otherwise, must specify a date) - the fiscal period associated with the fundamental:
FY | Q1 | Q2 | Q3 | Q4 | Q1TTM | Q2TTM | Q3TTM | Q2YTD | Q3YTD - sequence (optional, must specify a date or must specify a fiscal year and fiscal period) - the sequence of the requested fundamental (i.e. 0 is the first available fundamental associated with the fiscal period type:
0...last available - type (optional, must specify a date or must specify a fiscal year and fiscal period) - 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:
FY | QTR | TTM | YTD - date (optional, otherwise, must specify a fiscal year and fiscal period) - the first fundamental will be the latest as of this specified date:
YYYY-MM-DD - tag (required, only in Excel & Sheets add-in function) - the specified standardized tag: STANDARDIZED INDUSTRIAL TAGS | STANDARDIZED FINANCIAL TAGS
- rounding (optional, only in Excel & Sheets add-ins function) – round the returned value (actuals, thousands, millions, billions):
A | K | M | B - page_size (optional, default page size is 100) - an integer greater than 1 for specifying the number of results on each page
- page_number (optional, default page number is 1) - an integer greater than or equal to 1 for specifying the page number for the return values
Return Values
- tag - the Intrinio standardized tag of the financial data point
- value - the value of the Intrinio tag of the financial data point
As Reported Fundamentals
// API URI: https://api.intrinio.com
// GET: /fundamentals/reported?identifier=AAPL&statement=income_statement&type=FY
// FULL URL: https://api.intrinio.com/fundamentals/reported?identifier=AAPL&statement=income_statement&type=FY
{
"result_count": 9,
"page_size": 250,
"current_page": 1,
"total_pages": 1,
"api_call_credits": 1,
"data": [
{
"fiscal_year": 2015,
"end_date": "2015-09-26",
"start_date": "2014-09-28",
"fiscal_period": "FY",
"filing_date": "2015-10-28 16:31:09 +0000"
},
{
"fiscal_year": 2014,
"end_date": "2014-09-27",
"start_date": "2013-09-29",
"fiscal_period": "FY",
"filing_date": "2015-10-28 16:31:09 +0000"
},
...
]
}
=IntrinioReportedFundamentals("AAPL","income_statement","FY",0,"fiscal_year")
2014
=IntrinioReportedFundamentals("AAPL","income_statement","QTR",2,"fiscal_period")
Q1
=IntrinioReportedFundamentals("AAPL","balance_sheet","QTR",5,"end_date")
2013-12-28
Function not available
Returns a list of available as reported fundamentals (fiscal year, fiscal period, start date, and end date) for a given ticker and statement. Also, you may add a date and type parameter to specify the fundamentals you wish to be returned in the response.
Endpoint
https://api.intrinio.com/fundamentals/reported?identifier={symbol}&statement={statement}
Excel Function
=IntrinioReportedFundamentals(identifier, statement, type, sequence, item)
Parameters
- identifier - the stock market ticker symbol associated with the companies common stock securities: TICKER SYMBOL
- statement - the financial statement requested, options include the income statement, balance sheet and statement of cash flows:
income_statement | balance_sheet | cash_flow_statement - type (optional, returns all available fundamentals) - the type of periods requested - includes fiscal years for annual data, quarters for quarterly data:
FY | QTR - date (optional, default=today) - the first fundamental will be the latest as of this specified date:
YYYY-MM-DD - sequence (optional, returns full list without a sequence number) - an integer 0 or greater for calling a single fundamental from the first entry
- item (required, only in Excel add-in function) - the return value for the fundamental:
fiscal_year | end_date | start_date | fiscal_period | filing_date - page_size (optional, default page size is 100) - an integer greater than 1 for specifying the number of results on each page.
- page_number (optional, default page number is 1) - an integer greater than or equal to 1 for specifying the page number for the return values.
Return Values
- fiscal_year - the fiscal year of the fundamental
- fiscal_period - the fiscal period of the fundamental
- end_date - the last date of the fundamental
- start_date - (not available on the balance sheet) the first date of the fundamental
As Reported XBRL Tags and Labels
// API URI: https://api.intrinio.com
// GET: /tags/reported?identifier=AAPL&statement=income_statement&fiscal_year=2015&fiscal_period=FY
// FULL URL: https://api.intrinio.com/tags/reported?identifier=AAPL&statement=income_statement&fiscal_year=2015&fiscal_period=FY
{
"result_count": 19,
"page_size": 5000,
"current_page": 1,
"total_pages": 1,
"api_call_credits": 1,
"data": [
{
"name": "Net sales",
"tag": "SalesRevenueNet",
"balance": "credit",
"unit": "usd",
"domain_tag": null,
"abstract": false,
"sequence": 1,
"depth": 1,
"factor": "+"
},
{
"name": "Cost of sales",
"tag": "CostOfGoodsAndServicesSold",
"balance": "debit",
"unit": "usd",
"domain_tag": null,
"abstract": false,
"sequence": 2,
"depth": 1,
"factor": "-"
},
...
]
}
=IntrinioReportedTags("AAPL","income_statement",2014,"FY",0,"name")
Net sales
=IntrinioReportedTags("AAPL","income_statement",2014,"FY",0,"tag")
SalesRevenueNet
=IntrinioReportedTags("AAPL","balance_sheet",7,"QTR",28,"name")
Retained earnings
=IntrinioReportedTags("AAPL","balance_sheet",7,"QTR",28,"tag")
RetainedEarningsAccumulatedDeficit
Function not available
Returns the As Reported XBRL tags and labels for a given ticker, statement, and date or fiscal year/fiscal quarter.
Endpoint
https://api.intrinio.com/tags/reported?identifier={symbol}&statement={statement}
Excel Function
=IntrinioReportedTags(identifier, statement, fiscal_year, fiscal_period, sequence, item)
Parameters
- identifier - the stock market ticker symbol associated with the companies common stock securities: TICKER SYMBOL
- statement - the financial statement requested:
income_statement | balance_sheet | cash_flow_statement - fiscal_year (optional, otherwise, must specify a date) - the fiscal year associated with the fundamental:
YYYY - fiscal_period (optional, otherwise, must specify a date) - the fiscal period associated with the fundamental:
FY | Q1 | Q2 | Q3 - sequence (optional, returns full list without a sequence number) - an integer 0 or greater for calling a single tag from the first entry, based on order
- item (required, only in Excel add-in function) - the return value for the tag:
name | tag | balance | unit | domain_tag | abstract | sequence | depth | factor - type (optional, must specify a date or must specify a fiscal year and fiscal period) - 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:
FY | QTR - date (optional, otherwise, must specify a fiscal year and fiscal period) - the first fundamental will be the latest as of this specified date:
YYYY-MM-DD - page_size (optional, default page size is 100) - an integer greater than 1 for specifying the number of results on each page
- page_number (optional, default page number is 1) - an integer greater than or equal to 1 for specifying the page number for the return values
Return Values
- name - the label of the XBRL tag as reported of the financial statement
- tag - the XBRL tag of the associated financial data point
- balance - the accounting balance (debit or credit) of the tag
- unit - the unit type of the XBRL tag
- 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
- 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.
- sequence - an integer 0 or greater indicating the presentation order of the XBRL tag and label in the financial statement
- depth - an integer 0 or greater indicating the presentation indentation depth of the XBRL tag and label in the financial statement
As Reported Financials
// API URI: https://api.intrinio.com
// GET: /financials/reported?identifier=AAPL&statement=income_statement&fiscal_year=2015&fiscal_period=FY
// FULL URL: https://api.intrinio.com/financials/reported?identifier=AAPL&statement=income_statement&fiscal_year=2015&fiscal_period=FY
{
"result_count": 16,
"page_size": 5000,
"current_page": 1,
"total_pages": 1,
"api_call_credits": 1,
"data": [
{
"xbrl_tag": "SalesRevenueNet",
"domain_tag": null,
"value": 233715000000.0
},
{
"xbrl_tag": "CostOfGoodsAndServicesSold",
"domain_tag": null,
"value": 140089000000.0
},
...
]
}
=IntrinioReportedFinancials("AAPL","income_statement",2015,"FY","SalesRevenueNet")
233715000000
=IntrinioReportedFinancials("AAPL","income_statement",2,"QTR","EarningsPerShareBasic")
3.08
=IntrinioReportedFinancials("AAPL","balance_sheet",2014,"FY","PropertyPlantAndEquipmentNet")
20,624,000,000
=IntrinioReportedFinancials("AAPL","balance_sheet",1,"QTR","LongTermDebt")
40,072,000,000
Function not available
Returns the As Reported Financials directly from the financial statements of the XBRL filings from the company.
Endpoint
https://api.intrinio.com/financials/reported?identifier={symbol}&statement={statement}&fiscal_year={fiscal_year}&fiscal_period={fiscal_period}
Excel Function
=IntrinioReportedFinancials(identifier, statement, fiscal_year, fiscal_period, xbrl_tag, domain_tag)
OR
=IntrinioReportedFinancials(identifier, statement, sequence, type, xbrl_tag, domain_tag)
Parameters
- identifier - the stock market ticker symbol associated with the companies common stock securities: TICKER SYMBOL
- statement - the financial statement requested, options include the income statement, balance sheet, statement of cash flows and calculated metrics and ratios :
income_statement | balance_sheet | cash_flow_statement - fiscal_year (optional, otherwise, must specify a date) - the fiscal year associated with the fundamental:
YYYY - fiscal_period (optional, otherwise, must specify a date) - the fiscal period associated with the fundamental:
FY | Q1 | Q2 | Q3 - sequence (optional, must specify a date or must specify a fiscal year and fiscal period) - the sequence of the requested fundamental (i.e. 0 is the first available fundamental associated with the fiscal period type:
0...last available - type (optional, must specify a date or must specify a fiscal year and fiscal period) - 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:
FY | QTR - date (optional, otherwise, must specify a fiscal year and fiscal period) - the first fundamental will be the latest as of this specified date:
YYYY-MM-DD - xbrl_tag (required, only available in the Excel add-in function) - the specified XBRL tag
- domain_tag (optional, only available in the Excel add-in function) - the specified domain XBRL tag, associated with certain data points on the financial statements that have a dimension associated with the data point
- page_size (optional, default page size is 100) - an integer greater than 1 for specifying the number of results on each page
- page_number (optional, default page number is 1) - an integer greater than or equal to 1 for specifying the page number for the return values
Return Values
- xbrl_tag - the reported XBRL tag of the financial data point
- value - the value of the XBRL tag of the financial data point
Insider Transactions & Ownership Data Feed
Reports all insider transactions for owners and companies. Insiders must file Form 4, 5, or 6 with the SEC after any transaction. Provides transaction details for both non-derivative and derivative transactions for all owners. Ownership holdings are aggregated by both owners and by companies, with the value of the holdings as of the previous trading day.
Owners
// API URI: https://api.intrinio.com
// GET: /owners?institutional=false
// FULL URL: https://api.intrinio.com/owners?institutional=false
{
"result_count": 106185,
"page_size": 250,
"current_page": 1,
"total_pages": 425,
"api_call_credits": 1,
"data": [
{
"owner_cik": "0000001800",
"owner_name": "ABBOTT LABORATORIES"
},
{
"owner_cik": "0000002488",
"owner_name": "ADVANCED MICRO DEVICES INC"
},
...
]
}
// API URI: https://api.intrinio.com
// GET: /owners?query=Musk
// FULL URL: https://api.intrinio.com/owners?query=Musk
{
"result_count": 4,
"page_size": 250,
"current_page": 1,
"total_pages": 1,
"api_call_credits": 1,
"data": [
{
"owner_cik": "0001310611",
"owner_name": "Musket David B"
},
{
"owner_cik": "0001494730",
"owner_name": "Musk Elon"
},
{
"owner_cik": "0001494731",
"owner_name": "Musk Kimbal"
},
{
"owner_cik": "0001626280",
"owner_name": "Muskus Richard A Jr."
}
]
}
// API URI: https://api.intrinio.com
// GET: /owners?identifier=0001494730
// FULL URL: https://api.intrinio.com/owners?identifier=0001494730
{
"cik_id": "0001494730",
"name": "Musk Elon",
"state": null,
"state_inc": null,
"country_inc": null,
"business_address": null,
"business_phone_no": null,
"mailing_address": "C/O TESLA MOTORS, INC., 3500 DEER CREEK ROAD, PALO ALTO CA 94304",
"institutional": false
}
Function not available
Function not available
Returns owners list and information for all insider and institutional owners of securities covered by Intrinio. Includes detailed info for a single owner and the ability to query by name.
Endpoint
https://api.intrinio.com/owners?institutional=false
https://api.intrinio.com/owners?institutional=false&query={query-string}
https://api.intrinio.com/owners?identifier={owner_cik}
Parameters
- identifier (optional, returns full list of owners with compacted response values, if no identifier specified) - the Central Index Key issued by the SEC, which is the unique identifier all owner filings are issued under: CENTRAL INDEX KEY
- institutional (optional, returns all owners otherwise) - (false) - a boolean to include only insider owners who have filed forms 3, 4, or 5 with the SEC
- query (optional, returns full list of owners with compacted response values, if no query specified) - a string query search of owner name or cik id with the returned results being the relevant owners in compacted list format.
- page_size (optional, default page size is 100) - an integer greater than 1 for specifying the number of results on each page.
- page_number (optional, default page number is 1) - an integer greater than or equal to 1 for specifying the page number for the return values.
Return Values
- owner_cik - the Central Index Key issued by the SEC, which is the unique identifier all owner filings
- owner_name - the name of the owner, either an institutional owner or an insider owner
- state - the state (US & Canada Only) where the company headquarters is located
- state_inc - the state (US & Canada Only) where the company is incorporated
- country_inc - the country where the company is incorporated
- business_address - the company’s headquarters address
- business_phone_no - the phone number reported by the company
- mailing_address - the mailing address reported by the company
- institutional - (true or false) boolean indicating whether or not the owner is an institutional owner or other owner type (such as insider owner)
Insider Transactions by Company
// API URI: https://api.intrinio.com
// GET: /companies/insider_transactions?identifier=TSLA
// FULL URL: https://api.intrinio.com/companies/insider_transactions?identifier=TSLA
{
"result_count": 1108,
"page_size": 250,
"current_page": 1,
"total_pages": 5,
"api_call_credits": 1,
"data": [
{
"owner_cik": "0001650649",
"owner_name": "FIELD JOHN DOUGLAS",
"filing_date": "2016-09-07",
"filing_url": "https://www.sec.gov/Archives/edgar/data/1318605/000167051216000006/xslF345X03/primary_doc.xml",
"director": false,
"officer": true,
"ten_percent_owner": false,
"other_relation": false,
"officer_title": "VP, Engineering",
"derivative_transaction": false,
"security_title": "Common Stock",
"transaction_date": "2016-09-05",
"deemed_execution_date": null,
"transaction_type_code": "M",
"amount_of_shares": 563.0,
"acquisition_disposition_code": "A",
"transaction_price": 0.0,
"total_shares_owned": 12055.0,
"ownership_type_code": "D",
"report_line_number": 1
},
{
"owner_cik": "0001650649",
"owner_name": "FIELD JOHN DOUGLAS",
"filing_date": "2016-09-07",
"filing_url": "https://www.sec.gov/Archives/edgar/data/1318605/000167051216000006/xslF345X03/primary_doc.xml",
"director": false,
"officer": true,
"ten_percent_owner": false,
"other_relation": false,
"officer_title": "VP, Engineering",
"derivative_transaction": false,
"security_title": "Common Stock",
"transaction_date": "2016-09-05",
"deemed_execution_date": null,
"transaction_type_code": "M",
"amount_of_shares": 3593.0,
"acquisition_disposition_code": "A",
"transaction_price": 0.0,
"total_shares_owned": 15648.0,
"ownership_type_code": "D",
"report_line_number": 2
},
...
]
}
Function not available
Function not available
Returns a list of all insider transactions in a company. Criteria for being an insider include being a director, officer, or 10%+ owner in the company. Transactions are detailed for both non-derivative and derivative transactions by the insider.
Endpoint
https://api.intrinio.com/companies/insider_transactions?identifier={symbol}
Parameters
- identifier - the stock market ticker symbol associated with the companies common stock securities or the Central Index Key issued by the SEC, which is the unique identifier all company filings are issued under: TICKER SYMBOL | CENTRAL INDEX KEY
- page_size (optional, default page size is 100) - an integer greater than 1 for specifying the number of results on each page.
- page_number (optional, default page number is 1) - an integer greater than or equal to 1 for specifying the page number for the return values.
Return Values
All Filings
- identifier - the ticker symbol for the company’s common stock
- owner_cik - the owner’s Central Index Key (CIK) unique identifier with the SEC
- owner_name - the name of the owner
- filing_date - the date of the filing with the SEC made by the owner
- filing_url - the URL of the filing with the SEC
- director - (true/false) a boolean indicating whether or not the owner is a director in the company
- officer - (true/false) a boolean indicating whether or not the owner is a officer in the company
- ten_percent_owner - (true/false) a boolean indicating whether or not the owner has a ten percent or greater interest in the company
- other_relation - (true/false) a boolean indicating whether or not the owner has another relationship with the company beside, direct, officer, or significant owner in the company
- officer_title - the officer title of the owner in the company
Non-Derivative Transaction
- derivative_transaction - (false) a boolean indicating the transaction is not a derivative transaction and instead is dealings in the common stock of the company
- security_title - the name of the security transacted
- transaction_date - the date of the transaction by the owner
- deemed_execution_date - the date of the transaction by the owner had it not a directly identifiable date
- transaction_type_code - a symbol representing the transaction type:
P - Purchase | S — Sale | A — Award | M - Conversion | F - Payment of Exercise or Tax Withholding | G - GiftMore Transaction Codes - amount_of_shares - the number of shares involved in the subject transaction
- acquisition_disposition_code - a symbol representing whether or not the securities are Acquired or Disposed:
A - Acquisition | D - Disposition - transaction_price - the price (or weighted average price) of the transaction
- total_shares_owned - immediately after the transaction, the total number of shares owned by the owner
- ownership_type_code - a symbol representing the ownership of the securities transacted:
D - Direct Ownership | I - Indirect Ownership - nature_of_ownership - if the ownership type is indirect, an indication of who is the owner of the securities - usually a trust, foundation, or spouse
- report_line_number - the line number of the transaction from the filing document
Derivative Transaction
- derivative_transaction - (true) a boolean indicating the transaction is a derivative transaction, which may or may not become common stock due to various possible exercise or conversion requirements
- security_title - the name of the derivative security transacted
- conversion_exercise_price - the conversion or exercise price of the derivative security transacted
- transaction_date - the date of the transaction
- deemed_execution_date - the date of the transaction had it not a directly identifiable date
- transaction_type_code - a symbol representing the transaction type:
P - Purchase | S — Sale | A — Award | M - Conversion to Common | C — Conversion | X - Exercise of DerivativeMore Transaction Codes - acquisition_disposition_code - a symbol representing whether or not the derivative securities are Acquired or Disposed:
A - Acquisition | D - Disposition - amount_of_shares - the number of derivative securities involved in the subject transaction
- exercise_date - the exercise date of the derivative securities
- expiration_date - the expiration date of the derivative securities
- underlying_security_title - the name of the underlying non-derivative security related to this derivative transaction
- underlying_shares - the number of non-derivative shares involved in the subject transaction
- transaction_price - the price of the derivative securities
- total_shares_owned - the total number of derivative securities owned following the subject transaction
- ownership_type_code - a symbol representing the ownership of the securities transacted:
D - Direct Ownership | I - Indirect Ownership - nature_of_ownership - if the ownership type is indirect, an indication of who is the owner of the securities - usually a trust, foundation, or spouse
- report_line_number - the line number of the transaction from the filing document
Insider Ownership by Company
// API URI: https://api.intrinio.com
// GET: /companies/insider_ownership?identifier=TSLA
// FULL URL: https://api.intrinio.com/companies/insider_ownership?identifier=TSLA
{
"result_count": 21,
"page_size": 250,
"current_page": 1,
"total_pages": 1,
"api_call_credits": 1,
"data": [
{
"owner_cik": "0001494730",
"owner_name": "Musk Elon",
"last_reported_date": "2016-05-26",
"value": 6451844000.0,
"amount": 31100719.0
},
{
"owner_cik": "0001495013",
"owner_name": "Kohler Herbert",
"last_reported_date": "2012-06-25",
"value": 2692938000.0,
"amount": 12981144.0
},
...
]
}
Function not available
Function not available
Endpoint
https://api.intrinio.com/companies/insider_ownership?identifier={symbol}
Parameters
- identifier - the stock market ticker symbol associated with the companies common stock securities or the Central Index Key issued by the SEC, which is the unique identifier all company filings are issued under: TICKER SYMBOL | CENTRAL INDEX KEY
- page_size (optional, default page size is 100) - an integer greater than 1 for specifying the number of results on each page.
- page_number (optional, default page number is 1) - an integer greater than or equal to 1 for specifying the page number for the return values.
Return Values
- owner_cik - the Central Index Key issued by the SEC, which is the unique identifier all owner filings
- owner_name - the name of the owner, either an institutional owner or an insider owner
- last_reported_date - the last insider transaction date where indicated ownership
- value - the value of the owners direct and indirect interests in the company based on the price from the previous day’s price.
- amount - the total number of the owners direct and indirect interests in the company - direct interests are in the insiders name, while indirect interests may be in a trust, foundation, or spouses name but the owner still has some control over the securities
Insider Transactions By Owner
// API URI: https://api.intrinio.com
// GET: /owners/insider_transactions?identifier=0001494730
// FULL URL: https://api.intrinio.com/owners/insider_transactions?identifier=0001494730
{
"result_count": 94,
"page_size": 250,
"current_page": 1,
"total_pages": 1,
"api_call_credits": 1,
"data": [
{
"ticker": "TSLA",
"company_cik": "0001494730",
"company_name": "Tesla Motors Inc",
"filing_date": "2016-05-26",
"filing_url": "https://www.sec.gov/Archives/edgar/data/1318605/000149473016000008/xslF345X03/edgardoc.xml",
"director": true,
"officer": true,
"ten_percent_owner": true,
"other_relation": false,
"officer_title": "CEO",
"derivative_transaction": false,
"security_title": "Common Stock",
"transaction_date": "2016-05-25",
"deemed_execution_date": null,
"transaction_type_code": "S",
"amount_of_shares": 2782670.0,
"acquisition_disposition_code": "D",
"transaction_price": 213.22,
"total_shares_owned": 31100644.0,
"ownership_type_code": "I",
"report_line_number": 1
},
{
"ticker": "TSLA",
"company_cik": "0001494730",
"company_name": "Tesla Motors Inc",
"filing_date": "2016-05-23",
"filing_url": "https://www.sec.gov/Archives/edgar/data/1318605/000149473016000007/xslF345X03/edgardoc.xml",
"director": true,
"officer": true,
"ten_percent_owner": true,
"other_relation": false,
"officer_title": "CEO",
"derivative_transaction": false,
"security_title": "Common Stock",
"transaction_date": "2016-05-19",
"deemed_execution_date": null,
"transaction_type_code": "M",
"amount_of_shares": 2147986.0,
"acquisition_disposition_code": "A",
"transaction_price": 6.63,
"total_shares_owned": 31727328.0,
"ownership_type_code": "I",
"report_line_number": 1
},
...
]
}
Function not available
Function not available
Returns a list of all insider transactions by an owner in as many companies as the owner may be considered an insider. Criteria for being an insider include being a director, officer, or 10%+ owner in the company. Transactions are detailed for both non-derivative and derivative transactions by the insider.
Endpoint
https://api.intrinio.com/owners/insider_transactions?cik={owner_cik}
Parameters
- identifier - the Central Index Key issued by the SEC, which is the unique identifier all owner filings are issued under: CENTRAL INDEX KEY
- page_size (optional, default page size is 100) - an integer greater than 1 for specifying the number of results on each page.
- page_number (optional, default page number is 1) - an integer greater than or equal to 1 for specifying the page number for the return values.
Return Values
All Filings
- ticker - the ticker symbol for the company’s common stock
- company_cik - the company’s Central Index Key (CIK) unique identifier with the SEC
- company_name - the name of the company
- filing_date - the date of the filing with the SEC made by the owner
- filing_url - the URL of the filing with the SEC
- director - (true/false) a boolean indicating whether or not the owner is a director in the company
- officer - (true/false) a boolean indicating whether or not the owner is a officer in the company
- ten_percent_owner - (true/false) a boolean indicating whether or not the owner has a ten percent or greater interest in the company
- other_relation - (true/false) a boolean indicating whether or not the owner has another relationship with the company beside, direct, officer, or significant owner in the company
- officer_title - the officer title of the owner in the company
Non-Derivative Transaction
- derivative_transaction - (false) a boolean indicating the transaction is not a derivative transaction and instead is dealings in the common stock of the company
- security_title - the name of the security transacted
- transaction_date - the date of the transaction by the owner
- deemed_execution_date - the date of the transaction by the owner had it not a directly identifiable date
- transaction_type_code - a symbol representing the transaction type:
P - Purchase | S — Sale | A — Award | M - Conversion | F - Payment of Exercise or Tax Withholding | G - GiftMore Transaction Codes - amount_of_shares - the number of shares involved in the subject transaction
- acquisition_disposition_code - a symbol representing whether or not the securities are Acquired or Disposed:
A - Acquisition | D - Disposition - transaction_price - the price (or weighted average price) of the transaction
- total_shares_owned - immediately after the transaction, the total number of shares owned by the owner
- ownership_type_code - a symbol representing the ownership of the securities transacted:
D - Direct Ownership | I - Indirect Ownership - nature_of_ownership - if the ownership type is indirect, an indication of who is the owner of the securities - usually a trust, foundation, or spouse
- report_line_number - the line number of the transaction from the filing document
Derivative Transaction
- derivative_transaction - (true) a boolean indicating the transaction is a derivative transaction, which may or may not become common stock due to various possible exercise or conversion requirements
- security_title - the name of the derivative security transacted
- conversion_exercise_price - the conversion or exercise price of the derivative security transacted
- transaction_date - the date of the transaction
- deemed_execution_date - the date of the transaction had it not a directly identifiable date
- transaction_type_code - a symbol representing the transaction type:
P - Purchase | S — Sale | A — Award | M - Conversion to Common | C — Conversion | X - Exercise of DerivativeMore Transaction Codes - acquisition_disposition_code - a symbol representing whether or not the derivative securities are Acquired or Disposed:
A - Acquisition | D - Disposition - amount_of_shares - the number of derivative securities involved in the subject transaction
- exercise_date - the exercise date of the derivative securities
- expiration_date - the expiration date of the derivative securities
- underlying_security_title - the name of the underlying non-derivative security related to this derivative transaction
- underlying_shares - the number of non-derivative shares involved in the subject transaction
- transaction_price - the price of the derivative securities
- total_shares_owned - the total number of derivative securities owned following the subject transaction
- ownership_type_code - a symbol representing the ownership of the securities transacted:
D - Direct Ownership | I - Indirect Ownership - nature_of_ownership - if the ownership type is indirect, an indication of who is the owner of the securities - usually a trust, foundation, or spouse
- report_line_number - the line number of the transaction from the filing document
Insider Holdings by Owner
// API URI: https://api.intrinio.com
// GET: /owners/insider_holdings?cik=0001494730
// FULL URL: https://api.intrinio.com/owners/insider_holdings?cik=0001494730
{
"result_count": 2,
"page_size": 250,
"current_page": 1,
"total_pages": 1,
"api_call_credits": 1,
"data": [
{
"ticker": "TSLA",
"company_cik": "0001318605",
"company_name": "Tesla Motors Inc",
"last_reported_date": "2016-05-26",
"value": 6451844000.0,
"amount": 31100719.0
},
{
"ticker": "SCTY",
"company_cik": "0001408356",
"company_name": "SolarCity Corp",
"last_reported_date": "2016-02-12",
"value": 420311000.0,
"amount": 21845674.0
}
]
}
Function not available
Function not available
A list of all ownership interests and the value of their interests by a single owner. A single owner may own insider interests in a number of companies.
Endpoint
https://api.intrinio.com/owners/insider_holdings?cik={owner_cik}
Parameters
- owner_cik - the Central Index Key issued by the SEC, which is the unique identifier all owner filings
- page_size (optional, default page size is 100) - an integer greater than 1 for specifying the number of results on each page.
- page_number (optional, default page number is 1) - an integer greater than or equal to 1 for specifying the page number for the return values.
Return Values
- identifier - the stock market ticker symbol associated with the companies common stock securities
- company_cik - the Central Index Key issued by the SEC, which is the unique identifier all company filings are issued under
- company_name - the company name in shorter form
- last_reported_date - the last insider transaction date where indicated ownership
- value - the value of the owners direct and indirect interests in the company based on the price from the previous day’s price.
- amount - the total number of the owners direct and indirect interests in the company - direct interests are in the insiders name, while indirect interests may be in a trust, foundation, or spouses name but the owner still has some control over the securities
Institutional Holdings Data Feed
Institutional Holdings are reported each quarter by Institutional Owners by filing Form 13-F with the SEC. Institutional Holdings in securities are represented by CUSIP number by the firm. Holdings data includes the value and number of shares, and voting control.
Owners
// API URI: https://api.intrinio.com
// GET: /owners?institutional=true
// FULL URL: https://api.intrinio.com/owners?institutional=true
{
"result_count": 10701,
"page_size": 250,
"current_page": 1,
"total_pages": 43,
"api_call_credits": 1,
"data": [
{
"owner_cik": "0000002110",
"owner_name": "COLUMBIA ACORN TRUST"
},
{
"owner_cik": "0000002230",
"owner_name": "ADAMS DIVERSIFIED EQUITY FUND, INC."
},
...
]
}
// API URI: https://api.intrinio.com
// GET: /owners?query=Wisconsin
// FULL URL: https://api.intrinio.com/owners?query=Wisconsin
{
"result_count": 6,
"page_size": 250,
"current_page": 1,
"total_pages": 1,
"api_call_credits": 1,
"data": [
{
"owner_cik": "0000854157",
"owner_name": "STATE OF WISCONSIN INVESTMENT BOARD"
},
{
"owner_cik": "0000887833",
"owner_name": "WELLS FARGO BANK WISCONSIN NATIONAL ASSOCIATION"
},
{
"owner_cik": "0000926833",
"owner_name": "WISCONSIN CAPITAL MANAGEMENT LLC"
},
{
"owner_cik": "0001066266",
"owner_name": "WISCONSIN ASSET MANAGEMENT LLC"
},
{
"owner_cik": "0001662497",
"owner_name": "JBS WISCONSIN PROPERTIES, LLC"
},
{
"owner_cik": "0001672728",
"owner_name": "WISCONSIN ALUMNI RESEARCH FOUNDATION"
}
]
}
// API URI: https://api.intrinio.com
// GET: /owners?identifier=0001494730
// FULL URL: https://api.intrinio.com/owners?identifier=0000854157
{
"owner_cik": "0000854157",
"owner_name": "STATE OF WISCONSIN INVESTMENT BOARD"
"state": "Wisconsin",
"state_inc": "Wisconsin",
"country_inc": "United States of America",
"business_address": "121 EAST WILSON STREET, MADISON, WI 53703",
"business_phone_no": "6082662381",
"mailing_address": "P.O. BOX 7842, 121 EAST WILSON STREET, MADISON, WI 53707",
"institutional": true,
}
Function not available
Function not available
Returns owners list and information for all institutional owners of securities covered by Intrinio. Includes detailed info for a single owner and the ability to query by name.
Endpoint
https://api.intrinio.com/owners?institutional=true
https://api.intrinio.com/owners?institutional=true&query={query-string}
https://api.intrinio.com/owners?identifier={owner_cik}
Parameters
- identifier (optional, returns full list of owners with compacted response values, if no identifier specified) - the Central Index Key issued by the SEC, which is the unique identifier all owner filings are issued under: CENTRAL INDEX KEY
- institutional (optional, returns all owners otherwise) - (true) - a boolean to include only institutional owners who file 13-F with the SEC
- query (optional, returns full list of owners with compacted response values, if no query specified) - a string query search of owner name or cik id with the returned results being the relevant owners in compacted list format.
- page_size (optional, default page size is 100) - an integer greater than 1 for specifying the number of results on each page.
- page_number (optional, default page number is 1) - an integer greater than or equal to 1 for specifying the page number for the return values.
Return Values
- owner_cik - the Central Index Key issued by the SEC, which is the unique identifier all owner filings
- owner_name - the name of the owner, either an institutional owner or an insider owner
- state - the state (US & Canada Only) where the company headquarters is located
- state_inc - the state (US & Canada Only) where the company is incorporated
- country_inc - the country where the company is incorporated
- business_address - the company’s headquarters address
- business_phone_no - the phone number reported by the company
- mailing_address - the mailing address reported by the company
- institutional - (true or false) boolean indicating whether or not the owner is an institutional owner or other owner type (such as insider owner)
Institutional Holdings by Owner
// API URI: https://api.intrinio.com
// GET: /owners/institutional_holdings?cik=0000854157
// FULL URL: https://api.intrinio.com/owners/institutional_holdings?cik=0000854157
{
"result_count": 1307,
"page_size": 250,
"current_page": 1,
"total_pages": 6,
"api_call_credits": 1,
"data": [
{
"cusip": "060505104",
"ticker": "BAC",
"security_name": "Bank of America Corporation Common Stock",
"security_type": "Common Stock",
"title_of_class": "COM",
"stock_exchange": "NYSE",
"period_ended": "2016-06-30",
"value": 157505000.0,
"amount": 11869261.0,
"type": "SH",
"investment_discretion": "SOLE",
"other_manager": " ",
"sole_voting_authority": 11869261.0,
"shared_voting_authority": 0.0,
"no_voting_authority": 0.0
},
{
"cusip": "369604103",
"ticker": "GE",
"security_name": "General Electric Company Common Stock",
"security_type": "Common Stock",
"title_of_class": "COM",
"stock_exchange": "NYSE",
"period_ended": "2016-06-30",
"value": 287416000.0,
"amount": 9130107.0,
"type": "SH",
"investment_discretion": "SOLE",
"other_manager": " ",
"sole_voting_authority": 9130107.0,
"shared_voting_authority": 0.0,
"no_voting_authority": 0.0
},
...
]
}
Function not available
Function not available
Endpoint
https://api.intrinio.com/owners/institutional_holdings?cik={owner_cik}
Parameters
- identifier (optional, must have owner cik otherwise) - the stock market ticker symbol associated with the institutional owner’s common stock securities or the Central Index Key issued by the SEC, which is the unique identifier for the institutional owner: TICKER SYMBOL | CENTRAL INDEX KEY
- page_size (optional, default page size is 100) - an integer greater than 1 for specifying the number of results on each page.
- page_number (optional, default page number is 1) - an integer greater than or equal to 1 for specifying the page number for the return values.
Return Values
- cusip - the CUSIP number for the security report by the Institutional Owner
- ticker - the ticker symbol for the security
- security_name - the name of the security
- security_type - the type of the security
- title_of_class - the class of stock held
- stock_exchange - the stock exchange where the security is traded
- period_ended - the date of the latest 13-F filing on record with the SEC.
- value - the market value in amount of dollars of the holding in the listed security
- amount - the number of shares held in the listed security
- type - shares
- investment_discretion - Segregate the holdings of securities of a class according to the nature of the investment discretion held by the Manager.
- other_manager - a code for other managerial authority of the securities listed
- sole_voting_authority - the number of shares where the insitutional holder has sole voting authority
- shared_voting_authority - the number of shares where the insitutional holder has shared voting authority
- no_voting_authority - the number of shares where the insitutional holder has no voting authority
Institutional Owners by Security
// API URI: https://api.intrinio.com
// GET: /securities/institutional_ownership?identifier=AAPL
// FULL URL: https://api.intrinio.com/securities/institutional_ownership?identifier=AAPL
{
"result_count": 2332,
"page_size": 250,
"current_page": 1,
"total_pages": 10,
"api_call_credits": 1,
"data": [
{
"owner_cik": "0000102909",
"owner_name": "VANGUARD GROUP INC",
"period_ended": "2016-06-30",
"value": 31681440000.0,
"amount": 331395817.0,
"sole_voting_authority": 10414679.0,
"shared_voting_authority": 1119643.0,
"no_voting_authority": 319861495.0,
"prev_amount": 329987175.0,
"amount_chg": 1408642.0,
"amount_pct_chg": 0.004269
},
{
"owner_cik": "0000093751",
"owner_name": "STATE STREET CORP",
"period_ended": "2016-06-30",
"value": 19981552000.0,
"amount": 209011754.0,
"sole_voting_authority": 0.0,
"shared_voting_authority": 0.0,
"no_voting_authority": 0.0,
"prev_amount": 215644530.0,
"amount_chg": -6632776.0,
"amount_pct_chg": -0.030758
},
...
]
}
Function not available
Function not available
Endpoint
https://api.intrinio.com/securities/institutional_ownership?identifier={symbol}
Parameters
- identifier (optional, must have company cik otherwise) - the stock market ticker symbol associated with the companies common stock securities or the Central Index Key issued by the SEC, which is the unique identifier all company filings are issued under: TICKER SYMBOL | CENTRAL INDEX KEY
- page_size (optional, default page size is 100) - an integer greater than 1 for specifying the number of results on each page.
- page_number (optional, default page number is 1) - an integer greater than or equal to 1 for specifying the page number for the return values.
Return Values
- owner_cik - the Central Index Key issued by the SEC, which is the unique identifier all owner filings
- owner_name - the name of the institutional owner
- period_ended - the date of the latest 13-F filing on record with the SEC.
- value - the market value in amount of dollars of the holding in the listed security
- amount - the number of shares held in the listed security
- sole_voting_authority - the number of shares where the insitutional holder has sole voting authority
- shared_voting_authority - the number of shares where the insitutional holder has shared voting authority
- no_voting_authority - the number of shares where the insitutional holder has no voting authority
- prev_amount - the prior quarter number of shares held by the owner
- amount_chg - the change in number of shares held from the prior quarter
- amount_pct_chg - the percentage change in the number of shares held from the prior quarter
Economic Data Feed
Access the massive repository of economic data from the Federal Reserve Economic Data system via the Intrinio API. Fetch the most recent data point for an index, or refine your search with historical data.
Economic Indices
// API URI: https://api.intrinio.com
// GET: /indices?type=economic
// FULL URL: https://api.intrinio.com/indices?type=economic
{
"result_count": 294706,
"page_size": 250,
"current_page": 1,
"total_pages": 1179,
"api_call_credits": 1,
"data": [
{
"symbol": "$00XALCATM086NEST",
"index_name": "Harmonized Index of Consumer Prices: Overall Index Excluding Alcohol and Tobacco for Austria©",
"fred_symbol": "00XALCATM086NEST",
"update_frequency": "monthly",
"last_updated": "2015-12-16 16:09:25 +0000",
"description": "The Harmonized Index of Consumer Prices category...",
"observation_start": "1996-01-01",
"observation_end": "2015-11-01",
"popularity": 20,
"seasonal_adjustment": "Not Seasonally Adjusted",
"seasonal_adjustment_short": "NSA",
"units": "Index 2005=100",
"units_short": "Index 2005=100",
"index_type": "economic"
},
{
"symbol": "$00XALCBEM086NEST",
"index_name": "Harmonized Index of Consumer Prices: Overall Index Excluding Alcohol and Tobacco for Belgium©",
"fred_symbol": "00XALCBEM086NEST",
"update_frequency": "monthly",
"last_updated": "2015-12-16 16:09:26 +0000",
"description": "The Harmonized Index of Consumer Prices category...",
"observation_start": "1996-01-01",
"observation_end": "2015-11-01",
"popularity": 0,
"seasonal_adjustment": "Not Seasonally Adjusted",
"seasonal_adjustment_short": "NSA",
"units": "Index 2005=100",
"units_short": "Index 2005=100",
"index_type": "economic"
},
...
]
}
// API URI: https://api.intrinio.com
// GET: /indices?type=sic
// FULL URL: https://api.intrinio.com/indices?type=economic&query=GDP
{
"result_count": 6918,
"page_size": 250,
"current_page": 1,
"total_pages": 28,
"api_call_credits": 1,
"data": [
{
"symbol": "$AFGBCAGDPGDPPT",
"index_name": "Current Account Balance for Afghanistan",
"fred_symbol": "AFGBCAGDPGDPPT",
"update_frequency": "yearly",
"last_updated": "2015-12-04 19:11:01 +0000",
"description": null,
"observation_start": "2004-01-01",
"observation_end": "2015-01-01",
"popularity": 0,
"seasonal_adjustment": "Not Seasonally Adjusted",
"seasonal_adjustment_short": "NSA",
"units": "Percent of GDP",
"units_short": "% of GDP",
"index_type": "economic"
},
{
"symbol": "$AFGDGDPGDPPT",
"index_name": "Total External Debt for Afghanistan",
"fred_symbol": "AFGDGDPGDPPT",
"update_frequency": "yearly",
"last_updated": "2015-12-04 19:11:03 +0000",
"description": null,
"observation_start": "2004-01-01",
"observation_end": "2015-01-01",
"popularity": 11,
"seasonal_adjustment": "Not Seasonally Adjusted",
"seasonal_adjustment_short": "NSA",
"units": "Percent of GDP",
"units_short": "% of GDP",
"index_type": "economic"
},
...
]
}
// API URI: https://api.intrinio.com
// GET: /indices?identifier=$GDP
// FULL URL: https://api.intrinio.com/indices?identifier=$GDP
{
"symbol": "$GDP",
"index_name": "Gross Domestic Product",
"fred_symbol": "GDP",
"update_frequency": "quarterly",
"last_updated": "2015-12-22 13:51:18 +0000",
"description": "BEA Account Code: A191RC1 Gross domestic product (GDP), the featured measure of U.S. output, is the market value of the goods and services produced by labor and property located in the United States. For more information, see the Guide to the National Income and Product Accounts of the United States (NIPA) - (http://www.bea.gov/national/pdf/nipaguid.pdf)",
"observation_start": "1947-01-01",
"observation_end": "2015-07-01",
"popularity": 91,
"seasonal_adjustment": "Seasonally Adjusted Annual Rate",
"seasonal_adjustment_short": "SAAR",
"units": "Billions of Dollars",
"units_short": "Bil. of $",
"index_type": "economic"
}
Function not available
Function not available
Returns indices list and information for all indices covered by Intrinio.
Endpoint
https://api.intrinio.com/indices?type=economic
https://api.intrinio.com/indices?identifier={symbol}&type=economic
https://api.intrinio.com/indices?query={query-string}&type=economic
Parameters
- type - the type of indices specified - Economic Indices:
economic - identifier (optional, returns full list of indices with compacted response values if no symbol or identifier specified) - the Intrinio symbol associated with the index: ECONOMIC INDICES
- query (optional, returns list of indices with compacted response values, if no query specified) - a string query search of index name or symbol with the returned results being the relevant securities in compacted list format.
- page_size (optional, default page size is 100) - an integer greater than 1 for specifying the number of results on each page.
- page_number (optional, default page number is 1) - an integer greater than or equal to 1 for specifying the page number for the return values.
Return Values
- symbol - the Intrinio symbol associated with the index
- index_name - the index name
- country - the country of focus for the index
- continent - the continent of the country of focus for the index
- index_type - the index type, SIC Indices code:
sic
Data Point
// API URI: https://api.intrinio.com
// GET: /data_point?identifier=$GDP&item=level
// FULL URL: https://api.intrinio.com/data_point?identifier=$GDP&item=level
{
"identifier": "$GDP",
"item": "level",
"value": 18436.5
}
// API URI: https://api.intrinio.com
// GET: /data_point?identifier=$GDP&item=yr_percent_change
// FULL URL: https://api.intrinio.com/data_point?identifier=$GDP&item=yr_percent_change
{
"identifier": "$GDP",
"item": "yr_percent_change",
"value": 0.024347
}
=IntrinioDataPoint("$GDP","level")
18,436.5
=IntrinioDataPoint("$GDP","yr_percent_change")
0.024347
=IntrinioDataPoint("$GDP","level")
18,436.5
=IntrinioDataPoint("$GDP","yr_percent_change")
0.024347
Returns the most recent median data point for an Economic index for a selected tag. The complete list of Economic Indices can be found here. The complete list of Economic tags available through this function are available here.
Endpoint
https://api.intrinio.com/data_point?identifier={symbol}&item={tag}
https://api.intrinio.com/data_point?identifier={symbol1,symbol2}&item={tag1,tag2}
Excel Function
=IntrinioDataPoint(identifier, item)
Sheets Function
=IntrinioDataPoint(identifier, item)
Parameters
- identifier - an identifier for the Economic Index selected: ECONOMIC INDICES
- item - the specified standardized tag or series ID requested: ECONOMIC TAGS
Limits
You may request up to 150 identifier/item combinations at a time. For example, you may request 1 identifier and 150 items, or 150 identifiers and 1 item, or 12 identifiers and 12 items (144 combinations), or anywhere in between.
Return Values
- identifier - the ticker or identifier for the data point
- item - the requested standardized tag or series ID
- value - the value of the Intrinio tag of the financial data point
- “nm” - No meaning: the value is not meaningful, such as a negative P/E ratio
- “na” - Not applicable: there is no value for the given item/identifier combo, or the user does not have the proper access
Historical Data
// API URI: https://api.intrinio.com
// GET: /historical_data?identifier=$GDP&item=level
// FULL URL: https://api.intrinio.com/historical_data?identifier=$GDP&item=level
{
"identifier": "$GDP",
"item": "level",
"result_count": 278,
"page_size": 50000,
"current_page": 1,
"total_pages": 1,
"api_call_credits": 1,
"data": [
{
"date": "2016-04-01",
"value": 18436.5
},
{
"date": "2016-01-01",
"value": 18281.6
},
...
]
}
// API URI: https://api.intrinio.com
// GET: /historical_data?identifier=$GDP&item=yr_percent_change
// FULL URL: https://api.intrinio.com/historical_data?identifier=$GDP&item=yr_percent_change
{
"identifier": "$GDP",
"item": "yr_percent_change",
"result_count": 274,
"page_size": 50000,
"current_page": 1,
"total_pages": 1,
"api_call_credits": 1,
"data": [
{
"date": "2016-04-01",
"value": 0.024347
},
{
"date": "2016-01-01",
"value": 0.028003
},
...
]
}
=IntrinioHistoricalData("$GDP","level",0)
18,436.5
=IntrinioHistoricalData("$GDP","level",1)
18,281.6
=IntrinioHistoricalData("$GDP","yr_percent_change",0)
0.024347
=IntrinioHistoricalData("$GDP","yr_percent_change",1)
0.028003
Function not available
Returns the historical data for for an identifier for a selected tag. The complete list of tags available through this function are available here.
Endpoint
https://api.intrinio.com/historical_data?identifier={symbol}&item={tag}
Excel Function
=IntrinioHistoricalData(identifier, item, sequence, start_date, end_date, frequency, type, show_date)
Parameters
- identifier - an identifier for the SIC Index selected: ECONOMIC INDICES
- item - the specified standardized tag requested. ECONOMIC TAGS
- sequence (required, only in Excel add-in function) - an integer 0 or greater for calling a single historical data point from the first entry, based on sort order:
0..last available - start_date (optional) - the earliest date for which to return data:
YYYY-MM-DD - end_date (optional, default=today) - the latest date for which to return data:
YYYY-MM-DD - frequency (optional, returns daily historical price data otherwise) - the frequency of the historical prices & valuation data:
daily | weekly | monthly | quarterly | yearly - show_date (optional, only in Excel add-in, false by default) if true, the function will return the date value, and if false the function will return the data point value for a given query:
true | false - sort_order (optional, default=desc) - the order of the historical stock price dates:
asc | desc - page_size (optional, default page size is 1000) - an integer greater than 1 for specifying the number of results on each page.
- page_number (optional, default page number is 1) - an integer greater than or equal to 1 for specifying the page number for the return values.
Return Values
- identifier - the ticker or identifier for the data point
- item - the requested standardized tag or series ID
- date - the date associated with the value of the data tag
- value - the value of the Intrinio tag of the financial data point
U.S. Sector & Industry Data Feed
Access aggregated sector and industry metrics and statistics for over 500 SIC Codes. Fetch the most recent data point, or refine your search with historical data.
To access the SIC Indices Master via API, use the /indices?type=sic end point in the Intrinio Master Data Feed
SIC Indices
// API URI: https://api.intrinio.com
// GET: /indices?type=sic
// FULL URL: https://api.intrinio.com/indices?type=sic
{
"result_count": 565,
"page_size": 250,
"current_page": 1,
"total_pages": 3,
"api_call_credits": 1,
"data": [
{
"symbol": "$SIC.1",
"index_name": "Agriculture, Forestry, And Fishing",
"continent": "North America",
"country": "United States",
"index_type": "sic"
},
{
"symbol": "$SIC.10",
"index_name": "Mining",
"continent": "North America",
"country": "United States",
"index_type": "sic"
},
...
]
}
// API URI: https://api.intrinio.com
// GET: /indices?type=sic
// FULL URL: https://api.intrinio.com/indices?type=sic&query=mining
{
"result_count": 5,
"page_size": 250,
"current_page": 1,
"total_pages": 1,
"api_call_credits": 1,
"data": [
{
"symbol": "$SIC.10",
"index_name": "Mining",
"continent": "North America",
"country": "United States",
"index_type": "sic"
},
{
"symbol": "$SIC.1000",
"index_name": "METAL MINING",
"continent": "North America",
"country": "United States",
"index_type": "sic"
},
{
"symbol": "$SIC.1200",
"index_name": "COAL MINING",
"continent": "North America",
"country": "United States",
"index_type": "sic"
},
{
"symbol": "$SIC.1220",
"index_name": "Bituminous Coal & Lignite Mining",
"continent": "North America",
"country": "United States",
"index_type": "sic"
},
{
"symbol": "$SIC.3532",
"index_name": "Mining Machinery",
"continent": "North America",
"country": "United States",
"index_type": "sic"
}
]
}
// API URI: https://api.intrinio.com
// GET: /indices?identifier=$SIC.20
// FULL URL: https://api.intrinio.com/indices?identifier=$SIC.20
{
"symbol": "$SIC.20",
"index_name": "Manufacturing",
"continent": "North America",
"country": "United States",
"index_type": "sic"
}
Function not available
Function not available
Returns indices list and information for all indices covered by Intrinio.
Endpoint
https://api.intrinio.com/indices?type=sic
https://api.intrinio.com/indices?identifier={symbol}&type=sic
https://api.intrinio.com/indices?query={query-string}&type=sic
Parameters
- type - the type of indices specified - SIC Indices:
sic - identifier (optional, returns full list of indices with compacted response values if no symbol or identifier specified) - the Intrinio symbol associated with the index: SIC INDICES
- query (optional, returns list of indices with compacted response values, if no query specified) - a string query search of index name or symbol with the returned results being the relevant securities in compacted list format.
- page_size (optional, default page size is 100) - an integer greater than 1 for specifying the number of results on each page.
- page_number (optional, default page number is 1) - an integer greater than or equal to 1 for specifying the page number for the return values.
Return Values
- symbol - the Intrinio symbol associated with the index
- index_name - the index name
- country - the country of focus for the index
- continent - the continent of the country of focus for the index
- index_type - the index type, SIC Indices code:
sic
Data Point
// API URI: https://api.intrinio.com
// GET: /data_point?identifier=$SIC.3500&item=name
// FULL URL: https://api.intrinio.com/data_point?identifier=$SIC.3500&item=totalrevenue
{
"identifier": "$SIC.3500",
"item": "totalrevenue",
"value": 637274000.0
}
// API URI: https://api.intrinio.com
// GET: /data_point?identifier=$SIC.3500&item=pricetoearnings
// FULL URL: https://api.intrinio.com/data_point?identifier=$SIC.3500&item=pricetoearnings
{
"identifier": "$SIC.3500",
"item": "pricetoearnings",
"value": 21.6242
}
=IntrinioDataPoint("$SIC.3500","totalrevenue")
637,274,000.0
=IntrinioDataPoint("$SIC.3500","pricetoearnings")
21.6242
=IntrinioDataPoint("$SIC.3500","totalrevenue")
637,274,000.0
=IntrinioDataPoint("$SIC.3500","pricetoearnings")
21.6242
Returns the most recent median data point for a SIC index for a selected tag. The complete list of SIC Indices can be found here. The complete list of tags available through this function are available here. All duration period values are returned as trailing twelve months and instant period types are returned as of the most recent quarter.
Endpoint
https://api.intrinio.com/data_point?identifier={symbol}&item={tag}
https://api.intrinio.com/data_point?identifier={symbol1,symbol2}&item={tag1,tag2}
Excel Function
=IntrinioDataPoint(identifier, item)
Sheets Function
=IntrinioDataPoint(identifier, item)
Parameters
- identifier - an identifier for the SIC Index selected: SIC INDICES
- item - the specified standardized tag or series ID requested: INTRINIO DATA POINT TAGS
Limits
You may request up to 150 identifier/item combinations at a time. For example, you may request 1 identifier and 150 items, or 150 identifiers and 1 item, or 12 identifiers and 12 items (144 combinations), or anywhere in between.
Return Values
- identifier - the ticker or identifier for the data point
- item - the requested standardized tag or series ID
- value - the value of the Intrinio tag of the financial data point
- “nm” - No meaning: the value is not meaningful, such as a negative P/E ratio
- “na” - Not applicable: there is no value for the given item/identifier combo, or the user does not have the proper access
Historical Data
// API URI: https://api.intrinio.com
// GET: /historical_data?identifier=$SIC.3500&item=totalrevenue
// FULL URL: https://api.intrinio.com/historical_data?identifier=$SIC.3500&item=totalrevenue&frequency=monthly&type=median
{
"identifier": "$SIC.3500",
"item": "totalrevenue",
"result_count": 108,
"page_size": 50000,
"current_page": 1,
"total_pages": 1,
"api_call_credits": 1,
"data": [
{
"date": "2016-08-31",
"value": 637274000.0
},
{
"date": "2016-07-31",
"value": 637274000.0
},
...
]
}
// API URI: https://api.intrinio.com
// GET: /historical_data?identifier=$SIC.3500&item=totalrevenue
// FULL URL: https://api.intrinio.com/historical_data?identifier=$SIC.3500&item=pricetoearnings&frequency=yearly&type=25thpctl
{
"identifier": "$SIC.3500",
"item": "pricetoearnings",
"result_count": 9,
"page_size": 50000,
"current_page": 1,
"total_pages": 1,
"api_call_credits": 1,
"data": [
{
"date": "2015-12-31",
"value": 13.5348
},
{
"date": "2014-12-31",
"value": 14.83125
},
...
]
}
=IntrinioHistoricalData("$SIC.3500","totalrevenue,1,,,"monthly","median")
637,274,000.0
=IntrinioHistoricalData("$SIC.3500","totalrevenue,1,,,"monthly","median","true")
2016-07-31
=IntrinioHistoricalData("$SIC.3500","open_price",2,,,"yearly","25thpctl")
15.884325
=IntrinioHistoricalData("$SIC.3500","open_price",2,,,"yearly","25thpctl","true")
2013-12-31
Function not available
Returns the historical data for for a selected identifier (ticker symbol or index symbol) for a selected tag. The complete list of tags available through this function are available here. 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.
Endpoint
https://api.intrinio.com/historical_data?identifier={symbol}&item={tag}
Excel Function
=IntrinioHistoricalData(identifier, item, sequence, start_date, end_date, frequency, type, show_date)
Parameters
- identifier - an identifier for the SIC Index selected: SIC INDICES
- item - the specified standardized tag requested. INTRINIO TAGS
- sequence (required, only in Excel add-in function) - an integer 0 or greater for calling a single historical data point from the first entry, based on sort order:
0..last available - start_date (optional) - the earliest date for which to return data:
YYYY-MM-DD - end_date (optional, default=today) - the latest date for which to return data:
YYYY-MM-DD - frequency (optional, returns daily historical price data otherwise) - the frequency of the historical prices & valuation data:
daily | weekly | monthly | quarterly | yearly - type (optional, must enter for any query of the SIC Indices to indicate the response type) – the type of statistic requested when querying using the SIC Indices:
count | sum | max | 75thpctl | mean | median | 25thpctl | min - show_date (optional, only in Excel add-in, false by default) if true, the function will return the date value, and if false the function will return the data point value for a given query:
true | false - sort_order (optional, default=desc) - the order of the historical stock price dates:
asc | desc - page_size (optional, default page size is 1000) - an integer greater than 1 for specifying the number of results on each page
- page_number (optional, default page number is 1) - an integer greater than or equal to 1 for specifying the page number for the return values
Return Values
- identifier - the ticker or identifier for the data point
- item - the requested standardized tag or series ID
- date - the date associated with the value of the data tag
- value - the value of the Intrinio tag of the financial data point
U.S. Bank Data Feed
Banks
// API URI: https://api.intrinio.com
// GET: /banks
// FULL URL: https://api.intrinio.com/banks
{
"result_count": 6049,
"page_size": 250,
"current_page": 1,
"total_pages": 25,
"api_call_credits": 1,
"data": [
{
"rssd_id": 423841,
"name": "Wenona State Bank",
"fdic_certificate_number": 17401
},
{
"rssd_id": 1897270,
"name": "Mohave State Bank",
"fdic_certificate_number": 33508
},
...
]
}
// API URI: https://api.intrinio.com
// GET: /banks?query=C1
// FULL URL: https://api.intrinio.com/banks?query=C1
{
"result_count": 1,
"page_size": 250,
"current_page": 1,
"total_pages": 1,
"api_call_credits": 1,
"data": [
{
"rssd_id": 2362074,
"name": "C1 Bank",
"fdic_certificate_number": 34092
}
]
}
// API URI: https://api.intrinio.com
// GET: /banks?rssd_id=2362074
// FULL URL: https://api.intrinio.com/banks?rssd_id=2362074
{
"rssd_id": 2362074,
"name": "C1 Bank",
"fdic_certificate_number": 34092,
"address": "100 5th Street South",
"city": "Saint Petersburg",
"state": "Florida",
"zip_code": "33701",
"county": "Pinellas",
"state_and_county_no": 12103,
"state_no": 12,
"url": "WWW.C1BANK.COM",
"total_branches": 35,
"domestic_branches": 35,
"foreign_branches": 0,
"asset_concentration_no": 4,
"asset_concentration": "Commercial Lending Specialization",
"occ_charter_number": null,
"fdic_geo_region_no": 5,
"fdic_supervisory_region": "Atlanta",
"fdic_supervisory_region_no": 5,
"frb_district_no": 6,
"frb_district": "Atlanta",
"ots_district_no": 2,
"ots_district": "Southeast",
"occ_district_no": 5,
"regulator": "FDIC",
"state_charter": true,
"federal_charter": false,
"fdic_field_office": "Tampa",
"bank_class": "NM",
"chartering_agency": "STATE",
"conservatorship": false,
"interstate_branches": true,
"s_corp": false,
"trust_fiduciary_services": false,
"community_bank": false,
"cmsa_no": null,
"cmsa": null,
"msa_no": 8280,
"msa": "Tampa-St. Petersburg-Clearwater, FL",
"csa_no": null,
"csa": null,
"cbsa_no": 45300,
"cbsa": "Tampa-St. Petersburg-Clearwater, FL",
"cbsa_metro_no": 45300,
"cbsa_metro": "Tampa-St. Petersburg-Clearwater, FL",
"cbsa_division_no": null,
"cbsa_division": null,
"last_update": "2013-08-05",
"last_structural_change": "2013-08-02",
"established_on": "1995-11-17",
"deposit_insurance_date": "1995-11-17",
"active": true,
"form31_filer": false,
"holding_company": [
{
"rssd_id": 4558901,
"name": "C1 Financial, Inc.",
"city": "Saint Petersburg",
"state": "FL"
}
]
}
Function not available
Function not available
Returns bank list and information for all banks covered by Intrinio.
Endpoints
https://api.intrinio.com/banks
https://api.intrinio.com/banks?query={query-string}
https://api.intrinio.com/banks?rssd_id={rssd_id}
Parameters
- ticker - the stock market ticker symbol associated with the companies common stock securities: TICKER SYMBOL
- rssd_id - the bank/bank holding company RSSD ID issued by the Federal Reserve: RSSD ID LOOKUP
- query (optional, returns full list of banks with compacted response values, if no identifier specified) - used to search for a ticker or bank name to return relevant banks
- page_size (optional, default page size is 100) - an integer greater than 1 for specifying the number of results on each page
- page_number (optional, default page number is 1) - an integer greater than or equal to 1 for specifying the page number for the return values
Return Values
- rssd_id - Federal Reserve ID Number, A unique number assigned by the Federal Reserve board as the entity’s unique identifier
- name - Institution name, The legal name of the institution
- fdic_certificate_number - FDIC Certificate #, A unique NUMBER assigned by the FDIC used to identify institutions and for the issuance of insurance certificates
- 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.
- address - Physical Street Address, Street address at which the institution or one of its branches is physically located
- 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
- 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
- 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
- county - County, County where the institution is physically located (abbreviated if the county name exceeds 16 characters)
- 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
- state_no - State Alpha code, State in which the the headquarters are physically located.
- url - Primary Internet Web Address, The primary internet web address is the public internet site obtained from the most recent FFIEC Call Report
- 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
- 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.
- foreign_branches - Number of Foreign Offices, The number of foreign offices (outside the U.S.) operated by the institution.
- asset_concentration - Name associated with the numeric indicator (SPECGRP) of an institution’s primary specialization in terms of asset concentration
- asset_concentration_no - Asset Concentration Hierarchy, An indicator of an institution’s primary specialization in terms of asset concentration
| # | Asset Concentration |
|---|---|
| 1 | International Specialization |
| 2 | Agricultural Specialization |
| 3 | Credit-card Specialization |
| 4 | Commercial Lending Specialization |
| 5 | Mortgage Lending Specialization |
| 6 | Consumer Lending SpecializationI |
| 7 | Other Specialized < $1 Billion |
| 8 | All Other < $1 Billion |
| 9 | All Other > $1 Billion |
- 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).
- fdic_geo_region_no - FDIC Geographic Region,The FDIC Office assigned to the geographic area.
- fdic_supervisory_region - FDIC Supervisory Region,The supervisory FDIC office assigned to the institution.
- fdic_supervisory_region_no - A numeric value associated with the name of an FDIC supervisory region
- 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.
- frb_district_no - Federal Reserve ID Number, A number used to identify the Federal Reserve district in which the institution is located.
| # | FRB District |
|---|---|
| 01 | Boston |
| 02 | New York |
| 03 | Philadelphia |
| 04 | Cleveland |
| 05 | Richmond |
| 06 | Atlanta |
| 07 | Chicago |
| 08 | St. Louis |
| 09 | Minneapolis |
| 10 | Kansas city |
| 11 | Dallas |
| 12 | San Francisco |
- ots_district_no - OTS District, Office of Thrift Supervision (OTS) District
- 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.
- occ_district_no - Office of the Comptroller, The Office of the Comptroller of the Currency (OCC) District in which the institution is physically located.
- regulator - Regulator, There are three Federal regulators of banks and savings and loan institutions: FDI, FRB, OCC ”“ ”
- state_charter - State Charter, A flag (true;false) that indicates if an institution is state chartered.
- federal_charter - Federal charter flag, A flag used to indicate whether the institution is chartered by an agent of the federal government.
- fdic_field_office - FDIC Field Office, The FDIC Field Office where an institution is physically located.
- 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)
| CODE | BANK CLASS |
|---|---|
| N | commercial bank, national (federal) charter and Fed member, supervised by the Office of the Comptroller of the Currency (OCC) |
| SM | commercial bank, state charter and Fed member, supervised by the Federal Reserve (FRB) |
| NM | commercial bank, state charter and Fed nonmember, supervised by the FDIC SB |
| SA | savings associations, state or federal charter, supervised by the Office of Thrift Supervision (OTS) |
| OI | insured U.S. branch of a foreign chartered institution (IBA) |
- chartering_agency - Chartering Agency, All Chartering Agencies - State and Federal Comptroller of the Currency.
- conservatorship - CONSERVE,Conservatorship,A flag (1=yes;0=no) that indicates if an institution is being operated in government conservatorship.
- 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.“”“
- 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.
- 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
- community_bank - FDIC community banks are identified based on criteria defined in the FDIC Community Banking Study
- cmsa_no - Consolidated Metropolitan Statistical Division Number, The numeric code given by the US Census Bureau office of Management and Budget
- cmsa - Consolidated Metropolitan Statistical Area, The Federal Information Processing Standards (FIPS) Consolidated Metropolitan Statistical Area (CMSA) code is a number representing the institution location
- msa_no - Metropolitan Statistical Area Number,The Metropolitan Statistical Area Number (MSA_NO) in which the institution is physically located
- 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
- 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
- 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
- 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
- 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
- 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
- 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)
- cbsa_division_no - Core Based Statistical Division Number, The numeric code given by the US Census Bureau office of Management and Budget
- 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)
- last_update - Last update, The date of the last data update
- last_structural_change - Last Structure Change Process Date, A date field indicating the date that a change to this record was processed
- established_on - Established Date, The date on which the institution began operations
- deposit_insurance_date - Date of Deposit Insurance, The date that an institution obtained federal deposit insurance
- active - Active, True=Institutions who remain open currently, False=Institutions that are currently closed but were once insured by the FDIC
Bank Holding Company Node
- rssd_id - High Regulatory Holder,The unique number assigned by the Federal Reserve Board to the regulatory high holding company of the institution
- name - Bank Holding Company (Regulatory Top Holder), Regulatory top holder is assigned by the Federal Reserve Board based on ownership and control percentages
- city - City of High Holder, City in which the headquarters of the institution’s regulatory high holder are physically located
- state - Regulatory holding company state location, State location of the regulatory high holding company (either direct or indirect owner).
Bank Holding Companies
// API URI: https://api.intrinio.com
// GET: /banks/holding_companies
// FULL URL: https://api.intrinio.com/banks/holding_companies
{
"result_count": 8179,
"page_size": 250,
"current_page": 1,
"total_pages": 33,
"api_call_credits": 1,
"data": [
{
"rssd_id": 1139523,
"name": "First Sandoval Bancorp, Inc."
},
{
"rssd_id": 1099421,
"name": "First Bancorp Of Sparta, Ltd."
},
...
]
}
// API URI: https://api.intrinio.com
// GET: /banks/holding_companies?query=Morgan
// FULL URL: https://api.intrinio.com/banks/holding_companies?query=Morgan
{
"result_count": 16,
"page_size": 250,
"current_page": 1,
"total_pages": 1,
"api_call_credits": 1,
"data": [
{
"rssd_id": 1832132,
"name": "J.P. MORGAN EQUITY HOLDINGS, INC."
},
{
"rssd_id": 3917873,
"name": "Scott Morgan Bancorp, Inc."
},
...
]
}
// API URI: https://api.intrinio.com
// GET: /banks/holding_companies?rssd_id=1039502
// FULL URL: https://api.intrinio.com/banks/holding_companies?rssd_id=1039502
{
"rssd_id": 1039502,
"name": "Jpmorgan Chase & Co.",
"city": "New York",
"state": "NY",
"banks": [
{
"rssd_id": 852218,
"name": "JPMorgan Chase Bank, National Association",
"fdic_certificate_number": 628,
"address": "1111 Polaris Parkway",
"city": "Columbus",
"state": "Ohio",
"zip_code": "43240",
"county": "Delaware",
"state_and_county_no": 39041,
"state_no": 39,
"url": "http://www.jpmorganchase.com",
"total_branches": 5446,
"domestic_branches": 5544,
"foreign_branches": 197,
"asset_concentration_no": 1,
"asset_concentration": "International Specialization",
"occ_charter_number": 8,
"fdic_geo_region_no": 9,
"fdic_supervisory_region": "Chicago",
"fdic_supervisory_region_no": 16,
"frb_district_no": 4,
"frb_district": "Washington",
"ots_district_no": 3,
"ots_district": "Central",
"occ_district_no": 3,
"regulator": "OCC",
"state_charter": false,
"federal_charter": true,
"fdic_field_office": "Columbus",
"bank_class": "N",
"chartering_agency": "OCC",
"conservatorship": false,
"interstate_branches": true,
"s_corp": false,
"trust_fiduciary_services": true,
"community_bank": false,
"cmsa_no": null,
"cmsa": null,
"msa_no": 1840,
"msa": "Columbus, OH",
"csa_no": 198,
"csa": "Columbus-Marion-Zanesville, OH",
"cbsa_no": 18140,
"cbsa": "Columbus, OH",
"cbsa_metro_no": 18140,
"cbsa_metro": "Columbus, OH",
"cbsa_division_no": null,
"cbsa_division": null,
"last_update": "2015-09-24",
"last_structural_change": "2015-08-31",
"established_on": "1824-01-01",
"deposit_insurance_date": "1934-01-01",
"active": true,
"form31_filer": true
}
]
}
Function not available
Function not available
Returns bank holding company list and information for all bank holding companies covered by Intrinio.
Endpoints
https://api.intrinio.com/banks/holding_companies
https://api.intrinio.com/banks/holding_companies?query={query-string}
https://api.intrinio.com/banks/holding_companies?rssd_id={rssd_id}
Parameters
- ticker - the stock market ticker symbol associated with the companies common stock securities: TICKER SYMBOL
- rssd_id - the bank/bank holding company RSSD ID issued by the Federal Reserve: RSSD ID LOOKUP
- query (optional, returns full list of bank holding companies with compacted response values, if no identifier specified) - used to search for a ticker or bank name to return relevant banks
- page_size (optional, default page size is 100) - an integer greater than 1 for specifying the number of results on each page.
- page_number (optional, default page number is 1) - an integer greater than or equal to 1 for specifying the page number for the return values.
Return Values
- rssd_id - High Regulatory Holder,The unique number assigned by the Federal Reserve Board to the regulatory high holding company of the institution
- name - Bank Holding Company (Regulatory Top Holder), Regulatory top holder is assigned by the Federal Reserve Board based on ownership and control percentages
- city - City of High Holder, City in which the headquarters of the institution’s regulatory high holder are physically located
- state - Regulatory holding company state location, State location of the regulatory high holding company (either direct or indirect owner).
Bank Branches
// API URI: https://api.intrinio.com
// GET: /banks/branches
// FULL URL: https://api.intrinio.com/banks/branches
{
"result_count": 250,
"page_size": 250,
"current_page": 1,
"total_pages": 374,
"api_call_credits": 1,
"data": [
{
"uninumber": 1,
"branch_number": 7636,
"branch_name": "Southington Main Branch",
"rssd_id": 480228,
"bank_name": "Bank of America, National Association"
},
{
"uninumber": 3,
"branch_number": 8203,
"branch_name": "Portland - One City Center Branch",
"rssd_id": 480228,
"bank_name": "Bank of America, National Association"
},
...
]
}
// API URI: https://api.intrinio.com
// GET: /banks/branches?rssd_id=2362074
// FULL URL: https://api.intrinio.com/banks/branches?rssd_id=2362074
{
"result_count": 32,
"page_size": 250,
"current_page": 1,
"total_pages": 1,
"api_call_credits": 1,
"data": [
{
"uninumber": 45104,
"branch_number": 8,
"branch_name": "Pinellas Park Branch",
"rssd_id": 2362074,
"bank_name": "C1 Bank"
},
{
"uninumber": 56232,
"branch_number": 0,
"branch_name": "C1 Bank",
"rssd_id": 2362074,
"bank_name": "C1 Bank"
},
...
]
}
// API URI: https://api.intrinio.com
// GET: /banks/branches?uninumber=56232
// FULL URL: https://api.intrinio.com/banks/branches?uninumber=56232
{
"rssd_id": 2362074,
"bank_name": "C1 Bank"
"uninumber": 56232,
"branch_number": 0,
"branch_name": "C1 Bank",
"address": "100 5th Street South",
"city": "Saint Petersburg",
"state": "FL",
"zip_code": "33701",
"county": "Pinellas",
"country": "United States",
"central_city": "Saint Petersburg",
"latitude": 27.770275932,
"longitude": -82.64009368,
"location_quality": "M",
"location_method": "100.0",
"state_and_county_no": 103,
"state_no": 12,
"place_num": 93042,
"branch_service_type": 11,
"main_office": true,
"msa_no": 45300,
"msa": "Tampa-St. Petersburg-Clearwater, FL",
"csa_no": null,
"csa": null,
"cbsa_division_no": null,
"cbsa_division": null,
"established_on": "1995-11-17",
"acquired_on": null,
"deposits": [
{
"reported_date": "2015-06-30",
"year": 2015,
"total_deposits": 390047000.0
},
{
"reported_date": "2014-06-30",
"year": 2014,
"total_deposits": 336016000.0
},
{
"reported_date": "2013-06-30",
"year": 2013,
"total_deposits": 262213000.0
},
...
]
}
Function not available
Function not available
Returns bank branch list and information for all bank branches covered by Intrinio.
Endpoints
https://api.intrinio.com/banks/branches
https://api.intrinio.com/banks/branches?rssd_id={rssd_id}
https://api.intrinio.com/banks/branches?uninumber={uninumber}
Parameters
- ticker - the stock market ticker symbol associated with the companies common stock securities: TICKER SYMBOL
- rssd_id - the bank/bank holding company RSSD ID issued by the Federal Reserve: RSSD ID LOOKUP
- uninumber (optional, returns full list of bank branches with compacted response values, if no uninumber specified) - the uninumber is the unique identifier for each bank branch office assigned by the Federal Reserve & the FDIC
- page_size (optional, default page size is 100) - an integer greater than 1 for specifying the number of results on each page.
- page_number (optional, default page number is 1) - an integer greater than or equal to 1 for specifying the page number for the return values.
Return Values
- rssd_id - The unique number assigned by the Federal Reserve Board (FRB) to the institution.
- bank_name - Institution name
- uninumber - The unique number associated with a specific physical location of a branch. This number remains with this location over time, regardless of ownership
- branch_number - Numerical reference to identify a branch office within one institution
- branch_name - Branch name
- address - Physical location of the branch
- city - Reported city in which the branch is located
- state - The state abbreviation of the location in which the branch is physically located.
- zip_code - The ZIP code associated with the physical address of the branch.
- county - County name in which the branch is located.
- country - Country name in which the branch is located.
- state_no - The FIPS number of the state in which the branch is physically located.
- state_and_county_no - The state and county FIPS code associated with the specific branch location.
- central_city - Central city based on the reported ZIP code of the branch
- latitude - The lattitude of the branch’s physical location.
- longitude - The longitude of the branch’s physical location
- location_quality - The quality of the match of the branch’s physical location to a latitude and longitude with a given projection.
- location_method - The method used to arrive at the latitude and longitude of the branch’s physical location.
- 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
- branch_service_type - Code that defines the type of service the branch office provides:
| CODE | BRANCH SERVICE TYPE |
|---|---|
| 11 | Full Service, brick and mortar office |
| 12 | Full Service, retail office |
| 13 | Full Service, cyber office |
| 21 | Limited Service, administrative office |
| 22 | Limited Service, military facility |
| 23 | Limited Service, drive-through facility |
| 24 | Limited Service, loan production office |
| 25 | Limited Service, consumer credit office |
| 26 | Limited Service, contractual office |
| 27 | Limited Service, messenger office |
| 28 | Limited Service, retail office |
| 29 | Limited Service, mobile/seasonal office |
| 30 | Limited Service, trust office” |
- main_office - Main office / branch identifier; true=Main office, false=branch
- 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
- msa - The Metropolitan Statistical Area name in which the branch is physically located
- 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
- 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
- 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
- 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
- established_on - The date that the branch location was established.
- acquired_on - The date that a branch was last acquired by another institution
Deposits History Node
- reported_date - The date the bank reported deposits for this branch
- year - The year the bank reported deposits for this branch
- total_deposits - Branch office deposits for the reported date
Failed Banks
// API URI: https://api.intrinio.com
// GET: /banks/failed
// FULL URL: https://api.intrinio.com/banks/failed
{
"result_count": 3554,
"page_size": 250,
"current_page": 1,
"total_pages": 15,
"api_call_credits": 1,
"data": [
{
"fin_id": 1967,
"name": "The Jefferson Guaranty Bank",
"city": "Metairie",
"state": "Louisiana",
"effective_date": "1988-01-13",
"insurance_fund": "FDIC",
"transaction_type": "A/A ",
"charter_class": "NM ",
"failed_or_assistance": "ASSISTANCE",
"total_deposits": 274423000.0,
"total_assets": 292381000.0,
"estimated_fdic_loss": 57525000.0
},
{
"fin_id": 10377,
"name": "High Trust Bank",
"city": "Stockbridge",
"state": "Georgia",
"effective_date": "2011-07-15",
"insurance_fund": "DIF",
"transaction_type": "PA ",
"charter_class": "NM ",
"failed_or_assistance": "FAILURE",
"total_deposits": 177221000.0,
"total_assets": 180340000.0,
"estimated_fdic_loss": 73127000.0
},
...
]
}
Function not available
Function not available
Returns failed bank list and information for all failed banks covered by Intrinio.
Endpoints
https://api.intrinio.com/banks/failed
https://api.intrinio.com/banks/failed?query={query-string}
Parameters
- query (optional, returns full list of failed banks with compacted response values, if no identifier specified) - used to search for a bank name to return relevant failed banks
- page_size (optional, default page size is 100) - an integer greater than 1 for specifying the number of results on each page
- page_number (optional, default page number is 1) - an integer greater than or equal to 1 for specifying the page number for the return values
Return Values
- rssd_id - The unique number assigned by the Federal Reserve Board (FRB) to the institution.
- fin_id - Financial Institution Number is a unique number assigned to the institution as an Assistance Agreement, Conservatorship, Bridge Bank or Receivership.
- name - This is the legal name of the institution
- city - The city and state (or territory) of the headquarters of the institution.
- state - The state in which the headquarters of the institution are physically located
- effective_date - The date that the failed / assisted institution ceased to exist as a privately held going concern. For institutions that entered into government ownership, such as FDIC Bridge Banks and RTC conservatorships, this is the date that they entered into such ownership.
- insurance_fund - Before 1989, there were two federal deposit insurance funds, one administered by the FDIC, which insured deposits in commercial banks and state-chartered savings banks, and another administered by the Federal Savings and Loan Insurance Corporation (FSLIC), which insured deposits in state- and federally-chartered savings associations. In 1989, the Financial Institutions Reform, Recovery and Enforcement Act (FIRREA) specified that thereafter the FDIC would be the federal deposit insurer of all banks and savings associations and would administer both the FDIC fund, which was renamed the Bank Insurance Fund (BIF) and the replacement for the insolvent FSLIC fund, which was called the Savings Association Insurance Fund (SAIF). Although it was created in 1989, the SAIF was not responsible for savings association failures until 1996. From 1989 through 1995, savings association failures were the responsibility of the Resolution Trust Corporation (RTC). In February 2006, The Federal Deposit Insurance Reform Act of 2005 provided for the merger of the BIF and the SAIF into a single Deposit Insurance Fund (DIF). Necessary technical and conforming changes to the law were made under The Federal Deposit Insurance Reform Conforming Amendments Act of 2005. The merger of the funds was effective on March 31, 2006.
- transaction_type - Institutions have been resolved through several different types of transactions. The transaction types outlined below can be grouped into three general categories, based upon the method employed to protect insured depositors and how each transaction affects a failed / assisted institution’s charter.
- charter_class - The FDIC assigns classification codes indicating an institution’s charter type (commercial bank, savings bank, or savings association), its chartering agent (state or federal government), its Federal Reserve membership status (member or nonmember), and its primary federal regulator. These codes are:
| CODE | CHARTER CLASS |
|---|---|
| N | National chartered commercial bank supervised by the Office of the Comptroller of the Currency |
| SM | State charter Fed member commercial bank supervised by the Federal Reserve |
| NM | State charter Fed nonmember commercial bank supervised by the FDIC |
| SA | State or federal charter savings association supervised by the Office of Thrift Supervision or Office of the Comptroller of the Currency |
| SB | State charter savings bank supervised by the FDIC |
- failed_or_assistance - The given institution has failure stature or it can be assistance has been provided by FDIC in merging with other institution.
- total_deposits - Total including demand deposits, money market deposits, other savings deposits, time deposits and deposits in foreign offices as of the last Call Report or Thrift Financial Report filed by the institution prior to the effective date
- total_assets - The Total assets owned by the institution including cash, loans, securities, bank premises and other assets as of the last Call Report or Thrift Financial Report filed by the institution prior to the effective date
- estimated_fdic_loss - The estimated loss is the difference between the amount disbursed from the Deposit Insurance Fund (DIF) to cover obligations to insured depositors and the amount estimated to be ultimately recovered from the liquidation of the receivership estate
Data Point
// API URI: https://api.intrinio.com
// GET: /data_point?identifier=C&item=bank_name
// FULL URL: https://api.intrinio.com/data_point?identifier=C&item=bank_name
{
"identifier": "C",
"item": "bank_name",
"value": "Citibank, National Association"
}
// API URI: https://api.intrinio.com
// GET: /data_point?identifier=852218&item=bank_name
// FULL URL: https://api.intrinio.com/data_point?identifier=852218&item=bank_name
{
"identifier": "2362074",
"item": "bank_name",
"value": "C1 Bank"
}
// API URI: https://api.intrinio.com
// GET: /data_point?identifier=852218&item=total_branches
// FULL URL: https://api.intrinio.com/data_point?identifier=852218&item=total_branches
{
"identifier": "2362074",
"item": "total_branches",
"value": 35
}
// API URI: https://api.intrinio.com
// GET: /data_point?identifier=2362074&item=RIAD4435
// FULL URL: https://api.intrinio.com/data_point?identifier=2362074&item=RIAD4435
{
"identifier": "2362074",
"item": "RIAD4435",
"value": 13423000.0
}
// API URI: https://api.intrinio.com
// GET: /data_point?identifier=2362074&item=RCON0081
// FULL URL: https://api.intrinio.com
{
"identifier": "2362074",
"item": "RCON0081",
"value": 16633000.0
}
=IntrinioDataPoint("C","bank_name")
Citibank, National Association
=IntrinioDataPoint(2362074,"bank_name")
C1 Bank
=IntrinioDataPoint(2362074,"total_branches")
35
=IntrinioDataPoint(2362074,"RIAD4435")
13423000.0
=IntrinioDataPoint(2362074,"RCON0081")
16633000.0
=IntrinioDataPoint("C","bank_name")
Citibank, National Association
=IntrinioDataPoint(2362074,"bank_name")
C1 Bank
=IntrinioDataPoint(2362074,"total_branches")
35
=IntrinioDataPoint(2362074,"RIAD4435")
13423000.0
=IntrinioDataPoint(2362074,"RCON0081")
16633000.0
Returns the most recent data point for a selected identifier (ticker symbol or RSSD ID) for a selected tag. The complete list of tags available through the Bank Data Feed using this function are available here. All duration period values are returned as trailing twelve months and instant period types are returned as of the most recent quarter.
Endpoint
https://api.intrinio.com/data_point?identifier={symbol/rssd}&item={tag}
https://api.intrinio.com/data_point?identifier={symbol1/rssd,symbol2/rssd}&item={tag1,tag2}
Excel Function
=IntrinioDataPoint(identifier, item)
Sheets Function
=IntrinioDataPoint(identifier, item)
Parameters
- identifier - 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: TICKER SYMBOL | RSSD ID LOOKUP
- item - the specified standardized tag as requested. The standardized tag corresponds to line numbers from the call report/UBPR/Y-9C reports: BANK DATA POINT TAGS | CALL REPORT 031 TAGS | CALL REPORT 041 TAGS | UBPR TAGS | Y-9C REPORT TAGS
Limits
You may request up to 150 identifier/item combinations at a time. For example, you may request 1 identifier and 150 items, or 150 identifiers and 1 item, or 12 identifiers and 12 items (144 combinations), or anywhere in between.
Return Values
- identifier - the ticker or identifier for the data point
- item - the requested standardized tag or series ID
- value - the value of the Intrinio tag of the financial data point
- “nm” - No meaning: the value is not meaningful, such as a negative P/E ratio
- “na” - Not applicable: there is no value for the given item/identifier combo, or the user does not have the proper access
Historical Data
// API URI: https://api.intrinio.com
// GET: /historical_data?identifier=2362074&item=RIAD4435
// FULL URL: https://api.intrinio.com/historical_data?identifier=2362074&item=RIAD4435
{
"identifier": "2362074",
"item": "RIAD4435",
"result_count": 34,
"page_size": 50000,
"current_page": 1,
"total_pages": 1,
"api_call_credits": 1,
"data": [
{
"date": "2016-06-30",
"value": 7096000.0
},
{
"date": "2016-03-31",
"value": 3417000.0
},
...
]
}
// API URI: https://api.intrinio.com
// GET: /historical_data?identifier=2362074&item=RCON0081
// FULL URL: https://api.intrinio.com/historical_data?identifier=2362074&item=RCON0081
{
"identifier": "2362074",
"item": "RCON0081",
"result_count": 49,
"page_size": 50000,
"current_page": 1,
"total_pages": 1,
"api_call_credits": 1,
"data": [
{
"date": "2016-06-30",
"value": 16633000.0
},
{
"date": "2016-03-31",
"value": 16332000.0
},
...
]
}
=IntrinioHistoricalData("2362074","RIAD4435",0)
7096000.0
=IntrinioHistoricalData("AAPL","RCON0081",1)
16332000.0
Function not available
Returns the historical data for for a selected identifier (ticker symbol or index symbol) for a selected tag. The complete list of tags available through this function are available here. 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.
Endpoint
https://api.intrinio.com/historical_data?identifier={symbol}&item={tag}
Excel Function
=IntrinioHistoricalData(identifier, item, sequence, start_date, end_date, frequency, type, show_date)
Parameters
- identifier - 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: TICKER SYMBOL | RSSD ID LOOKUP
- item - the specified standardized tag requested. CALL REPORT 031 TAGS | CALL REPORT 041 TAGS | UBPR TAGS | Y-9C REPORT TAGS
- sequence (required, only in Excel add-in function) - an integer 0 or greater for calling a single historical data point from the first entry, based on sort order:
0..last available - start_date (optional) - the earliest date for which to return data:
YYYY-MM-DD - end_date (optional, default=today) - the latest date for which to return data:
YYYY-MM-DD - frequency (optional, returns daily historical price data otherwise) - the frequency of the historical prices & valuation data:
daily | weekly | monthly | quarterly | yearly - type (optional, returns trailing twelve months (TTM) for the income statement, cash flow statement and calculations, and quarterly (QTR) for balance sheet) - 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:
FY | QTR | TTM | YTD - show_date (optional, only in Excel add-in, false by default) if true, the function will return the date value, and if false the function will return the data point value for a given query:
true | false - sort_order (optional, default=desc) - the order of the historical stock price dates:
asc | desc - page_size (optional, default page size is 1000) - an integer greater than 1 for specifying the number of results on each page
- page_number (optional, default page number is 1) - an integer greater than or equal to 1 for specifying the page number for the return values
Return Values
- identifier - the ticker or identifier for the data point
- item - the requested standardized tag or series ID
- date - the date associated with the value of the data tag
- value - the value of the Intrinio tag of the financial data point
Bank Fundamentals
// API URI: https://api.intrinio.com
// GET: /fundamentals/banks?identifier=2362074&statement=RI&type=FY
// FULL URL: https://api.intrinio.com/fundamentals/banks?identifier=2362074&statement=RI&type=FY
{
"result_count": 12,
"page_size": 250,
"current_page": 1,
"total_pages": 1,
"api_call_credits": 1,
"data": [
{
"statement_code": "RI",
"end_date": "2015-12-31",
"start_date": "2015-01-01",
"months": 12,
"fiscal_year": 2015,
"fiscal_period": "FY",
"report": "call_report"
},
{
"statement_code": "RI",
"end_date": "2014-12-31",
"start_date": "2014-01-01",
"months": 12,
"fiscal_year": 2014,
"fiscal_period": "FY",
"report": "call_report"
},
...
]
}
=IntrinioBankFundamentals(2362074,"RI","FY",0,"fiscal_year")
2015
=IntrinioBankFundamentals(2362074,"RI","FY",0,"report")
"call_report"
=IntrinioBankFundamentals(2362074,"RI","FY",1,"fiscal_period")
FY
=IntrinioBankFundamentals(2362074,"RI","FY",1,"end_date")
2014-12-31
Function not available
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. Also, you may add a date and type parameter to specify the fundamentals you wish to be returned in the response.
Endpoint
https://api.intrinio.com/fundamentals/banks?identifier={symbol}&statement={statement}
Excel Function
=IntrinioBankFundamentals(identifier, statement, type, sequence, item)
Parameters
- identifier - 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: TICKER SYMBOL | RSSD ID LOOKUP
- statement - (optional, returns all available statements) - the call report/UBPR/Y-9C financial statement requested: CALL REPORT 031 TAGS | CALL REPORT 041 TAGS | UBPR TAGS | Y-9C REPORT TAGS
- report - (optional, returns both call report and UBPR reports) - select report for all fundamentals:
call_report | ubpr | Y9C - type (optional, returns all available fundamentals) - the type of periods requested - includes fiscal years for annual data, quarters for quarterly data:
FY | QTR | YTD - date (optional, default=today) - the first fundamental will be the latest as of this specified date:
YYYY-MM-DD - sequence (optional, returns full list without a sequence number) - an integer 0 or greater for calling a single fundamental from the first entry
- item (required, only in Excel add-in function) - the return value for the fundamental:
statement_code | end_date | start_date | months | fiscal_year | fiscal_period | report - page_size (optional, default page size is 100) - an integer greater than 1 for specifying the number of results on each page
- page_number (optional, default page number is 1) - an integer greater than or equal to 1 for specifying the page number for the return values
Return Values
- statement_code - the statement code for the financial statement from the report
- fiscal_year - the fiscal year of the fundamental
- fiscal_period - the fiscal period of the fundamental
- end_date - the last date of the fundamental
- start_date - (not available on the balance sheet) the first date of the fundamental
- report - the report the financial statement is sourced from, corresponding with the statement_code
Bank XBRL Tags and Labels
// API URI: https://api.intrinio.com
// GET: /tags/banks?identifier=2362074&statement=RI&fiscal_year=2015&fiscal_period=FY
// FULL URL: https://api.intrinio.com/tags/banks?identifier=2362074&statement=RI&fiscal_year=2015&fiscal_period=FY
{
"result_count": 89,
"page_size": 5000,
"current_page": 1,
"total_pages": 1,
"api_call_credits": 1,
"data": [
{
"name": "Schedule RI - Income Statement",
"tag": "RI",
"unit": "String",
"sequence": 1,
"depth": 1,
"abstract": true
},
{
"name": "Savings deposits (includes MMDAs)",
"tag": "RIAD0093",
"unit": "Monetary",
"sequence": 2,
"depth": 4,
"abstract": false
},
...
]
}
=IntrinioBankTags(2362074,"RI",1,"name")
Savings deposits (includes MMDAs)
=IntrinioBankTags(2362074,"RI",1,"tag")
RIAD0093
Function not available
Returns the Bank XBRL tags and labels for a given ticker/RSSD ID, statement, and date or fiscal year/fiscal quarter.
Endpoint
https://api.intrinio.com/tags/banks?identifier={symbol}&statement={statement}
Excel Function
=IntrinioBankTags(identifier, statement, sequence, item)
Parameters
- identifier - 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: TICKER SYMBOL | RSSD ID LOOKUP
- statement - 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: CALL REPORT 031 TAGS | CALL REPORT 041 TAGS | UBPR TAGS | Y-9C REPORT TAGS
- fiscal_year (optional, otherwise, must specify a date) - the fiscal year associated with the fundamental:
YYYY - fiscal_period (optional, otherwise, must specify a date) - the fiscal period associated with the fundamental:
FY | Q1 | Q2 | Q3 | Q4 | Q1TTM | Q2TTM | Q3TTM | Q2YTD | Q3YTD - sequence (optional, returns full list without a sequence number) - an integer 0 or greater for calling a single tag from the first entry
- item (required, only in Excel add-in function) - the return value for the tag:
name | tag | unit | sequence | depth | abstract - page_size (optional, default page size is 100) - an integer greater than 1 for specifying the number of results on each page
- page_number (optional, default page number is 1) - an integer greater than or equal to 1 for specifying the page number for the return values
Return Values
- name - the label of the XBRL tag as reported of the financial statement
- tag - the XBRL tag of the associated financial data point
- unit - the unit type of the XBRL tag
- 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.
- sequence - an integer 0 or greater indicating the presentation order of the XBRL tag and label in the financial statement
- depth - an integer 0 or greater indicating the presentation indentation depth of the XBRL tag and label in the financial statement
Bank Financials
// API URI: https://api.intrinio.com
// GET: /financials/banks?identifier=2362074&statement=RI&fiscal_year=2015&fiscal_period=FY
// FULL URL: https://api.intrinio.com/financials/banks?identifier=2362074&statement=RI&fiscal_year=2015&fiscal_period=FY
{
"result_count": 76,
"page_size": 5000,
"current_page": 1,
"total_pages": 1,
"api_call_credits": 1,
"data": [
{
"tag": "RIADA518",
"value": 1503000.0
},
{
"tag": "RIAD4056",
"value": 0.0
},
...
]
}
=IntrinioBankFinancials(2362074,"RI",2015,"FY","RIAD0093")
2,006,000
=IntrinioBankFinancials(2362074,"RI",0,"FY","RIAD4107")
77,739,000
Function not available
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.
Endpoint
https://api.intrinio.com/financials/banks?identifier={symbol}&statement={statement}&fiscal_year={fiscal_year}&fiscal_period={fiscal_period}
Excel Function
=IntrinioBankFinancials(identifier, statement, fiscal_year, fiscal_period, tag, rounding)
OR
=IntrinioBankFinancials(identifier, statement, sequence, type, tag, rounding)
Parameters
- identifier - 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: TICKER SYMBOL | RSSD ID LOOKUP
- statement - 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. CALL REPORT 031 TAGS | CALL REPORT 041 TAGS | UBPR TAGS | Y-9C REPORT TAGS
- fiscal_year (optional, otherwise, must specify a date) - the fiscal year associated with the fundamental:
YYYY - fiscal_period (optional, otherwise, must specify a date) - the fiscal period associated with the fundamental:
FY | Q1 | Q2 | Q3 | Q4 | Q1TTM | Q2TTM | Q3TTM | Q2YTD | Q3YTD - sequence (optional, must specify a date or must specify a fiscal year and fiscal period) - the sequence of the requested fundamental (i.e. 0 is the first available fundamental associated with the fiscal period type:
0...last available - type (optional, must specify a date or must specify a fiscal year and fiscal period) - 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:
FY | QTR | TTM | YTD - tag (optional, required in Excel Function) - the specified bank call report, UBPR report, or Y-9C report XBRL tag: CALL REPORT 031 TAGS | CALL REPORT 041 TAGS | UBPR TAGS | Y-9C REPORT TAGS
- date (optional, otherwise, must specify a fiscal year and fiscal period) - the first fundamental will be the latest as of this specified date:
YYYY-MM-DD - rounding (optional, only in Excel & Sheets add-ins function) – round the returned value (actuals, thousands, millions, billions):
A | K | M | B - page_size (optional, default page size is 100) - an integer greater than 1 for specifying the number of results on each page
- page_number (optional, default page number is 1) - an integer greater than or equal to 1 for specifying the page number for the return values
Return Values
- tag - the bank call report, UBPR report, or Y-9C report XBRL tag of the financial data point
- value - the value of the XBRL tag of the financial data point
IEX Real-Time Price Data Feed
Overview
// Quote payload format:
{ type: 'ask',
timestamp: 1493409509.3932788,
ticker: 'GE',
size: 13750,
price: 28.97 }
The Intrinio IEX Real-Time Price Feed uses the WebSockets protocol to push out prices to clients in real time. For more information on WebSockets, visit:
https://developer.mozilla.org/en-US/docs/Web/API/WebSockets_API
Upon connection, the system will send you the last recorded bid/ask/last quotes, even during off-hours. So you will notice that the first quote update will come through immediately upon connection, and it will have an older timestamp. All quotes afterwards are live updates.
Quote Fields
- type - the quote type
-
last- represents the last traded price -
bid- represents the top-of-book bid price -
ask- represents the top-of-book ask price
-
- timestamp - a Unix timestamp (with microsecond precision)
- ticker - the ticker of the security
- size - the size of the
lasttrade, or total volume of orders at the top-of-bookbidoraskprice - price - the price in USD
Official SDKs
Currently we offer a NodeJS SDK anda Ruby SDK (see below). We are also working on developing SDKs in other languages.
Custom Integrations
Due to the complexity of the API, we cannot support every type of custom integration. Please refer to the NodeJS SDK code when building your integration. Here are a few helpful pointers to get you started:
- Make a
GET https://realtime.intrinio.com/authrequest with Basic Authorization containing the user’s Intrinio API Username and Password. This will return an authorization token to use for connecting to the websocket. The token is good for 2 weeks, after which you will need to request another token - Connect to the websocket using this address
wss://realtime.intrinio.com:443/socket/websocket?vsn=1.0.0&token={token}, substituting your authorization token from Step 1 - You will need to parse and format JSON messages between the websocket and your code
- Send a heartbeat message every 20 seconds in order to stay connected:
{"topic": "phoenix","event": "heartbeat","payload": {},"ref": null} - To join to a price channel for a security (for example AAPL), send
{"topic": "iex:securities:AAPL","event": "phx_join","payload": {},"ref": null} - To leave to a price channel for a security (for example AAPL), send
{"topic": "iex:securities:AAPL","event": "phx_leave","payload": {},"ref": null} - Your subscription will have limits to how many channels you can join at one time, as well as how many times you can switch channels in one day. We recommend keeping track of these limits in your code
- The websocket will send you price updates in the format:
{"topic":"iex:securities:BAC","ref":null,"payload":{"type":"ask","timestamp":1493409599.8448584,"ticker":"BAC","size":6300,"price":23.34},"event":"quote"}. Note that the “event” field is “quote”, which signifies this message is for a price quote. Extract the “payload” field and parse it according to the return values below - The websocket connection may be severed. We recommend to write self-healing process that will attempt to reconnect at intervals
NodeJS SDK
The official Intrinio NodeJS SDK for IEX:
https://github.com/intrinio/intrinio-realtime-node-sdk
'use strict';
var IntrinioRealtime = require('intrinio-realtime')
// Create an IntrinioRealtime instance
var ir = new IntrinioRealtime({
username: "INTRINIO_API_USERNAME",
password: "INTRINIO_API_PASSWORD",
})
// Listen for quotes
ir.onQuote(quote => {
var { ticker, type, price, size, timestamp } = quote
console.log("QUOTE: ", ticker, type, price, size, timestamp)
})
// Join channels
ir.join("AAPL", "MSFT", "GE")
Ruby SDK
The official Intrinio Ruby SDK for IEX:
https://github.com/intrinio/intrinio-realtime-ruby-sdk
require 'rubygems'
require 'intrinio-realtime'
require 'thread/pool'
# Provide your Intrinio API access keys (found in https://intrinio.com/account)
username = "YOUR_INTRINIO_API_USERNAME"
password = "YOUR_INTRINIO_API_PASSWORD"
# Setup a logger
logger = Logger.new($stdout)
logger.level = Logger::INFO
# Specify options
options = {
username: username,
password: password,
channels: ["MSFT","AAPL","GE"],
logger: logger
}
# Setup a pool of 50 threads to handle quotes
pool = Thread.pool(50)
# Start listening for quotes
Intrinio::Realtime.connect(options) do |quote|
# Process quote in next available thread
pool.process do
logger.info "QUOTE! #{quote}"
sleep 0.100 # simulate 100ms for I/O operation
end
end
EDI Security Prices Data Feed
Securities
// API URI: https://api.intrinio.com
// GET: /securities?exch_symbol=^XTSE
// FULL URL: https://api.intrinio.com/securities?exch_symbol=^XTSE
{
"result_count": 3019,
"page_size": 250,
"current_page": 1,
"total_pages": 13,
"api_call_credits": 1,
"data": [
{
"ticker": "ABC",
"figi_ticker": "ABC:CN",
"figi": "BBG000C961K5",
"security_name": "ASIA BIO-CHEM GROUP CORP",
"market_sector": "Equity",
"security_type": "Common Stock",
"stock_exchange": "TSE",
"last_crsp_adj_date": null
},
{
"ticker": "AB/H",
"figi_ticker": "AB/H:CN",
"figi": "BBG000BXBPV2",
"security_name": "ASBESTOS CORP LTD",
"market_sector": "Equity",
"security_type": "Common Stock",
"stock_exchange": "TSE",
"last_crsp_adj_date": null
},
...
]
}
// API URI: https://api.intrinio.com
// GET: /securities?identifier=FNV:CT
// FULL URL: https://api.intrinio.com/securities?identifier=FNV:CT
{
"ticker": "FNV",
"figi_ticker": "FNV:CT",
"figi": "BBG000TRN7T6",
"security_name": "FRANCO-NEVADA CORP",
"market_sector": "Equity",
"security_type": "Common Stock",
"stock_exchange": "TSE",
"last_crsp_adj_date": null,
"composite_figi": "BBG000TRN6Z1",
"figi_uniqueid": "EQ0000000004963575",
"share_class_figi": "BBG001STGSR5",
"figi_exch_cntry": "CT",
"currency": "CAD",
"mic": "XTSE",
"exch_symbol": "^XTSE",
"etf": false,
"delisted_security": false,
"primary_listing": true
}
Function not available
Function not available
Returns security list and information for all securities covered by Intrinio. Data from EDI is mapped to the OpenFIGI security master, which ensures all data represented is for a specified security.
Endpoint
https://api.intrinio.com/securities
https://api.intrinio.com/securities?identifier={symbol}
https://api.intrinio.com/securities?query={query-string}
https://api.intrinio.com/securities?exch_symbol={stock-exchange-symbol}
Parameters
- identifier (optional, returns list of securities with compacted response values, if no identifier specified) - the identifier for the specified security: FIGI TICKER | FIGI | OTHER IDENTIFIER
- query (optional, returns list of securities with compacted response values, if no query specified) - a string query search of security name or ticker symbol with the returned results being the relevant securities in compacted list format.
- exch_symbol (optional, returns list of all securities with compacted response values, if no query specified) - the Intrinio Stock Market Symbol, to specify the exchange for the list of securities STOCK EXCHANGE IDENTIFIER
- last_crsp_adj_date (optional) - a date value that returns the list of securities that have had adjusted stock prices due to a corporate event after this date: YYYY-MM-DD
- page_size (optional, default page size is 100) - an integer greater than 1 for specifying the number of results on each page.
- page_number (optional, default page number is 1) - an integer greater than or equal to 1 for specifying the page number for the return values.
Return Values
- ticker - the stock market ticker symbol associated with the security traded on the listed stock exchange
- figi_ticker - the OpenFIGI ticker symbol
- figi - the OpenFIGI identifier
- security_name - the security description as provided by the exchange
- market_sector - the type of market for the security
- security_type - the type of security, such as Common Stock, Preferred Stock, Warrants, Limited Partnership Interests, etc.
- stock_exchange - the Stock Exchange (and market category) where the company’s common stock is primarily traded
- 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.
- composite_figi - the security’s composite FIGI identifier
- figi_uniqueid - the security’s unique FIGI identifier
- share_class_figi - the security’s share class FIGI identifier
- figi_exch_cntry - the security’s FIGI country of the exchange
- currency - the security’s traded currency on the listed exchange
- mic - the Market Identification Code for the Stock Exchange where the security is listed.
- exch_symbol - the Intrinio Stock Exchange Symbol used as an identifier on the Intrinio API.
- etf - a boolean to represent whether the security is an ETF or otherwise
- 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.
- 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.
Stock Exchange Master
// API URI: https://api.intrinio.com
// GET: /stock_exchanges
// FULL URL: https://api.intrinio.com/stock_exchanges
{
"result_count": 29,
"page_size": 250,
"current_page": 1,
"total_pages": 1,
"api_call_credits": 1,
"data": [
{
"symbol": "^BMEX",
"mic": "BMEX",
"institution_name": "BME - BOLSAS Y MERCADOS ESPANOLES",
"acronym": "BME",
"city": "MADRID",
"country": "SPAIN",
"country_code": "ES",
"website": "HTTP://WWW.BOLSASYMERCADOS.ES"
},
{
"symbol": "^BVMF",
"mic": "BVMF",
"institution_name": "BM&FBOVESPA S.A. - BOLSA DE VALORES, MERCADORIAS E FUTUROS",
"acronym": null,
"city": "SAO PAULO",
"country": "BRAZIL",
"country_code": "BR",
"website": "HTTP://WWW.BMFBOVESPA.COM.BR"
},
...
]
}
Function not available
Function not available
Returns stock exchange list and information for all stock exchanges covered by Intrinio.
Endpoint
https://api.intrinio.com/stock_exchanges
https://api.intrinio.com/stock_exchanges?query={query-string}
Parameters
- query (optional, returns full list of stock exchanges with compacted response values, if no query specified) - a string query search of stock exchange name or MIC with the returned results being the relevant stock exchanges in compacted list format.
- page_size (optional, default page size is 100) - an integer greater than 1 for specifying the number of results on each page.
- page_number (optional, default page number is 1) - an integer greater than or equal to 1 for specifying the page number for the return values.
Return Values
- symbol - the Intrinio symbol associated with the stock exchange
- mic - the MIC identifier for the stock exchange
- institution_name - the name of the stock exchange
- acronym - the stock exchanges short form identifier
- city - the city where the stock exchange is located
- country - the country where the stock exchange is located
- country_code - the country code for the country where the stock exchange is located
- website - the website for the stock exchange
Data Point
// API URI: https://api.intrinio.com
// GET: /data_point?identifier=FNV:CT&item=close_price
// FULL URL: https://api.intrinio.com/data_point?identifier=FNV:CT&item=close_price
{
"identifier": "FNV:CT",
"item": "close_price",
"value": 80.28
}
// API URI: https://api.intrinio.com
// GET: /data_point?identifier=FNV:CT&item=price_date,close_price,open_price
// FULL URL: https://api.intrinio.com/data_point?identifier=FNV:CT&item=price_date,close_price,open_price
// NOTE: While this is a single API Call, it is considered
// a Dimensional Call, which counts as 3 API Calls against
// the subscription plan.
{
"result_count": 3,
"api_call_credits": 3,
"data": [
{
"identifier": "FNV:CT",
"item": "price_date",
"value": "2016-12-30"
},
{
"identifier": "FNV:CT",
"item": "close_price",
"value": 80.28
},
{
"identifier": "FNV:CT",
"item": "open_price",
"value": 83.01
}
]
}
=IntrinioDataPoint("FNV:CT","close_price")
80.28
=IntrinioDataPoint("FNV:CT","open_price")
83.01
=IntrinioDataPoint("FNV:CT","close_price")
80.28
=IntrinioDataPoint("FNV:CT","open_price")
83.01
Returns the most recent data point for a selected identifier (ticker symbol, FIGI, etc.) for a selected tag. The complete list of tags available through this function are available here. All data points are returned as their most recent value.
Endpoint
https://api.intrinio.com/data_point?identifier={symbol}&item={tag}
https://api.intrinio.com/data_point?identifier={symbol1,symbol2}&item={tag1,tag2}
Excel Function
=IntrinioDataPoint(identifier, item)
Sheets Function
=IntrinioDataPoint(identifier, item)
Parameters
- identifier - an identifier for the security: FIGI TICKER | FIGI | OTHER IDENTIFIER
- item - the specified standardized tag or series ID requested: EDI PRICES TAGS
Limits
You may request up to 150 identifier/item combinations at a time. For example, you may request 1 identifier and 150 items, or 150 identifiers and 1 item, or 12 identifiers and 12 items (144 combinations), or anywhere in between.
Return Values
- identifier - the ticker or identifier for the data point
- item - the requested standardized tag or series ID
- value - the value of the Intrinio tag of the financial data point
- “nm” - No meaning: the value is not meaningful, such as a negative P/E ratio
- “na” - Not applicable: there is no value for the given item/identifier combo, or the user does not have the proper access
Historical Data
// API URI: https://api.intrinio.com
// GET: /historical_data?identifier=FNV:CT&item=close_price&start_date=2010-01-01&end_date=2010-01-30
// FULL URL: https://api.intrinio.com/historical_data?identifier=FNV:CT&item=close_price&start_date=2010-01-01&end_date=2010-01-30
{
"identifier": "FNV:CT",
"item": "close_price",
"result_count": 20,
"page_size": 50000,
"current_page": 1,
"total_pages": 1,
"api_call_credits": 1,
"data": [
{
"date": "2010-01-29",
"value": 27.04
},
{
"date": "2010-01-28",
"value": 28.1
},
...
]
}
=IntrinioHistoricalData("FNV:CT","close_price",0)
80.28
Function not available
Returns the historical data for for a selected identifier (ticker symbol, FIGI or other identifier) for a selected tag. The complete list of tags available through this function are available here.
Endpoint
https://api.intrinio.com/historical_data?identifier={symbol}&item={tag}
Excel Function
=IntrinioHistoricalData(identifier, item, sequence, start_date, end_date, frequency, type, show_date)
Parameters
- identifier - the stock market ticker symbol associated with the company’s common stock or index. If the company is foreign, use the stock exchange code, followed by a colon, then the ticker: FIGI TICKER | FIGI
- item - the specified standardized tag requested. EDI PRICES TAGS
- sequence (required, only in Excel add-in function) - an integer 0 or greater for calling a single historical data point from the first entry, based on sort order:
0..last available - start_date (optional) - the earliest date for which to return data:
YYYY-MM-DD - end_date (optional, default=today) - the latest date for which to return data:
YYYY-MM-DD - frequency (optional, returns daily historical price data otherwise) - the frequency of the historical prices & valuation data:
daily | weekly | monthly | quarterly | yearly - show_date (optional, only in Excel add-in, false by default) if true, the function will return the date value, and if false the function will return the data point value for a given query:
true | false - sort_order (optional, default=desc) - the order of the historical stock price dates:
asc | desc - page_size (optional, default page size is 1000) - an integer greater than 1 for specifying the number of results on each page.
- page_number (optional, default page number is 1) - an integer greater than or equal to 1 for specifying the page number for the return values.
Return Values
- date - the date associated with the value of the data tag
- value - the value of the data tag for the data point
Prices
// API URI: https://api.intrinio.com
// GET: /prices?identifier=FNV:CT
// FULL URL: https://api.intrinio.com/prices?identifier=FNV:CT
{
"result_count": 2278,
"page_size": 50000,
"current_page": 1,
"total_pages": 1,
"api_call_credits": 1,
"data": [
{
"date": "2016-12-30",
"open": 83.01,
"high": 84.24,
"low": 80.22,
"close": 80.28,
"volume": 534318,
"ex_dividend": 0,
"split_ratio": 1,
"adj_open": 83.01,
"adj_high": 84.24,
"adj_low": 80.22,
"adj_close": 80.28,
"adj_volume": 534318
},
{
"date": "2016-12-29",
"open": 81.66,
"high": 82.97,
"low": 81,
"close": 82.92,
"volume": 524929,
"ex_dividend": 0,
"split_ratio": 1,
"adj_open": 81.66,
"adj_high": 82.97,
"adj_low": 81,
"adj_close": 82.92,
"adj_volume": 524929
},
...
]
}
=IntrinioHistoricalPrices("FNV:CT","open",0)
83.01
=IntrinioHistoricalPrices("FNV:CT","date",0,"2012-01-01","2012-12-31")
2012-12-31
=IntrinioHistoricalPrices("FNV:CT","adj_close",0,"2012-01-01","2012-12-31")
56.78
Function not available
Returns historical stock prices for a security from the Exchange Data International Data Feeds. New EOD prices are available as soon as they are posted by the various exchanges. At this time we do not offer intraday pricing for the exchanges covered by EDI. Historical prices are available back to 2007 or the IPO date.
Endpoint
https://api.intrinio.com/prices?identifier={symbol}
Excel Function
=IntrinioHistoricalPrices(identifier, item, sequence, start_date, end_date, frequency)
Parameters
- identifier - the stock market ticker symbol associated with the companies common stock securities or the stock market index: FIGI TICKER | FIGI | OTHER IDENTIFIER
- item (required, only in Excel add-in function) - the selected observation of the historical prices:
date | open | high | low | close | volume | ex_dividend | split_ratio | adj_open | adj_high | adj_low | adj_close | adj_volume - sequence (required, only in Excel add-in function) - an integer 0 or greater for calling a single historical data point from the first entry, based on sort order:
0..last available - start_date (optional) - 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:
YYYY-MM-DD - end_date (optional, default is today) - 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:
YYYY-MM-DD - frequency (optional, returns daily historical price data otherwise) - the frequency of the historical prices:
daily | weekly | monthly | quarterly | yearly - sort_order - (optional, default=desc) - the order of the historical stock price dates:
asc | desc - page_size (optional, default page size is 100) - an integer greater than 1 for specifying the number of results on each page.
- page_number (optional, default page number is 1) - an integer greater than or equal to 1 for specifying the page number for the return values.
Return Values
- date - the date of the stock price historical data
- open - the actual observed first traded stock price on the trading date
- high - the actual observed highest traded stock price on the trading date
- low - the actual observed lowest traded stock price on the trading date
- close - the actual observed last trade stock price on the trading date
- volume - the actual observed number of shares of stock traded between market participants on the trading date
- split_ratio - the split factor on the split date
- adj_open - the dividend and split adjusted open price
- adj_high - the dividend and split adjusted high price
- adj_low - the dividend and split adjusted low price
- adj_close - the dividend and split adjusted close price
- adj_volume - the dividend and split adjusted volume
Exchange Prices
// API URI: https://api.intrinio.com
// GET: /prices/exchange?identifier=^XTSE&price_date=2016-12-30
// FULL URL: https://api.intrinio.com/prices/exchange?identifier=^XTSE&price_date=2016-12-30
{
"result_count": 3043,
"page_size": 250,
"current_page": 1,
"total_pages": 13,
"api_call_credits": 1,
"data": [
{
"ticker": "AAB",
"figi_ticker": "AAB:CT",
"figi": "BBG000D2T2D0",
"date": "2016-12-30",
"open": 0.16,
"high": 0.16,
"low": 0.155,
"close": 0.155,
"volume": 39000,
"ex_dividend": 0,
"split_ratio": 1,
"adj_open": 0.16,
"adj_high": 0.16,
"adj_low": 0.155,
"adj_close": 0.155,
"adj_volume": 39000
},
{
"ticker": "AAR-U",
"figi_ticker": "AAR-U:CT",
"figi": "BBG000RQ99F7",
"date": "2016-12-30",
"open": 5.58,
"high": 5.61,
"low": 5.49,
"close": 5.59,
"volume": 453794,
"ex_dividend": 0,
"split_ratio": 1,
"adj_open": 5.58,
"adj_high": 5.61,
"adj_low": 5.49,
"adj_close": 5.59,
"adj_volume": 453794
},
...
]
}
Function not available
Function not available
Returns historical stock prices for all securities traded on a stock exchange for a single specified day from the Exchange Data International Data Feeds. Historical prices are available back to 2007 or the IPO date.
Endpoint
https://api.intrinio.com/prices/exchange?identifier={stock-exchange-symbol}&price_date{YYYY-MM-DD}
Parameters
- identifier - the stock market ticker symbol associated with the companies common stock securities or the stock market index: STOCK EXCHANGE SYMBOL
- price_date - the specified date in which historical stock prices are returned for a stock exchange -
YYYY-MM-DD - page_size (optional, returns the maximum of 250 without a page size & number) - an integer greater than 1 for specifying the number of results on each page.
- page_number (optional, returns the first page without a page size & number) - an integer greater than or equal to 1 for specifying the page number for the return values.
Return Values
- ticker - the stock exchange ticker symbol as listed on the stock exchange
- figi_ticker - the OpenFIGI Ticker Symbol
- figi - the FIGI identifier
- date - the date of the stock price historical data
- open - the actual observed first traded stock price on the trading date
- high - the actual observed highest traded stock price on the trading date
- low - the actual observed lowest traded stock price on the trading date
- close - the actual observed last trade stock price on the trading date
- volume - the actual observed number of shares of stock traded between market participants on the trading date
- split_ratio - the adjustment factor for splits and dividends
- adj_open - the dividend and split adjusted open price
- adj_high - the dividend and split adjusted high price
- adj_low - the dividend and split adjusted low price
- adj_close - the dividend and split adjusted close price
- adj_volume - the dividend and split adjusted volume
EDI Corporate Actions Data Feed
Securities
// API URI: https://api.intrinio.com
// GET: /securities?exch_symbol=^XTSE
// FULL URL: https://api.intrinio.com/securities?exch_symbol=^XTSE
{
"result_count": 3019,
"page_size": 250,
"current_page": 1,
"total_pages": 13,
"api_call_credits": 1,
"data": [
{
"ticker": "ABC",
"figi_ticker": "ABC:CN",
"figi": "BBG000C961K5",
"security_name": "ASIA BIO-CHEM GROUP CORP",
"market_sector": "Equity",
"security_type": "Common Stock",
"stock_exchange": "TSE",
"last_crsp_adj_date": null
},
{
"ticker": "AB/H",
"figi_ticker": "AB/H:CN",
"figi": "BBG000BXBPV2",
"security_name": "ASBESTOS CORP LTD",
"market_sector": "Equity",
"security_type": "Common Stock",
"stock_exchange": "TSE",
"last_crsp_adj_date": null
},
...
]
}
// API URI: https://api.intrinio.com
// GET: /securities?identifier=FNV:CT
// FULL URL: https://api.intrinio.com/securities?identifier=FNV:CT
{
"ticker": "FNV",
"figi_ticker": "FNV:CT",
"figi": "BBG000TRN7T6",
"security_name": "FRANCO-NEVADA CORP",
"market_sector": "Equity",
"security_type": "Common Stock",
"stock_exchange": "TSE",
"last_crsp_adj_date": null,
"composite_figi": "BBG000TRN6Z1",
"figi_uniqueid": "EQ0000000004963575",
"share_class_figi": "BBG001STGSR5",
"figi_exch_cntry": "CT",
"currency": "CAD",
"mic": "XTSE",
"exch_symbol": "^XTSE",
"etf": false,
"delisted_security": false,
"primary_listing": true
}
Function not available
Function not available
Returns security list and information for all securities covered by Intrinio. Data from EDI is mapped to the OpenFIGI security master, which ensures all data represented is for a specified security.
Endpoint
https://api.intrinio.com/securities
https://api.intrinio.com/securities?identifier={symbol}
https://api.intrinio.com/securities?query={query-string}
https://api.intrinio.com/securities?exch_symbol={stock-exchange-symbol}
Parameters
- identifier (optional, returns list of securities with compacted response values, if no identifier specified) - the identifier for the specified security: FIGI TICKER | FIGI | OTHER IDENTIFIER
- query (optional, returns list of securities with compacted response values, if no query specified) - a string query search of security name or ticker symbol with the returned results being the relevant securities in compacted list format.
- exch_symbol (optional, returns list of all securities with compacted response values, if no query specified) - the Intrinio Stock Market Symbol, to specify the exchange for the list of securities STOCK EXCHANGE IDENTIFIER
- last_crsp_adj_date (optional) - a date value that returns the list of securities that have had adjusted stock prices due to a corporate event after this date: YYYY-MM-DD
- page_size (optional, default page size is 100) - an integer greater than 1 for specifying the number of results on each page.
- page_number (optional, default page number is 1) - an integer greater than or equal to 1 for specifying the page number for the return values.
Return Values
- ticker - the stock market ticker symbol associated with the security traded on the listed stock exchange
- figi_ticker - the OpenFIGI ticker symbol
- figi - the OpenFIGI identifier
- security_name - the security description as provided by the exchange
- market_sector - the type of market for the security
- security_type - the type of security, such as Common Stock, Preferred Stock, Warrants, Limited Partnership Interests, etc.
- stock_exchange - the Stock Exchange (and market category) where the company’s common stock is primarily traded
- 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.
- composite_figi - the security’s composite FIGI identifier
- figi_uniqueid - the security’s unique FIGI identifier
- share_class_figi - the security’s share class FIGI identifier
- figi_exch_cntry - the security’s FIGI country of the exchange
- currency - the security’s traded currency on the listed exchange
- mic - the Market Identification Code for the Stock Exchange where the security is listed.
- exch_symbol - the Intrinio Stock Exchange Symbol used as an identifier on the Intrinio API.
- etf - a boolean to represent whether the security is an ETF or otherwise
- 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.
- 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.
Stock Exchange Master
// API URI: https://api.intrinio.com
// GET: /stock_exchanges
// FULL URL: https://api.intrinio.com/stock_exchanges
{
"result_count": 29,
"page_size": 250,
"current_page": 1,
"total_pages": 1,
"api_call_credits": 1,
"data": [
{
"symbol": "^BMEX",
"mic": "BMEX",
"institution_name": "BME - BOLSAS Y MERCADOS ESPANOLES",
"acronym": "BME",
"city": "MADRID",
"country": "SPAIN",
"country_code": "ES",
"website": "HTTP://WWW.BOLSASYMERCADOS.ES"
},
{
"symbol": "^BVMF",
"mic": "BVMF",
"institution_name": "BM&FBOVESPA S.A. - BOLSA DE VALORES, MERCADORIAS E FUTUROS",
"acronym": null,
"city": "SAO PAULO",
"country": "BRAZIL",
"country_code": "BR",
"website": "HTTP://WWW.BMFBOVESPA.COM.BR"
},
...
]
}
Function not available
Function not available
Returns stock exchange list and information for all stock exchanges covered by Intrinio.
Endpoint
https://api.intrinio.com/stock_exchanges
https://api.intrinio.com/stock_exchanges?query={query-string}
Parameters
- query (optional, returns full list of stock exchanges with compacted response values, if no query specified) - a string query search of stock exchange name or MIC with the returned results being the relevant stock exchanges in compacted list format.
- page_size (optional, default page size is 100) - an integer greater than 1 for specifying the number of results on each page.
- page_number (optional, default page number is 1) - an integer greater than or equal to 1 for specifying the page number for the return values.
Return Values
- symbol - the Intrinio symbol associated with the stock exchange
- mic - the MIC identifier for the stock exchange
- institution_name - the name of the stock exchange
- acronym - the stock exchanges short form identifier
- city - the city where the stock exchange is located
- country - the country where the stock exchange is located
- country_code - the country code for the country where the stock exchange is located
- website - the website for the stock exchange
Security Corporate Actions
// API URI: https://api.intrinio.com
// GET: /securities/corporate_actions?identifier=AAPL:US
// FULL URL: https://api.intrinio.com/securities/corporate_actions?identifier=AAPL:US
{
"result_count": 1,
"page_size": 250,
"current_page": 1,
"total_pages": 1,
"api_call_credits": 1,
"data": [
{
"event_id": 1080388,
"event_code": "DIV",
"date_data": {
"ex_date": "2017-02-09",
"fye_date": "2017-09-27",
"pay_date": "2017-02-16",
"record_date": "2017-02-13",
"period_end_date": "2016-12-27",
"declaration_date": "2017-01-31"
},
"rate_data": {
"gross_dividend": 0.57
},
"field_data": {
"marker": "INT",
"dap_flag": "N",
"tba_flag": "F",
"frequency": "QTR",
"approx_flag": "F",
"div_rescind": "F",
"nil_dividend": "F",
"rescind_cash_div": "F",
"rescind_stock_div": "F"
}
}
]
}
Function not available
Function not available
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
Endpoint
https://api.intrinio.com/securities/corporate_actions?identifier={symbol}
Parameters
- identifier - the stock market ticker symbol associated with the companies common stock securities or the stock market index: FIGI TICKER | FIGI | OTHER IDENTIFIER
- page_size (optional, default page size is 100) - an integer greater than 1 for specifying the number of results on each page.
- page_number (optional, default page number is 1) - an integer greater than or equal to 1 for specifying the page number for the return values.
Return Values
Stock Exchange Corporate Actions
// API URI: https://api.intrinio.com
// GET: /stock_exchange/corporate_actions?identifier=^XNAS
// FULL URL: https://api.intrinio.com/stock_exchange/corporate_actions?identifier=^XNAS
{
"result_count": 1712,
"page_size": 250,
"current_page": 1,
"total_pages": 7,
"api_call_credits": 1,
"data": [
{
"ticker": "CPA",
"figi_ticker": "CPA:US",
"figi": "BBG000C298Z6",
"event_id": 1086457,
"event_code": "DIV",
"date_data": {
"ex_date": "2017-02-24",
"fye_date": "2017-12-31",
"pay_date": "2017-03-15",
"record_date": "2017-02-28",
"period_end_date": "2017-03-31",
"declaration_date": "2017-02-15"
},
"rate_data": {
"gross_dividend": 0.51
},
"field_data": {
"marker": "INT",
"dap_flag": "N",
"tba_flag": "F",
"frequency": "QTR",
"approx_flag": "F",
"div_rescind": "F",
"nil_dividend": "F",
"rescind_cash_div": "F",
"rescind_stock_div": "F"
}
},
{
"ticker": "SLF",
"figi_ticker": "SLF:US",
"figi": "BBG000LRMW74",
"event_id": 721472,
"event_code": "AGM",
"date_data": {
"agm_date": "2017-05-10",
"fye_date": "2016-12-31"
},
"rate_data": {
},
"field_data": {
"agm_egm": "AGM",
"agm_time": ":",
"country_code": "US"
}
},
...
]
}
Function not available
Function not available
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
Endpoint
https://api.intrinio.com/stock_exchange/corporate_actions?identifier={stock-exchange-symbol}
Parameters
- identifier - the stock market ticker symbol associated with the companies common stock securities or the stock market index: STOCK EXCHANGE SYMBOL
- page_size (optional, returns the maximum of 250 without a page size & number) - an integer greater than 1 for specifying the number of results on each page.
- page_number (optional, returns the first page without a page size & number) - an integer greater than or equal to 1 for specifying the page number for the return values.
Return Values
- ticker - the stock exchange ticker symbol as listed on the stock exchange
- figi_ticker - the OpenFIGI Ticker Symbol
- figi - the FIGI identifier
Zacks Current Estimates Data Feeds
Data Point
// API URI: https://api.intrinio.com
// GET: /data_point?identifier=AAPL&item=zacks_target_price_mean
// FULL URL: https://api.intrinio.com/data_point?identifier=AAPL&item=zacks_target_price_mean
{
"identifier": "AAPL",
"item": "zacks_target_price_mean",
"value": 130.965
}
// API URI: https://api.intrinio.com
// GET: /data_point?identifier=BBG000B9XRY4&item=fy_1_sales_est_mean
// FULL URL: https://api.intrinio.com/data_point?identifier=BBG000B9XRY4&item=fy_1_sales_est_mean
{
"identifier": "BBG000B9XRY4",
"item": "fy_1_sales_est_mean",
"value": 227424420000
}
// API URI: https://api.intrinio.com
// GET: /data_point?identifier=BBG000B9XRY4&item=zacks_analyst_rating_mean
// FULL URL: https://api.intrinio.com/data_point?identifier=BBG000B9XRY4&item=zacks_analyst_rating_mean
{
"identifier": "BBG000B9XRY4",
"item": "zacks_analyst_rating_mean",
"value": 1.6
}
// API URI: https://api.intrinio.com
// GET: /data_point?identifier=AAPL&item=ltg_est_mean
// FULL URL: https://api.intrinio.com/data_point?identifier=AAPL&item=ltg_est_mean
{
"identifier": "AAPL",
"item": "ltg_est_mean",
"value": 0.10885
}
// API URI: https://api.intrinio.com
// GET: /data_point?identifier=BBG000B9XRY4&item=zacks_analyst_rating_strong_buys,zacks_analyst_rating_buys,zacks_analyst_rating_holds,zacks_analyst_rating_sells,zacks_analyst_rating_strong_sells,zacks_analyst_rating_mean
// FULL URL: https://api.intrinio.com/data_point?identifier=BBG000B9XRY4&item=zacks_analyst_rating_strong_buys,zacks_analyst_rating_buys,zacks_analyst_rating_holds,zacks_analyst_rating_sells,zacks_analyst_rating_strong_sells,zacks_analyst_rating_mean
// NOTE: While this is a single API Call, it is considered
// a Dimensional Call, which counts as 6 API Calls against
// the subscription plan.
{
"result_count": 6,
"api_call_credits": 6
"data": [
{
"identifier": "BBG000B9XRY4",
"item": "zacks_analyst_rating_strong_buys",
"value": 22
},
{
"identifier": "BBG000B9XRY4",
"item": "zacks_analyst_rating_buys",
"value": 4
},
{
"identifier": "BBG000B9XRY4",
"item": "zacks_analyst_rating_holds",
"value": 4
},
{
"identifier": "BBG000B9XRY4",
"item": "zacks_analyst_rating_sells",
"value": 0
},
{
"identifier": "BBG000B9XRY4",
"item": "zacks_analyst_rating_strong_sells",
"value": 2
},
{
"identifier": "BBG000B9XRY4",
"item": "zacks_analyst_rating_mean",
"value": 1.6
}
]
}
// API URI: https://api.intrinio.com
// GET: /data_point?identifier=GOOGL,AAPL&item=zacks_target_price_median,zacks_target_price_high,zacks_target_price_low,zacks_target_price_cnt,zacks_target_price_std_dev
// FULL URL: https://api.intrinio.com/data_point?identifier=GOOGL,AAPL&item=zacks_target_price_median,zacks_target_price_high,zacks_target_price_low,zacks_target_price_cnt,zacks_target_price_std_dev
// NOTE: While this is a single API Call, it is considered
// a Dimensional Call, which counts as 10 API Calls against
// the subscription plan.
{
"result_count": 10,
"api_call_credits": 10,
"data": [
{
"identifier": "GOOGL",
"item": "zacks_target_price_median",
"value": 950
},
{
"identifier": "AAPL",
"item": "zacks_target_price_median",
"value": 130
},
{
"identifier": "GOOGL",
"item": "zacks_target_price_high",
"value": 1080
},
{
"identifier": "AAPL",
"item": "zacks_target_price_high",
"value": 185
},
{
"identifier": "GOOGL",
"item": "zacks_target_price_low",
"value": 700
},
{
"identifier": "AAPL",
"item": "zacks_target_price_low",
"value": 82
},
{
"identifier": "GOOGL",
"item": "zacks_target_price_cnt",
"value": 29
},
{
"identifier": "AAPL",
"item": "zacks_target_price_cnt",
"value": 29
},
{
"identifier": "GOOGL",
"item": "zacks_target_price_std_dev",
"value": 75.493
},
{
"identifier": "AAPL",
"item": "zacks_target_price_std_dev",
"value": 20.956
}
]
}
=IntrinioDataPoint("AAPL","zacks_target_price_mean")
130.965
=IntrinioDataPoint("BBG000B9XRY4","zacks_analyst_rating_mean")
1.6
=IntrinioDataPoint("AAPL","ltg_est_mean")
0.10885
=IntrinioDataPoint("AAPL","fy_1_sales_est_mean")
$227,424,420,000.00
=IntrinioDataPoint("AAPL","zacks_target_price_mean")
130.965
=IntrinioDataPoint("BBG000B9XRY4","zacks_analyst_rating_mean")
1.6
=IntrinioDataPoint("AAPL","ltg_est_mean")
0.10885
=IntrinioDataPoint("AAPL","fy_1_sales_est_mean")
$227,424,420,000.00
Returns the most recent data point for a selected identifier (ticker symbol, FIGI, CIK ID, etc.) for a selected tag.
Endpoint
https://api.intrinio.com/data_point?identifier={symbol}&item={tag}
https://api.intrinio.com/data_point?identifier={symbol1,symbol2}&item={tag1,tag2}
Excel Function
=IntrinioDataPoint(identifier, item)
Sheets Function
=IntrinioDataPoint(identifier, item)
Parameters
- identifier - an identifier for the company or data point, including the ticker symbol, FIGI, SEC CIK ID: TICKER SYMBOL
- item - the specified Zacks current data tag for one of the Zacks Current Data Feeds: ANALYST RATINGS | TARGET PRICES | SALES ESTIMATES | EPS ESTIMATES | LT GROWTH ESTIMATES
Limits
You may request up to 150 identifier/item combinations at a time. For example, you may request 1 identifier and 150 items, or 150 identifiers and 1 item, or 12 identifiers and 12 items (144 combinations), or anywhere in between.
Return Values
- identifier - the ticker or identifier for the data point
- item - the requested standardized tag or series ID
- value - the value of the Intrinio tag of the financial data point
- “nm” - No meaning: the value is not meaningful, such as a negative P/E ratio
- “na” - Not applicable: there is no value for the given item/identifier combo, or the user does not have the proper access
Securities Search/Screener
// API URI: https://api.intrinio.com
// GET: /securities/search?conditions=zacks_analyst_rating_mean~gt~3
// FULL URL: https://api.intrinio.com/securities/search?conditions=zacks_analyst_rating_mean~gt~3
{
"result_count": 160,
"page_size": 5,
"current_page": 1,
"total_pages": 32,
"api_call_credits": 1,
"data": [
{
"ticker": "ABAX",
"zacks_analyst_rating_mean": 4
},
{
"ticker": "ALV",
"zacks_analyst_rating_mean": 3.1
},
{
"ticker": "ANF",
"zacks_analyst_rating_mean": 3.5
},
...
]
}
Function not available
The Screener API can be accessed through the Intrinio Screener for Excel
Function not available
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.
Endpoint
https://api.intrinio.com/securities/search?conditions={conditions}
Intrinio Screener for Excel
Parameters
- conditions - A comma-separated list of conditions. Each condition consists three elements separated by tildes (~):
- A data tag ANALYST RATINGS | TARGET PRICES | SALES ESTIMATES | EPS ESTIMATES | LT GROWTH ESTIMATES
- 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”
- A value
- order_column - A data tag by which to order the results ANALYST RATINGS | TARGET PRICES | SALES ESTIMATES | EPS ESTIMATES | LT GROWTH ESTIMATES
- order_direction - The direction in which to order the results (“asc” for Ascending or “desc” for descending)
- page_size - (optional, default page size is 100) - an integer greater than 1 for specifying the number of results on each page (up to 100)
- page_number - (optional, default page number is 1) - an integer greater than 1 for specifying the page number for the return values
Return Values
The return values will correspond to the data tags in the conditions. Ticker will always be included.
Zacks Historical Estimates Data Feeds
Data Point
// API URI: https://api.intrinio.com
// GET: /data_point?identifier=AAPL&item=zacks_target_price_mean
// FULL URL: https://api.intrinio.com/data_point?identifier=AAPL&item=zacks_target_price_mean
{
"identifier": "AAPL",
"item": "zacks_target_price_mean",
"value": 130.965
}
// API URI: https://api.intrinio.com
// GET: /data_point?identifier=AAPL&item=fy_2020_sales_est_median
// FULL URL: https://api.intrinio.com/data_point?identifier=AAPL&item=fy_2020_sales_est_median
{
"identifier": "AAPL",
"item": "fy_2020_sales_est_median",
"value": 242644000000
}
// API URI: https://api.intrinio.com
// GET: /data_point?identifier=BBG000B9XRY4&item=fy_1_sales_est_mean
// FULL URL: https://api.intrinio.com/data_point?identifier=BBG000B9XRY4&item=fy_1_sales_est_mean
{
"identifier": "BBG000B9XRY4",
"item": "fy_1_sales_est_mean",
"value": 227424420000
}
// API URI: https://api.intrinio.com
// GET: /data_point?identifier=BBG000B9XRY4&item=fy_2020_eps_est_median
// FULL URL: https://api.intrinio.com/data_point?identifier=BBG000B9XRY4&item=fy_2020_eps_est_median
{
"identifier": "AAPL",
"item": "fy_2020_eps_est_median",
"value": 10.81
}
// API URI: https://api.intrinio.com
// GET: /data_point?identifier=BBG000B9XRY4&item=zacks_analyst_rating_mean
// FULL URL: https://api.intrinio.com/data_point?identifier=BBG000B9XRY4&item=zacks_analyst_rating_mean
{
"identifier": "BBG000B9XRY4",
"item": "zacks_analyst_rating_mean",
"value": 1.6
}
// API URI: https://api.intrinio.com
// GET: /data_point?identifier=AAPL&item=ltg_est_mean
// FULL URL: https://api.intrinio.com/data_point?identifier=AAPL&item=ltg_est_mean
{
"identifier": "AAPL",
"item": "ltg_est_mean",
"value": 0.10885
}
// API URI: https://api.intrinio.com
// GET: /data_point?identifier=BBG000B9XRY4&item=zacks_analyst_rating_strong_buys,zacks_analyst_rating_buys,zacks_analyst_rating_holds,zacks_analyst_rating_sells,zacks_analyst_rating_strong_sells,zacks_analyst_rating_mean
// FULL URL: https://api.intrinio.com/data_point?identifier=BBG000B9XRY4&item=zacks_analyst_rating_strong_buys,zacks_analyst_rating_buys,zacks_analyst_rating_holds,zacks_analyst_rating_sells,zacks_analyst_rating_strong_sells,zacks_analyst_rating_mean
// NOTE: While this is a single API Call, it is considered
// a Dimensional Call, which counts as 6 API Calls against
// the subscription plan.
{
"result_count": 6,
"api_call_credits": 6
"data": [
{
"identifier": "BBG000B9XRY4",
"item": "zacks_analyst_rating_strong_buys",
"value": 22
},
{
"identifier": "BBG000B9XRY4",
"item": "zacks_analyst_rating_buys",
"value": 4
},
{
"identifier": "BBG000B9XRY4",
"item": "zacks_analyst_rating_holds",
"value": 4
},
{
"identifier": "BBG000B9XRY4",
"item": "zacks_analyst_rating_sells",
"value": 0
},
{
"identifier": "BBG000B9XRY4",
"item": "zacks_analyst_rating_strong_sells",
"value": 2
},
{
"identifier": "BBG000B9XRY4",
"item": "zacks_analyst_rating_mean",
"value": 1.6
}
]
}
// API URI: https://api.intrinio.com
// GET: /data_point?identifier=GOOGL,AAPL&item=zacks_target_price_median,zacks_target_price_high,zacks_target_price_low,zacks_target_price_cnt,zacks_target_price_std_dev
// FULL URL: https://api.intrinio.com/data_point?identifier=GOOGL,AAPL&item=zacks_target_price_median,zacks_target_price_high,zacks_target_price_low,zacks_target_price_cnt,zacks_target_price_std_dev
// NOTE: While this is a single API Call, it is considered
// a Dimensional Call, which counts as 10 API Calls against
// the subscription plan.
{
"result_count": 10,
"api_call_credits": 10,
"data": [
{
"identifier": "GOOGL",
"item": "zacks_target_price_median",
"value": 950
},
{
"identifier": "AAPL",
"item": "zacks_target_price_median",
"value": 130
},
{
"identifier": "GOOGL",
"item": "zacks_target_price_high",
"value": 1080
},
{
"identifier": "AAPL",
"item": "zacks_target_price_high",
"value": 185
},
{
"identifier": "GOOGL",
"item": "zacks_target_price_low",
"value": 700
},
{
"identifier": "AAPL",
"item": "zacks_target_price_low",
"value": 82
},
{
"identifier": "GOOGL",
"item": "zacks_target_price_cnt",
"value": 29
},
{
"identifier": "AAPL",
"item": "zacks_target_price_cnt",
"value": 29
},
{
"identifier": "GOOGL",
"item": "zacks_target_price_std_dev",
"value": 75.493
},
{
"identifier": "AAPL",
"item": "zacks_target_price_std_dev",
"value": 20.956
}
]
}
// API URI: https://api.intrinio.com
// GET: /data_point?identifier=GOOGL,AAPL&item=fy_2018_sales_est_median
// FULL URL: https://api.intrinio.com/data_point?identifier=GOOGL,AAPL&item=fy_2018_sales_est_median
// NOTE: While this is a single API Call, it is considered
// a Dimensional Call, which counts as 2 API Calls against
// the subscription plan.
{
"result_count": 2,
"api_call_credits": 2,
"data": [
{
"identifier": "GOOGL",
"item": "fy_2018_sales_est_median",
"value": 96374650000
},
{
"identifier": "AAPL",
"item": "fy_2018_sales_est_median",
"value": 242897000000
}
]
}
=IntrinioDataPoint("AAPL","zacks_target_price_mean")
130.965
=IntrinioDataPoint("BBG000B9XRY4","zacks_analyst_rating_mean")
1.6
=IntrinioDataPoint("GOOGL","fy_2018_sales_est_median")
96,374,650,000.00
=IntrinioDataPoint("AAPL","fy_2018_sales_est_median")
$242,897,000,000.00
=IntrinioDataPoint("AAPL","ltg_est_mean")
0.10885
=IntrinioDataPoint("AAPL","fy_1_sales_est_mean")
$227,424,420,000.00
=IntrinioDataPoint("AAPL","zacks_target_price_mean")
130.965
=IntrinioDataPoint("BBG000B9XRY4","zacks_analyst_rating_mean")
1.6
=IntrinioDataPoint("AAPL","ltg_est_mean")
0.10885
=IntrinioDataPoint("AAPL","fy_1_sales_est_mean")
$227,424,420,000.00
=IntrinioDataPoint("GOOGL","fy_2018_sales_est_median")
96,374,650,000.00
=IntrinioDataPoint("AAPL","fy_2018_sales_est_median")
$242,897,000,000.00
Returns the most recent data point for a selected identifier (ticker symbol, FIGI, CIK ID, etc.) for a selected tag.
Endpoint
https://api.intrinio.com/data_point?identifier={symbol}&item={tag}
https://api.intrinio.com/data_point?identifier={symbol1,symbol2}&item={tag1,tag2}
Excel Function
=IntrinioDataPoint(identifier, item)
Sheets Function
=IntrinioDataPoint(identifier, item)
Parameters
- identifier - an identifier for the company or data point, including the ticker symbol, FIGI, SEC CIK ID: TICKER SYMBOL
- item - the specified Zacks current data tag for one of the Zacks Current or Historical Data Feeds: CURRENT ANALYST RATINGS | CURRENT TARGET PRICES | CURRENT SALES ESTIMATES | CURRENT EPS ESTIMATES | CURRENT LT GROWTH ESTIMATES | HISTORICAL SALES ESTIMATES | HISTORICAL EPS ESTIMATES
Limits
You may request up to 150 identifier/item combinations at a time. For example, you may request 1 identifier and 150 items, or 150 identifiers and 1 item, or 12 identifiers and 12 items (144 combinations), or anywhere in between.
Return Values
- identifier - the ticker or identifier for the data point
- item - the requested standardized tag or series ID
- value - the value of the Intrinio tag of the financial data point
- “nm” - No meaning: the value is not meaningful, such as a negative P/E ratio
- “na” - Not applicable: there is no value for the given item/identifier combo, or the user does not have the proper access
Historical Data
// API URI: https://api.intrinio.com
// GET: /historical_data?identifier=AAPL&item=fy_2018_eps_est_median
// FULL URL: https://api.intrinio.com/historical_data?identifier=AAPL&item=fy_2018_eps_est_median
{
"identifier": "AAPL",
"item": "fy_2018_eps_est_median",
"result_count": 82,
"page_size": 50000,
"current_page": 1,
"total_pages": 1,
"api_call_credits": 1,
"data": [
{
"date": "2016-12-20",
"value": 10
},
{
"date": "2016-11-11",
"value": 10
},
{
"date": "2016-10-27",
"value": 10.045
},
{
"date": "2016-10-26",
"value": 10.09
},
{
"date": "2016-10-24",
"value": 10.24
},
...
]
}
// API URI: https://api.intrinio.com
// GET: /historical_data?identifier=AAPL&item=zacks_target_price_mean
// FULL URL: https://api.intrinio.com/historical_data?identifier=AAPL&item=zacks_target_price_mean
{
"identifier": "AAPL",
"item": "zacks_target_price_mean",
"result_count": 1008,
"page_size": 50000,
"current_page": 1,
"total_pages": 1,
"api_call_credits": 1,
"data": [
{
"date": "2016-12-04",
"value": 130.965
},
{
"date": "2016-11-27",
"value": 131.034
},
{
"date": "2016-11-14",
"value": 131.107
},
{
"date": "2016-10-27",
"value": 131
},
{
"date": "2016-10-26",
"value": 130.857
},
...
]
}
// API URI: https://api.intrinio.com
// GET: /historical_data?identifier=AAPL&item=zacks_analyst_rating_mean
// FULL URL: https://api.intrinio.com/historical_data?identifier=AAPL&item=zacks_analyst_rating_mean
{
"identifier": "AAPL",
"item": "zacks_analyst_rating_mean",
"result_count": 1199,
"page_size": 50000,
"current_page": 1,
"total_pages": 1,
"api_call_credits": 1
"data": [
{
"date": "2016-12-21",
"value": 1.6
},
{
"date": "2016-12-18",
"value": 1.6
},
{
"date": "2016-11-27",
"value": 1.6
},
{
"date": "2016-10-27",
"value": 1.6
},
{
"date": "2016-10-25",
"value": 1.6
},
{
"date": "2016-09-15",
"value": 1.5
},
{
"date": "2016-09-08",
"value": 1.5
},
{
"date": "2016-08-10",
"value": 1.5
},
...
]
}
=IntrinioHistoricalData("AAPL","fy_2018_eps_est_median",0)
$10.00
=IntrinioHistoricalData("AAPL","zacks_target_price_mean",0,"2012-01-01","2012-12-31")
108.521
=IntrinioHistoricalData("AAPL","zacks_analyst_rating_mean",0,"2010-01-01","2010-02-01")
1.3
Function not available
Returns the historical data for for a selected identifier (ticker symbol, CIK, FIGI) for a selected Zack’s Historical tag.
Endpoint
https://api.intrinio.com/historical_data?identifier={symbol}&item={tag}
Excel Function
=IntrinioHistoricalData(identifier, item, sequence, start_date, end_date, frequency, type, show_date)
Parameters
- identifier - the stock market ticker symbol associated with the company’s common stock or index. If the company is foreign, use the stock exchange code, followed by a colon, then the ticker: TICKER SYMBOL | FIGI | CIK
- item - the specified Zacks Historical data tag requested. ANALYST RATING | TARGET PRICE | SALES ESTIMATES | EPS ESTIMATES | LT GROWTH ESTIMATES
- sequence (required, only in Excel add-in function) - an integer 0 or greater for calling a single historical data point from the first entry, based on sort order:
0..last available - start_date (optional) - the earliest date for which to return data:
YYYY-MM-DD - end_date (optional, default=today) - the latest date for which to return data:
YYYY-MM-DD - frequency (optional, returns daily historical price data otherwise) - the frequency of the historical prices & valuation data:
daily | weekly | monthly | quarterly | yearly - show_date (optional, only in Excel add-in, false by default) if true, the function will return the date value, and if false the function will return the data point value for a given query:
true | false - sort_order (optional, default=desc) - the order of the historical stock price dates:
asc | desc - page_size (optional, default page size is 1000) - an integer greater than 1 for specifying the number of results on each page
- page_number (optional, default page number is 1) - an integer greater than or equal to 1 for specifying the page number for the return values
Return Values
- identifier - the ticker or identifier for the data point
- item - the requested standardized tag or series ID
- date - the date associated with the value of the data tag
- value - the value of the Intrinio tag of the financial data point
Zacks Sales Surprises
Sales Surprises
// API URI: https://api.intrinio.com
// GET: /securities/surprises/sales?identifier=AAPL
// FULL URL: https://api.intrinio.com/securities/surprises/sales?identifier=AAPL
{
"result_count": 68,
"page_size": 250,
"current_page": 1,
"total_pages": 1,
"api_call_credits": 1,
"data": [
{
"ticker": "AAPL",
"figi_ticker": "AAPL:US",
"figi": "BBG000B9XRY4",
"fiscal_year": 2017,
"fiscal_quarter": "Q1",
"calendar_year": 2016,
"calendar_quarter": "Q4",
"actual_reported_date": "2017-01-31",
"actual_reported_time": "16:30",
"actual_reported_code": "AMC",
"actual_reported_desc": "AFTER MARKET CLOSE",
"last_rev_date": "2017-01-24",
"sales_actual": 78351000000,
"sales_actual_zacks_adj": 0,
"sales_actual_gaap": 78351000000,
"sales_mean_estimate": 76926210000,
"sales_amount_diff": 1424790000,
"sales_percent_diff": 0.0185,
"sales_count_estimate": 11,
"sales_std_dev_estimate": 889990000
},
{
"ticker": "AAPL",
"figi_ticker": "AAPL:US",
"figi": "BBG000B9XRY4",
"fiscal_year": 2016,
"fiscal_quarter": "Q4",
"calendar_year": 2016,
"calendar_quarter": "Q3",
"actual_reported_date": "2016-10-25",
"actual_reported_time": "16:30",
"actual_reported_code": "AMC",
"actual_reported_desc": "AFTER MARKET CLOSE",
"last_rev_date": "2016-10-18",
"sales_actual": 46852000000,
"sales_actual_zacks_adj": 0,
"sales_actual_gaap": 46852000000,
"sales_mean_estimate": 46825750000,
"sales_amount_diff": 26250000,
"sales_percent_diff": 0.0006,
"sales_count_estimate": 11,
"sales_std_dev_estimate": 735580000
},
...
]
}
// API URI: https://api.intrinio.com
// GET: /securities/surprises/sales?earnings_date=2017-01-31
// FULL URL: https://api.intrinio.com/securities/surprises/sales?earnings_date=2017-01-31
{
"result_count": 137,
"page_size": 250,
"current_page": 1,
"total_pages": 1,
"api_call_credits": 1,
"data": [
{
"ticker": "AAPL",
"figi_ticker": "AAPL:US",
"figi": "BBG000B9XRY4",
"fiscal_year": 2017,
"fiscal_quarter": "Q1",
"calendar_year": 2016,
"calendar_quarter": "Q4",
"actual_reported_date": "2017-01-31",
"actual_reported_time": "16:30",
"actual_reported_code": "AMC",
"actual_reported_desc": "AFTER MARKET CLOSE",
"last_rev_date": "2017-01-24",
"sales_actual": 78351000000,
"sales_actual_zacks_adj": 0,
"sales_actual_gaap": 78351000000,
"sales_mean_estimate": 76926210000,
"sales_amount_diff": 1424790000,
"sales_percent_diff": 0.0185,
"sales_count_estimate": 11,
"sales_std_dev_estimate": 889990000
},
{
"ticker": "ABC",
"figi_ticker": "ABC:US",
"figi": "BBG000MDCSN6",
"fiscal_year": 2017,
"fiscal_quarter": "Q1",
"calendar_year": 2016,
"calendar_quarter": "Q4",
"actual_reported_date": "2017-01-31",
"actual_reported_time": "06:30",
"actual_reported_code": "BTO",
"actual_reported_desc": "BEFORE THE OPEN",
"last_rev_date": "2017-01-12",
"sales_actual": 38169270000,
"sales_actual_zacks_adj": 0,
"sales_actual_gaap": 38169270000,
"sales_mean_estimate": 39120770000,
"sales_amount_diff": -951500000,
"sales_percent_diff": -0.0243,
"sales_count_estimate": 5,
"sales_std_dev_estimate": 307870000
},
...
]
}
Function not available
Function not available
SUMMARY
Endpoint
https://api.intrinio.com/securities/surprises/sales?identifier={symbol}
https://api.intrinio.com//securities/surprises/sales?earnings_date={date}
Parameters
- identifier - an identifier for the company or security, including the ticker symbol, FIGI, SEC CIK ID: TICKER SYMBOL
- earnings_date - a specified date to return earnings for all securities on that date: YYYY-MM-DD
Return Values
- ticker - the stock market ticker symbol associated with the companies common stock securities
- figi_ticker - the OpenFIGI ticker symbol
- figi - the OpenFIGI identifier
- fiscal_year - the company’s fiscal year for the reported period
- fiscal_quarter - the company’s fiscal quarter for the reported period
- calendar_year - the closest calendar year for the company’s fiscal year
- calendar_quarter - the closest calendar quarter for the company’s fiscal year
- actual_reported_date - actual report date for the earnings release
- actual_reported_time - actual report time for the earnings release
- actual_reported_code - the code cooresponding to the earnings release
BTO = BEFORE THE OPEN | DTM = DURING THE MARKET | AMC = AFTER MARKET CLOSE - actual_reported_desc - the description for the type of earnings release
- last_rev_date - the last revision date for the analyst estimates
- sales_actual - the actual Non-GAAP sales figure released by the company, interpreted by Zacks.
- sales_actual_zacks_adj - the adjustments Zacks made to get to Non-GAAP sales to reconcile with GAAP sales.
- sales_actual_gaap - the actual GAAP sales figured released by the company
- sales_mean_estimate - the pre-earnings release mean sales estimate for the company sales_count_estimate - the pre-earnings release number of estimates by analysts
- sales_std_dev_estimate - the pre-earnings release standard deviation of sales estimates
- sales_amount_diff - sales surprise amount difference
- sales_percent_diff - sales surprise percent difference
Data Point
// API URI: https://api.intrinio.com
// GET: /data_point?identifier=AAPL&item=last_earnings_sales_report_date
// FULL URL: https://api.intrinio.com/data_point?identifier=AAPL&item=last_earnings_sales_report_date
{
"identifier": "AAPL",
"item": "last_earnings_sales_report_date",
"value": "2017-01-31"
}
// API URI: https://api.intrinio.com
// GET: /data_point?identifier=AAPL&item=sales_surprise_percent_diff
// FULL URL: https://api.intrinio.com/data_point?identifier=AAPL&item=sales_surprise_percent_diff
{
"identifier": "AAPL",
"item": "sales_surprise_percent_diff",
"value": 0.0185
}
// API URI: https://api.intrinio.com
// GET: /data_point?identifier=AAPL&item=last_earnings_sales_report_date,last_earnings_sales_report_time,last_earnings_sales_report_code,gaap_sales,non_gaap_sales,pre_earnings_sales_est_mean,sales_surprise_amount_diff
// FULL URL: https://api.intrinio.com/data_point?identifier=AAPL&item=last_earnings_sales_report_date,last_earnings_sales_report_time,last_earnings_sales_report_code,gaap_sales,non_gaap_sales,pre_earnings_sales_est_mean,sales_surprise_amount_diff
// NOTE: While this is a single API Call, it is considered
// a Dimensional Call, which counts as 7 API Calls against
// the subscription plan.
{
"result_count": 7,
"api_call_credits": 7,
"data": [
{
"identifier": "AAPL",
"item": "last_earnings_sales_report_date",
"value": "2017-01-31"
},
{
"identifier": "AAPL",
"item": "last_earnings_sales_report_time",
"value": "16:30"
},
{
"identifier": "AAPL",
"item": "last_earnings_sales_report_code",
"value": "AFTER MARKET CLOSE"
},
{
"identifier": "AAPL",
"item": "gaap_sales",
"value": 78351000000
},
{
"identifier": "AAPL",
"item": "non_gaap_sales",
"value": 78351000000
},
{
"identifier": "AAPL",
"item": "pre_earnings_sales_est_mean",
"value": 76926210000
},
{
"identifier": "AAPL",
"item": "sales_surprise_amount_diff",
"value": 1424790000
}
]
}
=IntrinioDataPoint("AAPL","last_earnings_sales_report_date")
"2017-01-31"
=IntrinioDataPoint("AAPL","sales_surprise_percent_diff")
0.0185
=IntrinioDataPoint("AAPL","last_earnings_sales_report_date")
"2017-01-31"
=IntrinioDataPoint("AAPL","sales_surprise_percent_diff")
0.0185
Returns the most recent data point for a selected identifier (ticker symbol, FIGI, CIK ID, etc.) for a selected tag.
Endpoint
https://api.intrinio.com/data_point?identifier={symbol}&item={tag}
https://api.intrinio.com/data_point?identifier={symbol1,symbol2}&item={tag1,tag2}
Excel Function
=IntrinioDataPoint(identifier, item)
Sheets Function
=IntrinioDataPoint(identifier, item)
Parameters
- identifier - an identifier for the company or data point, including the ticker symbol, FIGI, SEC CIK ID: TICKER SYMBOL
- item - the specified Zacks current data tag for one of the Zacks Current or Historical Data Feeds: SALES SURPRISES
Limits
You may request up to 150 identifier/item combinations at a time. For example, you may request 1 identifier and 150 items, or 150 identifiers and 1 item, or 12 identifiers and 12 items (144 combinations), or anywhere in between.
Return Values
- identifier - the ticker or identifier for the data point
- item - the requested standardized tag or series ID
- value - the value of the Intrinio tag of the financial data point
- “nm” - No meaning: the value is not meaningful, such as a negative P/E ratio
- “na” - Not applicable: there is no value for the given item/identifier combo, or the user does not have the proper access
Historical Data
// API URI: https://api.intrinio.com
// GET: /historical_data?identifier=AAPL&item=non_gaap_sales
// FULL URL: https://api.intrinio.com/historical_data?identifier=AAPL&item=non_gaap_sales
{
"identifier": "AAPL",
"item": "non_gaap_sales",
"result_count": 68,
"page_size": 50000,
"current_page": 1,
"total_pages": 1,
"api_call_credits": 1,
"data": [
{
"date": "2017-01-31",
"value": 78351000000
},
{
"date": "2016-10-25",
"value": 46852000000
},
...
]
}
// API URI: https://api.intrinio.com
// GET: /historical_data?identifier=AAPL&item=sales_surprise_percent_diff
// FULL URL: https://api.intrinio.com/historical_data?identifier=AAPL&item=sales_surprise_percent_diff
{
"identifier": "AAPL",
"item": "sales_surprise_percent_diff",
"result_count": 68,
"page_size": 50000,
"current_page": 1,
"total_pages": 1,
"api_call_credits": 1,
"data": [
{
"date": "2017-01-31",
"value": 0.0185
},
{
"date": "2016-10-25",
"value": 0.0006
},
...
]
}
=IntrinioHistoricalData("AAPL","non_gaap_sales",0)
$78,351,000,000.00
=IntrinioHistoricalData("AAPL","sales_surprise_percent_diff",0,"2012-01-01","2012-12-31")
0.0034
=IntrinioHistoricalData("AAPL","sales_surprise_percent_diff",0,"2010-01-01","2010-02-01")
0.2993
Function not available
Returns the historical data for for a selected identifier (ticker symbol, CIK, FIGI) for a selected Zack’s Historical tag.
Endpoint
https://api.intrinio.com/historical_data?identifier={symbol}&item={tag}
Excel Function
=IntrinioHistoricalData(identifier, item, sequence, start_date, end_date, frequency, type, show_date)
Parameters
- identifier - the stock market ticker symbol associated with the company’s common stock or index. If the company is foreign, use the stock exchange code, followed by a colon, then the ticker: TICKER SYMBOL | FIGI | CIK
- item - the specified Zacks Historical data tag requested. SALES SURPRISES
- sequence (required, only in Excel add-in function) - an integer 0 or greater for calling a single historical data point from the first entry, based on sort order:
0..last available - start_date (optional) - the earliest date for which to return data:
YYYY-MM-DD - end_date (optional, default=today) - the latest date for which to return data:
YYYY-MM-DD - show_date (optional, only in Excel add-in, false by default) if true, the function will return the date value, and if false the function will return the data point value for a given query:
true | false - sort_order (optional, default=desc) - the order of the historical stock price dates:
asc | desc - page_size (optional, default page size is 1000) - an integer greater than 1 for specifying the number of results on each page
- page_number (optional, default page number is 1) - an integer greater than or equal to 1 for specifying the page number for the return values
Return Values
- identifier - the ticker or identifier for the data point
- item - the requested standardized tag or series ID
- date - the date associated with the value of the data tag
- value - the value of the Intrinio tag of the financial data point
Securities Search/Screener
// API URI: https://api.intrinio.com
// GET: /securities/search?conditions=sales_surprise_percent_diff~gt~0.25
// FULL URL: https://api.intrinio.com/securities/search?conditions=sales_surprise_percent_diff~gt~0.25
{
"result_count": 119,
"page_size": 100,
"current_page": 1,
"total_pages": 2,
"api_call_credits": 1,
"data": [
{
"sales_surprise_percent_diff": 0.7889,
"ticker": "ACRE"
},
{
"sales_surprise_percent_diff": 0.3174,
"ticker": "ACRX"
},
{
"sales_surprise_percent_diff": 0.7633,
"ticker": "ADXS"
},
...
]
}
Function not available
The Screener API can be accessed through the Intrinio Screener for Excel
Function not available
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.
Endpoint
https://api.intrinio.com/securities/search?conditions={conditions}
Intrinio Screener for Excel
Parameters
- conditions - A comma-separated list of conditions. Each condition consists three elements separated by tildes (~):
- A data tag SALES SURPRISES
- 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”
- A value
- order_column - A data tag by which to order the results SALES SURPRISES
- order_direction - The direction in which to order the results (“asc” for Ascending or “desc” for descending)
- page_size - (optional, default page size is 100) - an integer greater than 1 for specifying the number of results on each page (up to 100)
- page_number - (optional, default page number is 1) - an integer greater than 1 for specifying the page number for the return values
Return Values
The return values will correspond to the data tags in the conditions. Ticker will always be included.
Zacks EPS Surprises
EPS Surprises
// API URI: https://api.intrinio.com
// GET: /securities/surprises/eps?identifier=AAPL
// FULL URL: https://api.intrinio.com/securities/surprises/eps?identifier=AAPL
{
"result_count": 65,
"page_size": 250,
"current_page": 1,
"total_pages": 1,
"api_call_credits": 1,
"data": [
{
"ticker": "AAPL",
"figi_ticker": "AAPL:US",
"figi": "BBG000B9XRY4",
"fiscal_year": 2017,
"fiscal_quarter": "Q1",
"calendar_year": 2016,
"calendar_quarter": "Q4",
"actual_reported_date": "2017-01-31",
"actual_reported_time": "16:30",
"actual_reported_code": "AMC",
"actual_reported_desc": "AFTER",
"eps_actual": 3.36,
"eps_actual_zacks_adj": 0,
"eps_mean_estimate": 3.22,
"eps_amount_diff": 0.14,
"eps_percent_diff": 0.0435,
"eps_count_estimate": 15,
"eps_std_dev_estimate": 0.08
},
{
"ticker": "AAPL",
"figi_ticker": "AAPL:US",
"figi": "BBG000B9XRY4",
"fiscal_year": 2016,
"fiscal_quarter": "Q4",
"calendar_year": 2016,
"calendar_quarter": "Q3",
"actual_reported_date": "2016-10-25",
"actual_reported_time": "16:30",
"actual_reported_code": "AMC",
"actual_reported_desc": "AFTER",
"eps_actual": 1.67,
"eps_actual_zacks_adj": 0,
"eps_mean_estimate": 1.66,
"eps_amount_diff": 0.01,
"eps_percent_diff": 0.006,
"eps_count_estimate": 14,
"eps_std_dev_estimate": 0.04
},
...
]
}
// API URI: https://api.intrinio.com
// GET: /securities/surprises/eps?earnings_date=2017-01-31
// FULL URL: https://api.intrinio.com/securities/surprises/eps?earnings_date=2017-01-31
{
"result_count": 137,
"page_size": 250,
"current_page": 1,
"total_pages": 1,
"api_call_credits": 1,
"data": [
{
"ticker": "AAPL",
"figi_ticker": "AAPL:US",
"figi": "BBG000B9XRY4",
"fiscal_year": 2017,
"fiscal_quarter": "Q1",
"calendar_year": 2016,
"calendar_quarter": "Q4",
"actual_reported_date": "2017-01-31",
"actual_reported_time": "16:30",
"actual_reported_code": "AMC",
"actual_reported_desc": "AFTER",
"eps_actual": 3.36,
"eps_actual_zacks_adj": 0,
"eps_mean_estimate": 3.22,
"eps_amount_diff": 0.14,
"eps_percent_diff": 0.0435,
"eps_count_estimate": 15,
"eps_std_dev_estimate": 0.08
},
{
"ticker": "ABC",
"figi_ticker": "ABC:US",
"figi": "BBG000MDCSN6",
"fiscal_year": 2017,
"fiscal_quarter": "Q1",
"calendar_year": 2016,
"calendar_quarter": "Q4",
"actual_reported_date": "2017-01-31",
"actual_reported_time": "06:30",
"actual_reported_code": "BTO",
"actual_reported_desc": "BEFOR",
"eps_actual": 1.36,
"eps_actual_zacks_adj": 0.25,
"eps_mean_estimate": 1.24,
"eps_amount_diff": 0.12,
"eps_percent_diff": 0.0968,
"eps_count_estimate": 9,
"eps_std_dev_estimate": 0.04
},
...
]
}
Function not available
Function not available
SUMMARY
Endpoint
https://api.intrinio.com/securities/surprises/eps?identifier={symbol}
https://api.intrinio.com//securities/surprises/eps?earnings_date={date}
Parameters
- identifier - an identifier for the company or security, including the ticker symbol, FIGI, SEC CIK ID: TICKER SYMBOL
- earnings_date - a specified date to return earnings for all securities on that date: YYYY-MM-DD
Return Values
- ticker - the stock market ticker symbol associated with the companies common stock securities
- figi_ticker - the OpenFIGI ticker symbol
- figi - the OpenFIGI identifier
- fiscal_year - the company’s fiscal year for the reported period
- fiscal_quarter - the company’s fiscal quarter for the reported period
- calendar_year - the closest calendar year for the company’s fiscal year
- calendar_quarter - the closest calendar quarter for the company’s fiscal year
- actual_reported_date - actual report date for the earnings release
- actual_reported_time - actual report time for the earnings release
- actual_reported_code - the code cooresponding to the earnings release
BTO = BEFORE THE OPEN | DTM = DURING THE MARKET | AMC = AFTER MARKET CLOSE - actual_reported_desc - the description for the type of earnings release
- eps_actual - the actual Non-GAAP EPS figure released by the company, interpreted by Zacks.
- eps_actual_zacks_adj - the adjustments Zacks made to get to Non-GAAP EPS to reconcile with GAAP EPS.
- eps_mean_estimate - the pre-earnings release mean EPS estimate for the company
- eps_count_estimate - the pre-earnings release number of estimates by analysts
- eps_std_dev_estimate - the pre-earnings release standard deviation of EPS estimates
- eps_amount_diff - EPS surprise amount difference
- eps_percent_diff - EPS surprise percent difference
Data Point
// API URI: https://api.intrinio.com
// GET: /data_point?identifier=AAPL&item=last_earnings_eps_report_date
// FULL URL: https://api.intrinio.com/data_point?identifier=AAPL&item=last_earnings_eps_report_date
{
"identifier": "AAPL",
"item": "last_earnings_eps_report_date",
"value": "2017-01-31"
}
// API URI: https://api.intrinio.com
// GET: /data_point?identifier=AAPL&item=eps_surprise_percent_diff
// FULL URL: https://api.intrinio.com/data_point?identifier=AAPL&item=eps_surprise_percent_diff
{
"identifier": "AAPL",
"item": "eps_surprise_percent_diff",
"value": 0.0435
}
// API URI: https://api.intrinio.com
// GET: /data_point?identifier=AAPL&item=last_earnings_eps_report_date,last_earnings_eps_report_time,last_earnings_eps_report_code,gaap_eps,non_gaap_eps,pre_earnings_eps_est_mean,eps_surprise_amount_diff
// FULL URL: https://api.intrinio.com/data_point?identifier=AAPL&item=last_earnings_eps_report_date,last_earnings_eps_report_time,last_earnings_eps_report_code,gaap_eps,non_gaap_eps,pre_earnings_eps_est_mean,eps_surprise_amount_diff
// NOTE: While this is a single API Call, it is considered
// a Dimensional Call, which counts as 6 API Calls against
// the subscription plan.
{
"result_count": 6,
"api_call_credits": 6,
"data": [
{
"identifier": "AAPL",
"item": "last_earnings_eps_report_date",
"value": "2017-01-31"
},
{
"identifier": "AAPL",
"item": "last_earnings_eps_report_time",
"value": "16:30"
},
{
"identifier": "AAPL",
"item": "last_earnings_eps_report_code",
"value": "AFTER"
},
{
"identifier": "AAPL",
"item": "non_gaap_eps",
"value": 3.36
},
{
"identifier": "AAPL",
"item": "pre_earnings_eps_est_mean",
"value": 3.22
},
{
"identifier": "AAPL",
"item": "eps_surprise_amount_diff",
"value": 0.14
}
]
}
=IntrinioDataPoint("AAPL","last_earnings_eps_report_date")
"2017-01-31"
=IntrinioDataPoint("AAPL","eps_surprise_percent_diff")
0.0435
=IntrinioDataPoint("AAPL","last_earnings_eps_report_date")
"2017-01-31"
=IntrinioDataPoint("AAPL","eps_surprise_percent_diff")
0.0435
Returns the most recent data point for a selected identifier (ticker symbol, FIGI, CIK ID, etc.) for a selected tag.
Endpoint
https://api.intrinio.com/data_point?identifier={symbol}&item={tag}
https://api.intrinio.com/data_point?identifier={symbol1,symbol2}&item={tag1,tag2}
Excel Function
=IntrinioDataPoint(identifier, item)
Sheets Function
=IntrinioDataPoint(identifier, item)
Parameters
- identifier - an identifier for the company or data point, including the ticker symbol, FIGI, SEC CIK ID: TICKER SYMBOL
- item - the specified Zacks current data tag for one of the Zacks Current or Historical Data Feeds: EPS SURPRISES
Limits
You may request up to 150 identifier/item combinations at a time. For example, you may request 1 identifier and 150 items, or 150 identifiers and 1 item, or 12 identifiers and 12 items (144 combinations), or anywhere in between.
Return Values
- identifier - the ticker or identifier for the data point
- item - the requested standardized tag or series ID
- value - the value of the Intrinio tag of the financial data point
- “nm” - No meaning: the value is not meaningful, such as a negative P/E ratio
- “na” - Not applicable: there is no value for the given item/identifier combo, or the user does not have the proper access
Historical Data
// API URI: https://api.intrinio.com
// GET: /historical_data?identifier=AAPL&item=non_gaap_eps
// FULL URL: https://api.intrinio.com/historical_data?identifier=AAPL&item=non_gaap_eps
{
"identifier": "AAPL",
"item": "non_gaap_eps",
"result_count": 65,
"page_size": 50000,
"current_page": 1,
"total_pages": 1,
"api_call_credits": 1,
"data": [
{
"date": "2017-01-31",
"value": 3.36
},
{
"date": "2016-10-25",
"value": 1.67
},
...
]
}
// API URI: https://api.intrinio.com
// GET: /historical_data?identifier=AAPL&item=eps_surprise_percent_diff
// FULL URL: https://api.intrinio.com/historical_data?identifier=AAPL&item=eps_surprise_percent_diff
{
"identifier": "AAPL",
"item": "eps_surprise_percent_diff",
"result_count": 65,
"page_size": 50000,
"current_page": 1,
"total_pages": 1,
"api_call_credits": 1,
"data": [
{
"date": "2017-01-31",
"value": 0.0435
},
{
"date": "2016-10-25",
"value": 0.006
},
...
]
}
=IntrinioHistoricalData("AAPL","non_gaap_eps",0)
$3.36
=IntrinioHistoricalData("AAPL","eps_surprise_percent_diff",0,"2012-01-01","2012-12-31")
-0.0203
=IntrinioHistoricalData("AAPL","eps_surprise_percent_diff",0,"2010-01-01","2010-02-01")
0.7644
Function not available
Returns the historical data for for a selected identifier (ticker symbol, CIK, FIGI) for a selected Zack’s Historical tag.
Endpoint
https://api.intrinio.com/historical_data?identifier={symbol}&item={tag}
Excel Function
=IntrinioHistoricalData(identifier, item, sequence, start_date, end_date, frequency, type, show_date)
Parameters
- identifier - 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: TICKER SYMBOL | FIGI | CIK
- item - the specified Zacks Historical data tag requested. EPS SURPRISES
- sequence (required, only in Excel add-in function) - an integer 0 or greater for calling a single historical data point from the first entry, based on sort order:
0..last available - start_date (optional) - the earliest date for which to return data:
YYYY-MM-DD - end_date (optional, default=today) - the latest date for which to return data:
YYYY-MM-DD - show_date (optional, only in Excel add-in, false by default) if true, the function will return the date value, and if false the function will return the data point value for a given query:
true | false - sort_order (optional, default=desc) - the order of the historical stock price dates:
asc | desc - page_size (optional, default page size is 1000) - an integer greater than 1 for specifying the number of results on each page
- page_number (optional, default page number is 1) - an integer greater than or equal to 1 for specifying the page number for the return values
Return Values
- identifier - the ticker or identifier for the data point
- item - the requested standardized tag or series ID
- date - the date associated with the value of the data tag
- value - the value of the Intrinio tag of the financial data point
Securities Search/Screener
// API URI: https://api.intrinio.com
// GET: /securities/search?conditions=eps_surprise_percent_diff~gt~0.25
// FULL URL: https://api.intrinio.com/securities/search?conditions=eps_surprise_percent_diff~gt~0.25
{
"result_count": 672,
"page_size": 100,
"current_page": 1,
"total_pages": 7,
"api_call_credits": 1,
"data": [
{
"eps_surprise_percent_diff": 2,
"ticker": "AAC"
},
{
"eps_surprise_percent_diff": 1.3333,
"ticker": "AAXN"
},
{
"eps_surprise_percent_diff": 0.4615,
"ticker": "ABCO"
},
...
]
}
Function not available
The Screener API can be accessed through the Intrinio Screener for Excel
Function not available
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.
Endpoint
https://api.intrinio.com/securities/search?conditions={conditions}
Intrinio Screener for Excel
Parameters
- conditions - A comma-separated list of conditions. Each condition consists three elements separated by tildes (~):
- A data tag EPS SURPRISES
- 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”
- A value
- order_column - A data tag by which to order the results EPS SURPRISES
- order_direction - The direction in which to order the results (“asc” for Ascending or “desc” for descending)
- page_size - (optional, default page size is 100) - an integer greater than 1 for specifying the number of results on each page (up to 100)
- page_number - (optional, default page number is 1) - an integer greater than 1 for specifying the page number for the return values
Return Values
The return values will correspond to the data tags in the conditions. Ticker will always be included.
Trade Alert US Options Data Feed
Options Master
// API URI: https://api.intrinio.com
// GET: /options?ticker=AAPL
// FULL URL: https://api.intrinio.com/options?ticker=AAPL
{
"result_count": 46637,
"page_size": 250,
"current_page": 1,
"total_pages": 187,
"api_call_credits": 1,
"data": [
{
"identifier": "AAPL190118C00195000",
"ticker": "AAPL",
"expiration": "2019-01-18",
"strike": 195,
"type": "call"
},
{
"identifier": "AAPL190118P00195000",
"ticker": "AAPL",
"expiration": "2019-01-18",
"strike": 195,
"type": "put"
},
...
]
}
Function not available
Function not available
Returns the master list of option contracts for a given ticker.
Endpoint
https://api.intrinio.com/options?ticker={ticker}
Parameters
- ticker - the option ticker symbol, corresponding to the underlying security
- expiration (optional) - the contract expiration date to filter by, in the format
YYYY-MM-DD - type (optional) - the contract type to filter by, either
putorcall - page_size (optional, default page size is 100) - an integer greater than 1 for specifying the number of results on each page.
- page_number (optional, default page number is 1) - an integer greater than or equal to 1 for specifying the page number for the return values.
Return Values
- identifier - the contract identifier, used for Data Point and Historical Data endpoints
- ticker - the option ticker symbol, corresponding to the underlying security
- expiration - the contract expiration date, in format
YYYY-MM-DD - strike - the contract strike price
- type - the contract type, either
putorcall
Option Expirations
// API URI: https://api.intrinio.com
// GET: /options/expirations?ticker=AAPL
// FULL URL: https://api.intrinio.com/options/expirations?ticker=AAPL
{
"result_count": 392,
"api_call_credits": 1,
"data": [
"2019-01-18",
"2018-06-15",
"2018-01-19",
"2017-11-17",
"2017-10-20",
...
]
}
Function not available
Function not available
Returns all option contract expiration dates for a given ticker.
Endpoint
https://api.intrinio.com/options/expirations?ticker={ticker}
Parameters
- ticker - the option ticker symbol, corresponding to the underlying security
Return Values
Dates of option contract expirations, in format: YYYY-MM-DD.
Current Prices
// API URI: https://api.intrinio.com
// GET: /options/current?ticker=AAPL
// FULL URL: https://api.intrinio.com/options/current?ticker=AAPL
{
"result_count": 208,
"api_call_credits": 1,
"data": [
{
"date": "2017-02-14",
"expiration": "2017-02-17",
"strike": 136,
"type": "call",
"close": 0.43,
"close_bid": 0.42,
"close_ask": 0.44,
"volume": 19349,
"volume_bid": 7075,
"volume_ask": 6815,
"trades": 915,
"open_interest": 8538,
"open_interest_change": 3074,
"next_day_open_interest": 12629,
"implied_volatility": 0.169001,
"implied_volatility_change": -0.009107,
"delta": 0.321807
},
...
]
}
// API URI: https://api.intrinio.com
// GET: /options/current?identifier=AAPL190118C00195000
// FULL URL: https://api.intrinio.com/options/current?identifier=AAPL190118C00195000
{
"result_count": 1,
"api_call_credits": 1,
"data": [
{
"date": "2017-02-14",
"expiration": "2019-01-18",
"strike": 195,
"type": "call",
"close": 2.08,
"close_bid": 1.91,
"close_ask": 2.25,
"volume": 128,
"volume_bid": 2,
"volume_ask": 125,
"trades": 24,
"open_interest": 81,
"open_interest_change": 49,
"next_day_open_interest": 195,
"implied_volatility": 0.208586,
"implied_volatility_change": -0.000267,
"delta": 0.123295
}
]
}
Function not available
Function not available
Returns the current prices for the given option contract(s).
Endpoint
https://api.intrinio.com/options/current?ticker={ticker}
https://api.intrinio.com/options/current?identifier={identifier}
Parameters
- ticker - the option ticker symbol, corresponding to the underlying security
- identifier (alternate) - the contract identifier (example:
AAPL190118C00195000) - expiration (optional) - the contract expiration date to filter by, in the format
YYYY-MM-DD - type (optional) - the contract type to filter by, either
putorcall - strike (optional) - the contract strike price to filter by
You must specify either a ticker or an identifier. If you specify ticker, you can also filter by expiration, strike, and type.
Return Values
- date - the price date, in the format
YYYY-MM-DD - expiration - the contract expiration date, in the format
YYYY-MM-DD - strike - the contract strike price
- type - the contract type, either
putorcall - close - the closing price of the contract
- close_bid - the closing bid price of the contract
- close_ask - the closing ask price of the contract
- volume - the closing volume of the contract
- volume_bid - the closing bid volume of the contract
- volume_ask - the closing ask volume of the contract
- trades - the number of trades executed that day
- open_interest - the open interest at the end of the day
- open_interest_change - the change in open interest from the previous day
- next_day_open_interest - the open interest at the start of the next day
- implied_volatility - the implied volatility of the contract
- implied_volatility_change - the change in implied volatility that day
- delta - the delta of the contract vs the underlying security
Historical Prices
// API URI: https://api.intrinio.com
// GET: /options/historical?ticker=AAPL&expiration=2017-03-03&type=put&strike=127
// FULL URL: https://api.intrinio.com/options/historical?ticker=AAPL&expiration=2017-03-03&type=put&strike=127
{
"result_count": 23,
"page_size": 250,
"current_page": 1,
"total_pages": 1,
"api_call_credits": 1,
"data": [
{
"date": "2017-02-14",
"close": 8.225,
"close_bid": 8.15,
"close_ask": 8.3,
"volume": 37,
"volume_bid": 36,
"volume_ask": 1,
"trades": 5,
"open_interest": 288,
"open_interest_change": -27,
"next_day_open_interest": 309,
"implied_volatility": 0.19727,
"implied_volatility_change": 0.016137,
"delta": 0.928281
},
{
"date": "2017-02-13",
"close": 6.6,
"close_bid": 6.5,
"close_ask": 6.7,
"volume": 39,
"volume_bid": 4,
"volume_ask": 0,
"trades": 3,
"open_interest": 315,
"open_interest_change": -3,
"next_day_open_interest": 288,
"implied_volatility": 0.181133,
"implied_volatility_change": 0.024007,
"delta": 0.889855
},
...
]
}
// API URI: https://api.intrinio.com
// GET: /options/historical?identifier=AAPL170303C00127000
// FULL URL: https://api.intrinio.com/options/historical?identifier=AAPL170303C00127000
{
"result_count": 1,
"api_call_credits": 1,
"data": [
{
"date": "2017-02-14",
"close": 8.225,
"close_bid": 8.15,
"close_ask": 8.3,
"volume": 37,
"volume_bid": 36,
"volume_ask": 1,
"trades": 5,
"open_interest": 288,
"open_interest_change": -27,
"next_day_open_interest": 309,
"implied_volatility": 0.19727,
"implied_volatility_change": 0.016137,
"delta": 0.928281
},
{
"date": "2017-02-13",
"close": 6.6,
"close_bid": 6.5,
"close_ask": 6.7,
"volume": 39,
"volume_bid": 4,
"volume_ask": 0,
"trades": 3,
"open_interest": 315,
"open_interest_change": -3,
"next_day_open_interest": 288,
"implied_volatility": 0.181133,
"implied_volatility_change": 0.024007,
"delta": 0.889855
},
...
]
}
Function not available
Function not available
Returns the historical prices for the given option contract.
Endpoint
https://api.intrinio.com/options/historical?ticker={ticker}&expiration={expiration}&strike={strike}&type={type}
https://api.intrinio.com/options/historical?identifier={identifier}
Parameters
- ticker - the option ticker symbol, corresponding to the underlying security
- expiration - the contract expiration date, in the format
YYYY-MM-DD - type - the contract type, either
putorcall - strike - the contract strike price
- identifier (alternate) - the contract identifier (example:
AAPL190118C00195000) - page_size (optional, default page size is 100) - an integer greater than 1 for specifying the number of results on each page.
- page_number (optional, default page number is 1) - an integer greater than or equal to 1 for specifying the page number for the return values.
You must specify either an identifier or a combination of ticker, expiration, strike, and type.
Return Values
- date - the price date, in the format
YYYY-MM-DD - close - the closing price of the contract
- close_bid - the closing bid price of the contract
- close_ask - the closing ask price of the contract
- volume - the closing volume of the contract
- volume_bid - the closing bid volume of the contract
- volume_ask - the closing ask volume of the contract
- trades - the number of trades executed that day
- open_interest - the open interest at the end of the day
- open_interest_change - the change in open interest from the previous day
- next_day_open_interest - the open interest at the start of the next day
- implied_volatility - the implied volatility of the contract
- implied_volatility_change - the change in implied volatility that day
- delta - the delta of the contract vs the underlying security
Data Point
// API URI: https://api.intrinio.com
// GET: /data_point?identifier=AAPL170203C00127000&item=open_interest
// FULL URL: https://api.intrinio.com/data_point?identifier=AAPL170203C00127000&item=open_interest
{
"identifier": "AAPL170203C00127000",
"item": "open_interest",
"value": 12560
}
// API URI: https://api.intrinio.com
// GET: /data_point?identifier=AAPL170203C00127000,AAPL170203P00127000&item=volume
// FULL URL: https://api.intrinio.com/data_point?identifier=AAPL170203C00127000,AAPL170203P00127000&item=open_interest
// NOTE: While this is a single API Call, it is considered
// a Dimensional Call, which counts as 2 API Calls against
// the subscription plan.
{
"data": [
{
"identifier": "AAPL170203C00127000",
"item": "volume",
"value": 5564
},
{
"identifier": "AAPL170203P00127000",
"item": "volume",
"value": 6520
}
],
"result_count": 2,
"api_call_credits": 2
}
// API URI: https://api.intrinio.com
// GET: /data_point?identifier=AAPL170303C00127000,AAPL170303C00128000&item=implied_volatility,delta
// FULL URL: https://api.intrinio.com/data_point?identifier=AAPL170303C00127000,AAPL170303C00128000&item=implied_volatility,delta
// NOTE: While this is a single API Call, it is considered
// a Dimensional Call, which counts as 4 API Calls against
// the subscription plan.
{
"data": [
{
"identifier": "AAPL170303C00127000",
"item": "implied_volatility",
"value": 0.19727
},
{
"identifier": "AAPL170303C00128000",
"item": "implied_volatility",
"value": 0.188689
},
{
"identifier": "AAPL170303C00127000",
"item": "delta",
"value": 0.928281
},
{
"identifier": "AAPL170303C00128000",
"item": "delta",
"value": 0.909085
}
],
"result_count": 4,
"api_call_credits": 4
}
=IntrinioDataPoint("AAPL170303C00127000","implied_volatility")
0.19727
=IntrinioDataPoint("AAPL170303C00127000","delta")
0.928281
=IntrinioDataPoint("AAPL170303C00127000","close_price")
8.225
=IntrinioDataPoint("AAPL170303C00127000","implied_volatility")
0.19727
=IntrinioDataPoint("AAPL170303C00127000","delta")
0.928281
=IntrinioDataPoint("AAPL170303C00127000","close_price")
8.225
Returns the most recent value for the given option contract identifier(s) and data tag(s).
Endpoint
https://api.intrinio.com/data_point?identifier={identifier}&item={tag}
https://api.intrinio.com/data_point?identifier={identifier,identifier}&item={tag1,tag2}
Excel Function
=IntrinioDataPoint(identifier, item)
Sheets Function
=IntrinioDataPoint(identifier, item)
Parameters
- identifier - the contract identifier (example:
AAPL190118C00195000) - item - a data tag applicable to options: OPTIONS TAGS
Return Values
- identifier - the ticker or identifier for the data point
- item - the requested standardized tag or series ID
- value - the value of the Intrinio tag of the financial data point
- “nm” - No meaning: the value is not meaningful, such as a negative P/E ratio
- “na” - Not applicable: there is no value for the given item/identifier combo, or the user does not have the proper access
Limits
You may request up to 150 identifier/item combinations at a time. For example, you may request 1 identifier and 150 items, or 150 identifiers and 1 item, or 12 identifiers and 12 items (144 combinations), or anywhere in between.
Historical Data
// API URI: https://api.intrinio.com
// GET: /historical_data?identifier=AAPL170203C00127000&item=open_interest
// FULL URL: https://api.intrinio.com/historical_data?identifier=AAPL170203C00127000&item=open_interest
{
"identifier": "AAPL170203C00127000",
"item": "open_interest",
"result_count": 29,
"page_size": 5,
"current_page": 1,
"total_pages": 6,
"api_call_credits": 1,
"data": [
{
"date": "2017-02-03",
"value": 12560
},
{
"date": "2017-02-02",
"value": 12949
},
{
"date": "2017-02-01",
"value": 12850
},
{
"date": "2017-01-31",
"value": 8336
},
...
]
}
=IntrinioHistoricalData("AAPL170203C00127000","open_interest",0)
12560
=IntrinioHistoricalData("AAPL170203C00127000","open_interest",1)
12949
=IntrinioHistoricalData("AAPL170203C00127000","open_interest",0,"2017-01-01","2011-01-31")
8336
Function not available
Returns the historical values for the given option contract identifier and data tag.
Endpoint
https://api.intrinio.com/historical_data?identifier={identifier}&item={tag}
Excel Function
=IntrinioHistoricalData(identifier, item, sequence, start_date, end_date, frequency, type, show_date)
Parameters
- identifier - the contract identifier (example:
AAPL190118C00195000) - item - a data tag applicable to options: OPTIONS TAGS
- sequence (required, only in Excel add-in function) - an integer 0 or greater for calling a single historical data point from the first entry, based on sort order:
0..last available - start_date (optional) - the earliest date for which to return data:
YYYY-MM-DD - end_date (optional, default=today) - the latest date for which to return data:
YYYY-MM-DD - frequency (optional, returns daily historical price data otherwise) - the frequency of the historical prices & valuation data:
daily | weekly | monthly | quarterly | yearly - show_date (optional, only in Excel add-in, false by default) if true, the function will return the date value, and if false the function will return the data point value for a given query:
true | false - sort_order (optional, default=desc) - the order of the historical stock price dates:
asc | desc - page_size (optional, default page size is 100) - an integer greater than 1 for specifying the number of results on each page.
- page_number (optional, default page number is 1) - an integer greater than or equal to 1 for specifying the page number for the return values.
Return Values
- identifier - the identifier for the option contract
- item - the requested data tag
- date - the date associated with the value of the data tag
- value - the value at the date
TipRanks News Sentiment Data Feed
Security News Sentiments
// API URI: https://api.intrinio.com
// GET: /news_sentiments?identifier=AAPL&source=tip-ranks
// FULL URL: https://api.intrinio.com/news_sentiments?identifier=AAPL&source=tip-ranks
{
"result_count": 216,
"page_size": 100,
"current_page": 1,
"total_pages": 3,
"api_call_credits": 1,
"data": [
{
"date": "2017-03-08",
"ticker": "AAPL",
"figi_ticker": "AAPL:US",
"figi": "BBG000B9XRY4",
"sector": "Consumer Goods",
"total_1w": 250,
"bullish_1w": 44,
"bearish_1w": 7,
"total_4w": 1172,
"bullish_4w": 222,
"bearish_4w": 29,
"total_12w": 3706,
"bullish_12w": 584,
"bearish_12w": 180,
"sentiment_1w": 4,
"sentiment_4w": 4,
"sentiment_12w": 3,
"buzz_1w4w": 0.853741496598639,
"buzz_1w12w": 0.810112963959118,
"buzz_4w12w": 3.78590640129102,
"source": "tip-ranks"
},
{
"date": "2017-03-07",
"ticker": "AAPL",
"figi_ticker": "AAPL:US",
"figi": "BBG000B9XRY4",
"sector": "Consumer Goods",
"total_1w": 262,
"bullish_1w": 50,
"bearish_1w": 9,
"total_4w": 1194,
"bullish_4w": 234,
"bearish_4w": 30,
"total_12w": 3728,
"bullish_12w": 589,
"bearish_12w": 184,
"sentiment_1w": 4,
"sentiment_4w": 4,
"sentiment_12w": 3,
"buzz_1w4w": 0.878130217028381,
"buzz_1w12w": 0.843850267379679,
"buzz_4w12w": 3.83422459893048,
"source": "tip-ranks"
},
...
]
}
=Function not available
Function not available
Returns daily summaries of news sentiments by security and date.
Endpoint
https://api.intrinio.com/news_sentiments?source=tip-ranks
https://api.intrinio.com/news_sentiments?identifier={identifier}&source=tip-ranks
https://api.intrinio.com/news_sentiments?sector={sector}&source=tip-ranks
Parameters
- source - The source of the data:
tip-ranks - identifier (optional, returns news sentiments for the security with the given identifier) - the identifier for the legal entity or a security associated with the company: TICKER SYMBOL | FIGI | OTHER IDENTIFIER
- sector (optional, returns news sentiments for securities in the given sector) - the name of the sector: SECTORS
- start_date (optional) - the earliest date for which to return data:
YYYY-MM-DD - end_date (optional) - the latest date for which to return data:
YYYY-MM-DD - page_size (optional, default=100) - an integer greater than 1 for specifying the number of results on each page.
- page_number (optional, default=1) - an integer greater than or equal to 1 for specifying the page number for the return values.
Return Values
- date - The date of the news sentiment
- ticker - The ticker of the security
- figi_ticker - The OpenFIGI ticker symbol
- figi - The OpenFIGI identifier
- sector - The sector of the security
- total_1w - Total number of news articles in the past 1 week
- bullish_1w - Total number of bullish news articles in the past 1 week
- bearish_1w - Total number of bearish news articles in the past 1 week
- total_4w - Total number of news articles in the past 4 weeks
- bullish_4w - Total number of bullish news articles in the past 4 weeks
- bearish_4w - Total number of bearish news articles in the past 4 weeks
- total_12w - Total number of news articles in the past 12 weeks
- bullish_12w - Total number of bullish news articles in the past 12 weeks
- bearish_12w - Total number of bearish news articles in the past 12 weeks
- sentiment_1w - The sentiment rating of news articles in the past 1 week
- sentiment_4w - The sentiment rating of news articles in the past 4 weeks
- sentiment_12w - The sentiment rating of news articles in the past 12 weeks
- buzz_1w4w - The buzz factor for the past 1 week compared to the past 4 weeks
- buzz_1w12w - The buzz factor for the past 1 week compared to the past 12 weeks
- buzz_4w12w - The buzz factor for the past 4 weeks compared to the past 12 weeks
- source - Source of the news sentiment:
tip-ranks
Sentiment
Sentiment is a special rating from 0 to 5, measuring the bullishness of the stock in a given time period.
A rating of 0 indicates a bearish sentiment.
A rating of 5 indicates a bullish sentiment.
Buzz
The buzz factor is gives us an insight into the change in coverage regarding a particular stock, and is a great way to identify stocks with potential high volatility.
A “buzz_1w4w" would indicate by how much last week’s coverage is above or below the four week, weekly average coverage. If there were 20 articles in the last week, and 40 articles in the last four weeks would calculate the buzz as
(20 +1) / (40 /4 + 1) = 1.909 (190.9%)
Sector News Sentiments
// API URI: https://api.intrinio.com
// GET: /news_sector_sentiments?sector=Technology&source=tip-ranks
// FULL URL: https://api.intrinio.com/news_sector_sentiments?sector=Technology&source=tip-ranks
{
"result_count": 216,
"page_size": 100,
"current_page": 1,
"total_pages": 3,
"api_call_credits": 1,
"data": [
{
"date": "2017-01-27",
"sector": "Technology",
"total_1w": 4396,
"bullish_1w": 790,
"bearish_1w": 222,
"total_4w": 13464,
"bullish_4w": 2523,
"bearish_4w": 535,
"total_12w": 42465,
"bullish_12w": 7758,
"bearish_12w": 1752,
"sentiment_1w": 2.403292181,
"sentiment_4w": 2.728370221,
"sentiment_12w": 3.252824859,
"buzz_1w4w": 1.261367413,
"buzz_1w12w": 1.247343971,
"buzz_4w12w": 2.681420126,
"source": "tip-ranks"
},
{
"date": "2017-01-26",
"sector": "Technology",
"total_1w": 4076,
"bullish_1w": 717,
"bearish_1w": 198,
"total_4w": 12956,
"bullish_4w": 2408,
"bearish_4w": 510,
"total_12w": 42710,
"bullish_12w": 7783,
"bearish_12w": 1799,
"sentiment_1w": 2.259259259,
"sentiment_4w": 2.680080483,
"sentiment_12w": 3.245416079,
"buzz_1w4w": 1.249317893,
"buzz_1w12w": 1.192603236,
"buzz_4w12w": 2.575009053,
"source": "tip-ranks"
},
...
]
}
=Function not available
Function not available
Returns daily summaries of news sentiments by sector and date.
Endpoint
https://api.intrinio.com/news_sector_sentiments?source=tip-ranks
https://api.intrinio.com/news_sector_sentiments?sector={sector}&source=tip-ranks
Parameters
- source - The source of the data:
tip-ranks - sector (optional, returns news sentiments for the given sector) - the name of the sector: SECTORS
- start_date (optional) - the earliest date for which to return data:
YYYY-MM-DD - end_date (optional) - the latest date for which to return data:
YYYY-MM-DD - page_size (optional, default=100) - an integer greater than 1 for specifying the number of results on each page.
- page_number (optional, default=1) - an integer greater than or equal to 1 for specifying the page number for the return values.
Return Values
- date - The date of the news sentiment
- sector - The sector of the news sentiment
- total_1w - Total number of news articles in the past 1 week
- bullish_1w - Total number of bullish news articles in the past 1 week
- bearish_1w - Total number of bearish news articles in the past 1 week
- total_4w - Total number of news articles in the past 4 weeks
- bullish_4w - Total number of bullish news articles in the past 4 weeks
- bearish_4w - Total number of bearish news articles in the past 4 weeks
- total_12w - Total number of news articles in the past 12 weeks
- bullish_12w - Total number of bullish news articles in the past 12 weeks
- bearish_12w - Total number of bearish news articles in the past 12 weeks
- sentiment_1w - The sentiment rating of news articles in the past 1 week
- sentiment_4w - The sentiment rating of news articles in the past 4 weeks
- sentiment_12w - The sentiment rating of news articles in the past 12 weeks
- buzz_1w4w - The buzz factor for the past 1 week compared to the past 4 weeks
- buzz_1w12w - The buzz factor for the past 1 week compared to the past 12 weeks
- buzz_4w12w - The buzz factor for the past 4 weeks compared to the past 12 weeks
- source - Source of the news sentiment:
tip-ranks
Sentiment
Sentiment is a special rating from 0 to 5, measuring the bullishness of the stock in a given time period.
A rating of 0 indicates a bearish sentiment.
A rating of 5 indicates a bullish sentiment.
Buzz
The buzz factor is gives us an insight into the change in coverage regarding a particular stock, and is a great way to identify stocks with potential high volatility.
A “buzz_1w4w" would indicate by how much last week’s coverage is above or below the four week, weekly average coverage. If there were 20 articles in the last week, and 40 articles in the last four weeks would calculate the buzz as
(20 +1) / (40 /4 + 1) = 1.909 (190.9%)
Data Point
// API URI: https://api.intrinio.com
// GET: /data_point?identifier=AAPL&item=tipranks_news_bearish_4w
// FULL URL: https://api.intrinio.com/data_point?identifier=AAPL&item=tipranks_news_bearish_4w
{
"identifier": "AAPL",
"item": "tipranks_news_bearish_4w",
"value": 31
}
// API URI: https://api.intrinio.com
// GET: /data_point?identifier=$Technology&item=tipranks_news_bearish_4w
// FULL URL: https://api.intrinio.com/data_point?identifier=$Technology&item=tipranks_news_bearish_4w
{
"identifier": "$Technology",
"item": "tipranks_news_bearish_4w",
"value": 535
}
// API URI: https://api.intrinio.com
// GET: /data_point?identifier=AAPL,MSFT&item=tipranks_news_rating_1w
// FULL URL: https://api.intrinio.com/data_point?identifier=AAPL,MSFT&item=tipranks_news_rating_1w
// NOTE: While this is a single API Call, it is considered
// a Dimensional Call, which counts as 2 API Calls against
// the subscription plan.
{
"data": [
{
"identifier": "AAPL",
"item": "tipranks_news_rating_1w",
"value": 4
},
{
"identifier": "MSFT",
"item": "tipranks_news_rating_1w",
"value": 2
}
],
"result_count": 2,
"api_call_credits": 2
}
=IntrinioDataPoint("AAPL","tipranks_news_bearish_4w")
31
=IntrinioDataPoint("AAPL","tipranks_news_rating_1w")
4
=IntrinioDataPoint("$Technology","tipranks_news_bearish_4w")
535
=IntrinioDataPoint("AAPL","tipranks_news_bearish_4w")
31
=IntrinioDataPoint("AAPL","tipranks_news_rating_1w")
4
=IntrinioDataPoint("$Technology","tipranks_news_bearish_4w")
535
Returns the most recent value for the given ticker(s) and data tag(s).
Endpoint
https://api.intrinio.com/data_point?identifier={identifier}&item={tag}
https://api.intrinio.com/data_point?identifier={identifier,identifier}&item={tag1,tag2}
Excel Function
=IntrinioDataPoint(identifier, item)
Sheets Function
=IntrinioDataPoint(identifier, item)
Parameters
- identifier - and identifier for the security or sector: TICKER SYMBOL | FIGI | OTHER IDENTIFIER | SECTOR
- item - a data tag applicable to news sentiments: NEWS SENTIMENT TAGS
Return Values
- identifier - the ticker or identifier for the data point
- item - the requested standardized tag or series ID
- value - the value of the Intrinio tag of the financial data point
- “nm” - No meaning: the value is not meaningful, such as a negative P/E ratio
- “na” - Not applicable: there is no value for the given item/identifier combo, or the user does not have the proper access
Limits
You may request up to 150 identifier/item combinations at a time. For example, you may request 1 identifier and 150 items, or 150 identifiers and 1 item, or 12 identifiers and 12 items (144 combinations), or anywhere in between.
Historical Data
// API URI: https://api.intrinio.com
// GET: /historical_data?identifier=AAPL&item=tipranks_news_rating_1w
// FULL URL: https://api.intrinio.com/historical_data?identifier=AAPL&item=tipranks_news_rating_1w
{
"identifier": "AAPL",
"item": "tipranks_news_rating_1w",
"result_count": 243,
"page_size": 50000,
"current_page": 1,
"total_pages": 1,
"api_call_credits": 1,
"data": [
{
"date": "2017-03-01",
"value": 4
},
{
"date": "2017-02-27",
"value": 4
},
{
"date": "2017-01-27",
"value": 0
},
{
"date": "2017-01-26",
"value": 1
},
{
"date": "2017-01-25",
"value": 2
}
...
]
}
// API URI: https://api.intrinio.com
// GET: /historical_data?identifier=$Technology&item=tipranks_news_rating_1w
// FULL URL: https://api.intrinio.com/historical_data?identifier=$Technology&item=tipranks_news_rating_1w
{
"identifier": "$Technology",
"item": "tipranks_news_rating_1w",
"result_count": 244,
"page_size": 50000,
"current_page": 1,
"total_pages": 1,
"api_call_credits": 1,
"data": [
{
"date": "2017-01-27",
"value": 2.403292181
},
{
"date": "2017-01-26",
"value": 2.259259259
},
{
"date": "2017-01-25",
"value": 2.165975104
},
{
"date": "2017-01-24",
"value": 2.204633205
},
...
]
}
=IntrinioHistoricalData("AAPL","tipranks_news_bearish_4w",0)
31
=IntrinioHistoricalData("AAPL","tipranks_news_rating_1w",0)
4
=IntrinioHistoricalData("$Technology","tipranks_news_bearish_4w",0)
535
Function not available
Returns the historical values for the given option contract identifier and data tag.
Endpoint
https://api.intrinio.com/historical_data?identifier={identifier}&item={tag}
Excel Function
=IntrinioHistoricalData(identifier, item, sequence, start_date, end_date, frequency, type, show_date)
Parameters
- identifier - and identifier for the security or sector: TICKER SYMBOL | FIGI | OTHER IDENTIFIER | SECTOR
- item - a data tag applicable to news sentiments: NEWS SENTIMENT TAGS
- sequence (required, only in Excel add-in function) - an integer 0 or greater for calling a single historical data point from the first entry, based on sort order:
0..last available - start_date (optional) - the earliest date for which to return data:
YYYY-MM-DD - end_date (optional, default=today) - the latest date for which to return data:
YYYY-MM-DD - show_date (optional, only in Excel add-in, false by default) if true, the function will return the date value, and if false the function will return the data point value for a given query:
true | false - sort_order (optional, default=desc) - the order of the historical stock price dates:
asc | desc - page_size (optional, default page size is 1000) - an integer greater than 1 for specifying the number of results on each page.
- page_number (optional, default page number is 1) - an integer greater than or equal to 1 for specifying the page number for the return values.
Return Values
- identifier - the identifier for the security or sector
- item - the requested data tag
- date - the date associated with the value of the data tag
- value - the value at the date
Securities Search/Screener
// API URI: https://api.intrinio.com
// GET: /securities/search?conditions=tipranks_news_bullish_12w~gt~5
// FULL URL: https://api.intrinio.com/securities/search?conditions=tipranks_news_bullish_12w~gt~5
{
"result_count": 1450,
"page_size": 5,
"current_page": 1,
"total_pages": 290,
"api_call_credits": 1,
"data": [
{
"ticker": "A",
"tipranks_news_bullish_12w": 11
},
{
"ticker": "AAL",
"tipranks_news_bullish_12w": 50
},
{
"ticker": "AAOI",
"tipranks_news_bullish_12w": 44
},
...
]
}
Function not available
The Screener API can be accessed through the Intrinio Screener for Excel
Function not available
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.
Endpoint
https://api.intrinio.com/securities/search?conditions={conditions}
Intrinio Screener for Excel
Parameters
- conditions - A comma-separated list of conditions. Each condition consists three elements separated by tildes (~):
- A data tag NEWS SENTIMENT TAGS
- 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”
- A value
- order_column - A data tag by which to order the results NEWS SENTIMENT TAGS
- order_direction - The direction in which to order the results (“asc” for Ascending or “desc” for descending)
- page_size - (optional, default page size is 100) - an integer greater than 1 for specifying the number of results on each page (up to 100)
- page_number - (optional, default page number is 1) - an integer greater than 1 for specifying the page number for the return values
Return Values
The return values will correspond to the data tags in the conditions. Ticker will always be included.
TipRanks Blogger Ratings Data Feed
Bloggers
// API URI: https://api.intrinio.com
// GET: /bloggers?source=tip-ranks
// FULL URL: https://api.intrinio.com/bloggers?source=tip-ranks
{
"result_count": 8582,
"page_size": 250,
"current_page": 1,
"total_pages": 35,
"api_call_credits": 1,
"data": [
{
"id": 1,
"source": "tip-ranks",
"external_id": "030e1d81584dd138712ca00cbac56fac31e4f6ea"
},
{
"id": 2,
"source": "tip-ranks",
"external_id": "009f0071499c489dd84876c8f68adb01c1255e30"
},
...
]
}
=Function not available
Function not available
Returns a list of bloggers. TipRanks bloggers are anonymized, but you will be able to reference them with the provided id field.
Endpoint
https://api.intrinio.com/bloggers?source=tip-ranks
Parameters
- source - The source of the data:
tip-ranks - page_size (optional, default=250) - an integer greater than 1 for specifying the number of results on each page.
- page_number (optional, default=1) - an integer greater than or equal to 1 for specifying the page number for the return values.
Return Values
- id - System number to identify bloggers
- source - The source of the data:
tip-ranks - external_id - The external ID
Blogs
// API URI: https://api.intrinio.com
// GET: /blogs?source=tip-ranks
// FULL URL: https://api.intrinio.com/blogs?source=tip-ranks
{
"result_count": 26,
"page_size": 250,
"current_page": 1,
"total_pages": 1,
"api_call_credits": 1,
"data": [
{
"id": 1,
"source": "tip-ranks",
"external_id": "55"
},
{
"id": 2,
"source": "tip-ranks",
"external_id": "12"
},
...
]
}
=Function not available
Function not available
Returns a list of blogs. TipRanks blogs are anonymized, but you will be able to reference them with the provided id field.
Endpoint
https://api.intrinio.com/blogs?source=tip-ranks
Parameters
- source - The source of the data:
tip-ranks - page_size (optional, default=250) - an integer greater than 1 for specifying the number of results on each page.
- page_number (optional, default=1) - an integer greater than or equal to 1 for specifying the page number for the return values.
Return Values
- id - System number to identify blogger firms
- source - The source of the data:
tip-ranks - external_id - The external ID
Blogger Ratings
// API URI: https://api.intrinio.com
// GET: /blogger_ratings?source=tip-ranks
// FULL URL: https://api.intrinio.com/blogger_ratings?source=tip-ranks
{
"result_count": 8973,
"page_size": 100,
"current_page": 1,
"total_pages": 90,
"api_call_credits": 1,
"data": [
{
"date": "2017-03-08",
"ticker": "NVGS",
"figi_ticker": "NVGS:US",
"figi": "BBG000R9BMT8",
"sector": "Consumer Goods",
"blog_id": 4,
"blogger_id": 1323,
"rating": "Buy",
"source": "tip-ranks"
},
{
"date": "2017-03-08",
"ticker": "CCP",
"figi_ticker": "CCP:US",
"figi": "BBG008LG18C1",
"sector": "Financial",
"blog_id": 4,
"blogger_id": 2356,
"rating": "Buy",
"source": "tip-ranks"
},
...
]
}
=Function not available
Function not available
Returns blogger buy/sell/hold ratings for a specific security and date.
Endpoint
https://api.intrinio.com/blogger_ratings?source=tip-ranks
https://api.intrinio.com/blogger_ratings?identifier=AAPL&source=tip-ranks
https://api.intrinio.com/blogger_ratings?sector=$Technology&source=tip-ranks
Parameters
- source - The source of the data:
tip-ranks - identifier (optional, filters the results by the security with the given identifier) - the identifier for the legal entity or a security associated with the company: TICKER SYMBOL | FIGI | OTHER IDENTIFIER
- sector (optional, filters the results by the given sector) - The name of the sector
- blogger_id (optional, filters the results by the given blogger) - The ID of the blogger
- blog_id (optional, filters the results by the given blog) - The ID of the blog
- rating (optional, filters the results by the given rating) - The blogger rating (see section below)
- page_size (optional, default=100) - an integer greater than 1 for specifying the number of results on each page.
- page_number (optional, default=1) - an integer greater than or equal to 1 for specifying the page number for the return values.
Return Values
- date - The date of the rating
- ticker - The ticker of the security
- figi_ticker - The OpenFIGI ticker symbol
- figi - The OpenFIGI identifier
- sector - The sector of the security
- blog_id - The ID of the blog
- blogger_id - The ID of the blogger
- rating - The blogger’s rating
- source - The source of the data:
tip-ranks
Ratings
Each result from this endpoint contains a rating field. Possible ratings include:
- Buy - The blogger recommends to buy the security
- Hold - The blogger recommends to hold the security
- Sell - The blogger recommends to sell the security
Data Point
// API URI: https://api.intrinio.com
// GET: /data_point?identifier=AAPL&item=tipranks_blogger_rating_buys_12w
// FULL URL: https://api.intrinio.com/data_point?identifier=AAPL&item=tipranks_blogger_rating_buys_12w
{
"identifier": "AAPL",
"item": "tipranks_blogger_rating_buys_12w",
"value": 29
}
// API URI: https://api.intrinio.com
// GET: /data_point?identifier=$Technology&item=tipranks_blogger_rating_buys_12w
// FULL URL: https://api.intrinio.com/data_point?identifier=$Technology&item=tipranks_blogger_rating_buys_12w
{
"identifier": "$Technology",
"item": "tipranks_blogger_rating_buys_12w",
"value": 1403
}
// API URI: https://api.intrinio.com
// GET: /data_point?identifier=AAPL,MSFT&item=tipranks_blogger_rating_buys_12w
// FULL URL: https://api.intrinio.com/data_point?identifier=AAPL,MSFT&item=tipranks_blogger_rating_buys_12w
// NOTE: While this is a single API Call, it is considered
// a Dimensional Call, which counts as 2 API Calls against
// the subscription plan.
{
"data": [
{
"identifier": "AAPL",
"item": "tipranks_blogger_rating_buys_12w",
"value": 79
},
{
"identifier": "MSFT",
"item": "tipranks_blogger_rating_buys_12w",
"value": 35
}
],
"result_count": 2,
"api_call_credits": 2
}
=IntrinioDataPoint("AAPL","tipranks_blogger_rating_buys_12w")
79
=IntrinioDataPoint("$Technology","tipranks_blogger_rating_buys_12w")
1403
=IntrinioDataPoint("AAPL","tipranks_blogger_rating_buys_12w")
79
=IntrinioDataPoint("$Technology","tipranks_blogger_rating_buys_12w")
1403
Returns the most recent value for the given ticker(s) and data tag(s).
Endpoint
https://api.intrinio.com/data_point?identifier={identifier}&item={tag}
https://api.intrinio.com/data_point?identifier={identifier,identifier}&item={tag1,tag2}
Excel Function
=IntrinioDataPoint(identifier, item)
Sheets Function
=IntrinioDataPoint(identifier, item)
Parameters
- identifier - and identifier for the security or sector: TICKER SYMBOL | FIGI | OTHER IDENTIFIER | SECTOR
- item - a data tag applicable to news sentiments: BLOGGER RATINGS TAGS
Return Values
- identifier - the ticker or identifier for the data point
- item - the requested standardized tag or series ID
- value - the value of the Intrinio tag of the financial data point
- “nm” - No meaning: the value is not meaningful, such as a negative P/E ratio
- “na” - Not applicable: there is no value for the given item/identifier combo, or the user does not have the proper access
Limits
You may request up to 150 identifier/item combinations at a time. For example, you may request 1 identifier and 150 items, or 150 identifiers and 1 item, or 12 identifiers and 12 items (144 combinations), or anywhere in between.
Historical Data
// API URI: https://api.intrinio.com
// GET: /historical_data?identifier=AAPL&item=tipranks_blogger_rating_buys
// FULL URL: https://api.intrinio.com/historical_data?identifier=AAPL&item=tipranks_blogger_rating_buys
{
"identifier": "AAPL",
"item": "tipranks_blogger_rating_buys",
"result_count": 48,
"page_size": 50000,
"current_page": 1,
"total_pages": 1,
"api_call_credits": 1,
"data": [
{
"date": "2017-03-07",
"value": 1
},
{
"date": "2017-03-03",
"value": 1
},
{
"date": "2017-03-01",
"value": 1
},
...
]
}
// API URI: https://api.intrinio.com
// GET: /historical_data?identifier=$Technology&item=tipranks_blogger_rating_buys
// FULL URL: https://api.intrinio.com/historical_data?identifier=$Technology&item=tipranks_blogger_rating_buys
{
"identifier": "$Technology",
"item": "tipranks_blogger_rating_buys",
"result_count": 91,
"page_size": 50000,
"current_page": 1,
"total_pages": 1,
"api_call_credits": 1,
"data": [
{
"date": "2017-03-08",
"value": 1
},
{
"date": "2017-03-07",
"value": 33
},
{
"date": "2017-03-06",
"value": 11
},
...
]
}
=IntrinioHistoricalData("AAPL","tipranks_blogger_rating_buys",0)
1
=IntrinioHistoricalData("$Technology","tipranks_blogger_rating_buys",0)
1
Function not available
Returns the historical values for the given option contract identifier and data tag.
Endpoint
https://api.intrinio.com/historical_data?identifier={identifier}&item={tag}
Excel Function
=IntrinioHistoricalData(identifier, item, sequence, start_date, end_date, frequency, type, show_date)
Parameters
- identifier - and identifier for the security or sector: TICKER SYMBOL | FIGI | OTHER IDENTIFIER | SECTOR
- item - a data tag applicable to news sentiments: BLOGGER RATINGS TAGS
- sequence (required, only in Excel add-in function) - an integer 0 or greater for calling a single historical data point from the first entry, based on sort order:
0..last available - start_date (optional) - the earliest date for which to return data:
YYYY-MM-DD - end_date (optional, default=today) - the latest date for which to return data:
YYYY-MM-DD - show_date (optional, only in Excel add-in, false by default) if true, the function will return the date value, and if false the function will return the data point value for a given query:
true | false - sort_order (optional, default=desc) - the order of the historical stock price dates:
asc | desc - page_size (optional, default page size is 1000) - an integer greater than 1 for specifying the number of results on each page.
- page_number (optional, default page number is 1) - an integer greater than or equal to 1 for specifying the page number for the return values.
Return Values
- identifier - the identifier for the security or sector
- item - the requested data tag
- date - the date associated with the value of the data tag
- value - the value at the date
Securities Search/Screener
// API URI: https://api.intrinio.com
// GET: /securities/search?conditions=tipranks_blogger_rating_buys_12w~gt~5
// FULL URL: https://api.intrinio.com/securities/search?conditions=tipranks_blogger_rating_buys_12w~gt~5
{
"result_count": 255,
"page_size": 5,
"current_page": 1,
"total_pages": 51,
"api_call_credits": 1,
"data": [
{
"ticker": "AAL",
"tipranks_blogger_rating_buys_12w": 7
},
{
"ticker": "AAOI",
"tipranks_blogger_rating_buys_12w": 8
},
{
"ticker": "AAPL",
"tipranks_blogger_rating_buys_12w": 81
},
...
]
}
Function not available
The Screener API can be accessed through the Intrinio Screener for Excel
Function not available
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.
Endpoint
https://api.intrinio.com/securities/search?conditions={conditions}
Intrinio Screener for Excel
Parameters
- conditions - A comma-separated list of conditions. Each condition consists three elements separated by tildes (~):
- A data tag BLOGGER RATINGS TAGS
- 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”
- A value
- order_column - A data tag by which to order the results BLOGGER RATINGS TAGS
- order_direction - The direction in which to order the results (“asc” for Ascending or “desc” for descending)
- page_size - (optional, default page size is 100) - an integer greater than 1 for specifying the number of results on each page (up to 100)
- page_number - (optional, default page number is 1) - an integer greater than 1 for specifying the page number for the return values
Return Values
The return values will correspond to the data tags in the conditions. Ticker will always be included.
TipRanks Analyst Ratings Data Feed
Analysts
// API URI: https://api.intrinio.com
// GET: /analysts?source=tip-ranks
// FULL URL: https://api.intrinio.com/analysts?source=tip-ranks
{
"result_count": 6756,
"page_size": 250,
"current_page": 1,
"total_pages": 28,
"api_call_credits": 1,
"data": [
{
"id": 1,
"source": "tip-ranks",
"external_id": "033aba966a1646c03888fa43818714b56b4fcdab"
},
{
"id": 2,
"source": "tip-ranks",
"external_id": "01649fe897c34aaf625a7de8c494d95d8f2141a3"
},
...
]
}
=Function not available
Function not available
Returns a list of analysts. TipRanks analysts are anonymized, but you will be able to reference them with the provided id field.
Endpoint
https://api.intrinio.com/analysts?source=tip-ranks
Parameters
- source - The source of the data:
tip-ranks - page_size (optional, default=250) - an integer greater than 1 for specifying the number of results on each page.
- page_number (optional, default=1) - an integer greater than or equal to 1 for specifying the page number for the return values.
Return Values
- id - System number to identify analysts
- source - The source of the data:
tip-ranks - external_id - The external ID
Analyst Firms
// API URI: https://api.intrinio.com
// GET: /analyst_firms?source=tip-ranks
// FULL URL: https://api.intrinio.com/analyst_firms?source=tip-ranks
{
"result_count": 486,
"page_size": 250,
"current_page": 1,
"total_pages": 2,
"api_call_credits": 1,
"data": [
{
"id": 1,
"source": "tip-ranks",
"external_id": "BMO"
},
{
"id": 2,
"source": "tip-ranks",
"external_id": "86Research"
},
...
]
}
=Function not available
Function not available
Returns a list of analyst firms. TipRanks analyst firms are anonymized, but you will be able to reference them with the provided id field.
Endpoint
https://api.intrinio.com/analyst_firms?source=tip-ranks
Parameters
- source - The source of the data:
tip-ranks - page_size (optional, default=250) - an integer greater than 1 for specifying the number of results on each page.
- page_number (optional, default=1) - an integer greater than or equal to 1 for specifying the page number for the return values.
Return Values
- id - System number to identify analyst firms
- source - The source of the data:
tip-ranks - external_id - The external ID
Analyst Ratings
// API URI: https://api.intrinio.com
// GET: /analyst_ratings?source=tip-ranks
// FULL URL: https://api.intrinio.com/analyst_ratings?source=tip-ranks
{
"result_count": 8374,
"page_size": 100,
"current_page": 1,
"total_pages": 84,
"api_call_credits": 1,
"data": [
{
"date": "2017-03-08",
"ticker": "AERI",
"figi_ticker": "AERI:US",
"figi": "BBG001KJ7WJ5",
"sector": "Healthcare",
"analyst_id": 772,
"analyst_firm_id": 28,
"analyst_firm_name": "Cantor Fitzgerald",
"action": "Reiterated",
"rating": "Buy",
"price_target": 56,
"source": "tip-ranks"
},
{
"date": "2017-03-08",
"ticker": "NMBL",
"figi_ticker": "NMBL:US",
"figi": "BBG005M8F5H0",
"sector": "Technology",
"analyst_id": 2241,
"analyst_firm_id": 364,
"analyst_firm_name": "Pacific Crest",
"action": "Downgraded",
"rating": "Hold",
"price_target": null,
"source": "tip-ranks"
},
...
]
}
=Function not available
Function not available
Returns analyst buy/sell/hold ratings for a specific security and date, as well as target prices.
Endpoint
https://api.intrinio.com/analyst_ratings?source=tip-ranks
https://api.intrinio.com/analyst_ratings?identifier=AAPL&source=tip-ranks
https://api.intrinio.com/analyst_ratings?sector=$Technology&source=tip-ranks
Parameters
- source - The source of the data:
tip-ranks - identifier (optional, filters the results by the security with the given identifier) - the identifier for the legal entity or a security associated with the company: TICKER SYMBOL | FIGI | OTHER IDENTIFIER
- sector (optional, filters the results by the given sector) - The name of the sector
- analyst_id (optional, filters the results by the given analyst) - The ID of the analyst
- analyst_firm_id (optional, filters the results by the given analyst firm) - The ID of the analyst firm
- action (optional, filters the results by the given action) - The analyst action (see section below)
- rating (optional, filters the results by the given rating) - The analyst rating (see section below)
- page_size (optional, default=100) - an integer greater than 1 for specifying the number of results on each page.
- page_number (optional, default=1) - an integer greater than or equal to 1 for specifying the page number for the return values.
Return Values
- date - The date of the rating
- ticker - The ticker of the security
- figi_ticker - The OpenFIGI ticker symbol
- figi - The OpenFIGI identifier
- sector - The sector of the security
- analyst_id - The ID of the analyst
- analyst_firm_id - The ID of the analyst firm
- analyst_firm_name - The name of the analyst firm
- action - The analyst’s action
- rating - The analyst’s rating
- price_target - The analyst’s price target
- source - The source of the data:
tip-ranks
Actions & Ratings
Each result from this endpoint contains an action and rating field. The action refers to the context of the rating.
Possible actions include:
- Downgraded - The analyst downgraded the rating
- Reiterated - The analyst reiterated the rating
- Upgraded - The analyst upgraded the rating
- Maintained - The analyst maintained the rating
- InitiatedCoverage - The analyst is stating their initial rating for the security
- ResumedCoverage - The analyst is stating a new rating for the security after having paused coverage for some time
- Rated - The analyst’s action is unclear
- HasStatus - The analyst’s action is unclear
Possible ratings include:
- Buy - The analyst recommends to buy the security
- Hold - The analyst recommends to hold the security
- Sell - The analyst recommends to sell the security
Data Point
// API URI: https://api.intrinio.com
// GET: /data_point?identifier=AAPL&item=tipranks_analyst_rating_sells_12w
// FULL URL: https://api.intrinio.com/data_point?identifier=AAPL&item=tipranks_analyst_rating_sells_12w
{
"identifier": "AAPL",
"item": "tipranks_analyst_rating_sells_12w",
"value": 3
}
// API URI: https://api.intrinio.com
// GET: /data_point?identifier=$Technology&item=tipranks_analyst_rating_sells_12w
// FULL URL: https://api.intrinio.com/data_point?identifier=$Technology&item=tipranks_analyst_rating_sells_12w
{
"identifier": "$Technology",
"item": "tipranks_analyst_rating_sells_12w",
"value": 136
}
// API URI: https://api.intrinio.com
// GET: /data_point?identifier=AAPL,MSFT&item=tipranks_analyst_rating_buys_12w
// FULL URL: https://api.intrinio.com/data_point?identifier=AAPL,MSFT&item=tipranks_analyst_rating_buys_12w
// NOTE: While this is a single API Call, it is considered
// a Dimensional Call, which counts as 2 API Calls against
// the subscription plan.
{
"data": [
{
"identifier": "AAPL",
"item": "tipranks_analyst_rating_buys_1w",
"value": 87
},
{
"identifier": "MSFT",
"item": "tipranks_analyst_rating_buys_1w",
"value": 23
}
],
"result_count": 2,
"api_call_credits": 2
}
=IntrinioDataPoint("AAPL","tipranks_analyst_rating_sells_12w")
3
=IntrinioDataPoint("$Technology","tipranks_analyst_rating_sells_12w")
136
=IntrinioDataPoint("AAPL","tipranks_analyst_rating_sells_12w")
3
=IntrinioDataPoint("$Technology","tipranks_analyst_rating_sells_12w")
136
Returns the most recent value for the given ticker(s) and data tag(s).
Endpoint
https://api.intrinio.com/data_point?identifier={identifier}&item={tag}
https://api.intrinio.com/data_point?identifier={identifier,identifier}&item={tag1,tag2}
Excel Function
=IntrinioDataPoint(identifier, item)
Sheets Function
=IntrinioDataPoint(identifier, item)
Parameters
- identifier - and identifier for the security or sector: TICKER SYMBOL | FIGI | OTHER IDENTIFIER | SECTOR
- item - a data tag applicable to news sentiments: ANALYST RATINGS TAGS
Return Values
- identifier - the ticker or identifier for the data point
- item - the requested standardized tag or series ID
- value - the value of the Intrinio tag of the financial data point
- “nm” - No meaning: the value is not meaningful, such as a negative P/E ratio
- “na” - Not applicable: there is no value for the given item/identifier combo, or the user does not have the proper access
Limits
You may request up to 150 identifier/item combinations at a time. For example, you may request 1 identifier and 150 items, or 150 identifiers and 1 item, or 12 identifiers and 12 items (144 combinations), or anywhere in between.
Historical Data
// API URI: https://api.intrinio.com
// GET: /historical_data?identifier=AAPL&item=tipranks_analyst_rating_sells
// FULL URL: https://api.intrinio.com/historical_data?identifier=AAPL&item=tipranks_analyst_rating_sells
{
"identifier": "AAPL",
"item": "tipranks_analyst_rating_sells",
"result_count": 3,
"page_size": 50000,
"current_page": 1,
"total_pages": 1,
"api_call_credits": 1,
"data": [
{
"date": "2017-02-17",
"value": 1
},
{
"date": "2017-01-23",
"value": 1
},
{
"date": "2017-01-12",
"value": 1
},
...
]
}
// API URI: https://api.intrinio.com
// GET: /historical_data?identifier=$Technology&item=tipranks_analyst_rating_sells
// FULL URL: https://api.intrinio.com/historical_data?identifier=$Technology&item=tipranks_analyst_rating_sells
{
"identifier": "$Technology",
"item": "tipranks_analyst_rating_sells",
"result_count": 46,
"page_size": 50000,
"current_page": 1,
"total_pages": 1,
"data": [
{
"date": "2017-03-07",
"value": 1
},
{
"date": "2017-03-03",
"value": 3
},
{
"date": "2017-02-28",
"value": 3
},
...
]
}
=IntrinioHistoricalData("AAPL","tipranks_analyst_rating_sells",0)
1
=IntrinioHistoricalData("$Technology","tipranks_analyst_rating_sells",0)
1
Function not available
Returns the historical values for the given option contract identifier and data tag.
Endpoint
https://api.intrinio.com/historical_data?identifier={identifier}&item={tag}
Excel Function
=IntrinioHistoricalData(identifier, item, sequence, start_date, end_date, frequency, type, show_date)
Parameters
- identifier - and identifier for the security or sector: TICKER SYMBOL | FIGI | OTHER IDENTIFIER | SECTOR
- item - a data tag applicable to news sentiments: ANALYST RATINGS TAGS
- sequence (required, only in Excel add-in function) - an integer 0 or greater for calling a single historical data point from the first entry, based on sort order:
0..last available - start_date (optional) - the earliest date for which to return data:
YYYY-MM-DD - end_date (optional, default=today) - the latest date for which to return data:
YYYY-MM-DD - show_date (optional, only in Excel add-in, false by default) if true, the function will return the date value, and if false the function will return the data point value for a given query:
true | false - sort_order (optional, default=desc) - the order of the historical stock price dates:
asc | desc - page_size (optional, default page size is 1000) - an integer greater than 1 for specifying the number of results on each page.
- page_number (optional, default page number is 1) - an integer greater than or equal to 1 for specifying the page number for the return values.
Return Values
- identifier - the identifier for the security or sector
- item - the requested data tag
- date - the date associated with the value of the data tag
- value - the value at the date
Securities Search/Screener
// API URI: https://api.intrinio.com
// GET: /securities/search?conditions=tipranks_analyst_rating_buys_12w~gt~5
// FULL URL: https://api.intrinio.com/securities/search?conditions=tipranks_analyst_rating_buys_12w~gt~5
{
"result_count": 602,
"page_size": 5,
"current_page": 1,
"total_pages": 121,
"api_call_credits": 1,
"data": [
{
"ticker": "A",
"tipranks_analyst_rating_buys_12w": 8
},
{
"ticker": "AAOI",
"tipranks_analyst_rating_buys_12w": 6
},
{
"ticker": "AAPL",
"tipranks_analyst_rating_buys_12w": 92
},
...
]
}
Function not available
The Screener API can be accessed through the Intrinio Screener for Excel
Function not available
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.
Endpoint
https://api.intrinio.com/securities/search?conditions={conditions}
Intrinio Screener for Excel
Parameters
- conditions - A comma-separated list of conditions. Each condition consists three elements separated by tildes (~):
- A data tag ANALYST RATINGS TAGS
- 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”
- A value
- order_column - A data tag by which to order the results ANALYST RATINGS TAGS
- order_direction - The direction in which to order the results (“asc” for Ascending or “desc” for descending)
- page_size - (optional, default page size is 100) - an integer greater than 1 for specifying the number of results on each page (up to 100)
- page_number - (optional, default page number is 1) - an integer greater than 1 for specifying the page number for the return values
Return Values
The return values will correspond to the data tags in the conditions. Ticker will always be included.
Nasdaq Press Releases Data Feed
Press Releases
// API URI: https://api.intrinio.com
// GET: /press_releases
// FULL URL: https://api.intrinio.com/press_releases
{
"result_count": 17079,
"page_size": 100,
"current_page": 1,
"total_pages": 171,
"api_call_credits": 1,
"data": [
{
"press_release_id": 16934,
"issuer_name": "Stk'emlupsemc te Secwepemc Nation (SSN)",
"title": "Stk'eml\u00c3\u00bapsemc te Secw\u00c3\u00a9pemc Nation (SSN) Building Allies Across B.C. and Canada To Oppose KGHM's Ajax Mine in Kamloops",
"publication_date": "2017-04-01T18:28:04+00:00",
"url": "https:\/\/s3.amazonaws.com\/intrinio-data\/NASDAQ\/press-releases\/201704011090750001.newsml",
"summary": "Today, over 30 organizations representing hundreds of thousands of members across British Columbia and Canada announced their support to the Stk'eml\u00c3\u00bapsemc te Secw\u00c3\u00a9pemc Nation's (SSN) decision to withhold its free, prior and informed..."
},
{
"press_release_id": 17069,
"issuer_name": "Centennial Animal Hospital",
"title": "Colorado Springs Veterinary, Centennial Animal Hospital, Hosts iPad and Chromecast Raffle to Raise Heartworm Awareness",
"publication_date": "2017-04-01T06:00:00-0700",
"url": "https:\/\/s3.amazonaws.com\/intrinio-data\/NASDAQ\/press-releases\/201704010900NASDAQ__NDE______6736600_en.xml",
"summary": null
},
{
"press_release_id": 17070,
"ticker": "PN",
"figi_ticker": "PN:US",
"figi": "BBG007QX4HV7",
"issuer_name": "Kahn Swick & Foti, LLC",
"title": "PATRIOT NATIONAL SHAREHOLDER ALERT BY FORMER LOUISIANA ATTORNEY GENERAL: KAHN SWICK & FOTI, LLC REMINDS INVESTORS WITH LOSSES IN EXCESS OF $100,000 of Lead Plaintiff Deadline in Class Action Lawsuit Against Patriot National, Inc. - (PN)",
"publication_date": "2017-04-01T02:50:00+00:00",
"url": "https:\/\/s3.amazonaws.com\/intrinio-data\/NASDAQ\/press-releases\/2017040111G134548-001.newsml",
"summary": "Kahn Swick & Foti, LLC (\"KSF\") and KSF partner, the former Attorney General of Louisiana, Charles C. Foti, Jr., remind investors that they have until May 15, 2017 to file lead plaintiff applications in a securities class action lawsuit against..."
},
...
]
}
// API URI: https://api.intrinio.com
// GET: /press_releases?identifier=AAPL
// FULL URL: https://api.intrinio.com/press_releases?identifier=FB
{
"result_count": 13,
"page_size": 100,
"current_page": 1,
"total_pages": 1,
"api_call_credits": 1,
"data": [
{
"press_release_id": 9056,
"ticker": "FB",
"figi_ticker": "FB:US",
"figi": "BBG000MM2P62",
"issuer_name": "Bronstein, Gewirtz & Grossman, LLC",
"title": "DEADLINE ALERT: Bronstein, Gewirtz & Grossman, LLC Reminds Investors of Class Action Against Facebook, Inc. (FB) and Lead Plaintiff Deadline: March 28, 2017",
"publication_date": "2017-03-22T07:10:00-0700",
"url": "https:\/\/s3.amazonaws.com\/intrinio-data\/NASDAQ\/press-releases\/201703221010NASDAQ__NDE______6695319_en.xml",
"summary": null
},
{
"press_release_id": 8876,
"ticker": "FB",
"figi_ticker": "FB:US",
"figi": "BBG000MM2P62",
"issuer_name": "The Law Offices of Vincent Wong",
"title": "FB SHAREHOLDER ALERT: The Law Offices of Vincent Wong Reminds Investors of Commencement of a Class Action Involving Facebook, Inc. and a Lead Plaintiff Deadline of March 28, 2017",
"publication_date": "2017-03-21T07:13:33-0700",
"url": "https:\/\/s3.amazonaws.com\/intrinio-data\/NASDAQ\/press-releases\/201703211013NASDAQ__NDE______6712647_en.xml",
"summary": null
},
...
]
}
Function not available
Function not available
Returns the most recent press releases by Nasdaq GlobeNewsire for a company.
Endpoint
https://api.intrinio.com/press_releases
Parameters
- identifier (optional, returns all press releases) - 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: TICKER SYMBOL
- related (optional, returns all press releases) - filter whether the list returned includes all press releases where a company is the subject or only press releases issued by the company: all | false | true
- page_size (optional, default page size is 100) - an integer greater than 1 for specifying the number of results on each page.
- page_number (optional, default page number is 1) - an integer greater than or equal to 1 for specifying the page number for the return values.
Return Values
- ticker - the stock market ticker symbol associated with the companies common stock securities
- figi_ticker - the OpenFIGI ticker symbol
- figi - the OpenFIGI identifier
- issuer_name - the name of the issuer of the press release
- title - the title of the press release
- publication_date - the date the press release was published
- url - the hyperlink to the press release
- summary - a brief summary of the press release
Press Release Content
// API URI: https://api.intrinio.com
// GET: /press_releases
// FULL URL: https://api.intrinio.com/press_releases/detail?id=9056
{
"press_release_id": 9056,
"ticker": "FB",
"figi_ticker": "FB:US",
"figi": "BBG000MM2P62",
"issuer_name": "Bronstein, Gewirtz & Grossman, LLC",
"title": "DEADLINE ALERT: Bronstein, Gewirtz & Grossman, LLC Reminds Investors of Class Action Against Facebook, Inc. (FB) and Lead Plaintiff Deadline: March 28, 2017",
"publication_date": "2017-03-22T07:10:00-0700",
"url": "https:\/\/s3.amazonaws.com\/intrinio-data\/NASDAQ\/press-releases\/201703221010NASDAQ__NDE______6695319_en.xml",
"summary": null,
"issuer_city": "New York",
"issuer_state": "NY",
"issuer_postalcode": "10165",
"issuer_country": "US",
"issuer_industry": "Consumer Services",
"article_revision": "0",
"article_language": "en",
"keywords": "Class Action",
"content": "Law & Legal Issues",
"distributor": "GlobeNewswire",
"body": "<?xml version=\"1.0\"?>\n<nitf version=\"-\/\/IPTC\/\/DTD NITF 3.4 GLOBENEWSWIRE\/\/EN\" change.date=\"October 18, 2006\" change.time=\"19:30\">\n <head>\n <title>DEADLINE ALERT: Bronstein, Gewirtz & Grossman, LLC Reminds Investors of Class Action Against Facebook, Inc. (FB) and Lead Plaintiff Deadline: March 28, 2017<\/title>\n <meta name=\"issuer-name\" content=\"Bronstein, Gewirtz & Grossman, LLC\"\/>\n <meta name=\"issuer-industry\" content=\"Consumer Services\"\/>\n <meta name=\"issuer-city\" content=\"New York\"\/>\n <meta name=\"issuer-state\" content=\"NY\"\/>\n <meta name=\"issuer-postalcode\" content=\"10165\"\/>\n <meta name=\"issuer-country\" content=\"US\"\/>\n <meta name=\"article-headline\" content=\"DEADLINE ALERT: Bronstein, Gewirtz & Grossman, LLC Reminds Investors of Class Action Against Facebook, Inc. (FB) and Lead Plaintiff Deadline: March 28, 2017\"\/>\n <meta name=\"article-id\" content=\"6695319\"\/>\n <meta name=\"article-revision\" content=\"0\"\/>\n <meta name=\"article-pubdate\" content=\"2017-03-22T07:10:00-0700\"\/>\n <meta name=\"article-language\" content=\"en\"\/>\n <meta name=\"article-keywords\" content=\"Class Action\"\/>\n <meta name=\"article-content\" content=\"Class Action\"\/>\n <meta name=\"article-content\" content=\"Law & Legal Issues\"\/>\n <meta name=\"article-symbol\" content=\"Nasdaq:FB\"\/>\n <docdata>\n <doc-id id-string=\"6695319\" regsrc=\"GlobeNewswire\"\/>\n <date.issue norm=\"20170322T141000Z\"\/>\n <doc.copyright holder=\"GlobeNewswire, Inc.\" year=\"2017\"\/>\n <\/docdata>\n <\/head>\n <body>\n <body.head>\n <hedline>\n <hl1>DEADLINE ALERT: Bronstein, Gewirtz & Grossman, LLC Reminds Investors of Class Action Against Facebook, Inc. (FB) and Lead Plaintiff Deadline: March 28, 2017<\/hl1>\n <\/hedline>\n <distributor>GLOBE NEWSWIRE<\/distributor>\n <dateline>\n <story.date>March 22, 2017<\/story.date>\n <\/dateline>\n <\/body.head>\n <body.content><link type=\"text\/css\" rel=\"stylesheet\" href=\"http:\/\/www.globenewswire.com\/styles\/gnw_nitf.css\"\/>\n\n <p>NEW YORK, March 22, 2017 (GLOBE NEWSWIRE) -- Attorney Advertising -- Bronstein, Gewirtz & Grossman, LLC reminds investors that a class action lawsuit has been filed against Facebook, Inc. (\u00e2\u20ac\u0153Facebook\u00e2\u20ac\u009d or the \u00e2\u20ac\u0153Company\u00e2\u20ac\u009d) (NASDAQ:FB) and certain of its officers, and is on behalf of shareholders who purchased or otherwise acquired Facebook securities between May 5, 2014 through December 9, 2016, both dates inclusive (the \u00e2\u20ac\u0153Class Period\u00e2\u20ac\u009d). Such investors are advised to join this case by visiting the firm\u00e2\u20ac\u2122s site: <a href=\"https:\/\/www.globenewswire.com\/Tracker?data=cVcgUnMJoMhPa-jzt7GnPxqbSFcRLRvTKxs9RIU0AR7r86P_UzHGTwOCZ0aDDGgIt9YsDCAHdgFL_XvcZf6m-SqpdYmlFXx_VGQ-OAZBIjg=\" rel=\"nofollow\" target=\"_blank\">http:\/\/www.bgandg.com\/fb<\/a>.  <\/p>\n <p>The class action lawsuit seeks to recover damages against Defendants for alleged violations of the federal securities laws under the Securities Exchange Act of 1934 (the \u00e2\u20ac\u0153Exchange Act\u00e2\u20ac\u009d).<\/p> <p>The Complaint alleges that throughout the Class Period Defendants made false and\/or misleading statements and\/or failed to disclose that: (1) Facebook\u00e2\u20ac\u2122s metrics to calculate the average time users spent watching videos was overestimated by between 60% and 80%; (2) Facebook provided inaccurate statistics to advertisers regarding the amount of activity their ads received on the Website; and (3) consequently, Defendants\u00e2\u20ac\u2122 public statements were materially false and misleading at all relevant times. Once this information was made known to the investing public, the lawsuit claims that investors suffered damages.<\/p> <p>A class action lawsuit has already been filed. If you wish to review a copy of the Complaint you can visit the firm\u00e2\u20ac\u2122s site: <a href=\"https:\/\/www.globenewswire.com\/Tracker?data=cVcgUnMJoMhPa-jzt7GnPxqbSFcRLRvTKxs9RIU0AR6RoQp85KrrVoV42SG1QdljczPYAbRrkck8lWRVePTwOCuRXwvGBNfiUqLh_iQpCgo=\" rel=\"nofollow\" target=\"_blank\">http:\/\/www.bgandg.com\/fb<\/a> or you may contact Peretz Bronstein, Esq. or his Investor Relations Analyst, Yael Hurwitz of Bronstein, Gewirtz & Grossman, LLC at 212-697-6484. If you suffered a loss in Facebook you have until <strong>March 28, 2017<\/strong> to request that the Court appoint you as lead plaintiff.  Your ability to share in any recovery doesn't require that you serve as a lead plaintiff.<\/p> <p>Bronstein, Gewirtz & Grossman, LLC is a corporate litigation boutique.  Our primary expertise is the aggressive pursuit of litigation claims on behalf of our clients.  In addition to representing institutions and other investor plaintiffs in class action security litigation, the firm\u00e2\u20ac\u2122s expertise includes general corporate and commercial litigation, as well as securities arbitration.   Attorney advertising. Prior results do not guarantee similar outcomes.<\/p><img class=\"__GNW8366DE3E__IMG\" src=\"https:\/\/www.globenewswire.com\/newsroom\/ti?nf=NjY5NTMxOSMxNDgzMjM0IzIwMTc2OTA=\" width=\"1\" height=\"1\"\/>\n<pre>Contact:\nBronstein, Gewirtz & Grossman, LLC\nPeretz Bronstein or Yael Hurwitz \n212-697-6484 | info@bgandg.com<\/pre>\n<p><a href=\"https:\/\/www.globenewswire.com\/NewsRoom\/AttachmentNg\/a0da9a10-1592-437a-9c10-d30eeb243cb7\"><img src=\"https:\/\/resource.globenewswire.com\/Resource\/Download\/a0da9a10-1592-437a-9c10-d30eeb243cb7?size=1\" border=\"0\" width=\"150\" height=\"150\" alt=\"Primary Logo\" \/><\/a><\/p>\n<p><img src=\"http:\/\/www.globenewswire.com\/newsroom\/ti?ndecode=NzA2NDUjNjY5NTMxOQ==\" alt=\"\" width=\"1\" height=\"1\"\/><\/p>\n <\/body.content>\n <\/body>\n<\/nitf>\n"
}
Function not available
Function not available
Returns the detail of a press release by Nasdaq GlobeNewsire.
Endpoint
https://api.intrinio.com/press_releases/detail
Parameters
- id - the press release id of a specified press release for a company
Return Values
- ticker - the stock market ticker symbol associated with the companies common stock securities
- figi_ticker - the OpenFIGI ticker symbol
- figi - the OpenFIGI identifier
- issuer_name - the name of the issuer of the press release
- title - the title of the press release
- publication_date - the date the press release was published
- url - the hyperlink to the press release
- summary - a brief summary of the press release
- issuer_city - the city of the issuer of the press release
- issuer_state - the state of the issuer of the press release
- issuer_postalcode - the postal code of the issuer of the press release
- issuer_country - the country of the issuer of the press release
- issuer_industry - the industry of the issuer of the press release
- article_revision - the revision number of the press release
- article_language - the language of the body of the press release
- keywords - all keywords for the press release
- content - a summarized content for the press release
- distributor - the distributor of the press release
- body - the body of the press release
Executive Contacts & Compensation Data Feed
Executive Master
// API URI: https://api.intrinio.com
// GET: /executives
// FULL URL: https://api.intrinio.com/executives
{
"result_count": 46110,
"page_size": 250,
"current_page": 1,
"total_pages": 185,
"api_call_credits": 1,
"data": [
{
"identifier": "@AALSTAD_88681",
"full_name": "Ms. Regi Aalstad",
"type": "non-us"
},
{
"identifier": "@AAMIR_58233",
"full_name": "Mr. Mir Aamir",
"type": "us"
},
{
"identifier": "@AANENSEN_64830",
"full_name": "Mr. Theodore Aanensen",
"type": "us"
},
...
]
}
// API URI: https://api.intrinio.com
// GET: /executives?query=Musk
// FULL URL: https://api.intrinio.com/executives?query=Musk
{
"result_count": 2,
"page_size": 250,
"current_page": 1,
"total_pages": 1,
"api_call_credits": 1,
"data": [
{
"identifier": "@MUSK_51244",
"full_name": "Mr. Elon Musk",
"type": "us"
},
{
"identifier": "@MUSK_65276",
"full_name": "Mr. Kimbal Musk",
"type": "us"
}
]
}
// API URI: https://api.intrinio.com
// GET: /executives?company=AAPL
// FULL URL: https://api.intrinio.com/executives?company=AAPL
{
"result_count": 15,
"page_size": 250,
"current_page": 1,
"total_pages": 1,
"api_call_credits": 1,
"data": [
{
"identifier": "@AHRENDTS_47985",
"full_name": "Ms. Angela Ahrendts",
"type": "us"
},
{
"identifier": "@BELL_54590",
"full_name": "Mr. James Bell",
"type": "us"
},
{
"identifier": "@COOK_49578",
"full_name": "Mr. Timothy Cook",
"type": "us"
},
...
}
// API URI: https://api.intrinio.com
// GET: /executives?type=us
// FULL URL: https://api.intrinio.com/executives?type=us
{
"result_count": 31030,
"page_size": 250,
"current_page": 1,
"total_pages": 125,
"api_call_credits": 1,
"data": [
{
"identifier": "@AAMIR_58233",
"full_name": "Mr. Mir Aamir",
"type": "us"
},
{
"identifier": "@AANENSEN_64830",
"full_name": "Mr. Theodore Aanensen",
"type": "us"
},
{
"identifier": "@AARO_86150",
"full_name": "Mr. Thomas Aaro",
"type": "us"
},
...
]
}
// API URI: https://api.intrinio.com
// GET: /executives?role=Chief%20Executive%20Officer
// FULL URL: https://api.intrinio.com/executives?role=Chief%20Executive%20Officer
{
"result_count": 4817,
"page_size": 250,
"current_page": 1,
"total_pages": 20,
"api_call_credits": 1,
"data": [
{
"identifier": "@ABASCAL_81779",
"full_name": "Mr. Jose Abascal",
"type": "non-us"
},
{
"identifier": "@ABBEY_57545",
"full_name": "Mr. Jeffrey Abbey",
"type": "us"
},
{
"identifier": "@ABDALLAH_66078",
"full_name": "Mr. Norman Abdallah",
"type": "us"
},
...
]
}
Function not available
Function not available
Returns a list of all executives and their unique executive identifier, including both U.S. and International executives.
Endpoint
https://api.intrinio.com/executives
https://api.intrinio.com/executives?company={symbol}
https://api.intrinio.com/executives?query={query-string}
https://api.intrinio.com/executives?type={executive-type}
https://api.intrinio.com/executives?role={executive-position}
Parameters
- company (optional, returns list of executives) - the identifier for the specified security or company: TICKER SYMBOL | FIGI | OTHER IDENTIFIER
- query (optional, returns list of executives, if no query specified) - a string query search of executives name.
- type (optional, returns list of executives, if no type specified) - select whether to show only US or International executives: us | non-us
- role (optional, returns list of executives, if no role specified) - the normalized executive and officer role. Tip: remember to encode URL parameters, since roles may have spaces and other non-alphanumeric characters.
- page_size (optional, restricted by max page size) - an integer greater than 1 for specifying the number of results on each page.
- page_number (optional, default = 1) - an integer greater than or equal to 1 for specifying the page number for the return values.
Return Values
- identifier - the unique executive identifier assigned by Intrinio
- full_name - the full name of the executive including first and last name
- type - either us or non-us, specifying the necessary subscription access to retrieve contact, compensation and role data for the executive.
Roles
Below is a list of executive roles that can be used to filter the results via the role parameter.
- Accounting
- Assistant Corporate Secretary
- Chairman
- Chief Accounting Officer
- Chief Administrative Officer
- Chief Compliance Officer
- Chief Executive Officer
- Chief Financial Officer
- Chief Information Officer
- Chief Marketing Officer
- Chief Operating Officer
- Chief Technology Officer
- Compliance Officer
- Controller
- Corporate Communications
- Corporate Development
- Corporate Secretary
- Director
- Executive Officer
- Finance
- General Counsel
- Human Resources
- Investor Relations
- Legal Officer
- Marketing
- M&A/Strategy Planning
- President
- Sales
- Treasurer
- Trustee
Executive Details
// API URI: https://api.intrinio.com
// GET: /executives/details?identifier=@MUSK_51244
// FULL URL: https://api.intrinio.com/executives/details?identifier=@MUSK_51244
{
"identifier": "@MUSK_51244",
"full_name": "Mr. Elon Musk",
"prefix": "Mr.",
"first_name": "Elon",
"middle_name": null,
"last_name": "Musk",
"nick_name": null,
"suffix": null,
"gender": "M",
"age": 44,
"age_as_on_date": "2016-04-15",
"contact_status": "Active",
"type": "us",
"companies": [
{
"identifier": "@MUSK_51244-TSLA:US",
"company": "Tesla Inc.",
"job_title": "Chairman, Product Architect and Chief Executive Officer",
"effective_date": null,
"ticker": "TSLA",
"figi_ticker": "TSLA:US",
"figi": "BBG000N9MNX3",
"type": "Public Company",
"sic": "Motor Vehicles & Passenger Car Bodies",
"cik": "0001318605",
"lead_independent_director": false,
"finance_expert_director": false,
"industry_expert_director": true,
"risk_expert_director": false,
"roles": [
{
"role_name": "Chief Executive Officer",
"status": "Active",
"effective_date": "2008-10-01",
"division": null,
"executive_director": false,
"independent_director": false
},
{
"role_name": "Director",
"status": "Active",
"effective_date": "2004-04-01",
"division": null,
"executive_director": true,
"independent_director": false
},
{
"role_name": "Chairman",
"status": "Active",
"effective_date": "2004-04-01",
"division": null,
"executive_director": false,
"independent_director": false
}
],
"compensations": [
{
"compensation_year": 2016,
"proxy_year": 2017,
"meeting_date": "2017-06-06",
"cash_paid": null,
"salary": 45936,
"bonus": null,
"stock_awards": null,
"option_awards": null,
"pension_nqdc": null,
"non_eqty_incentive_plan": null,
"all_other_compensation": null,
"total_summary": 45936,
"currency_denomination": "Absolute",
"currency": "USD",
"director_compensation": false
},
{
"compensation_year": 2015,
"proxy_year": 2016,
"meeting_date": "2016-05-31",
"cash_paid": null,
"salary": 37584,
"bonus": null,
"stock_awards": null,
"option_awards": null,
"pension_nqdc": null,
"non_eqty_incentive_plan": null,
"all_other_compensation": null,
"total_summary": 37584,
"currency_denomination": "Absolute",
"currency": "USD",
"director_compensation": false
}
]
}
]
}
Function not available
Function not available
A detailed output of the detailed information for an executive, including summary contact info, companies (including the unique Intrinio executive company id), roles, and compensation.
Endpoint
https://api.intrinio.com/executives/details?identifier={executive-id}
Parameters
- identifier - the Intrinio executive identifier.
Return Values
- identifier - the Intrinio executive identifier.
- full_name - the full name of the executive including first and last name
- prefix - the prefix of the persons name providing context
- first_name - the first name of the person
- middle_name - the middle name of the person
- last_name - the last name of the person
- nick_name - the persons nick name
- suffix - the suffix of the persons name
- gender - the gender of the person
- age - the age of the person
- age_as_on_date - the date of which the persons age was last determined
- contact_status - a booleon representing whether the contact information is still being collected
Companies Node
- identifier - the Intrinio executive company identifier
- company - the name of the company
- job_title - the job title of the executive at the company
- effective_date - the effective date of the executive’s current job
- ticker - the company’s ticker symbol
- figi_ticker - the company security’s FIGI ticker
- figi - the FIGI identifier for the company security’s
- type - the type of company, such as Public Company or Private Company
- sic - the Standard Industrial Classification of the company
- cik - the Central Index Key of the company with the SEC
- lead_independent_director - a boolean, representing whether the executive is the lead independent director on the company’s Board
- finance_expert_director - a boolean, representing whether the executive is a finance expert director on the company’s Board
- industry_expert_director - a boolean, representing whether the executive is a industry expert director on the company’s Board
- risk_expert_director - a boolean, representing whether the executive is a risk expert on the company’s Board
Roles Node
- role_name - the normalized role name for the executive with the company
- status - a representation of whether the executive’s role is active or inactive
- effective_date - the date when the role became active
- division - the division where the executive operates within the company
- executive_director - a boolean, representing whether the executive is an executive director on the company’s Board
- independent_director - a boolean, representing whether the executive is a independent director on the company’s Board
Compensations Node
- compensation_year - the fiscal year of the executive’s compensation package
- proxy_year - the proxy when the compensation is disclosed
- meeting_date - the date of the Board of Directors meeting where the executives compensation package was determined
- cash_paid - the amount of cash paid out to the executive not considered a salary or bonus
- salary - the established salary of the executive
- bonus - the bonus for the executive
- stock_awards - the total value of all stock grants
- option_awards - the total value of all option grants at their fair market value
- pension_nqdc - the value of pension benefit contributions
- non_eqty_incentive_plan - the value of any non-equity incentive plan benefits
- all_other_compensation - the value of all other compensation not otherwise accounted for in the other categories
- total_summary - the total value of all compensation for the fiscal year
- currency_denomination - the currency denomination, such as absolute, thousands or millions
- currency - the currency of the compensation for the executive
- director_compensation - a boolean, representing whether the compensation includes or is exclusively for a directorship
Company Executive Contacts
// API URI: https://api.intrinio.com
// GET: /executives/companies?identifier=@MUSK_51244
// FULL URL: https://api.intrinio.com/executives/companies?identifier=@MUSK_51244
{
"result_count": 1,
"page_size": 250,
"current_page": 1,
"total_pages": 1,
"api_call_credits": 1,
"data": [
{
"identifier": "@MUSK_51244-TSLA:US",
"company": "Tesla Inc.",
"job_title": "Chairman, Product Architect and Chief Executive Officer",
"effective_date": null,
"ticker": "TSLA",
"figi_ticker": "TSLA:US",
"figi": "BBG000N9MNX3",
"type": "Public Company",
"sic": "Motor Vehicles & Passenger Car Bodies",
"cik": "0001318605",
"incorporated_country": "United States",
"address_line_1": "3500 Deer Creek Rd.",
"address_line_2": null,
"city": "Palo Alto",
"state": "California",
"zip": "94304",
"country_name": "United States",
"main_phone": "650-681-5000",
"direct_no": null,
"direct_extn": null,
"dept_no": null,
"dept_extn": null,
"fax": null,
"fax_extn": null,
"email": "elon.musk@teslamotors.com",
"depart_email": null,
"lead_independent_director": false,
"finance_expert_director": false,
"industry_expert_director": true,
"risk_expert_director": false
}
]
}
Function not available
Function not available
Returns a list of all information for an executive and their related companies. Information includes the unique Intrinio executive company identifier, and detailed contact information for the executive at a specified company.
Endpoint
https://api.intrinio.com/executives/companies?identifier={executive-id}?company={symbol}
Parameters
- identifier - the Intrinio executive identifier.
- company (optional, returns list of all companies related to the executive) - the identifier for the specified security or company: TICKER SYMBOL | FIGI | OTHER IDENTIFIER
Return Values
- identifier - the Intrinio executive company identifier.
- company - the name of the company.
- job_title - the job title of the executive at the company.
- effective_date - the effective date of the executive’s current job.
- ticker - the company’s ticker symbol.
- figi_ticker - the company security’s FIGI ticker.
- figi - the FIGI identifier for the company security’s.
- type - the type of company, such as Public Company or Private Company.
- sic - the Standard Industrial Classification of the company.
- cik - the Central Index Key of the company with the SEC.
- incorporated_country - the country where the company is incorporated.
- address_line_1 - the company’s address, first line.
- address_line_2 - the company’s address, second line.
- city - the city where the company is headquartered.
- state - the state where the company is headquartered.
- zip - the zip code of the company’s headquarter’s.
- country_name - the country where the company is headquartered.
- main_phone - the main phone number of the company’s executive.
- direct_no - the direct phone number of the company’s executive.
- direct_extn - the direct phone number extension of the company’s executive.
- dept_no - the department’s phone number of the company’s executive.
- dept_extn - the department’s phone number extension of the company’s executive.
- fax - the fax number of the company’s executive.
- fax_extn - the fax number extension of the company’s executive.
- email - the email address of the company’s executive.
- depart_email - the department’s email address for the company’s executive.
- lead_independent_director - a boolean, representing whether the executive is the lead independent director on the company’s Board.
- finance_expert_director - a boolean, representing whether the executive is a finance expert director on the company’s Board.
- industry_expert_director - a boolean, representing whether the executive is a industry expert director on the company’s Board.
- risk_expert_director - a boolean, representing whether the executive is a risk expert on the company’s Board.
Company Executive Compensation
// API URI: https://api.intrinio.com
// GET: /executives/compensations?identifier=@MUSK_51244&company=TSLA
// FULL URL: https://api.intrinio.com/executives/compensations?identifier=@MUSK_51244&company=TSLA
{
"result_count": 2,
"page_size": 250,
"current_page": 1,
"total_pages": 1,
"api_call_credits": 1,
"data": [
{
"job_title": "Chairman, Product Architect and Chief Executive Officer",
"company": "Tesla Inc.",
"ticker": "TSLA",
"figi_ticker": "TSLA:US",
"figi": "BBG000N9MNX3",
"compensation_year": 2016,
"proxy_year": 2017,
"meeting_date": "2017-06-06",
"cash_paid": null,
"salary": 45936,
"bonus": null,
"stock_awards": null,
"option_awards": null,
"pension_nqdc": null,
"non_eqty_incentive_plan": null,
"all_other_compensation": null,
"total_summary": 45936,
"currency_denomination": "Absolute",
"currency": "USD",
"director_compensation": false
},
{
"job_title": "Chairman, Product Architect and Chief Executive Officer",
"company": "Tesla Inc.",
"ticker": "TSLA",
"figi_ticker": "TSLA:US",
"figi": "BBG000N9MNX3",
"compensation_year": 2015,
"proxy_year": 2016,
"meeting_date": "2016-05-31",
"cash_paid": null,
"salary": 37584,
"bonus": null,
"stock_awards": null,
"option_awards": null,
"pension_nqdc": null,
"non_eqty_incentive_plan": null,
"all_other_compensation": null,
"total_summary": 37584,
"currency_denomination": "Absolute",
"currency": "USD",
"director_compensation": false
}
]
}
Function not available
Function not available
Returns a list of all historical compensation data for an executive at a specified company. Compensation data includes all cash and salary payments, bonuses, stock options, pension benefits and more.
Important: Note the currency and the currency denomination. Non-US executives are likely paid in local currency. Also, some compensation figures may be denominated in absolute terms, while others in the thousands or millions.
Endpoint
https://api.intrinio.com/executives/compensations?identifier={executive-id}?company={symbol}
Parameters
- identifier - the Intrinio executive identifier.
- company (optional, returns list of executives) - the identifier for the specified security or company: TICKER SYMBOL | FIGI | OTHER IDENTIFIER
Return Values
- job_title - the job title of the executive at the company.
- company - the name of the company.
- ticker - the company’s ticker symbol.
- figi_ticker - the company security’s FIGI ticker.
- figi - the FIGI identifier for the company security’s.
- compensation_year - the fiscal year of the executive’s compensation package.
- proxy_year - the proxy when the compensation is disclosed.
- meeting_date - the date of the Board of Directors meeting where the executives compensation package was determined.
- cash_paid - the amount of cash paid out to the executive not considered a salary or bonus.
- salary - the established salary of the executive.
- bonus - the bonus for the executive.
- stock_awards - the total value of all stock grants.
- option_awards - the total value of all option grants at their fair market value.
- pension_nqdc - the value of pension benefit contributions.
- non_eqty_incentive_plan - the value of any non-equity incentive plan benefits.
- all_other_compensation - the value of all other compensation not otherwise accounted for in the other categories.
- total_summary - the total value of all compensation for the fiscal year.
- currency_denomination - the currency denomination: Absolute | Thousands | Millions.
- currency - the currency of the compensation for the executive.
- director_compensation - a boolean, representing whether the compensation includes or is exclusively for a directorship.
Company Executive Roles
// API URI: https://api.intrinio.com
// GET: /executives/roles?identifier=@MUSK_51244&company=TSLA
// FULL URL: https://api.intrinio.com/executives/roles?identifier=@MUSK_51244&company=TSLA
{
"result_count": 3,
"page_size": 250,
"current_page": 1,
"total_pages": 1,
"api_call_credits": 1,
"data": [
{
"role_name": "Chief Executive Officer",
"company": "Tesla Inc.",
"ticker": "TSLA",
"figi_ticker": "TSLA:US",
"figi": "BBG000N9MNX3",
"status": "Active",
"effective_date": "2008-10-01",
"division": null,
"executive_director": false,
"independent_director": false
},
{
"role_name": "Director",
"company": "Tesla Inc.",
"ticker": "TSLA",
"figi_ticker": "TSLA:US",
"figi": "BBG000N9MNX3",
"status": "Active",
"effective_date": "2004-04-01",
"division": null,
"executive_director": true,
"independent_director": false
},
{
"role_name": "Chairman",
"company": "Tesla Inc.",
"ticker": "TSLA",
"figi_ticker": "TSLA:US",
"figi": "BBG000N9MNX3",
"status": "Active",
"effective_date": "2004-04-01",
"division": null,
"executive_director": false,
"independent_director": false
}
]
}
Function not available
Function not available
For a specific executive company identifier, returns a list of all roles within the company. For example, an executive may be the Chief Executive Officer, a Director, and the Chairman of the Board of Directors.
Endpoint
https://api.intrinio.com/executives/roles?identifier={executive-id}?company={symbol}
Parameters
- identifier - the Intrinio executive identifier.
- company (optional, returns list of executives) - the identifier for the specified security or company: TICKER SYMBOL | FIGI | OTHER IDENTIFIER
Return Values
- role_name - the normalized role name for the executive with the company.
- company - the name of the company.
- ticker - the company’s ticker symbol.
- figi_ticker - the company security’s FIGI ticker.
- figi - the FIGI identifier for the company security’s.
- status - a representation of whether the executive’s role is active or inactive.
- effective_date - the date when the role became active.
- division - the division where the executive operates within the company.
- executive_director - a boolean, representing whether the executive is an executive director on the company’s Board.
- independent_director - a boolean, representing whether the executive is a independent director on the company’s Board.
Data Point
// API URI: https://api.intrinio.com
// GET: /data_point?identifier=FNV:CT&item=close_price
// FULL URL: https://api.intrinio.com/data_point?identifier=@MUSK_51244-TSLA:US&item=comp_total_summary
{
"identifier": "@MUSK_51244-TSLA:US",
"item": "comp_total_summary",
"value": 45936
}
// API URI: https://api.intrinio.com
// GET: /data_point?identifier=@MUSK_51244-TSLA:US&item=comp_total_summary,comp_currency,comp_denomination
// FULL URL: https://api.intrinio.com/data_point?identifier=@MUSK_51244-TSLA:US&item=comp_total_summary,comp_currency,comp_denomination
// NOTE: While this is a single API Call, it is considered
// a Dimensional Call, which counts as 3 API Calls against
// the subscription plan.
{
"result_count": 3,
"api_call_credits": 3,
"data": [
{
"identifier": "@MUSK_51244-TSLA:US",
"item": "comp_total_summary",
"value": 45936
},
{
"identifier": "@MUSK_51244-TSLA:US",
"item": "comp_currency",
"value": "USD"
},
{
"identifier": "@MUSK_51244-TSLA:US",
"item": "comp_denomination",
"value": "Absolute"
}
]
}
=IntrinioDataPoint("@MUSK_51244-TSLA:US","comp_total_summary")
45936
=IntrinioDataPoint("@MUSK_51244-TSLA:US","comp_currency")
USD
=IntrinioDataPoint("@MUSK_51244-TSLA:US","comp_total_summary")
45936
=IntrinioDataPoint("@MUSK_51244-TSLA:US","comp_currency")
USD
Returns the most recent data point for a selected identifier for a selected tag. All data points are returned as their most recent value.
Endpoint
https://api.intrinio.com/data_point?identifier={executive-company-id}&item={tag}
https://api.intrinio.com/data_point?identifier={executive-company-id-1,executive-company-id-2}&item={tag1,tag2}
Excel Function
=IntrinioDataPoint(identifier, item)
Sheets Function
=IntrinioDataPoint(identifier, item)
Parameters
- identifier - an identifier for the executive with a specifc company: EXECUTIVE_ID-FIGI_TICKER
- item - the specified standardized tag for executive compensation data: EXEC COMPENSATION TAGS
Limits
You may request up to 150 identifier/item combinations at a time. For example, you may request 1 identifier and 150 items, or 150 identifiers and 1 item, or 12 identifiers and 12 items (144 combinations), or anywhere in between.
Return Values
- identifier - the ticker or identifier for the data point
- item - the requested standardized tag or series ID
- value - the value of the Intrinio tag of the financial data point
Historical Data
// API URI: https://api.intrinio.com
// GET: /historical_data?identifier=@MUSK_51244-TSLA:US&item=comp_total_summary
// FULL URL: https://api.intrinio.com/historical_data?identifier=@MUSK_51244-TSLA:US&item=comp_total_summary
{
"identifier": "@MUSK_51244-TSLA:US",
"item": "comp_total_summary",
"result_count": 2,
"page_size": 50000,
"current_page": 1,
"total_pages": 1,
"api_call_credits": 1,
"data": [
{
"date": "2016-12-31",
"value": 45936
},
{
"date": "2015-12-31",
"value": 37584
}
]
}
=IntrinioHistoricalData("@MUSK_51244-TSLA:US","comp_total_summary",0)
45936
=IntrinioHistoricalData("@MUSK_51244-TSLA:US","comp_total_summary",1)
37584
Function not available
Returns the historical data for for a selected identifier for a selected tag.
Endpoint
https://api.intrinio.com/historical_data?identifier={executive-company-id}&item={tag}
Excel Function
=IntrinioHistoricalData(identifier, item, sequence, start_date, end_date, frequency, type, show_date)
Parameters
- identifier - an identifier for the executive with a specifc company: EXECUTIVE_ID-FIGI_TICKER
- item - the specified standardized tag for executive compensation data: EXECUTIVE COMPENSATION TAGS
- sequence (required, only in Excel add-in function) - an integer 0 or greater for calling a single historical data point from the first entry, based on sort order:
0..last available - start_date (optional) - the earliest date for which to return data:
YYYY-MM-DD - end_date (optional, default=today) - the latest date for which to return data:
YYYY-MM-DD - show_date (optional, only in Excel add-in, false by default) if true, the function will return the date value, and if false the function will return the data point value for a given query:
true | false - sort_order (optional, default=desc) - the order of the historical stock price dates:
asc | desc - page_size (optional, returns full list without a page size & number) - an integer greater than 1 for specifying the number of results on each page.
- page_number (optional, returns full list without a page size & number) - an integer greater than or equal to 1 for specifying the page number for the return values.
Return Values
- date - the date associated with the value of the data tag
- value - the value of the data tag for the data point