All Filing Notes

All Filing Notes Ruby API Documentation

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.

API Class:
Intrinio::FilingApi
Instance Method:
get_all_notes()

Stock Price Code Example

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

Parameters

NameTypeDescriptionNotes
companyStringA Company identifier (Ticker, CIK, LEI, Intrinio ID)[optional]  
report_typeStringNotes contained in filings that match the given report type[optional]  
filing_start_dateDateLimit search to filings on or after this date[optional]  
filing_end_dateDateLimit search to filings on or before this date[optional]  
period_ended_start_dateDateLimit search to filings with a period end date on or after this date[optional]  
period_ended_end_dateDateLimit search to filings with a period end date on or before this date[optional]  
page_sizeIntegerThe number of results to return[optional] [default to 100]  
next_pageStringGets the next page of data from a previous API call[optional]  

Return Type

object
Intrinio::ApiResponseFilingNotes

Properties

NameTypeDescription
filing_notesArray 
next_pageStringThe token required to request the next page of the data. If null, no further results are available.  
object
Intrinio::FilingNoteSummary

Properties

NameTypeDescription
idStringThe Intrinio ID of the note  
xbrl_tagStringThe XBRL tag used for the note by the filing entity  
filingFilingNoteFiling 
object
Intrinio::FilingNoteFiling

Properties

NameTypeDescription
cikStringThe Central Index Key (CIK) assigned to the company  
report_typeStringThe filing report type  
period_end_dateDateThe ending date of the fiscal period for the filing  
filing_dateDateThe date the report was filed with the SEC