Getting started

Welcome to the Bavest API. Get a key, make your first v2 request and find the data or AI integration you need.

Use the Bavest v2 API to build with financial data: equities, ETFs, funds, corporate actions, news and portfolio analytics. Browse the reference without signing in; requests need your API key and count against its plan.

Start with a connectivity check, then open the reference for the data your application needs. Examples here use v2 exclusively.

1. Get your API key

Create an account to get a key, or sign in to use your existing account. Keep the key on your server in the BAVEST_API_KEY environment variable.

Every request uses the x-api-key header. The authentication guide covers trial access, quotas, errors and key rotation.

2. Make your first request

Call API Status to check connectivity. The example JSON below comes from the shared API specification; timestamps and processing times in a real response can differ.

{
  "data": {
    "status": "active",
    "version": "v2"
  }
}
curl 'https://api.bavest.co/v2/account/status' \
  -H "x-api-key: $BAVEST_API_KEY"

Base URL: https://api.bavest.co/v2. Most data endpoints return JSON with a data field. Logo and document downloads return images or PDF; MCP uses JSON-RPC. Each reference page documents its response type.

3. Find your data

Use the identifier and reporting period documented for each endpoint. Where a route requires one of symbol and isin, send exactly one. Read field-level coverage and data-quality notes before using a value in calculations.

4. Try a route and handle errors

On a reference page, paste your own key to send a request, or sign in to use your account's key in the dashboard. Keep keys out of shared URLs, source code and screenshots.

  • 401 or 403: check the key and its access. Repeating the same refused request will not fix it.
  • 429 with Limit Exceeded: your monthly quota is used up. Other 429 responses can indicate throttling or a route outside your plan; check access and respect Retry-After when provided.
  • Check remaining usage with Usage Quota.

AI clients and resources

Use explicit .md links for Markdown downloads. The static Docs host serves HTML at page URLs and Markdown at their .md twins.

This page as Markdown: /docs/getting-started.md