Search Securities

Search Securities Ruby API Documentation

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

API Class:
Intrinio::SecurityApi
Instance Method:
search_securities()

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
security_api = Intrinio::SecurityApi.new
query = "Apple"
opts = {
page_size: 100
}
result = security_api.search_securities(query, opts)
pp result
הההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההה
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

Parameters

NameTypeDescriptionNotes
queryString 
page_sizeIntegerThe number of results to return[optional] [default to 100]  

Return Type

object
Intrinio::ApiResponseSecuritiesSearch

Properties

NameTypeDescription
securitiesArray 
object
Intrinio::SecuritySummary

Properties

NameTypeDescription
idStringThe Intrinio ID for Security  
company_idStringThe Intrinio ID for the Company for which the Security is issued  
exchangeStringThe exchange's MIC  
exchange_micStringThe security's exchange MIC  
stock_exchange_idStringThe exchange's Intrinio ID  
nameStringThe name of the Security  
codeStringA 2-3 digit code classifying the Security (reference)  
currencyStringThe currency in which the Security is traded on the exchange  
tickerStringThe common/local ticker of the Security  
composite_tickerStringThe country-composite ticker of the Security  
figiStringThe OpenFIGI identifier  
composite_figiStringThe country-composite OpenFIGI identifier  
share_class_figiStringThe global-composite OpenFIGI identifier  
primary_listingBOOLEANIf true, the Security is the primary issue for the company, otherwise it is a secondary issue on a secondary stock exchange