Returns a list of all securities available. Delisted securities included.
| Name | Type | Description | Notes |
|---|---|---|---|
| active | Logical | 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 | Logical | 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 | Character | Return securities classified with the given code (reference). | [optional] |
| currency | Character | Return securities traded in the given 3-digit ISO 4217 currency code (reference). | [optional] |
| ticker | Character | 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 | Character | Return securities with the given text in their name (not case sensitive). | [optional] |
| composite_mic | Character | 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 | Character | 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 | Character | Return securities belonging to the company with the given Central Index Key (CIK). | [optional] |
| figi | Character | Return securities with the given Exchange Level FIGI (reference). | [optional] |
| composite_figi | Character | Return securities with the given Country Composite FIGI (reference). | [optional] |
| share_class_figi | Character | Return securities with the given Global Share Class FIGI (reference). | [optional] |
| figi_unique_id | Character | Return securities with the given FIGI Unique ID (reference). | [optional] |
| include_non_figi | Logical | 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 | Logical | 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 | Character | Gets the next page of data from a previous API call | [optional] |
| Name | Type | Description |
|---|---|---|
| securities | List of SecuritySummary | |
| securities_data_frame | Data Frame | Data frame representation of securities |
| next_page | Character | The token required to request the next page of the data. If null, no further results are available. |
Back to Product Docs