Skip to content

Latest commit

 

History

History
511 lines (302 loc) · 13.7 KB

FundamentalsApi.md

File metadata and controls

511 lines (302 loc) · 13.7 KB
Raw

Intrinio::FundamentalsApi

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

filter_fundamental

View Intrinio API Documentation

Fundamental filter_fundamental(opts)

Filter Fundamental

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

Example

# 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

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

Fundamental

get_fundamental_by_id

View Intrinio API Documentation

Fundamental get_fundamental_by_id(id)

Fundamental by ID

Returns a specific fundamental associated with a particular unique fundamental ID. Useful for pulling reference data for a specific fundamental.

Example

# 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
id = "fun_ge9LlE"

result = fundamentals_api.get_fundamental_by_id(id)
pp result

Parameters

Name Type Description Notes
id String The Intrinio ID for the Fundamental  

Return type

Fundamental

get_fundamental_reported_financials

View Intrinio API Documentation

ApiResponseReportedFinancials get_fundamental_reported_financials(id)

Reported Financials

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.

Example

# 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
id = "AAPL-income_statement-2018-Q1"

result = fundamentals_api.get_fundamental_reported_financials(id)
pp result

Parameters

Name Type Description Notes
id String The Intrinio ID or lookup code (ticker-statement-year-period) for the Fundamental  

Return type

ApiResponseReportedFinancials

get_fundamental_standardized_financials

View Intrinio API Documentation

ApiResponseStandardizedFinancials get_fundamental_standardized_financials(id)

Standardized Financials

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.

Example

# 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
id = "AAPL-income_statement-2018-Q1"

result = fundamentals_api.get_fundamental_standardized_financials(id)
pp result

Parameters

Name Type Description Notes
id String The Intrinio ID or lookup code (ticker-statement-year-period) for the Fundamental  

Return type

ApiResponseStandardizedFinancials

get_fundamental_standardized_financials_dimensions

View Intrinio API Documentation

ApiResponseStandardizedFinancialsDimensions get_fundamental_standardized_financials_dimensions(id, tag)

Standardized Financials Dimensions

Returns as reported dimensionality of a data tag

Example

# 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
id = "AAPL-income_statement-2020-FY"
tag = "ceo"

result = fundamentals_api.get_fundamental_standardized_financials_dimensions(id, tag)
pp result

Parameters

Name Type Description Notes
id String The Intrinio ID or lookup code (ticker-statement-year-period) for the Fundamental  
tag String An Intrinio data tag ID or code (<a href='https://data.intrinio.com/data-tags&#39;&gt;reference&lt;/a>)  

Return type

ApiResponseStandardizedFinancialsDimensions

lookup_fundamental

View Intrinio API Documentation

Fundamental lookup_fundamental(identifier, statement_code, fiscal_year, fiscal_period)

Lookup Fundamental

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.

Example

# 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
identifier = "AAPL"
statement_code = "income_statement"
fiscal_year = 2017
fiscal_period = "FY"

result = fundamentals_api.lookup_fundamental(identifier, statement_code, fiscal_year, fiscal_period)
pp result

Parameters

Name Type Description Notes
identifier String A Company identifier (Ticker, CIK, LEI, Intrinio ID)  
statement_code String The statement code  
fiscal_year Integer The fiscal year  
fiscal_period String The fiscal period  

Return type

Fundamental