Full Financials
Overview
How to fetch all fields in the Full Financials data set
URI Examples
Overview
Full Financials provides a standardized view of financial data from income statements, balance sheets and cash flow statements and a large set of pre-calculated ratios. Coverage includes approximately 1,500 data points for 12,000+ companies representing both SEC filers and exclusive access to OTC listed filers. Data is extracted from 8-K, 10-K, 10-Q, 20-F, S-1 and other SEC and OTC filings and, after being processed by a rules-based programming engine. This process ensures a consistent set of key data elements and ratios and reflects the taxonomy specific data point for large industry groups; taxonomies include consumer and industrials, oil and gas, banks, brokerage, insurance and real estate.
Financials’ four resources base duration on the following timeframes: annual, quarterly, trailing twelve months (TTM) and year to date (YTD).
Note: After you fetch Full Financials data, you can call the Taxonomy resource to fetch information that provides important context to the data. For more information, see Taxonomy resource.
| Parameter Name | Field Name | Resource | Description |
| entityids |
entityid |
financials/ann
financials/qtr
financials/ttm
financials/ytd
|
Retrieve financial information using single entity id or list of entity ids, separated by comma, for specified fields. |
| primarysymbols |
primarysymbol |
financials/ann
financials/qtr
financials/ttm
financials/ytd
|
Retrieve financial information using valid single primary symbol or list of valid primary symbols, separated by comma, for specified fields. |
| companynames |
companyname |
financials/ann
financials/qtr
financials/ttm
financials/ytd
|
Search financial information based on company name or list of company names, separated by comma. Also asterisk might be used. Examples: Microsoft*, *inc*, *co. Length up to 255 characters of a company name. |
| cusip |
cusip |
financials/ann
financials/qtr
financials/ttm
financials/ytd
|
Search financial data based on CUSIP or list of valid CUSIPs, separated by comma. It might be 6-, 8- or 9-digit value. Because of the license required by The CUSIP Bureau to use these unique identifiers, this is a separate entitlement that can be provided upon receipt of a CUSIP license. |
| fiscalperiod |
fiscalperiod |
financials/ann
financials/qtr
financials/ttm
financials/ytd
|
Retrieve financial information for specified fields based on fiscal year and the quarter defined by [~]FYQ[~][FYQ] where FYQ has following format YYYYQ{1-4}. For example: to retrieve data:
– between the fiscal periods of 2010 Q1 and 2012 Q4, specify fiscalperiod=2010q1~2012q4;
– exact period - fiscalperiod=2015Q1;
– all data up to 2015Q1 - fiscalperiod=~2015Q1;
– all data after 2015Q1 - fiscalperiod=2015Q1~.
Note that the date format should be year followed by "q".
|
| numperiods |
numperiods |
financials/ann
financials/qtr
financials/ttm
financials/ytd
|
Numperiod defines the time period for which the financial information is retrieved for specified fields. For example: to retrieve 3 years of history, specify numperiods=3 for financials/ann , for 3 years of quarterly data specify numperiods=12 for other resources. |
| periodenddate |
periodenddate |
financials/ann
financials/qtr
financials/ttm
financials/ytd
|
Retrieve financial information based on the financial year or quarter end. For example: to retrieve data for the period end date 6/31/2012, specify periodenddate=20120631. Note that the date format should be year, month, day. If date range specified, dates should be separated by tilda (~). For example to retrieve data:
– prior to 01/27/2014 - periodenddate=~20140127;
– for all the data after 01/27/2014 - periodenddate=20140127~;
– for the range 01/01/2014-31/12/2014 - periodenddate=20140101~20141231
|
| fields |
|
financials/ann
financials/qtr
financials/ttm
financials/ytd
|
Fields parameter is used to add the field or list of fields in the response. If it is not specified, then the default not null fields are returned in the response*. |
| limit |
|
financials/ann
financials/qtr
financials/ttm
financials/ytd
|
Limit defines the number of rows to return in a single call. See description here. |
| offset |
|
financials/ann
financials/qtr
financials/ttm
financials/ytd
|
Offset can be useful to narrow the result set. See description here. |
| sortby |
|
financials/ann
financials/qtr
financials/ttm
financials/ytd
|
Sortby is a filter in the request to sort the data in ascending or descending order. Fields available for sorting: entityid, cusip, companyname, primarysymbol, periodenddate, fiscalyear, fiscalquarter, fiscalperiod. Default values: primarysymbol asc,periodenddate desc. |
*List of default Financials fields:
entityid, fiscalquarter, fiscalyear, numperiods, periodenddate, currentquartermeanearningsestimate, currentyearmeanearningsestimate, nextquartermeanearningsestimate, operatingcashflow, pricebook, priceearnings, pricesales, assets, cashcashequivalents, grossprofit, liabilities, netcashflowsprovidedusedfinancingactivities, netcashflowsprovidedusedinvestingactivities, netincome, operatingrevenue, primarysymbol, cusip, earningspersharebasic, grossmargin, marketcapitalizationbasic, marketcapitalizationdiluted, operatingmargin, debtequity, currentratio, ebit, marketcapitalizationtsodaily, companyname, fiscalperiod.
How to fetch all fields in the Full Financials data set
To fetch all fields in the Full Financials data set, specify the "fields" query paramter in the call with "defaultfieldgroup" as the value of the parameter.
Note: If your entitlement is not granted access to CUSIP numbers, you must negate the CUSIP number field from the call or the error "The field - CUSIP - you are trying to access is not entitled for your application key" will return.
Example 1 (includes CUSIP numbers)
https://datafied.api.edgar-online.com/v2/financials/ann?entityids=10358&periodenddate=20161231~20161231&fields=defaultfieldgroup&appkey={APPKEY}
Example 2 (negation excludes CUSIP numbers from the request)
https://datafied.api.edgar-online.com/v2/financials/ann?entityids=10358&periodenddate=20161231~20161231&fields=defaultfieldgroup,!cusip&appkey={APPKEY}
URI Examples
Get Financials data using EntityIds and PeriodEndDate parameters:
Annual
https://datafied.api.edgar-online.com/v2/financials/ann?entityids=10358&periodenddate=20101231~&appkey={APPKEY}
Quarterly
https://datafied.api.edgar-online.com/v2/financials/qtr?entityids=10358&periodenddate=~20150630&appkey={APPKEY}
Trailing Twelve Months
https://datafied.api.edgar-online.com/v2/financials/ttm?entityids=8528&periodenddate=20101231~20150630&appkey={APPKEY}
Year to Date
https://datafied.api.edgar-online.com/v2/financials/ytd?entityids=8528&periodenddate=20141231&appkey={APPKEY}
Get Financials data using PrimarySymbols and FiscalPeriod parameters:
Annual
https://datafied.api.edgar-online.com/v2/financials/ann?primarysymbols=aapl&fiscalperiod=2012q4&appkey={APPKEY}
Quarterly
https://datafied.api.edgar-online.com/v2/financials/qtr?primarysymbols=msft&fiscalperiod=2010q3~&appkey={APPKEY}
Trailing Twelve Months
https://datafied.api.edgar-online.com/v2/financials/ttm?primarysymbols=ibm&fiscalperiod=~2015q1&appkey={APPKEY}
Year to Date
https://datafied.api.edgar-online.com/v2/financials/ytd?primarysymbols=ibm,aapl,msft&fiscalperiod=2012q4~2015q3&appkey={APPKEY}
Get Financials data using CompanyNames and Fields parameters:
Annual
https://datafied.api.edgar-online.com/v2/financials/ann?companynames=apple inc&fields=companyname,periodenddate,operatingcashflow,cashcashequivalents,grossprofit&appkey={APPKEY}
Quarterly
https://datafied.api.edgar-online.com/v2/financials/qtr?companynames=micro*&fields=companyname,fiscalperiod,fiscalyear,fiscalquarter,operatingcashflow,cashcashequivalents,grossprofit&appkey={APPKEY}
Trailing Twelve Months
https://datafied.api.edgar-online.com/v2/financials/ttm?companynames=*inc*&fields=companyname,assets,operatingcashflow,grossprofit&appkey={APPKEY}
Year to Date
https://datafied.api.edgar-online.com/v2/financials/ytd?companynames=appleinc,appalachian power co&fields=companyname,periodenddate,assets,operatingcashflow,grossprofit&appkey={APPKEY}
To get all available fields make a call to the Metadata resource:
https://datafied.api.edgar-online.com/v2/metadata/resources/financials-ann/fields?appkey={APPKEY}
Get Financials data using CUSIP (replace 'xxxxxx' with valid value) and NumPeriods parameters:
Annual
https://datafied.api.edgar-online.com/v2/financials/ann?cusip=xxxxxx&numperiods=3&appkey={APPKEY}
Quarterly
https://datafied.api.edgar-online.com/v2/financials/qtr?cusip=xxxxxxxx&numperiods=12&appkey={APPKEY}
Trailing Twelve Months
https://datafied.api.edgar-online.com/v2/financials/ttm?cusip=xxxxxx,xxxxxxxx&numperiods=12&appkey={APPKEY}
Year to Date
https://datafied.api.edgar-online.com/v2/financials/ytd?cusip=xxxxxxxxx&numperiods=12&appkey={APPKEY}
One of parameters identifying company should be specified. Otherwise error occurs.
Example:
https://datafied.api.edgar-online.com/v2/financials/ann?debug=true&appkey={APPKEY}
Response:
400 Bad Request
{
"Message":"No filter parameters included."
}
Get Financials data applying SortBy, Limit, Offset parameters:
Annual
https://datafied.api.edgar-online.com/v2/financials/ann?primarysymbols=msft&sortby=periodenddate%20desc&limit=10&appkey={APPKEY}
Quarterly
https://datafied.api.edgar-online.com/v2/financials/qtr?primarysymbols=msft,ibm&sortby=companyname,fiscalyear desc,fiscalquarter desc&limit=200&offset=25&appkey={APPKEY}
Trailing Twelve Months
https://datafied.api.edgar-online.com/v2/financials/ttm.json?primarysymbols=aapl&fields=primarysymbol,companyname,fiscalperiod,grossprofit,operatingcashflow,assets&sortby=fiscalperiod desc&limit=1&appkey={APPKEY}
JSON Response:
{
"result":{
"totalrows":67,
"rows":[
{
"rownum":1,
"values":[
{
"field":"primarysymbol",
"value":"AAPL"
},
{
"field":"companyname",
"value":"APPLE INC"
},
{
"field":"fiscalperiod",
"value":20151
},
{
"field":"grossprofit",
"value":"78432000000.0"
},
{
"field":"operatingcashflow",
"value":"70765000000.0"
},
{
"field":"assets",
"value":"261894000000.0"
}
]
}
]
}
}
Year to Date
https://datafied.api.edgar-online.com/v2/financials/ytd.xml?primarysymbols=msft&periodenddate=~20150930&sortby=periodenddate%20desc&limit=1&offset=2&appkey={APPKEY}
XML Response:
<response>
<result>
<totalrows>58</totalrows>
<rows>
<row>
<rownum>3</rownum>
<values>
<value field="entityid">8528</value>
<value field="fiscalquarter">3</value>
<value field="fiscalyear">2015</value>
<value field="numperiods">5</value>
<value field="periodenddate">3/31/2015 12:00 AM</value>
<value field="operatingcashflow">22819000000</value>
<value field="pricebook">3.74</value>
<value field="priceearnings">21.74</value>
<value field="pricesales">4.72</value>
<value field="assets">176683000000</value>
<value field="cashcashequivalents">7414000000</value>
<value field="grossprofit">45830000000</value>
<value field="liabilities">86551000000</value>
<value field="netcashflowsprovidedusedfinancingactivities">-6064000000</value>
<value field="netcashflowsprovidedusedinvestingactivities">-17934000000</value>
<value field="netincome">15388000000</value>
<value field="operatingrevenue">71400000000</value>
<value field="primarysymbol">MSFT</value>
<value field="earningspersharebasic">1.87</value>
<value field="grossmargin">0.6419</value>
<value field="marketcapitalizationbasic">333980825000</value>
<value field="marketcapitalizationdiluted">337151915000</value>
<value field="operatingmargin">0.2831</value>
<value field="debtequity">0.3536</value>
<value field="currentratio">2.91</value>
<value field="ebit">20214000000</value>
<value field="companyname">MICROSOFT CORP</value>
<value field="fiscalperiod">20153</value>
<values>
<row>
<rows>
<result>
<response>
If unavailable for sorting field is specified, then error occurs.
Example:
https://datafied.api.edgar-online.com/v2/financials/ytd?primarysymbols=msft&sortby=numperiods&appkey={APPKEY}
Response:
400 Bad Request
{
"Message":"Field - 'numperiods' - is not enabled for sorting operations."
}