All Securities Ruby API Documentation

Back to Product Docs

Returns a list of all securities available. Delisted securities included.

API Class:

Intrinio::SecurityApi

Instance Method:

get_all_securities()

Stock Price Code Example

Use my API Key

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
# 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
opts = {
  active: true,
  delisted: false,
  code: nil,
  currency: nil,
  ticker: nil,
  name: nil,
  composite_mic: nil,
  exchange_mic: nil,
  stock_prices_after: nil,
  stock_prices_before: nil,
  cik: nil,
  figi: nil,
  composite_figi: nil,
  share_class_figi: nil,
  figi_unique_id: nil,
  include_non_figi: false,
  page_size: 100,
  primary_listing: nil,
  next_page: nil
}
result = security_api.get_all_securities(opts)
pp result
הההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההה
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

Parameters

Name	Type	Description	Notes
active	BOOLEAN	When true, return securities that are active. When false, return securities that are not active. A security is considered active if it has traded or has had a corporate action in the past 30 days, and has not been merged into another security (such as due to ticker changes or corporate restructurings).	[optional]
delisted	BOOLEAN	When true, return securities that have been delisted from their exchange. Note that there may be a newer security for the same company that has been relisted on a differente exchange. When false, return securities that have not been delisted.	[optional]
code	String	Return securities classified with the given code (reference).	[optional]
currency	String	Return securities traded in the given 3-digit ISO 4217 currency code (reference).	[optional]
ticker	String	Return securities traded with the given ticker. Note that securities across the world (and through time) may trade with the same ticker but represent different companies. Use this in conjuction with other parameters for more specificity.	[optional]
name	String	Return securities with the given text in their name (not case sensitive).	[optional]
composite_mic	String	Return securities classified under the composite exchange with the given Market Identification Code (MIC). A composite exchange may or may not be a real exchange. For example, the USCOMP exchange (our only composite exchange to date) is a combination of exchanges with the following MICs: ARCX, XASE, XPOR, FINR, XCIS, XNAS, XNYS, BATS. This composite grouping is done for user convenience. At this time, all US securities are classified under the composite exchange with MIC USCOMP. To query for specific US exchanges, use the exchange_mic parameter below.	[optional]
exchange_mic	String	The MIC code of the exchange where the security is actually traded.	[optional]
stock_prices_after	Date	Return securities with end-of-day stock prices on or after this date.	[optional]
stock_prices_before	Date	Return securities with end-of-day stock prices on or before this date.	[optional]
cik	String	Return securities belonging to the company with the given Central Index Key (CIK).	[optional]
figi	String	Return securities with the given Exchange Level FIGI (reference).	[optional]
composite_figi	String	Return securities with the given Country Composite FIGI (reference).	[optional]
share_class_figi	String	Return securities with the given Global Share Class FIGI (reference).	[optional]
figi_unique_id	String	Return securities with the given FIGI Unique ID (reference).	[optional]
include_non_figi	BOOLEAN	When true, include securities that do not have a FIGI. By default, this is false. If this parameter is not specified, only securities with a FIGI are returned.	[optional] [default to false]
page_size	Integer	The number of results to return	[optional] [default to 100]
primary_listing	BOOLEAN	If true, the Security is the primary issue for the company, otherwise it is a secondary issue on a secondary stock exchange. Returns both if omitted.	[optional]
next_page	String	Gets the next page of data from a previous API call	[optional]

Return Type

object

Intrinio::ApiResponseSecurities

Properties

Name	Type	Description
securities	Array
next_page	String	The token required to request the next page of the data. If null, no further results are available.

object

Intrinio::SecuritySummary

Properties

Name	Type	Description
id	String	The Intrinio ID for Security
company_id	String	The Intrinio ID for the Company for which the Security is issued
exchange	String	The exchange's MIC
exchange_mic	String	The security's exchange MIC
stock_exchange_id	String	The exchange's Intrinio ID
name	String	The name of the Security
code	String	A 2-3 digit code classifying the Security (reference)
currency	String	The currency in which the Security is traded on the exchange
ticker	String	The common/local ticker of the Security
composite_ticker	String	The country-composite ticker of the Security
figi	String	The OpenFIGI identifier
composite_figi	String	The country-composite OpenFIGI identifier
share_class_figi	String	The global-composite OpenFIGI identifier
primary_listing	BOOLEAN	If true, the Security is the primary issue for the company, otherwise it is a secondary issue on a secondary stock exchange

All Securities

SDKs

EOD Historical Stock Prices - API Endpoints

Security Reference Data

Historical End of Day Prices

Technical Indicators

All Securities Ruby API Documentation

Stock Price Code Example

Parameters

Return Type

Properties

Properties