Returns a list of all securities that have options listed and are tradable on a US market exchange. Useful to retrieve the entire universe.
| Name | Type | Description | Notes |
|---|---|---|---|
| symbol | Character | The option symbol, corresponding to the underlying security. | |
| type | Character | The option contract type. | [optional] |
| strike | Numeric | The strike price of the option contract. This will return options contracts with strike price equal to this price. | [optional] |
| strike_greater_than | Numeric | The strike price of the option contract. This will return options contracts with strike prices greater than this price. | [optional] |
| strike_less_than | Numeric | The strike price of the option contract. This will return options contracts with strike prices less than this price. | [optional] |
| expiration | Character | The expiration date of the option contract. This will return options contracts with expiration dates on this date. | [optional] |
| expiration_after | Character | The expiration date of the option contract. This will return options contracts with expiration dates after this date. | [optional] |
| expiration_before | Character | The expiration date of the option contract. This will return options contracts with expiration dates before this date. | [optional] |
| source | Character | Realtime or 15-minute delayed contracts. | [optional] |
| include_related_symbols | Logical | Include related symbols that end in a 1 or 2 because of a corporate action. | [optional] |
| Name | Type | Description |
|---|---|---|
| options | List of OptionRealtime | A list of options contracts with the given symbol |
| options_data_frame | Data Frame | Data frame representation of options |
Back to Product Docs