Crypto
Endpoints
List

Function: list()

Overview

The list() function provides a comprehensive inventory of all cryptocurrency symbols available through the GoldenGoose API. Use this function to discover the full range of cryptocurrencies supported by the platform and to validate cryptocurrency symbols before making data requests.

Syntax

list()

Parameters

This function does not accept any parameters.

Return Value

TypeDescription
list[str]A list of strings where each string represents a cryptocurrency symbol (e.g., "BTC", "ETH", "SOL") available in the GoldenGoose database

Usage Examples

Basic Usage

import goldengoose
 
# Retrieve all available cryptocurrency symbols
crypto_symbols = goldengoose.crypto.list()
 
# Print the total number of available cryptocurrencies
print(f"Total cryptocurrencies available: {len(crypto_symbols)}")
 
# Display the first 10 available cryptocurrencies
print("Available cryptocurrencies (first 10):")
for symbol in crypto_symbols[:10]:
    print(f"- {symbol}")

Filtering Cryptocurrencies

import goldengoose
 
# Get all available cryptocurrency symbols
all_cryptos = goldengoose.crypto.list()
 
# Filter for specific cryptocurrencies by prefix
defi_tokens = [crypto for crypto in all_cryptos if crypto.startswith("D")]
print(f"DeFi tokens available: {len(defi_tokens)}")
print(defi_tokens)
 
# Check if a specific cryptocurrency is available
target_crypto = "XRP"
if target_crypto in all_cryptos:
    # Retrieve the cryptocurrency data
    xrp_data = goldengoose.crypto.get(target_crypto)
    print(f"Found {target_crypto} data")
else:
    print(f"{target_crypto} is not available in the GoldenGoose database")

Creating a Cryptocurrency Portfolio Tracker

import goldengoose
 
# Define a portfolio with symbol and quantity
portfolio = [
    {"symbol": "BTC", "quantity": 0.5},
    {"symbol": "ETH", "quantity": 10},
    {"symbol": "SOL", "quantity": 100},
    {"symbol": "AVAX", "quantity": 50}
]
 
# Get all available cryptocurrencies
available_cryptos = goldengoose.crypto.list()
 
# Validate and track portfolio
valid_portfolio = []
current_epoch = goldengoose.get_current_epoch()
 
print("Portfolio Valuation:")
print("Symbol | Quantity | Price ($) | Value ($)")
print("-------|----------|-----------|----------")
 
total_value = 0
 
for asset in portfolio:
    symbol = asset["symbol"]
    quantity = asset["quantity"]
    
    if symbol in available_cryptos:
        # Get current data for the cryptocurrency
        crypto_data = goldengoose.crypto.get(symbol)
        current_price = crypto_data[current_epoch].oneMinute.close
        asset_value = quantity * current_price
        total_value += asset_value
        
        print(f"{symbol.ljust(7)}| {quantity:9.2f} | {current_price:9,.2f} | {asset_value:10,.2f}")
        valid_portfolio.append(asset)
    else:
        print(f"{symbol.ljust(7)}| {quantity:9.2f} | Not available | N/A")
 
print("-" * 45)
print(f"Total Portfolio Value: ${total_value:,.2f}")

Notes

  • The returned list contains only the cryptocurrency symbols, not full names
  • The list is alphabetically sorted for convenient reference
  • Use this function before making calls to goldengoose.crypto.get() to verify symbol availability
  • The list is regularly updated as new cryptocurrencies are added to the platform
  • Symbol format typically follows industry standards (e.g., "BTC" for Bitcoin)
  • The function has minimal latency as it only returns symbol strings, not actual market data
GetGgcrypto