Crypto
Endpoints
Get

Function: get()

Overview

The get() function serves as the primary entry point for retrieving 1-minute and 5-minute aggregate data for any cryptocurrency asset. This function provides access to detailed price and volume information that can be used for analysis, trading strategies, and monitoring cryptocurrency markets.

Syntax

get(crypto)

Parameters

ParameterTypeDescription
cryptostrThe cryptocurrency symbol to retrieve (e.g., "BTC" for Bitcoin, "ETH" for Ethereum)

Return Value

TypeDescription
ggCryptoA GoldenGoose cryptocurrency object containing comprehensive price and market data

Key Properties of Returned Object

The returned ggCrypto object includes the following properties:

PropertyDescription
symbolThe cryptocurrency symbol
nameFull name of the cryptocurrency
currentPriceCurrent market price in USD
volume24h24-hour trading volume
marketCapTotal market capitalization
circulatingSupplyNumber of coins/tokens in circulation
maxSupplyMaximum possible supply (if applicable)
historicalDataTime-series data keyed by timestamps

Usage Example

import goldengoose
 
# Get Bitcoin data
btc = goldengoose.crypto.get("BTC")
 
# Access the current data
current_epoch = goldengoose.get_current_epoch()
current_data = btc[current_epoch]
 
# Print basic information
print(f"Bitcoin (BTC)")
print(f"Current Price: ${btc.currentPrice:,.2f}")
print(f"Market Cap: ${btc.marketCap:,.2f}")
print(f"24h Volume: ${btc.volume24h:,.2f}")
 
# Access 1-minute candle data
print("\n1-Minute Data:")
print(f"Open: ${current_data.oneMinute.open:,.2f}")
print(f"High: ${current_data.oneMinute.high:,.2f}")
print(f"Low: ${current_data.oneMinute.low:,.2f}")
print(f"Close: ${current_data.oneMinute.close:,.2f}")
print(f"Volume: {current_data.oneMinute.volume:,.2f}")
 
# Access 5-minute candle data
print("\n5-Minute Data:")
print(f"Open: ${current_data.fiveMinute.open:,.2f}")
print(f"High: ${current_data.fiveMinute.high:,.2f}")
print(f"Low: ${current_data.fiveMinute.low:,.2f}")
print(f"Close: ${current_data.fiveMinute.close:,.2f}")
print(f"Volume: {current_data.fiveMinute.volume:,.2f}")
 
# Calculate price change
price_change = current_data.oneMinute.close - current_data.oneMinute.open
price_change_pct = (price_change / current_data.oneMinute.open) * 100
print(f"\nPrice Change: ${price_change:.2f} ({price_change_pct:.2f}%)")

Advanced Usage

Accessing Historical Data

import goldengoose
from datetime import datetime, timedelta
 
# Get Ethereum data
eth = goldengoose.crypto.get("ETH")
 
# Convert a past datetime to epoch format
yesterday = datetime.now() - timedelta(days=1)
yesterday_epoch = yesterday.strftime("%Y-%m-%dT%H:%M:%S")
 
# Access historical data
yesterday_data = eth[yesterday_epoch]
yesterday_price = yesterday_data.oneMinute.close
 
# Calculate 24-hour performance
current_epoch = goldengoose.get_current_epoch()
current_price = eth[current_epoch].oneMinute.close
performance_24h = ((current_price - yesterday_price) / yesterday_price) * 100
 
print(f"ETH 24h Performance: {performance_24h:.2f}%")

Comparing Multiple Cryptocurrencies

import goldengoose
 
# Get data for multiple cryptocurrencies
btc = goldengoose.crypto.get("BTC")
eth = goldengoose.crypto.get("ETH")
sol = goldengoose.crypto.get("SOL")
 
current_epoch = goldengoose.get_current_epoch()
 
# Create a comparison table
cryptos = [
    {"symbol": "BTC", "data": btc},
    {"symbol": "ETH", "data": eth},
    {"symbol": "SOL", "data": sol}
]
 
print("Cryptocurrency Comparison:")
print("Symbol | Price ($) | 24h Volume ($) | Market Cap ($B)")
print("-------|-----------|----------------|---------------")
 
for crypto in cryptos:
    symbol = crypto["symbol"]
    data = crypto["data"]
    price = data[current_epoch].oneMinute.close
    volume = data.volume24h
    market_cap = data.marketCap / 1_000_000_000  # Convert to billions
    
    print(f"{symbol.ljust(7)}| {price:,.2f} | {volume:,.2f} | {market_cap:,.2f}")

Notes

  • Symbol parameter is case-insensitive ("BTC" and "btc" are treated the same)
  • Timestamps used to access historical data are in UTC format
  • The returned object contains both 1-minute and 5-minute candle data
  • Price values are denominated in USD by default
  • Data is updated in real-time with minimal latency
  • Historical data availability may vary by cryptocurrency
CryptoList