Search Filing Notes

Search Filing Notes Ruby API Documentation

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

API Class:
Intrinio::FilingApi
Instance Method:
search_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
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
הההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההה
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

Parameters

NameTypeDescriptionNotes
queryStringSearch for notes that contain all or parts of this text 
filing_start_dateDateLimit search to filings on or after this date[optional]  
filing_end_dateDateLimit search to filings on or before this date[optional]  
page_sizeIntegerThe number of results to return[optional] [default to 100]  

Return Type

object
Intrinio::ApiResponseFilingNotesSearch

Properties

NameTypeDescription
filing_notesArray 
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