Intrinio::FilingApi

All URIs are relative to https://api-v2.intrinio.com

Method	HTTP request	Description
get_all_filings	GET /filings	All Filings
get_all_notes	GET /filings/notes	All Filing Notes
get_filing_answers	GET /filings/identifier/answers	Filing Answers
get_filing_by_id	GET /filings/id	Lookup Filing
get_filing_fundamentals	GET /filings/identifier/fundamentals	All Fundamentals by Filing
get_filing_html	GET /filings/identifier/html	Filing Html
get_filing_text	GET /filings/identifier/text	Filing Text
get_note	GET /filings/notes/identifier	Filing Note by ID
get_note_html	GET /filings/notes/identifier/html	Filing Note HTML
get_note_text	GET /filings/notes/identifier/text	Filing Note Text
search_notes	GET /filings/notes/search	Search Filing Notes

get_all_filings

View Intrinio API Documentation

ApiResponseFilings get_all_filings(opts)

All Filings

Returns pertinent filing reference data for a specific company filing or latest filings for all companies. Useful for tracking the latest filings submitted and updating your database accordingly with the new information.

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

filing_api = Intrinio::FilingApi.new

opts = {
  company: "AAPL",
  report_type: "10-Q",
  start_date: Date.parse("2015-01-01"),
  end_date: nil,
  industry_category: nil,
  industry_group: nil,
  thea_enabled: nil,
  page_size: 100,
  next_page: nil
}

result = filing_api.get_all_filings(opts)
pp result

Parameters

Name	Type	Description	Notes
company	String	Filings for the given `company` identifier (ticker, CIK, LEI, Intrinio ID)	[optional]
report_type	String	Filter by report type. Separate values with commas to return multiple The filing <a href=&quot;https://docs.intrinio.com/documentation/sec_filing_report_types\" target=&quot;_blank&quot;>report types</a>.	[optional]
start_date	Date	Filed on or after the given date	[optional]
end_date	Date	Filed before or after the given date	[optional]
industry_category	String	Return companies in the given industry category	[optional]
industry_group	String	Return companies in the given industry group	[optional]
thea_enabled	BOOLEAN	Return filings that have been read by our Thea NLP and are ready for our answers endpoint	[optional]
page_size	Integer	The number of results to return	[optional] [default to 100]
next_page	String	Gets the next page of data from a previous API call	[optional]

Return type

ApiResponseFilings

get_all_notes

View Intrinio API Documentation

ApiResponseFilingNotes get_all_notes(opts)

All Filing Notes

Returns a list of the latest XBRL filing note sections from the SEC 10-K and 10-Q statements. The returned Intrinio XBRL filing note ID can then be utilized with the “Filing Note by ID” endpoint to retrieve the contents of the note in HTML or text format.

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

filing_api = Intrinio::FilingApi.new

opts = {
  company: "AAPL",
  report_type: "10-Q",
  filing_start_date: nil,
  filing_end_date: nil,
  period_ended_start_date: nil,
  period_ended_end_date: nil,
  page_size: 100,
  next_page: nil
}

result = filing_api.get_all_notes(opts)
pp result

Parameters

Name	Type	Description	Notes
company	String	A Company identifier (Ticker, CIK, LEI, Intrinio ID)	[optional]
report_type	String	Notes contained in filings that match the given <a href=&quot;https://docs.intrinio.com/documentation/sec_filing_report_types\" target=&quot;_blank&quot;>report type</a>	[optional]
filing_start_date	Date	Limit search to filings on or after this date	[optional]
filing_end_date	Date	Limit search to filings on or before this date	[optional]
period_ended_start_date	Date	Limit search to filings with a period end date on or after this date	[optional]
period_ended_end_date	Date	Limit search to filings with a period end date on or before this date	[optional]
page_size	Integer	The number of results to return	[optional] [default to 100]
next_page	String	Gets the next page of data from a previous API call	[optional]

Return type

ApiResponseFilingNotes

get_filing_answers

View Intrinio API Documentation

ApiResponseFilingAnswers get_filing_answers(identifier, query)

Filing Answers

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

filing_api = Intrinio::FilingApi.new
identifier = "fil_B73xBG"
query = "What do they believe in?"

result = filing_api.get_filing_answers(identifier, query)
pp result

Parameters

Name	Type	Description	Notes
identifier	String	A Filing identifier
query	String	The query to ask the Thea API

Return type

ApiResponseFilingAnswers

get_filing_by_id

View Intrinio API Documentation

Filing get_filing_by_id(id)

Lookup Filing

Returns the Filing with the given identifier

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

filing_api = Intrinio::FilingApi.new
id = "fil_7Kn2P6"

result = filing_api.get_filing_by_id(id)
pp result

Parameters

Name	Type	Description	Notes
id	String	The Intrinio ID of the Filing

Return type

Filing

get_filing_fundamentals

View Intrinio API Documentation

ApiResponseFilingFundamentals get_filing_fundamentals(identifier, opts)

All Fundamentals by Filing

Returns a list of fundamentals with unique fundamental IDs associated with a particular Intrinio Filing ID (if applicable) that have been updated or created as a result of a company`s latest SEC filing. Useful to ensure your database is up to date with the latest fundamentals.

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

filing_api = Intrinio::FilingApi.new
identifier = "fil_B73xBG"

opts = {
  statement_code: nil,
  type: nil,
  fiscal_year: nil,
  fiscal_period: nil,
  start_date: nil,
  end_date: nil,
  next_page: nil
}

result = filing_api.get_filing_fundamentals(identifier, opts)
pp result

Parameters

Name	Type	Description	Notes
identifier	String	A Filing identifier
statement_code	String	Filters fundamentals by statement code	[optional]
type	String	Filters fundamentals by type	[optional]
fiscal_year	Integer	Filters fundamentals by fiscal year	[optional]
fiscal_period	String	Filters fundamentals by fiscal period	[optional]
start_date	Date	Returns fundamentals on or after the given date	[optional]
end_date	Date	Returns fundamentals on or before the given date	[optional]
next_page	String	Gets the next page of data from a previous API call	[optional]

Return type

ApiResponseFilingFundamentals

get_filing_html

View Intrinio API Documentation

String get_filing_html(identifier)

Filing Html

Returns a SEC filing in HTML Format for a specified filing ID.

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

filing_api = Intrinio::FilingApi.new
identifier = "fil_B73xBG"

result = filing_api.get_filing_html(identifier)
pp result

Parameters

Name	Type	Description	Notes
identifier	String	A Filing identifier

Return type

String

get_filing_text

View Intrinio API Documentation

String get_filing_text(identifier)

Filing Text

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

filing_api = Intrinio::FilingApi.new
identifier = "fil_B73xBG"

result = filing_api.get_filing_text(identifier)
pp result

Parameters

Name	Type	Description	Notes
identifier	String	A Filing identifier

Return type

String

get_note

View Intrinio API Documentation

FilingNote get_note(identifier, opts)

Filing Note by ID

Returns the XBRL filing note contents in HTML or text format for a specified Intrinio XBRL filing note ID.

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

filing_api = Intrinio::FilingApi.new
identifier = "xbn_ydK3QL"

opts = {
  content_format: "text"
}

result = filing_api.get_note(identifier, opts)
pp result

Parameters

Name	Type	Description	Notes
identifier	String	The Intrinio ID of the filing note
content_format	String	Returns content in html (as filed) or plain text	[optional] [default to text]

Return type

FilingNote

get_note_html

View Intrinio API Documentation

String get_note_html(identifier)

Filing Note HTML

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

filing_api = Intrinio::FilingApi.new
identifier = "xbn_ydK3QL"

result = filing_api.get_note_html(identifier)
pp result

Parameters

Name	Type	Description	Notes
identifier	String	The Intrinio ID of the filing note

Return type

String

get_note_text

View Intrinio API Documentation

String get_note_text(identifier)

Filing Note Text

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

filing_api = Intrinio::FilingApi.new
identifier = "xbn_ydK3QL"

result = filing_api.get_note_text(identifier)
pp result

Parameters

Name	Type	Description	Notes
identifier	String	The Intrinio ID of the filing note

Return type

String

search_notes

View Intrinio API Documentation

ApiResponseFilingNotesSearch search_notes(query, opts)

Search Filing Notes

Search the XBRL note database and return a list of XBRL note sections containing text from the text query parameter passed through.

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

filing_api = Intrinio::FilingApi.new
query = "inflation"

opts = {
  filing_start_date: Date.parse("2018-07-15"),
  filing_end_date: Date.parse("2018-11-30"),
  page_size: 100
}

result = filing_api.search_notes(query, opts)
pp result

Parameters

Name	Type	Description	Notes
query	String	Search for notes that contain all or parts of this text
filing_start_date	Date	Limit search to filings on or after this date	[optional]
filing_end_date	Date	Limit search to filings on or before this date	[optional]
page_size	Integer	The number of results to return	[optional] [default to 100]

Return type

ApiResponseFilingNotesSearch