Docs/OpenAPI Reference

OpenAPI Reference

The VectorFin API follows the OpenAPI 3.1 specification. The spec is available at https://api.vectorfinancials.com/openapi.json.

Interactive API Explorer — Coming Soon

The Swagger UI / Redoc interactive reference will be embedded here. For now, access the raw OpenAPI spec or use the endpoint reference in the docs.

Download openapi.jsonView Endpoint Reference

Core response schemas

EmbeddingChunk
tickerstringStock ticker symbol (e.g. AAPL)
fiscal_periodstringFiscal quarter (e.g. 2024-Q3)
chunk_idxintegerChunk index within the transcript
textstringSource transcript text for this chunk
embeddingnumber[]1536-dimensional embedding vector
effective_tsstring (ISO 8601)When the data became effective
knowledge_tsstring (ISO 8601)When VectorFin ingested this data
model_versionstringEmbedding model used (e.g. text-embedding-004)
QuantSignal
tickerstringStock ticker symbol
datestring (YYYY-MM-DD)Signal date
regimestring | nullMarket regime: bull / bear / neutral / volatile
garch_vol_1dnumber | null1-day GARCH volatility forecast
garch_vol_5dnumber | null5-day GARCH volatility forecast
garch_vol_21dnumber | null21-day GARCH volatility forecast
anomaly_scorenumber | nullAnomaly score (0–1)
whystock_scorenumber | nullComposite quant score (0–100)
effective_tsstring (ISO 8601)When the data became effective
knowledge_tsstring (ISO 8601)When VectorFin computed this signal