Filter Fundamental

Filter Fundamental R API Documentation

Returns fundamentals that meet the set of filters specified in parameters.

API Class:
IntrinioSDK::FundamentalsApi
Instance Method:
filter_fundamental()

Stock Price Code Example

Use my API Key
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)
הההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההה
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

Parameters

NameTypeDescriptionNotes
filed_afterDateOnly include fundamentals that were filed on or after this date.[optional]  
filed_beforeDateOnly include fundamentals that were filed on or before this date.[optional]  
reported_onlyLogicalOnly as-reported fundamentals[optional]  
fiscal_yearIntegerOnly for the given fiscal year[optional]  
statement_codeCharacterOnly of the given statement code[optional]  
typeCharacterOnly of the given type[optional]  
fiscal_periodCharacterThe fiscal period[optional]  
start_dateDateOnly include fundamentals where covered period is on or after this date.[optional]  
end_dateDateOnly include fundamentals where covered period is on or before this date.[optional]  
updated_afterDateOnly include fundamentals where it was updated after this date.[optional]  
updated_beforeDateOnly include fundamentals where it was updated before this date.[optional]  
templateCharacterThe financial statement template used by Intrinio to standardize the as reported data[optional]  
next_pageCharacterGets the next page of data from a previous API call[optional]  


Return Type

object
IntrinioSDK::Fundamental

Properties

NameTypeDescription
idCharacterThe Intrinio ID of the Fundamental  
statement_codeCharacterThe code of the financial statement that the Fundamental represents  
fiscal_yearNumericThe fiscal year  
fiscal_periodCharacterThe fiscal period  
typeCharacterThe type of Fundamental  
start_dateDateThe period start date  
end_dateDateThe period start date  
filing_datePOSIXltThe date and time when the Fundamental was filed with the SEC  
is_latestLogicalIs this the latest fundamental available based on the company's most recent filings? Use the Lookup Fundamental endpoint to find the latest fundamental (reference)  
companyCompanySummaryThe Company that the Fundamental was belongs to  
object
IntrinioSDK::CompanySummary

Properties

NameTypeDescription
idCharacterThe Intrinio ID of the company  
tickerCharacterThe stock market ticker symbol associated with the company's common stock securities  
nameCharacterThe company's common name  
leiCharacterThe Legal Entity Identifier (LEI) assigned to the company  
cikCharacterThe Central Index Key (CIK) assigned to the company