Authentication

All API requests require authentication via API key passed in the Authorization header.

Getting Your API Key

• Sign up at portal.odum.io
• Navigate to Settings > API Keys
• Generate a new key with appropriate permissions

Using Your Key

curl -H "Authorization: Bearer YOUR_API_KEY" \
  https://api.odum.io/v1/data/markets

Key Permissions

• read:data - Access market data endpoints
• write:backtest - Submit backtest jobs
• write:orders - Execute orders
• admin - Full access (for Live Trading Platform clients)

Rate Limits

Quick Start Guide

Get up and running in 5 minutes.

1. Install the SDK (optional)

pip install odum-client  # Python
npm install @odum/client # JavaScript

2. Set Your API Key

import os
os.environ["ODUM_API_KEY"] = "your_api_key"

3. Fetch Market Data

from odum import Client

client = Client()
orderbook = client.data.orderbook("binance", "BTC-USDT")
print(orderbook.bids[:5])

4. Run a Backtest

job = client.backtest.submit({
    "strategy": "momentum",
    "symbols": ["BTC-USDT"],
    "start": "2024-01-01",
    "end": "2024-12-31"
})
results = client.backtest.wait(job.id)
print(f"Sharpe: {results.sharpe}")

Next Steps

• Explore the Data API for market data access
• Learn about Backtesting for strategy simulation
• Set up Execution for live trading