Screen Securities using complex logic. Use POST only. See screener documentation for details on how to construct conditions.
| Name | Type | Description | Notes |
|---|---|---|---|
| logic | SecurityScreenGroup | The logic to screen with, consisting of operators, clauses, and nested groups. </br> See <a href="https://docs.intrinio.com/documentation/screener_v2" target="_blank">screener documentation</a> for details on how to construct conditions. | [optional] |
| order_column | Character | Results returned sorted by this column | [optional] |
| order_direction | Character | Sort order to use with the order_column | [optional] [default to asc] |
| primary_only | Logical | Return only primary securities | [optional] [default to FALSE] |
| page_size | Integer | The number of results to return. Maximum for this endpoint is 50000. | [optional] [default to 100] |
| Name | Type | Description |
|---|---|---|
| security | SecuritySummary | |
| data | List of SecurityScreenResultData | |
| data_data_frame | Data Frame | Data frame representation of data |
| Name | Type | Description |
|---|---|---|
| id | Character | The Intrinio ID for Security |
| company_id | Character | The Intrinio ID for the Company for which the Security is issued |
| exchange | Character | The exchange’s MIC |
| exchange_mic | Character | The security’s exchange MIC |
| stock_exchange_id | Character | The exchange’s Intrinio ID |
| name | Character | The name of the Security |
| code | Character | A 2-3 digit code classifying the Security (<a href="https://docs.intrinio.com/documentation/security_codes" target="_blank">reference</a>) |
| currency | Character | The currency in which the Security is traded on the exchange |
| ticker | Character | The common/local ticker of the Security |
| composite_ticker | Character | The country-composite ticker of the Security |
| figi | Character | The OpenFIGI identifier |
| composite_figi | Character | The country-composite OpenFIGI identifier |
| share_class_figi | Character | The global-composite OpenFIGI identifier |
| 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 |
Back to Product Docs