API Key Management
Generate and manage API keys for programmatic access
API keys allow you to access Optionomics data programmatically through our REST API and MCP Server. This feature is available with the Vega plan subscription.
Generating API Keys
Prerequisites
- Active Vega plan subscription
- Verified email address
- Account in good standing
Steps to Generate a Key
- Navigate to API Keys
- Log into your account
- Go to Account → API Keys
- Click “Create new key”
- Configure Your Key
- Name: Provide a descriptive name (e.g., “Trading Bot”, “Research Script”)
- Expiry: Set expiration period (30, 60, 90 days, or custom)
- Permissions: All keys have full read access to API endpoints
- Save Your Token
- Copy the generated token immediately
- Important: The token is shown only once for security
- Store it securely in your application
Rate Limits
Vega Plan Limits
- 100 requests per minute
- Requests above the limit return
429 Too Many Requests
Build clients with local backoff and retries rather than relying on specific rate-limit response headers.
Using Your API Key
Authentication Headers
Include in all API requests:
X-USER-EMAIL: [email protected]
X-USER-TOKEN: your-api-token
Example Request
Fetch SPY options:
curl -X GET "https://optionomics.ai/api/v1/stocks/SPY/options" \
-H "X-USER-EMAIL: [email protected]" \
-H "X-USER-TOKEN: abc123xyz789"
List supported symbols:
curl -X GET "https://optionomics.ai/api/v1/tickers" \
-H "X-USER-EMAIL: [email protected]" \
-H "X-USER-TOKEN: abc123xyz789"
The currently documented REST endpoints are available in the interactive API Reference. Note: live real-time flow is available in the workstation terminal, not via REST.
Troubleshooting
Common Issues
- 401 Unauthorized: Invalid token or email
- 403 Forbidden: No API access (upgrade to Vega plan)
- 429 Too Many Requests: Rate limit exceeded
Getting Help
- Review API Documentation
- Review MCP Server Guide
- Contact [email protected]
Security Note: Treat API keys as passwords. If compromised, delete immediately and generate new ones.
