class SecEdgar::FullTextSearch

Public Class Methods

perform(keys_typed:, narrow: false) click to toggle source

Performs a text search using the EDGAR Full Text Search API

@keys_typed [String] The search term to use in the search query. @narrow [Boolean] Whether or not to narrow the search results. The Company Search Page seems to use this control parameter. www.sec.gov/edgar/searchedgar/companysearch.html

# File lib/sec-edgar/full_text_search.rb, line 15
def self.perform(keys_typed:, narrow: false)
  response = post(
    '/LATEST/search-index',
    headers: { 'Content-Type': 'application/json' },
    body: {
      keysTyped: keys_typed,
      narrow: narrow
    }.compact.to_json
  )

  ClientResult.new(response)
end