Environment Variables

Overview

The XAUUSD Trading Bot requires API credentials to function. This page covers the required environment variables and best practices for managing them securely.

Required Variables

GROQ_API_KEY

The GROQ API key is used to power the LLM-based market analysis and signal generation.

GROQ_API_KEY

string

required

Your GROQ API key for accessing LLM services. This key must be kept secure and never committed to version control.

Configuration Methods

Streamlit Secrets

When deploying with Streamlit, use the built-in secrets management:

# Local development secrets file
# Add this file to .gitignore

GROQ_API_KEY = "your-groq-api-key-here"

For non-Streamlit deployments, use standard environment variables:

# Set environment variable
export GROQ_API_KEY="your-groq-api-key-here"

# Run your application
python your_app.py

.env File

For local development, use a .env file with python-dotenv:

# Add this file to .gitignore
GROQ_API_KEY=your-groq-api-key-here

Security Best Practices

Show Never Commit Secrets

Always add secrets files to .gitignore to prevent accidental commits:

.gitignore

# Secrets and environment files
.env
.streamlit/secrets.toml
*.key
credentials.json

Show Use Secrets Management Services

For production deployments, consider using dedicated secrets management:

Streamlit Cloud: Built-in secrets management in app settings
AWS: AWS Secrets Manager or Parameter Store
Google Cloud: Secret Manager
Azure: Key Vault
HashiCorp: Vault

Show Rotate Keys Regularly

Change API keys periodically (e.g., every 90 days)
Immediately rotate keys if you suspect they’ve been compromised
Keep track of key rotation dates

Show Limit Key Permissions

Use API keys with minimum required permissions
Create separate keys for development and production
Monitor API key usage for unusual activity

Show Validate Before Use

Always validate that required environment variables are set:

import os

def get_api_key():
    api_key = os.getenv("GROQ_API_KEY")
    if not api_key:
        raise ValueError(
            "GROQ_API_KEY is not set. "
            "Please configure it in your environment or secrets."
        )
    return api_key

bot = XAUUSDTradingBot(api_key=get_api_key())

Obtaining a GROQ API Key

Visit the GROQ Console
Sign up or log in to your account
Navigate to API Keys section
Generate a new API key
Copy and securely store your key
Configure it in your application using one of the methods above

Troubleshooting

Key Not Found Error

# Error: KeyError: 'GROQ_API_KEY'
# Solution: Verify the key is set

import streamlit as st

if "GROQ_API_KEY" not in st.secrets:
    st.error("GROQ_API_KEY not found in secrets. Please configure it.")
    st.stop()

bot = XAUUSDTradingBot(api_key=st.secrets["GROQ_API_KEY"])

Invalid API Key

# Error: Authentication failed
# Solution: Verify key is correct and active

try:
    bot = XAUUSDTradingBot(api_key=st.secrets["GROQ_API_KEY"])
    result = bot.run_analysis()
except Exception as e:
    if "authentication" in str(e).lower():
        st.error("Invalid API key. Please check your GROQ_API_KEY.")
    else:
        st.error(f"Error: {str(e)}")

Secrets File Not Loading

# Streamlit secrets location:
# .streamlit/secrets.toml (local)

# Verify file exists and has correct format
cat .streamlit/secrets.toml

# Ensure proper TOML syntax (no quotes around key names)
GROQ_API_KEY = "your-key-here"

Example: Complete Setup

# .streamlit/secrets.toml
GROQ_API_KEY = "gsk_your_actual_groq_api_key_here"

Core Components

Configuration

Environment Variables

Overview

Required Variables

GROQ_API_KEY

Configuration Methods

Streamlit Secrets