HomeChatAlertsCalendarScreenerWatchlistsFiles
Docs
Sign upJoinLog inLogin

Docs

Overview

IntroductionMCP ServerOpenAPI Spec

REST API

Overview

WebSocket API

OverviewLive Quotes (Per Second)Live Quotes (Per Minute)Live NewsLive SEC FilingsTrading Halts

OpenAPI Spec

View as markdown

Machine-readable API specification for programmatic integration. The document follows the OpenAPI 3 standard and describes every public /v1 endpoint, its parameters and the authentication schemes - so you can explore the API in tools like Swagger UI or Postman and generate typed clients in any language.

Document URL
https://api.vantafin.com/v1/openapi.json
Format
OpenAPI 3 (JSON)
Server
https://api.vantafin.com
Access
Public - no key required to fetch the spec
Official SDKs
github.com/vantafin/vantafin

Fetch the spec

The document is served without authentication so tooling can fetch it before you have a key.

curl https://api.vantafin.com/v1/openapi.json

Generate a client

Point any OpenAPI generator at the document to scaffold a typed client. For example, with openapi-generator. Prefer maintained wrappers? Use the official SDKs on github.com/vantafin/vantafin (Python, JavaScript, Go, Java, and Ruby).

# Generate a typed client in any language from the spec
npx @openapitools/openapi-generator-cli generate \
  -i https://api.vantafin.com/v1/openapi.json \
  -g typescript-fetch \
  -o ./vantafin-client

Authentication

Every endpoint accepts a Vantafin API key via the X-API-Key header, an Authorization: Bearer header, or the apiKey query parameter. The spec declares all three as security schemes so generated clients can wire them up automatically.

MCP Server
REST API Overview