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(opts)
Returns fundamentals that meet the set of filters specified in parameters.
# Setup client
client <- IntrinioSDK::ApiClient$new()
# Configure API key authorization: ApiKeyAuth
client$configuration$apiKey <- "YOUR_API_KEY"
#Configure retries
client$configuration$allowRetries <- TRUE
# Setup API with client
FundamentalsApi <- IntrinioSDK::FundamentalsApi$new(client)
# Optional params
opts <- list(
filed_after = as.Date("2022-01-01"),
filed_before = as.Date("2022-12-01"),
reported_only = FALSE,
fiscal_year = 2017,
statement_code = NULL,
type = "FALSE",
fiscal_period = "FY",
start_date = as.Date("2022-01-01"),
end_date = as.Date("2022-12-01"),
updated_after = as.Date("2022-12-01"),
updated_before = as.Date("2022-12-01"),
template = "indu",
next_page = NULL
)
response <- FundamentalsApi$filter_fundamental(opts)
print(response)
print(response$content)| 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 | Logical | Only as-reported fundamentals | [optional] |
| fiscal_year | Integer | Only for the given fiscal year | [optional] |
| statement_code | Character | Only of the given statement code | [optional] |
| type | Character | Only of the given type | [optional] |
| fiscal_period | Character | 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 | Character | The financial statement template used by Intrinio to standardize the as reported data | [optional] |
| next_page | Character | 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.
# Setup client
client <- IntrinioSDK::ApiClient$new()
# Configure API key authorization: ApiKeyAuth
client$configuration$apiKey <- "YOUR_API_KEY"
#Configure retries
client$configuration$allowRetries <- TRUE
# Setup API with client
FundamentalsApi <- IntrinioSDK::FundamentalsApi$new(client)
# Required params
id <- "fun_ge9LlE"
response <- FundamentalsApi$get_fundamental_by_id(id)
print(response)
print(response$content)| Name | Type | Description | Notes |
|---|---|---|---|
| id | Character | 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.
# Setup client
client <- IntrinioSDK::ApiClient$new()
# Configure API key authorization: ApiKeyAuth
client$configuration$apiKey <- "YOUR_API_KEY"
#Configure retries
client$configuration$allowRetries <- TRUE
# Setup API with client
FundamentalsApi <- IntrinioSDK::FundamentalsApi$new(client)
# Required params
id <- "AAPL-income_statement-2018-Q1"
response <- FundamentalsApi$get_fundamental_reported_financials(id)
print(response)
print(response$content)| Name | Type | Description | Notes |
|---|---|---|---|
| id | Character | 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.
# Setup client
client <- IntrinioSDK::ApiClient$new()
# Configure API key authorization: ApiKeyAuth
client$configuration$apiKey <- "YOUR_API_KEY"
#Configure retries
client$configuration$allowRetries <- TRUE
# Setup API with client
FundamentalsApi <- IntrinioSDK::FundamentalsApi$new(client)
# Required params
id <- "AAPL-income_statement-2018-Q1"
response <- FundamentalsApi$get_fundamental_standardized_financials(id)
print(response)
print(response$content)| Name | Type | Description | Notes |
|---|---|---|---|
| id | Character | 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
# Setup client
client <- IntrinioSDK::ApiClient$new()
# Configure API key authorization: ApiKeyAuth
client$configuration$apiKey <- "YOUR_API_KEY"
#Configure retries
client$configuration$allowRetries <- TRUE
# Setup API with client
FundamentalsApi <- IntrinioSDK::FundamentalsApi$new(client)
# Required params
id <- "AAPL-income_statement-2020-FY"
tag <- "ceo"
response <- FundamentalsApi$get_fundamental_standardized_financials_dimensions(id, tag)
print(response)
print(response$content)| Name | Type | Description | Notes |
|---|---|---|---|
| id | Character | The Intrinio ID or lookup code (ticker-statement-year-period) for the Fundamental | |
| tag | Character | 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.
# Setup client
client <- IntrinioSDK::ApiClient$new()
# Configure API key authorization: ApiKeyAuth
client$configuration$apiKey <- "YOUR_API_KEY"
#Configure retries
client$configuration$allowRetries <- TRUE
# Setup API with client
FundamentalsApi <- IntrinioSDK::FundamentalsApi$new(client)
# Required params
identifier <- "AAPL"
statement_code <- "income_statement"
fiscal_year <- 2017
fiscal_period <- "FY"
response <- FundamentalsApi$lookup_fundamental(identifier, statement_code, fiscal_year, fiscal_period)
print(response)
print(response$content)| Name | Type | Description | Notes |
|---|---|---|---|
| identifier | Character | A Company identifier (Ticker, CIK, LEI, Intrinio ID) | |
| statement_code | Character | The statement code | |
| fiscal_year | Integer | The fiscal year | |
| fiscal_period | Character | The fiscal period |