Options¶
-
pyEX.options.options.optionExpirations(symbol, token='', version='stable', filter='', format='json')[source] Returns end of day options data
https://iexcloud.io/docs/api/#options 9:30am-5pm ET Mon-Fri
Parameters: - symbol (str) – Ticker to request
- token (str) – Access token
- version (str) – API version
- filter (str) – filters: https://iexcloud.io/docs/api/#filter-results
- format (str) – return format, defaults to json
Returns: result
Return type: dict or DataFrame
-
pyEX.options.options.options(contract, token='', version='stable', filter='', format='json', **timeseries_kwargs)[source] Options EOD prices :param contract: Specific dated option contract, e.g. SPY20210714C00475000 :type contract: str :param token: Access token :type token: str :param version: API version :type version: str :param filter: filters: https://iexcloud.io/docs/api/#filter-results :type filter: str :param format: return format, defaults to json :type format: str :param Supports all kwargs from pyEX.timeseries.timeSeries:
Returns: result Return type: dict or DataFrame
-
pyEX.options.options.optionsDF(contract, token='', version='stable', filter='', format='json', **timeseries_kwargs)[source] Options EOD prices :param contract: Specific dated option contract, e.g. SPY20210714C00475000 :type contract: str :param token: Access token :type token: str :param version: API version :type version: str :param filter: filters: https://iexcloud.io/docs/api/#filter-results :type filter: str :param format: return format, defaults to json :type format: str :param Supports all kwargs from pyEX.timeseries.timeSeries:
Returns: result Return type: dict or DataFrame
-
pyEX.options.options.stockOptions(symbol, expiration, side='', token='', version='stable', filter='', format='json')[source] Returns end of day options data
https://iexcloud.io/docs/api/#options 9:30am-5pm ET Mon-Fri
Parameters: - symbol (str) – Ticker to request
- expiration (str) – Expiration date
- side (str) – Side (optional)
- token (str) – Access token
- version (str) – API version
- filter (str) – filters: https://iexcloud.io/docs/api/#filter-results
- format (str) – return format, defaults to json
Returns: result
Return type: dict or DataFrame
Deprecated since version Deprecated:: Migrate to options
-
pyEX.options.options.stockOptionsDF(symbol, expiration, side='', token='', version='stable', filter='', format='json')[source] Returns end of day options data
https://iexcloud.io/docs/api/#options 9:30am-5pm ET Mon-Fri
Parameters: - symbol (str) – Ticker to request
- expiration (str) – Expiration date
- side (str) – Side (optional)
- token (str) – Access token
- version (str) – API version
- filter (str) – filters: https://iexcloud.io/docs/api/#filter-results
- format (str) – return format, defaults to json
Returns: result
Return type: dict or DataFrame
Deprecated since version Deprecated:: Migrate to options