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

1. Navigate to API Keys
   • Log into your account
   • Go to Account → API Keys
   • Click “Create new key”
2. Configure Your Key
   • Name: Provide a descriptive name (e.g., “Trading Bot”, “Research Script”)
   • Expiry: Set the number of days before the key expires
   • Access: Keys authenticate the supported read-only API and MCP surfaces available to your account
3. 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

The public API Reference is the source of truth for the current quota. Requests above the active limit return 429 Too Many Requests. Build clients with backoff and avoid retrying every request immediately.

Using Your API Key

Authentication Headers

Include in all API requests:

X-USER-EMAIL: your-email@example.com
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: user@example.com" \
  -H "X-USER-TOKEN: abc123xyz789"

List supported symbols:

curl -X GET "https://optionomics.ai/api/v1/tickers" \
  -H "X-USER-EMAIL: user@example.com" \
  -H "X-USER-TOKEN: abc123xyz789"

The currently supported REST endpoints and schemas are listed in the API Reference. Application routes that are not listed there are not part of the public developer contract.

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 support@optionomics.ai

Security Note: Treat API keys as passwords. If compromised, delete immediately and generate new ones.