Options API

Overview

The Options API provides access to options market data and analytics. This documentation outlines the available objects and functions to help you integrate options data into your trading algorithms and analysis workflows.

Available Objects

Object	Description	Documentation
`goldengoose.options.ggOptionChain`	Container for entire option chains, including puts and calls across multiple strike prices and expirations	ggOptionChain Documentation
`goldengoose.options.ggOption`	Individual option contract data including pricing, greeks, and underlying information	ggOption Documentation

Available Functions

Function	Description	Documentation
`goldengoose.options.list()`	Returns a list of all available option symbols	list() Documentation
`goldengoose.options.get(option)`	Retrieves data for a specific option or option chain	get() Documentation

Getting Started

To begin working with options data:

Import the GoldenGoose library
Use list() to discover available option symbols
Use get() to retrieve data for specific options
Access option chain or individual option data through the returned objects

Example

import goldengoose
 
# Get all available option symbols
available_options = goldengoose.options.list()
 
# Retrieve data for a specific option chain
spy_options = goldengoose.options.get("SPY")
 
# Access the current data point
current_epoch = goldengoose.get_current_epoch()
current_chain = spy_options[current_epoch]
 
# Get a specific option from the chain (e.g., SPY $400 Call expiring on 2023-06-16)
call_option = current_chain.get_option("C", 400.0, "2023-06-16")
 
# Print option data
print(f"SPY $400 Call premium: ${call_option.price}")
print(f"Delta: {call_option.greeks.delta}")

Get