OpenAPI Specification

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

Spec URLs

Format	URL
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`

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

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

npx openapi-typescript https://api.vectrade.io/v1/openapi.yaml -o ./types/vectrade.d.ts

oapi-codegen -generate types,client -package vectrade \
  https://api.vectrade.io/v1/openapi.yaml > vectrade.gen.go

openapi-generator generate -i https://api.vectrade.io/v1/openapi.yaml \
  -g rust -o ./vectrade-rs

The spec covers all public endpoints across 11 resource groups:

The spec is versioned alongside the API. Breaking changes are announced with a deprecation period:

Version	Status	Notes
`v1`	Current	Stable, production-ready
`v2`	Planned	—

The repository includes CI checks:

# Run locally
npx @stoplight/spectral-cli lint openapi/spec.yaml