Search Companies

Search Companies Ruby API Documentation

Search the companies database and return a list of companies matching the text query parameter passed through. Query parameter searches across the company ticker and name.

API Class:
Intrinio::CompanyApi
Instance Method:
search_companies()

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
company_api = Intrinio::CompanyApi.new
query = "Apple"
opts = {
active: true,
mode: nil,
page_size: 100
}
result = company_api.search_companies(query, opts)
pp result
הההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההה
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

Parameters

NameTypeDescriptionNotes
queryStringSearch parameters 
activeBOOLEANWhen true, return companies that are actively traded (having stock prices within the past 14 days). When false, return companies that are not actively traded or never have been traded. Not setting this value returns all. Not used when mode is set.[optional]  
modeStringWhen set, changes search mode to the specified mode.[optional]  
page_sizeIntegerThe number of results to return[optional] [default to 100]  

Return Type

object
Intrinio::ApiResponseCompaniesSearch

Properties

NameTypeDescription
companiesArray 
object
Intrinio::CompanySummary

Properties

NameTypeDescription
idStringThe Intrinio ID of the company  
tickerStringThe stock market ticker symbol associated with the company's common stock securities  
nameStringThe company's common name  
leiStringThe Legal Entity Identifier (LEI) assigned to the company  
cikStringThe Central Index Key (CIK) assigned to the company