All Securities

All Securities R API Documentation

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

API Class:
IntrinioSDK::SecurityApi
Instance Method:
get_all_securities()

Stock Price Code Example

Use my API Key
client <- IntrinioSDK::ApiClient$new()
# Configure API key authorization: ApiKeyAuth
client$configuration$apiKey <- "YOUR_API_KEY"
#Configure retries
client$configuration$allowRetries <- TRUE
# Setup API with client
SecurityApi <- IntrinioSDK::SecurityApi$new(client)
# Optional params
opts <- list(
active = TRUE,
delisted = FALSE,
code = NULL,
currency = NULL,
ticker = NULL,
name = NULL,
composite_mic = NULL,
exchange_mic = NULL,
stock_prices_after = NULL,
stock_prices_before = NULL,
cik = NULL,
figi = NULL,
composite_figi = NULL,
share_class_figi = NULL,
figi_unique_id = NULL,
include_non_figi = FALSE,
page_size = 100,
primary_listing = NULL,
next_page = NULL
)
response <- SecurityApi$get_all_securities(opts)
print(response)
print(response$content)
הההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההה
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

Parameters

NameTypeDescriptionNotes
activeLogicalWhen 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]  
delistedLogicalWhen 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]  
codeCharacterReturn securities classified with the given code (reference).[optional]  
currencyCharacterReturn securities traded in the given 3-digit ISO 4217 currency code (reference).[optional]  
tickerCharacterReturn 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]  
nameCharacterReturn securities with the given text in their name (not case sensitive).[optional]  
composite_micCharacterReturn 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_micCharacterThe MIC code of the exchange where the security is actually traded.[optional]  
stock_prices_afterDateReturn securities with end-of-day stock prices on or after this date.[optional]  
stock_prices_beforeDateReturn securities with end-of-day stock prices on or before this date.[optional]  
cikCharacterReturn securities belonging to the company with the given Central Index Key (CIK).[optional]  
figiCharacterReturn securities with the given Exchange Level FIGI (reference).[optional]  
composite_figiCharacterReturn securities with the given Country Composite FIGI (reference).[optional]  
share_class_figiCharacterReturn securities with the given Global Share Class FIGI (reference).[optional]  
figi_unique_idCharacterReturn securities with the given FIGI Unique ID (reference).[optional]  
include_non_figiLogicalWhen 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_sizeIntegerThe number of results to return[optional] [default to 100]  
primary_listingLogicalIf 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_pageCharacterGets the next page of data from a previous API call[optional]  


Return Type

object
IntrinioSDK::ApiResponseSecurities

Properties

NameTypeDescription
securitiesList of SecuritySummary 
securities_data_frameData FrameData frame representation of securities
next_pageCharacterThe token required to request the next page of the data. If null, no further results are available.  
object
IntrinioSDK::SecuritySummary

Properties

NameTypeDescription
idCharacterThe Intrinio ID for Security  
company_idCharacterThe Intrinio ID for the Company for which the Security is issued  
exchangeCharacterThe exchange's MIC  
exchange_micCharacterThe security's exchange MIC  
stock_exchange_idCharacterThe exchange's Intrinio ID  
nameCharacterThe name of the Security  
codeCharacterA 2-3 digit code classifying the Security (reference)  
currencyCharacterThe currency in which the Security is traded on the exchange  
tickerCharacterThe common/local ticker of the Security  
composite_tickerCharacterThe country-composite ticker of the Security  
figiCharacterThe OpenFIGI identifier  
composite_figiCharacterThe country-composite OpenFIGI identifier  
share_class_figiCharacterThe global-composite OpenFIGI identifier  
primary_listingLogicalIf TRUE, the Security is the primary issue for the company, otherwise it is a secondary issue on a secondary stock exchange