All URIs are relative to https://api-v2.intrinio.com
| Method | HTTP request | Description |
|---|---|---|
| filter_fundamental | GET /fundamentals | Filter Fundamental |
| get_fundamental_by_id | GET /fundamentals/{id} | Fundamental by ID |
| get_fundamental_reported_financials | GET /fundamentals/{id}/reported_financials | Reported Financials |
| get_fundamental_standardized_financials | GET /fundamentals/{id}/standardized_financials | Standardized Financials |
| get_fundamental_standardized_financials_dimensions | GET /fundamentals/{id}/standardized_financials/dimensions/{tag} | Standardized Financials Dimensions |
| lookup_fundamental | GET /fundamentals/lookup/{identifier}/{statement_code}/{fiscal_year}/{fiscal_period} | Lookup Fundamental |
View Intrinio API Documentation
Fundamental filter_fundamental(filed_after=filed_after, filed_before=filed_before, reported_only=reported_only, fiscal_year=fiscal_year, statement_code=statement_code, type=type, fiscal_period=fiscal_period, start_date=start_date, end_date=end_date, updated_after=updated_after, updated_before=updated_before, template=template, next_page=next_page)
Returns fundamentals that meet the set of filters specified in parameters.
from __future__ import print_function
import time
import intrinio_sdk as intrinio
from intrinio_sdk.rest import ApiException
intrinio.ApiClient().set_api_key('YOUR_API_KEY')
intrinio.ApiClient().allow_retries(True)
filed_after = '2022-01-01'
filed_before = '2022-12-01'
reported_only = False
fiscal_year = 2017
statement_code = ''
type = 'False'
fiscal_period = 'FY'
start_date = '2022-01-01'
end_date = '2022-12-01'
updated_after = '2022-12-01'
updated_before = '2022-12-01'
template = 'indu'
next_page = ''
response = intrinio.FundamentalsApi().filter_fundamental(filed_after=filed_after, filed_before=filed_before, reported_only=reported_only, fiscal_year=fiscal_year, statement_code=statement_code, type=type, fiscal_period=fiscal_period, start_date=start_date, end_date=end_date, updated_after=updated_after, updated_before=updated_before, template=template, next_page=next_page)
print(response)
# Note: For a Pandas DataFrame, import Pandas and use pd.DataFrame(response.property_name_dict) | Name | Type | Description | Notes |
|---|---|---|---|
| filed_after | date | Only include fundamentals that were filed on or after this date. | [optional] |
| filed_before | date | Only include fundamentals that were filed on or before this date. | [optional] |
| reported_only | bool | Only as-reported fundamentals | [optional] |
| fiscal_year | int | Only for the given fiscal year | [optional] |
| statement_code | str | Only of the given statement code | [optional] |
| type | str | Only of the given type | [optional] |
| fiscal_period | str | The fiscal period | [optional] |
| start_date | date | Only include fundamentals where covered period is on or after this date. | [optional] |
| end_date | date | Only include fundamentals where covered period is on or before this date. | [optional] |
| updated_after | date | Only include fundamentals where it was updated after this date. | [optional] |
| updated_before | date | Only include fundamentals where it was updated before this date. | [optional] |
| template | str | The financial statement template used by Intrinio to standardize the as reported data | [optional] |
| next_page | str | Gets the next page of data from a previous API call | [optional] |
View Intrinio API Documentation
Fundamental get_fundamental_by_id(id)
Returns a specific fundamental associated with a particular unique fundamental ID. Useful for pulling reference data for a specific fundamental.
from __future__ import print_function
import time
import intrinio_sdk as intrinio
from intrinio_sdk.rest import ApiException
intrinio.ApiClient().set_api_key('YOUR_API_KEY')
intrinio.ApiClient().allow_retries(True)
id = 'fun_ge9LlE'
response = intrinio.FundamentalsApi().get_fundamental_by_id(id)
print(response)
# Note: For a Pandas DataFrame, import Pandas and use pd.DataFrame(response.property_name_dict) | Name | Type | Description | Notes |
|---|---|---|---|
| id | str | The Intrinio ID for the Fundamental |
View Intrinio API Documentation
ApiResponseReportedFinancials get_fundamental_reported_financials(id)
Returns as-reported financial statement data for income statement, balance sheet, and cash flow statement. Data for income statement and cash flow statement is available on a FY, QTR (Q1, Q2, Q3, Q4), TTM (Q1TTM, Q2TTM, Q3TTM), and YTD (Q2YTD, Q3YTD) basis. Data for the balance sheet is available on a FY or QTR (Q1, Q2, Q3, Q4) basis only due its point-in-time nature.
from __future__ import print_function
import time
import intrinio_sdk as intrinio
from intrinio_sdk.rest import ApiException
intrinio.ApiClient().set_api_key('YOUR_API_KEY')
intrinio.ApiClient().allow_retries(True)
id = 'AAPL-income_statement-2018-Q1'
response = intrinio.FundamentalsApi().get_fundamental_reported_financials(id)
print(response)
# Note: For a Pandas DataFrame, import Pandas and use pd.DataFrame(response.property_name_dict) | Name | Type | Description | Notes |
|---|---|---|---|
| id | str | The Intrinio ID or lookup code (ticker-statement-year-period) for the Fundamental |
View Intrinio API Documentation
ApiResponseStandardizedFinancials get_fundamental_standardized_financials(id)
Returns standardized financial statement data for income statement, balance sheet, cash flow statement and over 100 associated calculations for a given company. Data for income statement, cash flow statement, and calculations is available on a FY, QTR (Q1, Q2, Q3, Q4), TTM (Q1TTM, Q2TTM, Q3TTM), and YTD (Q2YTD, Q3YTD) basis. Data for the balance sheet is available on a FY or QTR (Q1, Q2, Q3, Q4) basis only due its point-in-time nature.
from __future__ import print_function
import time
import intrinio_sdk as intrinio
from intrinio_sdk.rest import ApiException
intrinio.ApiClient().set_api_key('YOUR_API_KEY')
intrinio.ApiClient().allow_retries(True)
id = 'AAPL-income_statement-2018-Q1'
response = intrinio.FundamentalsApi().get_fundamental_standardized_financials(id)
print(response)
# Note: For a Pandas DataFrame, import Pandas and use pd.DataFrame(response.property_name_dict) | Name | Type | Description | Notes |
|---|---|---|---|
| id | str | The Intrinio ID or lookup code (ticker-statement-year-period) for the Fundamental |
ApiResponseStandardizedFinancials
View Intrinio API Documentation
ApiResponseStandardizedFinancialsDimensions get_fundamental_standardized_financials_dimensions(id, tag)
Returns as reported dimensionality of a data tag
from __future__ import print_function
import time
import intrinio_sdk as intrinio
from intrinio_sdk.rest import ApiException
intrinio.ApiClient().set_api_key('YOUR_API_KEY')
intrinio.ApiClient().allow_retries(True)
id = 'AAPL-income_statement-2020-FY'
tag = 'ceo'
response = intrinio.FundamentalsApi().get_fundamental_standardized_financials_dimensions(id, tag)
print(response)
# Note: For a Pandas DataFrame, import Pandas and use pd.DataFrame(response.property_name_dict) | Name | Type | Description | Notes |
|---|---|---|---|
| id | str | The Intrinio ID or lookup code (ticker-statement-year-period) for the Fundamental | |
| tag | str | An Intrinio data tag ID or code (<a href='https://data.intrinio.com/data-tags'>reference</a>) |
ApiResponseStandardizedFinancialsDimensions
View Intrinio API Documentation
Fundamental lookup_fundamental(identifier, statement_code, fiscal_year, fiscal_period)
Returns a specific fundamental with unique fundamental ID associated with a particular company, year, period and statement. Useful for pulling the unique fundamental ID and reference data for a specific fundamental.
from __future__ import print_function
import time
import intrinio_sdk as intrinio
from intrinio_sdk.rest import ApiException
intrinio.ApiClient().set_api_key('YOUR_API_KEY')
intrinio.ApiClient().allow_retries(True)
identifier = 'AAPL'
statement_code = 'income_statement'
fiscal_year = 2017
fiscal_period = 'FY'
response = intrinio.FundamentalsApi().lookup_fundamental(identifier, statement_code, fiscal_year, fiscal_period)
print(response)
# Note: For a Pandas DataFrame, import Pandas and use pd.DataFrame(response.property_name_dict) | Name | Type | Description | Notes |
|---|---|---|---|
| identifier | str | A Company identifier (Ticker, CIK, LEI, Intrinio ID) | |
| statement_code | str | The statement code | |
| fiscal_year | int | The fiscal year | |
| fiscal_period | str | The fiscal period |