Filter Fundamental Ruby API Documentation

Back to Product Docs

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

API Class:

Intrinio::FundamentalsApi

Instance Method:

filter_fundamental()

Stock Price Code Example

Use my API Key

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
# Load the gem
require 'intrinio-sdk'
require 'pp'
# Setup authorization
Intrinio.configure do |config|
  config.api_key['api_key'] = 'YOUR_API_KEY'
  config.allow_retries = true
end
fundamentals_api = Intrinio::FundamentalsApi.new
opts = {
  filed_after: Date.parse("2022-01-01"),
  filed_before: Date.parse("2022-12-01"),
  reported_only: false,
  fiscal_year: 2017,
  statement_code: nil,
  type: "false",
  fiscal_period: "FY",
  start_date: Date.parse("2022-01-01"),
  end_date: Date.parse("2022-12-01"),
  updated_after: Date.parse("2022-12-01"),
  updated_before: Date.parse("2022-12-01"),
  template: "indu",
  next_page: nil
}
result = fundamentals_api.filter_fundamental(opts)
pp result
הההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההה
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

Parameters

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	BOOLEAN	Only as-reported fundamentals	[optional]
fiscal_year	Integer	Only for the given fiscal year	[optional]
statement_code	String	Only of the given statement code	[optional]
type	String	Only of the given type	[optional]
fiscal_period	String	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	String	The financial statement template used by Intrinio to standardize the as reported data	[optional]
next_page	String	Gets the next page of data from a previous API call	[optional]

Return Type

object

Intrinio::Fundamental

Properties

Name	Type	Description
id	String	The Intrinio ID of the Fundamental
statement_code	String	The code of the financial statement that the Fundamental represents
fiscal_year	Float	The fiscal year
fiscal_period	String	The fiscal period
type	String	The type of Fundamental
start_date	Date	The period start date
end_date	Date	The period start date
filing_date	DateTime	The date and time when the Fundamental was filed with the SEC
is_latest	BOOLEAN	Is this the latest fundamental available based on the company’s most recent filings? Use the Lookup Fundamental endpoint to find the latest fundamental (<a href="https://docs.intrinio.com/documentation/web_api/lookup_fundamental_v2" target="_blank">reference</a>)
company	CompanySummary	The Company that the Fundamental was belongs to

object

Intrinio::CompanySummary

Properties

Name	Type	Description
id	String	The Intrinio ID of the company
ticker	String	The stock market ticker symbol associated with the company’s common stock securities
name	String	The company’s common name
lei	String	The Legal Entity Identifier (LEI) assigned to the company
cik	String	The Central Index Key (CIK) assigned to the company

Filter Fundamental

SDKs

API Endpoints

Standardized & As-Reported Financial Statement Data

Company Reference & Metadata

Company News

Insider & Institutional Holdings Data

Upcoming & Historical IPOs

Raw Text Filings

XBRL Searchable Financial Statement Notes

Aggregate Standardized Financial Statement Data by SIC Codes

Economic Data

Security Reference Data

Real-Time Prices

Historical Intraday Prices

Historical End of Day Prices

Technical Indicators

Historical End of Day Index Prices

Reference & Metadata

Holdings

Returns & Analytics