All Securities

All Securities Javascript API Documentation

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

API Class:
SecurityApi
Instance Method:
getAllSecurities()

Stock Price Code Example

Use my API Key
var intrinioSDK = require('intrinio-sdk');
intrinioSDK.ApiClient.instance.authentications['ApiKeyAuth'].apiKey = "YOUR_API_KEY";
intrinioSDK.ApiClient.instance.enableRetries = true;
var security = new intrinioSDK.SecurityApi();
var opts = {
'active': true,
'delisted': false,
'code': null,
'currency': null,
'ticker': null,
'name': null,
'compositeMic': null,
'exchangeMic': null,
'stockPricesAfter': null,
'stockPricesBefore': null,
'cik': null,
'figi': null,
'compositeFigi': null,
'shareClassFigi': null,
'figiUniqueId': null,
'includeNonFigi': false,
'pageSize': 100,
'primaryListing': null,
'nextPage': null
};
security.getAllSecurities(opts).then(function(data) {
data = JSON.stringify(data, null, 2)
console.log(data);
}, function(error) {
console.error(error);
});
הההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההה
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

Parameters

NameTypeDescriptionNotes
activeBooleanWhen 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]  
delistedBooleanWhen 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]  
codeStringReturn securities classified with the given code (reference).[optional]  
currencyStringReturn securities traded in the given 3-digit ISO 4217 currency code (reference).[optional]  
tickerStringReturn 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]  
nameStringReturn securities with the given text in their name (not case sensitive).[optional]  
compositeMicStringReturn 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]  
exchangeMicStringThe MIC code of the exchange where the security is actually traded.[optional]  
stockPricesAfterDateReturn securities with end-of-day stock prices on or after this date.[optional]  
stockPricesBeforeDateReturn securities with end-of-day stock prices on or before this date.[optional]  
cikStringReturn securities belonging to the company with the given Central Index Key (CIK).[optional]  
figiStringReturn securities with the given Exchange Level FIGI (reference).[optional]  
compositeFigiStringReturn securities with the given Country Composite FIGI (reference).[optional]  
shareClassFigiStringReturn securities with the given Global Share Class FIGI (reference).[optional]  
figiUniqueIdStringReturn securities with the given FIGI Unique ID (reference).[optional]  
includeNonFigiBooleanWhen 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]  
pageSizeNumberThe number of results to return[optional] [default to 100]  
primaryListingBooleanIf 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]  
nextPageStringGets the next page of data from a previous API call[optional]  


Return Type

object
ApiResponseSecurities

Properties

NameTypeDescription
securities[SecuritySummary] 
nextPageStringThe token required to request the next page of the data. If null, no further results are available.  
object
SecuritySummary

Properties

NameTypeDescription
idStringThe Intrinio ID for Security  
companyIdStringThe Intrinio ID for the Company for which the Security is issued  
exchangeStringThe exchange's MIC  
exchangeMicStringThe security's exchange MIC  
stockExchangeIdStringThe 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  
compositeTickerStringThe country-composite ticker of the Security  
figiStringThe OpenFIGI identifier  
compositeFigiStringThe country-composite OpenFIGI identifier  
shareClassFigiStringThe global-composite OpenFIGI identifier  
primaryListingBooleanIf true, the Security is the primary issue for the company, otherwise it is a secondary issue on a secondary stock exchange