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.

​
OpenAPI Specification

VecTrade publishes a machine-readable API contract following OpenAPI 3.1 and AsyncAPI standards.

​
Spec URLs

FormatURL
OpenAPI 3.1 (YAML)https://api.vectrade.io/v1/openapi.yaml
OpenAPI 3.1 (JSON)https://api.vectrade.io/v1/openapi.json
AsyncAPI (Webhooks)https://api.vectrade.io/v1/asyncapi.yaml

​
Repository

vectrade-openapi

Source of truth for the VecTrade API contract. Includes validation, changelog, and CI linting.

​
Generate a Client

Use any OpenAPI code generator to create a typed client in your language: 
pip install openapi-python-client
openapi-python-client generate --url https://api.vectrade.io/v1/openapi.yaml

​
What’s Included

The spec covers all public endpoints across 11 resource groups:
  • Quotes — Real-time and batch market data
  • Fundamentals — Financial statements, ratios
  • Technicals — 50+ technical indicators
  • News — Financial news with sentiment
  • Screener — Custom market filters
  • AI — Streaming analysis with citations
  • Options — Chains, Greeks, expirations
  • Analyst — Consensus, price targets, ratings
  • Earnings — History and calendar
  • Insider — Transactions and summaries
  • Developer — API key management, usage, quotas

​
Versioning

The spec is versioned alongside the API. Breaking changes are announced with a deprecation period:
VersionStatusNotes
v1CurrentStable, production-ready
v2Planned—

​
Validation & Linting

The repository includes CI checks:
  • Spectral — Linting rules for naming conventions, response schemas
  • OpenAPI Diff — Breaking change detection on PRs
  • Type Coverage — Ensures all endpoints have typed request/response schemas
# Run locally
npx @stoplight/spectral-cli lint openapi/spec.yaml