# REST API

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.

## Base URL

`https://api.vantafin.com/v1`

## Authentication

Pass `?apiKey=YOUR_KEY`, header `Authorization: Bearer YOUR_KEY`, or `X-API-Key: YOUR_KEY`.

## Format & rate limit

JSON responses with cursor pagination on list endpoints. 1,000 requests per minute per key (`X-RateLimit-*` headers).

## Quick start

```bash
pip install vantafin
```

```python
from vantafin import RESTClient

client = RESTClient("vf-live-your_api_key")
print(client.get_quote("AAPL"))
```

```bash
curl "https://api.vantafin.com/v1/quote/AAPL?apiKey=YOUR_KEY"
```

## Explore by category

- **Company Data** - The ticker universe, company and ETF profiles, and search. First endpoint: /app/docs/rest/all-tickers.
- **Market Data** - Latest quotes. First endpoint: /app/docs/rest/quote.
- **Screener** - Filter and rank the equity universe across 80+ fundamental, valuation, technical, market and dividend metrics. First endpoint: /app/docs/rest/screen-stocks.
- **Corporate Actions** - Earnings results, dividends, stock splits and IPOs. First endpoint: /app/docs/rest/all-earnings.
- **Ownership** - Institutional ownership, ETF holdings, and mutual fund holdings. First endpoint: /app/docs/rest/institutional-ownership.
- **Short Interest** - FINRA short interest, average daily volume, and days-to-cover by settlement date. First endpoint: /app/docs/rest/short-interest.
- **Insider Transactions** - Market-wide and ticker-specific SEC Form 4 insider purchases and sales. First endpoint: /app/docs/rest/all-insider-transactions.
- **Fundamentals** - Financial statements, revenue segmentation, and ETF allocation breakdowns. First endpoint: /app/docs/rest/financial-statements.
- **Macro** - Macroeconomic time series such as treasury rates and central bank policy. First endpoint: /app/docs/rest/macro-series.
- **SEC Filings** - SEC EDGAR filing metadata. First endpoint: /app/docs/rest/filings-by-ticker.
- **News** - Market-wide and ticker-specific news articles. First endpoint: /app/docs/rest/market-news.
- **Earnings Transcripts** - Earnings call transcripts. First endpoint: /app/docs/rest/transcript-symbols.