Documentation

Getting Started

Welcome to Grid Auction! This guide will help you get started with our power market bidding platform.

Step 1: Create an Account

Sign up for a Grid Auction account at gridauction.tech/signup. Choose a plan that fits your needs.

Step 2: Get Your API Key

After signing up, navigate to your dashboard and generate an API key under Settings → API Access.


                                    API_KEY: ga_live_1234567890abcdef

Step 3: Install SDK

Install our Python SDK to start building:


                                    pip install gridauction-sdk

API Reference

Authentication

All API requests require authentication using your API key in the header:

curl -H "Authorization: Bearer YOUR_API_KEY" \
     https://api.gridauction.tech/v1/markets

Get Market Data

GET /v1/markets/{market_id}

Response:
{
  "market_id": "day-ahead-pjm",
  "current_price": 45.23,
  "timestamp": "2024-11-19T13:22:00Z",
  "volume": 12500
}

Submit Bid

POST /v1/bids

Body:
{
  "market_id": "day-ahead-pjm",
  "volume_mwh": 100,
  "price": 50.00,
  "strategy": "moderate"
}

Response:
{
  "bid_id": "bid_abc123",
  "status": "submitted",
  "expected_profit": 4523.00
}

Running Simulations

Our simulation engine allows you to test bidding strategies without risking real capital.

Python Example

from gridauction import Client

client = Client(api_key="YOUR_API_KEY")

# Configure simulation
simulation = client.simulations.create({
    "market": "day-ahead-pjm",
    "strategy": "aggressive",
    "volume_mwh": 500,
    "duration_days": 30,
    "hedge_ratio": 0.3
})

# Run simulation
result = simulation.run()

print(f"Expected Profit: ${result.profit}")
print(f"Win Rate: {result.win_rate}%")
print(f"Max Drawdown: {result.max_drawdown}%")

Risk Management

Grid Auction provides comprehensive risk management tools to protect your portfolio.

Hedge Strategies

Dynamic hedging based on price volatility
Portfolio diversification across multiple markets
Stop-loss and take-profit automation
Real-time risk exposure monitoring

Risk Metrics

Value at Risk (VaR)

$12,450

Sharpe Ratio

1.87

P&L Analytics

Track your performance with detailed profit and loss analytics.

Available Reports

Daily, weekly, and monthly P&L summaries
Strategy performance comparison
Market-by-market breakdown
Transaction cost analysis
Custom date range reports

Integration Guide

Integrate Grid Auction with your existing trading infrastructure.

Supported Platforms

Command Line

Direct API integration

Python SDK

Full-featured library

Node.js SDK

JavaScript integration

WebSocket

Real-time data streaming

Quick Links