Documentation Index
Fetch the complete documentation index at: https://docs.vectrade.io/llms.txt
Use this file to discover all available pages before exploring further.
Installation
Homebrew
npm
pip
Scoop (Windows)
Shell
brew install VecTrade-io/vectrade/vectrade
npm install -g vectrade-cli
scoop bucket add vectrade https://github.com/VecTrade-io/scoop-vectrade
scoop install vectrade
curl -fsSL https://get.vectrade.io | sh
Authentication
# Interactive login (opens browser)
vectrade auth login
# Or set via environment variable
export VECTRADE_API_KEY=vq_live_...
Commands
Market Data
# Real-time quote
vectrade quote AAPL
# With specific fields
vectrade quote AAPL --fields price,volume,change
# JSON output
vectrade quote AAPL --output json
# CSV output (for piping)
vectrade quote AAPL --output csv
AI Analysis
# Streaming AI analysis
vectrade ai "Analyze MSFT earnings trend"
# Compare stocks
vectrade ai "Compare AAPL vs GOOGL for 2026"
API Key Management
# Create a new key
vectrade keys create --label "production"
# List all keys
vectrade keys list
# Revoke a key
vectrade keys revoke key_abc123
MCP IDE Setup
# Auto-configure Cursor IDE
vectrade mcp setup cursor
# Auto-configure VS Code
vectrade mcp setup vscode
# Auto-configure Claude Desktop
vectrade mcp setup claude
Webhooks
# Listen for webhook events locally (for development)
vectrade webhook listen
# Create a webhook subscription
vectrade webhook create --url https://example.com/hook --events quote.alert,trade.fill
# List subscriptions
vectrade webhook list
# Delete a subscription
vectrade webhook delete whk_abc123
Usage & Billing
# View current month usage
vectrade usage
# View API quota status
vectrade usage --this-month
OpenAPI Spec
# Download the latest spec
vectrade openapi download
# Diff against a local spec
vectrade openapi diff ./old-spec.yaml
Configuration
Config file location: ~/.vectrade/config.yaml
api_key: vq_live_...
base_url: https://api.vectrade.io/v1
output: table # table | json | csv
timeout: 30 # seconds
Resolution Order
- Command-line flags (
--api-key, --sandbox)
- Environment variables (
VECTRADE_API_KEY, VECTRADE_BASE_URL)
- Config file (
~/.vectrade/config.yaml)
- Defaults
Global Flags
| Flag | Description |
|---|
--api-key | Override API key |
--sandbox | Use sandbox environment |
--config | Custom config file path |
--output | Output format: table, json, csv |
GitHub
Source code, issues, and contributions
