Skip to main content

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.

​
Ecosystem

VecTrade is a modular financial data platform. Every component is open-source under the VecTrade-io GitHub organization.

​
Architecture

┌─────────────────────────────────────────────────────────────────┐
│                        Your Application                          │
├────────┬────────┬────────┬──────────┬──────────┬───────────────┤
│ Python │  Node  │  CLI   │ AI Prov. │   MCP    │    FinKit     │
│  SDK   │  SDK   │        │ (Vercel) │  Server  │  (Analytics)  │
├────────┴────────┴────────┴──────────┴──────────┴───────────────┤
│                     VecTrade REST API (v1)                       │
│              api.vectrade.io  ·  api-uat.vectrade.io            │
├─────────────────────────────────────────────────────────────────┤
│  Quotes · Fundamentals · Technicals · News · AI · Options · …  │
└─────────────────────────────────────────────────────────────────┘

​
SDKs & Libraries

Python SDK

pip install vectrade — Async-first, fully typed, streaming support.

TypeScript SDK

npm install @vectrade/sdk — Zero dependencies, edge-ready, pagination iterators.

CLI

brew install VecTrade-io/vectrade/vectrade — Cross-platform Go binary with shell completions.

AI Provider

npm install @vectrade/ai-provider — Vercel AI SDK integration for tool-use agents.

MCP Server

Model Context Protocol server for Claude, Cursor, Windsurf, and other AI IDEs.

FinKit

Open-source financial analytics toolkit: indicators, backtesting, risk metrics.

​
Developer Tools

OpenAPI Spec

Machine-readable API contract (OpenAPI 3.1 + AsyncAPI). Generate clients in any language.

Examples

Copy-paste quickstart examples in Python, TypeScript, Go, and cURL.

​
Distribution

ChannelRepositoryInstall
PyPIvectrade-pythonpip install vectrade
npmvectrade-nodenpm install @vectrade/sdk
Homebrewhomebrew-vectradebrew install VecTrade-io/vectrade/vectrade
Scoop (Windows)scoop-vectradescoop install vectrade
Govectrade-cligo install github.com/VecTrade-io/vectrade-cli@latest
Docker—docker pull ghcr.io/vectrade-io/vectrade-mcp

​
Community

awesome-vectrade

Curated list of community projects, integrations, tutorials, and resources built with VecTrade.

GitHub Discussions

Ask questions, share ideas, and connect with the community.

​
Environments

EnvironmentAPI BaseDocsDashboard
Productionapi.vectrade.iodocs.vectrade.ioapp.vectrade.io
UATapi-uat.vectrade.iodocs.vectrade.iouat.vectrade.io
SandboxSame endpoints, sandbox=true——
Sandbox uses test keys (vq_test_*) and returns simulated/delayed data. Free for development with no rate limits.