All Securities

All Securities Python API Documentation

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

API Class:
SecurityApi
Instance Method:
get_all_securities()

Stock Price Code Example

Use my API Key
from __future__ import print_function
import time
import intrinio_sdk as intrinio
from intrinio_sdk.rest import ApiException
intrinio.ApiClient().set_api_key('YOUR_API_KEY')
intrinio.ApiClient().allow_retries(True)
active = True
delisted = False
code = ''
currency = ''
ticker = ''
name = ''
composite_mic = ''
exchange_mic = ''
stock_prices_after = ''
stock_prices_before = ''
cik = ''
figi = ''
composite_figi = ''
share_class_figi = ''
figi_unique_id = ''
include_non_figi = False
page_size = 100
primary_listing = ''
next_page = ''
response = intrinio.SecurityApi().get_all_securities(active=active, delisted=delisted, code=code, currency=currency, ticker=ticker, name=name,
  composite_mic=composite_mic, exchange_mic=exchange_mic, stock_prices_after=stock_prices_after, stock_prices_before=stock_prices_before, cik=cik,
  figi=figi, composite_figi=composite_figi, share_class_figi=share_class_figi, figi_unique_id=figi_unique_id, include_non_figi=include_non_figi,
  page_size=page_size, primary_listing=primary_listing, next_page=next_page)
print(response)
הההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההה
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

Parameters

NameTypeDescriptionNotes
activeboolWhen 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]  
delistedboolWhen 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]  
codestrReturn securities classified with the given code (reference).[optional]  
currencystrReturn securities traded in the given 3-digit ISO 4217 currency code (reference).[optional]  
tickerstrReturn 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]  
namestrReturn securities with the given text in their name (not case sensitive).[optional]  
composite_micstrReturn 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_micstrThe 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]  
cikstrReturn securities belonging to the company with the given Central Index Key (CIK).[optional]  
figistrReturn securities with the given Exchange Level FIGI (reference).[optional]  
composite_figistrReturn securities with the given Country Composite FIGI (reference).[optional]  
share_class_figistrReturn securities with the given Global Share Class FIGI (reference).[optional]  
figi_unique_idstrReturn securities with the given FIGI Unique ID (reference).[optional]  
include_non_figiboolWhen 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_sizeintThe number of results to return[optional] [default to 100]  
primary_listingboolIf 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_pagestrGets the next page of data from a previous API call[optional]  


Return Type

object
ApiResponseSecurities

Properties

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

Properties

NameTypeDescription
idstrThe Intrinio ID for Security  
company_idstrThe Intrinio ID for the Company for which the Security is issued  
namestrThe name of the Security  
codestrA 2-3 digit code classifying the Security (reference)  
currencystrThe currency in which the Security is traded on the exchange  
tickerstrThe common/local ticker of the Security  
composite_tickerstrThe country-composite ticker of the Security  
figistrThe OpenFIGI identifier  
composite_figistrThe country-composite OpenFIGI identifier  
share_class_figistrThe global-composite OpenFIGI identifier  
primary_listingboolIf True, the Security is the primary issue for the company, otherwise it is a secondary issue on a secondary stock exchange