Options
Endpoints
Get

Function: get()

Overview

The get() function serves as the primary entry point for retrieving 1-minute and 5-minute aggregate data for options. It allows access to either complete option chains or specific option contracts.

Syntax

get(stock)

Parameters

ParameterTypeDescription
stockstrCan be either a ticker symbol (e.g., "AAPL") to retrieve the entire option chain, or a specific option identifier (e.g., "AAPL_031023P142") to retrieve a single option contract

Return Value

The function returns one of the following types, depending on the input parameter:

Input TypeReturn TypeDescription
Ticker symbol (e.g., "MSFT")ggOptionChainContains the complete option chain for the specified ticker
Option identifier (e.g., "AAPL_031023P142")ggOptionContains data for the specific option contract

Option Identifier Format

For specific options, the identifier follows this pattern: SYMBOL_EXPMMDDYY(P/C)STRIKE

Where:

  • SYMBOL: The underlying stock ticker
  • EXPMMDDYY: Expiration date in MMDDYY format (March 10, 2023 = 031023)
  • P/C: Put (P) or Call (C) indicator
  • STRIKE: Strike price

Usage Examples

Retrieving an Option Chain

import goldengoose
 
# Get the entire Microsoft option chain
msft_chain = goldengoose.options.get("MSFT")
 
# Access the current data
current_epoch = goldengoose.get_current_epoch()
current_chain = msft_chain[current_epoch]
 
# View available expirations
expirations = current_chain.expirations
print(f"Available expiration dates: {expirations}")

Retrieving a Specific Option

import goldengoose
 
# Get a specific Apple put option
# AAPL $142 put expiring March 10, 2023
apple_put = goldengoose.options.get("AAPL_031023P142")
 
# Access the current data
current_epoch = goldengoose.get_current_epoch()
current_option = apple_put[current_epoch]
 
# View option price and greeks
print(f"Option price: ${current_option.price}")
print(f"Delta: {current_option.greeks.delta}")

Notes

  • The returned objects provide epoch-based access to data using timestamp indices
  • Use goldengoose.get_current_epoch() to obtain the timestamp for the current time period
  • Both ggOptionChain and ggOption objects contain OHLC data for the specified time intervals
OptionsList