XBRLAnalyst Web API
Description
XBRLAnalyst Web API is provided to users of all subscription types of XBRLAnalyst. The API allows to retrieve fundamental and stock market financial information of all public companies that file XBRL reports with the Securities and Exchange Commission (SEC) in the US. All information is provided in the following formats: JSON(default) and XML (you can specify it with “format” parameter).
For Preview purposes, we provide unregistered visitor with open access to the API for companies listed in S&P100 Index.
Calls
Public Companies
Use:
Retrieve information about individual public company or a clist (company list) of companies.
Example:
https://xbrlanalyst.findynamics.com/api/v2/companies?ticker=wmt
Parameters:
Name | Description |
---|---|
cik | The CIK (central index key) number of a company (e.g., Walmart is “0000104169”). |
ticker | The trading symbol of a company (e.g., “MSFT” for Microsoft). |
clist | A list of companies. |
Financial Reports
Use:
Retrieve information about individual financial report or all reports submitted by the public company to SEC.
Example:
https://xbrlanalyst.findynamics.com/api/v2/reports?ticker=wmt
Parameters:
Name | Description |
---|---|
cik, ticker, clist | See Public Companies. |
accessionNumber | The SEC-assigned accession number. |
focusYear | The focus fiscal year of the accession (corresponds to the DocumentFiscalYearFocus DEI tag). |
focusPeriod | The focus fiscal period of the accession (corresponds to the DocumentFiscalPeriodFocus DEI tag). |
docType | The document type of the accession (corresponds to the DocumentType DEI tag). |
Report Sections
Use:
Retrieve detail information about sections of financial report (Statements and Disclosures)
Example:
https://xbrlanalyst.findynamics.com/api/v2/sections?ticker=wmt&accessionNumber=0001193125-11-083157
Parameters:
Name | Description |
---|---|
cik, ticker, clist | See Public Companies. |
accessionNumber, focusYear, focusPeriod, docType |
See Financial Reports. |
networkRole | A number representing the category of the section. For example, 2 represents an income or comprehensive income statement. |
networkOrdinal | The ordinal number of the section relative to list of all sections (sorted by network description). |
networkUri | The extended link role of the section. Together with the accession number, this uniquely identifies a section. |
Financial Facts
Use:
Retrieve one or many financial facts: values of XBRL facts or Normalized Financial Metrics pre-computed by FinDynamics.
Example:
https://xbrlanalyst.findynamics.com/api/v2/facts?ticker=wmt&tid=revenue&fiscalYear=2013&fiscalPeriod=Q1
https://xbrlanalyst.findynamics.com/api/v2/facts?ticker=googl&fiscalYear=2013&fiscalPeriod=FY&concept=Revenues&member=MotorolaMobilityHoldingsIncMember
Parameters:
Name | Description |
---|---|
cik, ticker, clist | See Public Companies. |
tid | The Tid (normalized financial metric) to lookup. |
concept | The XBRL concept of a fact. |
members | XBRL Dimension Members. |
fiscalYear | The fiscal year of a fact. |
fiscalPeriod | The fiscal period of a fact. |
accessionNumber, focusYear, focusPeriod, docType |
Additional input parameters limiting the selection of financial facts to specific report(s). For more details, see Financial Reports. |
Normalized Metrics
Use:
Retrieve the normalized metrics (“Tids”) available for use with the Financial Facts call.
Example:
https://xbrlanalyst.findynamics.com/api/v2/tids
Parameters:
Name | Description |
---|---|
tid | The Tid (normalized financial metric) to lookup. |
Market Quotes
Use:
Retrieve End Of Day stock market quotes: prices and trading volume.
Example:
https://xbrlanalyst.findynamics.com/api/v2/marketquotes?ticker=wmt&date=2014-08-07
Parameters:
Name | Description |
---|---|
cik, ticker, clist | See Public Companies. |
date | The date to get the quote from. |
Market Stats
Use:
Retrieve statistical estimates of stock market prices such as average price over a period of time.
Example:
https://xbrlanalyst.findynamics.com/api/v2/marketstats?ticker=wmt&date=2014-08-07&duration=30
Parameters:
Name | Description |
---|---|
cik, ticker, clist | See Public Companies. |
date | The last date for the interval. |
duration | The duration of the interval in days counted backward from the last date of the interval. |