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

REST API

View as markdown

A predictable, JSON-first HTTP API for US equities and ETFs. Every dataset that powers the Vantafin web app - company profiles, live quotes, fundamentals, SEC filings, corporate actions, ownership, and news - is available over a stable REST surface at https://api.vantafin.com/v1. Call it from any language, or use one of the official clients.

Get your API keyCreate or copy a vf-live-… key from Settings → API Usage.Make your first requestFetch a live quote for any supported ticker in one GET call.OpenAPI specMachine-readable schema for codegen and API explorers.SDKs on GitHubOfficial Python, JavaScript, Go, Java, and Ruby client source.

How requests work

All endpoints live under the version-prefixed base URL https://api.vantafin.com/v1 and return JSON. Authenticate with your API key on every request, then issue standard GET calls - list endpoints use cursor pagination and detail endpoints resolve by ticker or Vantafin id.

  • Base URL: https://api.vantafin.com/v1
  • Auth: ?apiKey=YOUR_KEY, header Authorization: Bearer YOUR_KEY, or X-API-Key: YOUR_KEY
  • Format: JSON responses with cursor pagination on list endpoints
  • Rate limit: 1,000 requests per minute per key (see X-RateLimit-* headers)

Quick start

  1. Install the Python client
    pip install vantafin

    Or install from source: pip install git+https://github.com/vantafin/vantafin.git. All official SDKs are on github.com/vantafin/vantafin.

  2. Fetch a quote
    from vantafin import RESTClient

client = RESTClient("vf-live-your_api_key")
print(client.get_quote("AAPL"))
  3. Or call it directly
    curl "https://api.vantafin.com/v1/quote/AAPL?apiKey=YOUR_KEY"

Explore by category

The REST API is organized into the categories below. Jump into any group to see its endpoints, parameters, and sample responses.

Company DataRetrieve the full ticker universe, company and ETF profiles, and fuzzy search by name or CIK.Market DataLatest single-ticker and batch quotes with price, change, volume, day range, and market cap.ScreenerScreen equities across 80+ fundamental, valuation, technical, market, and dividend metrics.Corporate ActionsEarnings calendars, dividend history, stock splits, and IPO records by ticker or market-wide.OwnershipInstitutional ownership, ETF constituent holdings, and mutual fund position data by ticker.Short InterestFINRA short interest, average daily volume, and days-to-cover figures by settlement date.Insider TransactionsMarket-wide and per-ticker SEC Form 4 insider purchases, sales, and ownership changes.FundamentalsIncome statements, balance sheets, cash flows, revenue segmentation, and ETF allocation data.MacroMacroeconomic time series including treasury rates, CPI, employment, and central bank policy.SEC FilingsSEC EDGAR filing metadata by ticker or id, with form type, date, accession, and CIK fields.NewsMarket-wide and ticker-specific news headlines, press releases, and article publisher metadata.Earnings TranscriptsList and retrieve full earnings call transcript text by ticker, quarter, and fiscal period.

Prefer a machine-readable contract? The full OpenAPI spec is available for codegen and API explorers.

OpenAPI Spec
All Tickers