Crypto API

Overview

The Crypto API provides access to cryptocurrency market data, including real-time and historical pricing information at 1-minute and 5-minute intervals. This documentation outlines the available objects and functions to help you integrate cryptocurrency data into your trading algorithms and analysis workflows.

Available Objects

Available Functions

Supported Cryptocurrencies

The Crypto API supports major cryptocurrencies including but not limited to:

• Bitcoin (BTC)
• Ethereum (ETH)
• Binance Coin (BNB)
• Ripple (XRP)
• Cardano (ADA)
• Solana (SOL)
• Polkadot (DOT)
• Dogecoin (DOGE)

Use the list() function to get the complete set of available cryptocurrencies.

Getting Started

To begin working with cryptocurrency data:

1. Import the GoldenGoose library
2. Use list() to discover available cryptocurrencies
3. Use get() to retrieve data for specific cryptocurrencies
4. Access historical and real-time data through the returned ggCrypto object

Example

import goldengoose
 
# Get all available cryptocurrencies
available_cryptos = goldengoose.crypto.list()
print(f"Available cryptocurrencies: {len(available_cryptos)}")
print(f"Examples: {', '.join(available_cryptos[:5])}")
 
# Retrieve data for Bitcoin
btc = goldengoose.crypto.get("BTC")
 
# Get current epoch
current_epoch = goldengoose.get_current_epoch()
 
# Access the current price data
current_candle = btc[current_epoch]
current_price = current_candle.oneMinute.close
 
# Print basic information
print(f"Bitcoin (BTC)")
print(f"Current Price: ${current_price:,.2f}")
print(f"24h Volume: ${btc.volume24h:,.2f}")
print(f"Market Cap: ${btc.marketCap:,.2f}")
 
# Calculate simple metrics
daily_high = current_candle.oneMinute.high
daily_low = current_candle.oneMinute.low
daily_range_pct = ((daily_high - daily_low) / daily_low) * 100
 
print(f"Today's Range: ${daily_low:,.2f} - ${daily_high:,.2f} ({daily_range_pct:.2f}%)")

Data Analysis Use Cases

Technical Analysis

Perform technical analysis on cryptocurrency price movements using indicators such as moving averages, RSI, and MACD.

Volatility Studies

Analyze price volatility across different cryptocurrencies to identify trading opportunities.

Correlation Analysis

Examine correlations between cryptocurrencies and traditional financial assets.

Backtesting

Test trading strategies against historical cryptocurrency data.

Notes

• Cryptocurrency data is provided in real-time with minimal latency
• Historical data is available for backtesting and analysis
• Data includes OHLC (Open, High, Low, Close) values and volume
• Market metrics such as market capitalization and 24-hour volume are included
• All timestamps are in UTC format
• Price data is denominated in USD by default

For more detailed information on specific objects and functions, please refer to the dedicated documentation pages linked in the tables above.