Search the companies database and return a list of companies matching the text query parameter passed through. Query parameter searches across the company ticker and name.
| Name | Type | Description | Notes |
|---|---|---|---|
| query | Character | Search parameters | |
| active | Logical | When TRUE, return companies that are actively traded (having stock prices within the past 14 days). When FALSE, return companies that are not actively traded or never have been traded. Not setting this value returns all. Not used when mode is set. | [optional] |
| mode | Character | When set, changes search mode to the specified mode. | [optional] |
| page_size | Integer | The number of results to return | [optional] [default to 100] |
| Name | Type | Description |
|---|---|---|
| companies | List of CompanySummary | |
| companies_data_frame | Data Frame | Data frame representation of companies |
| Name | Type | Description |
|---|---|---|
| id | Character | The Intrinio ID of the company |
| ticker | Character | The stock market ticker symbol associated with the company's common stock securities |
| name | Character | The company's common name |
| lei | Character | The Legal Entity Identifier (LEI) assigned to the company |
| cik | Character | The Central Index Key (CIK) assigned to the company |
Back to Product Docs