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 | String | The option symbol, corresponding to the underlying security. | |
type | String | The option contract type. | [optional] [enum: call, put] |
strike | BigDecimal | The strike price of the option contract. This will return options contracts with strike price equal to this price. | [optional] |
strikeGreaterThan | BigDecimal | The strike price of the option contract. This will return options contracts with strike prices greater than this price. | [optional] |
strikeLessThan | BigDecimal | The strike price of the option contract. This will return options contracts with strike prices less than this price. | [optional] |
expiration | String | The expiration date of the option contract. This will return options contracts with expiration dates on this date. | [optional] |
expirationAfter | String | The expiration date of the option contract. This will return options contracts with expiration dates after this date. | [optional] |
expirationBefore | String | The expiration date of the option contract. This will return options contracts with expiration dates before this date. | [optional] |
source | String | Realtime or 15-minute delayed contracts. | [optional] [enum: realtime, delayed] |
includeRelatedSymbols | Boolean | Include related symbols that end in a 1 or 2 because of a corporate action. | [optional] |
Name | Type | Description |
---|---|---|
options | List | A list of options contracts with the given symbol |