# Bavest API

> REST API for financial market data: equities, ETFs, funds, dividends, estimates, economic indicators, news, filings and portfolio analytics. Base URL https://api.bavest.co/v2. Authenticate with the `x-api-key` header; get a key at https://dashboard.bavest.co/sign-up.

This file lists all 99 routes. Each link is a Markdown page with the route's parameters, response fields, a cURL example, an example response and its errors. Every Markdown link is the twin of an HTML page at the same URL without `.md` (`https://dashboard.bavest.co/docs/<route id>`, `https://dashboard.bavest.co/docs/authentication`, `https://dashboard.bavest.co/docs/mcp`), which returns the same Markdown when requested with `Accept: text/markdown`. Each route page says which plans include it (`Included in: ...` or `Free in every plan`).

Essentials:

- Every request needs the header `x-api-key: <your key>`. Responses are JSON with the result in a `data` field.
- `403`: the key is invalid or switched off. `429` `Limit Exceeded`: monthly quota used up. `429` `Too Many Requests`: throttled, or the route is not in your plan.
- ETFs and funds are best identified by ISIN (`isin=IE00B4L5Y983`), stocks by ticker (`symbol=AAPL`) or ISIN.
- AI agents can call the data routes as tools through the MCP server https://api.bavest.co/v2/mcp (the MCP page lists which route each tool wraps).

## Start here

- [Authentication](https://dashboard.bavest.co/docs/authentication.md): the `x-api-key` header and how to get a key.
- [MCP server](https://dashboard.bavest.co/docs/mcp.md): connect Claude, ChatGPT, Cursor or your own agent to https://api.bavest.co/v2/mcp.
- [OpenAPI (JSON)](https://dashboard.bavest.co/openapi.json): OpenAPI 3.1 spec of every route listed here.
- [OpenAPI (YAML)](https://dashboard.bavest.co/openapi.yaml): the same spec as YAML.
- [All routes in one file](https://dashboard.bavest.co/llms-full.txt): every route page below, concatenated.

## Account

- [Usage Quota](https://dashboard.bavest.co/docs/v2_account_quota.md): Returns current monthly usage count, limit, and remaining calls for the API key.
- [API Status](https://dashboard.bavest.co/docs/v2_account_status.md): Returns API health status.

## AI

- [MCP Server](https://dashboard.bavest.co/docs/v2_mcp.md): Model Context Protocol (MCP) server for AI agents.

## Bavest QuantOS

- [QuantOS Allocation Exposure](https://dashboard.bavest.co/docs/v2_quant_os_allocate.md): Compute optimal allocation weights for a portfolio.
- [QuantOS Performance Chart](https://dashboard.bavest.co/docs/v2_quant_os_chart.md): Generate performance chart data for a portfolio over a date range.
- [QuantOS Valuation](https://dashboard.bavest.co/docs/v2_quant_os_price.md): Calculate current portfolio position value.
- [QuantOS Region Breakdown](https://dashboard.bavest.co/docs/v2_quant_os_region.md): Break down portfolio holdings by geographic region.
- [QuantOS Portfolio Return](https://dashboard.bavest.co/docs/v2_quant_os_return.md): Calculate portfolio return over a specified period.
- [QuantOS Sector Breakdown](https://dashboard.bavest.co/docs/v2_quant_os_sector.md): Break down portfolio holdings by GICS sector.
- [QuantOS Statistics](https://dashboard.bavest.co/docs/v2_quant_os_stats.md): Returns comprehensive portfolio statistics including returns, risk, and ratios.

## Bulk

- [Bulk Endpoint](https://dashboard.bavest.co/docs/v2_bulk.md): Fan out a single endpoint across up to 100 symbols or ISINs in one request.

## Calendar

- [Earnings Calendar](https://dashboard.bavest.co/docs/v2_calendar_earnings.md): Returns upcoming and recent earnings events across all securities.
- [IPO Calendar](https://dashboard.bavest.co/docs/v2_calendar_ipo.md): Returns upcoming and recent IPO events.
- [AGM Calendar](https://dashboard.bavest.co/docs/v2_calendar_agm.md): Returns upcoming Annual General Meeting dates sourced from SEC DEF 14A proxy filings.
- [Stock Splits Calendar](https://dashboard.bavest.co/docs/v2_calendar_splits.md): Returns recent and upcoming stock split events sorted by date descending.

## Corporate Actions

- [Earnings Events](https://dashboard.bavest.co/docs/v2_corporate_actions_earnings.md): Returns historical and upcoming earnings announcement dates and results.
- [Earnings Transcript](https://dashboard.bavest.co/docs/v2_corporate_actions_earnings_transcript.md): Returns the earnings call transcript for a specific quarter.
- [Earnings Transcript Periods](https://dashboard.bavest.co/docs/v2_corporate_actions_earnings_transcript_periods.md): Returns the list of year/quarter combinations that have earnings transcripts available for a symbol.
- [Stock Splits](https://dashboard.bavest.co/docs/v2_corporate_actions_splits.md): Returns historical stock split records.

## Crypto

- [Crypto Quote](https://dashboard.bavest.co/docs/v2_crypto_quote.md): Returns real-time cryptocurrency quote with price, change, volume, and market cap.
- [Crypto List](https://dashboard.bavest.co/docs/v2_crypto_list.md): Returns a paginated list of all available cryptocurrencies.

## Dividends

- [Annual Dividend Summary](https://dashboard.bavest.co/docs/v2_dividends_annual.md): Returns aggregated annual dividend totals and payment frequency.
- [Dividend Calendar](https://dashboard.bavest.co/docs/v2_dividends_calendar.md): Announced dividend events between `from` and `to`, soonest first.
- [Dividend History](https://dashboard.bavest.co/docs/v2_dividends_history.md): Dividend events for one instrument, newest first, including announced dividends that have not been paid yet (they sort to the top).
- [Dividend Estimates](https://dashboard.bavest.co/docs/v2_dividends_estimates.md): Bavest's per-share dividend forecast.

## Economic Indicators

- [CPI Data](https://dashboard.bavest.co/docs/v2_economy_cpi_country.md): Returns Consumer Price Index data for a country, grouped by metric.
- [GDP Data](https://dashboard.bavest.co/docs/v2_economy_gdp_country.md): Returns real gross domestic product data for a country, grouped by metric.
- [Inflation Data](https://dashboard.bavest.co/docs/v2_economy_inflation_country.md): Returns inflation indicator data for a country, grouped by metric (CPI, HICP, PPI, etc.).
- [Interest Rate Data](https://dashboard.bavest.co/docs/v2_economy_interest_rates_country.md): Returns central bank policy interest rate data for a country, grouped by metric.
- [Unemployment Data](https://dashboard.bavest.co/docs/v2_economy_unemployment_country.md): Returns unemployment rate data for a country, grouped by metric.
- [Economy Indicator](https://dashboard.bavest.co/docs/v2_economy_indicator.md): Returns macro-economic indicator data for a country, filtered by metric code or category.
- [List Available Countries](https://dashboard.bavest.co/docs/v2_economy_countries.md): Returns all countries that have macroeconomic data in the Bavest database.
- [Metric History](https://dashboard.bavest.co/docs/v2_metrics_metric_code_history.md): Returns the full time-series history for a specific macroeconomic metric and country.

## Equities

- [Balance Sheets](https://dashboard.bavest.co/docs/v2_equities_balance_sheets.md): Returns annual or quarterly balance sheet statements with full line-item detail.
- [Cash Flow Statements](https://dashboard.bavest.co/docs/v2_equities_cash_flow.md): Returns annual or quarterly cash flow statements.
- [Company Logo](https://dashboard.bavest.co/docs/v2_equities_logo.md): Returns the company logo as a PNG image.
- [Company Profile](https://dashboard.bavest.co/docs/v2_equities_profile.md): Returns company identity, classification, and market data.
- [Equity Metric Names](https://dashboard.bavest.co/docs/v2_equities_metrics_names.md): Returns registered equity metric names with their unit, description and -- per name -- which reporting bases GET /equities/metrics/history can actually serve.
- [Equity Metrics History Export](https://dashboard.bavest.co/docs/v2_equities_export_latest.md): Returns time-limited download links for this account's pre-materialized equity-metrics history export (Parquet, one part per metric) plus its manifest.
- [Submit Equity Data Export](https://dashboard.bavest.co/docs/v2_equities_export_submit.md): Submit an asynchronous export job for this account.
- [Comprehensive Metrics](https://dashboard.bavest.co/docs/v2_equities_metrics.md): Returns comprehensive per-metric financial data with validity flags, descriptions, and units.
- [Metric History](https://dashboard.bavest.co/docs/v2_equities_metrics_history.md): Returns one statement-derived metric (ratios, margins, growth and every *_ttm name) as a series of points, one per fiscal period end, newest first.
- [Financials Trailing Twelve Months](https://dashboard.bavest.co/docs/v2_equities_financials_ttm.md): Returns the most recent TTM snapshot across all three financial statements.
- [Income Statements](https://dashboard.bavest.co/docs/v2_equities_income_statement.md): Returns annual or quarterly income statements.
- [Market Capitalization](https://dashboard.bavest.co/docs/v2_equities_market_cap.md): Returns the current market capitalization for an equity.
- [Market Capitalization History](https://dashboard.bavest.co/docs/v2_equities_market_cap_history.md): Returns historical market capitalization values for an equity.
- [Peer Companies](https://dashboard.bavest.co/docs/v2_equities_peers.md): Returns a list of peer company tickers based on sector and market cap similarity.
- [Equities Metrics History Export Status](https://dashboard.bavest.co/docs/v2_equities_export_status.md): Poll a submitted export job.

## Estimates

- [Analyst Consensus Estimates](https://dashboard.bavest.co/docs/v2_estimates_consensus.md): Returns consensus EPS, EBITDA, and EBIT estimates across fiscal periods.
- [Analyst Recommendations](https://dashboard.bavest.co/docs/v2_estimates_recommendations.md): Returns how many analysts currently hold each rating on the security, with the consensus label derived from that distribution.
- [Price Target Consensus](https://dashboard.bavest.co/docs/v2_estimates_price_target.md): Returns analyst price target consensus including high, low, median and consensus values, and the currency they are quoted in.
- [Upgrades & Downgrades](https://dashboard.bavest.co/docs/v2_estimates_upgrades_downgrades.md): Returns analyst rating changes (upgrades, downgrades, initiations).
- [AI Estimates](https://dashboard.bavest.co/docs/v2_estimates_ai_estimates.md): Bavest's own AI estimates for a security across task types (regression, classification, sequence, hazard).
- [AI Estimates History](https://dashboard.bavest.co/docs/v2_estimates_ai_estimates_history.md): Returns how an AI estimate for one metric evolved over time.

## ETFs

- [ETF Category](https://dashboard.bavest.co/docs/v2_etfs_category.md): Returns ETF classification and categorization including asset class, focus, and niche.
- [ETF Country Exposure](https://dashboard.bavest.co/docs/v2_etfs_countries.md): Returns geographic allocation percentages.
- [ETF Documents Catalog](https://dashboard.bavest.co/docs/v2_etfs_documents_catalog.md): Returns a paginated catalog of all available ETF documents (KID/KIID) for a given language.
- [ETF Fees](https://dashboard.bavest.co/docs/v2_etfs_fees.md): Returns ETF fee and expense information including management fee and expense ratios.
- [ETF Holdings](https://dashboard.bavest.co/docs/v2_etfs_holdings.md): Returns all holdings with weights, values, and share counts.
- [ETF Holdings Top](https://dashboard.bavest.co/docs/v2_etfs_holdings_top.md): Returns top 10 holdings by weight, in the chosen `view` (`display` by market value, default; `raw` by absolute exposure weight).
- [ETF KID Document](https://dashboard.bavest.co/docs/v2_etfs_kid.md): Returns the Key Information Document (KID) as a PDF file.
- [ETF KID Languages](https://dashboard.bavest.co/docs/v2_etfs_kid_languages.md): Returns available language codes for a specific ETF's KID document.
- [ETF List](https://dashboard.bavest.co/docs/v2_etfs_list.md): Returns a paginated list of all ETF, ETP, and ETN listings.
- [ETF Metrics](https://dashboard.bavest.co/docs/v2_etfs_metrics.md): Returns a paginated list of all ETF metrics — performance, risk, volatility, and fund characteristics — with full lineage/traceability.
- [ETF Profile](https://dashboard.bavest.co/docs/v2_etfs_profile.md): Returns ETF identity and classification.
- [ETF Risk](https://dashboard.bavest.co/docs/v2_etfs_risk.md): Returns risk metrics including beta, SRI/SRRI, tracking error, and volatility.
- [ETF Sector Exposure](https://dashboard.bavest.co/docs/v2_etfs_sectors.md): Returns sector allocation percentages.
- [ETF Sectors Top](https://dashboard.bavest.co/docs/v2_etfs_sectors_top.md): Returns top sectors by allocation.
- [ETF Metric Names](https://dashboard.bavest.co/docs/v2_etfs_metrics_names.md): Returns every metric name available on `/v2/etfs/metrics`, with the unit and a description for each name.
- [ETF Countries Top](https://dashboard.bavest.co/docs/v2_etfs_top_countries.md): Returns top countries by allocation.
- [ETF Country List](https://dashboard.bavest.co/docs/v2_etfs_countries_list.md): Returns the canonical set of values the `country` field of ETF geographic allocation (`/v2/etfs/countries`) can take.
- [ETF Structure](https://dashboard.bavest.co/docs/v2_etfs_structure.md): Returns ETF structural classification including leverage, complexity, and benchmark status.
- [Submit ETF Data Export](https://dashboard.bavest.co/docs/v2_etfs_export_submit.md): Submit an asynchronous export job for this account's ETF data.
- [ETF Export Status](https://dashboard.bavest.co/docs/v2_etfs_export_status.md): Poll a submitted export job.
- [ETF Asset Class Breakdown](https://dashboard.bavest.co/docs/v2_etfs_asset_class_breakdown.md): Returns asset-class allocation percentages based on holdings, including recursive look-through of underlying funds and ETFs.

## Filings

- [Earnings Release Filings](https://dashboard.bavest.co/docs/v2_filings_earnings.md): Real-time feed of SEC 8-K earnings-release filings (item 2.02), source- agnostic and forward-compatible with future push delivery (websocket / webhook).

## Forex

- [Forex OHLCV Candles](https://dashboard.bavest.co/docs/v2_forex_candles_pair.md): Returns OHLCV candlestick data for a currency pair.
- [Forex Quote](https://dashboard.bavest.co/docs/v2_forex_quote_pair.md): Returns real-time forex pair quote.

## Funds

- [Fund Country Allocation](https://dashboard.bavest.co/docs/v2_funds_countries_isin.md): Returns geographic exposure percentages.
- [Fund Holdings](https://dashboard.bavest.co/docs/v2_funds_holdings_isin.md): Returns top holdings with exposure percentages.
- [Fund Metrics](https://dashboard.bavest.co/docs/v2_funds_metrics.md): Returns all metrics for a fund in a single paginated response, with the latest observation per metric name.
- [Fund Metric Names](https://dashboard.bavest.co/docs/v2_funds_metric_names.md): Returns every metric name available on `/v2/funds/metrics`, with the unit and a description for each name.
- [Fund Profile](https://dashboard.bavest.co/docs/v2_funds_profile_isin.md): Returns mutual fund identity and classification.
- [Fund Sector Allocation](https://dashboard.bavest.co/docs/v2_funds_sectors_isin.md): Returns sector exposure percentages.
- [Fund List](https://dashboard.bavest.co/docs/v2_funds_list.md): Returns a paginated list of all mutual funds.
- [Fund Asset Class Breakdown](https://dashboard.bavest.co/docs/v2_funds_asset_class_breakdown.md): Returns asset-class allocation percentages based on holdings, including recursive look-through of underlying funds and ETFs.

## IPO

- [Hot IPOs](https://dashboard.bavest.co/docs/v2_ipo_hot.md): Returns the curated list of hot IPO offerings, each with an offering summary and a headline financials snapshot (latest full-year period).
- [IPO Documents](https://dashboard.bavest.co/docs/v2_ipo_documents.md): Returns the document catalog for a single IPO (prospectus, SEC filings, multi-language prospectus summaries).
- [IPO Profile](https://dashboard.bavest.co/docs/v2_ipo_profile.md): Returns the full profile for a single IPO: the offering summary plus nested milestones, statement-grouped financials (income statement, balance sheet, cash flow), and the document catalog.

## News

- [Market News](https://dashboard.bavest.co/docs/v2_news_market.md): Returns market-wide financial news.
- [Stock News](https://dashboard.bavest.co/docs/v2_news_stock.md): Returns recent news articles for a specific stock.

## Reference

- [ADR List](https://dashboard.bavest.co/docs/v2_adrs_list.md): Returns a paginated list of all American Depositary Receipts (ADRs).
- [Security List](https://dashboard.bavest.co/docs/v2_securities_list.md): Returns a paginated list of all stock securities.
- [Delisted Securities List](https://dashboard.bavest.co/docs/v2_securities_delisted.md): Returns a paginated list of delisted securities (lifecycle status 'delisted' — isActivelyTrading became false with no successor).
- [ISIN Change List](https://dashboard.bavest.co/docs/v2_securities_isin_changed.md): Returns a paginated list of securities whose ISIN changed, with the old and new ISIN.
- [Security Search](https://dashboard.bavest.co/docs/v2_reference_search.md): Search across stocks, ETFs, funds, and crypto by name or ticker.
- [Security Search Aggregated](https://dashboard.bavest.co/docs/v2_reference_search_aggregated.md): Returns aggregated search results grouped by security type.
- [Stock Screener](https://dashboard.bavest.co/docs/v2_reference_screener_post.md): Filter securities by financial metrics, profile attributes, valuation multiples, stability ratios, ESG scores, and more.

## Timeseries Data

- [Security NAV](https://dashboard.bavest.co/docs/v2_securities_nav.md): Returns the current Net Asset Value (NAV) for any security that has one.

## Optional

- [Changelog](https://dashboard.bavest.co/changelog): API and dashboard changes, newest first.
- [Changelog RSS](https://dashboard.bavest.co/changelog/rss.xml): the changelog as a feed.
