Equities
Comprehensive Metrics
/v2/equities/metricsReturns per-metric financial data with validity flags, descriptions and units. Supports optional currency conversion. Results are paginated (default 50 metrics per page, max 200).
Included in: Startup, Pro, Growth.
Migrating from Stock Metric and Stock Fundamentals
Use GET /v2/equities/metrics when moving financial metrics and fundamental ratios from Stock Metric or Stock Fundamentals. Applications using POST /v0/stock/metric or POST /v0/stock/fundamentals need an updated request and response parser.
Provide exactly one query identifier: symbol or isin. For example, request GET /v2/equities/metrics?symbol=AAPL&limit=50&offset=0, omit isin, and send your key in the x-api-key header. Identifiers and filters belong in the query string rather than a legacy POST body. Set currency explicitly when monetary values need currency conversion.
Discover available metrics and their descriptions through Equity Metric Names. The optional fields filter selects comma-separated metricId values, not arbitrary response property names. Check the IDs in the current metrics response before adding a filter; unsupported IDs can produce an empty metrics list. Do not assume every legacy metric or label has an equivalent.
Read the JSON response example below when updating your parser:
- Entries are in
data.metrics, an array. Match each entry bymetricIdrather than relying on its position or expecting the old flat object. - Read each entry's
value,valid,reasonandrootCause. Preservenullvalues instead of converting missing data to zero. - Check the entry's
date,unitandcurrencybefore comparing values.data.latestDateis the most recent date across the metrics; individual observations can have different dates.
Fetch all pages you need: limit defaults to 50 and is capped at 200. With offset pagination, advance offset and use meta.totalCount to track completeness. With cursor pagination, follow meta.nextCursor while meta.hasMore is true; a supplied cursor takes precedence over offset. The first page is not necessarily the complete metric set.
For historical observations, use Equity Metric History and check the supported history bases in Metric Names. For complete financial statements, use Income Statements, Balance Sheets and Cash Flow Statements.
Build a mapping for the legacy fields your application actually uses, and compare matching dates, units and currencies before replacing calculations. Moving documentation to Equity Metrics does not make the old API URL, field names or calculation results automatically compatible.
Authentication
Send your API key in the x-api-key header on every request to https://api.bavest.co. The samples read it from the BAVEST_API_KEY environment variable. Get an API key (free trial) · Authentication guide.
Parameters
Required: one of symbol, isin, for example symbol=AAPL.
- stringquery · one of symbol, isin
Stock ticker symbol (e.g.,
AAPL,MSFT,GOOGL). Provide exactly one of symbol or isin.Example
AAPL - stringquery · one of symbol, isin
ISIN code (e.g.,
US0378331005). Provide exactly one of symbol or isin. Clear the symbol example before using an ISIN. - stringquery · no
Target currency for monetary values (ISO 4217). Converts from reporting currency if different. Example when explicitly filtering:
USD. - stringquery · no
Comma-separated list of metric ids to return. Unlike the statement endpoints, this filters metrics by
metricId, not by response key. Valid ids are served by/v2/equities/metrics/names. Ids that do not exist match nothing, so the metrics list comes back empty. Example when explicitly filtering:market_cap,roe_ttm. - integer (int32)query · no
Maximum number of metrics to return per page (default 50, max 200)
Default
50 - integer (int32)query · no
Number of metrics to skip for pagination (default 0)
Default
0 - stringquery · no
Opaque cursor for cursor-based pagination. When provided, returns results after the cursor position. Takes precedence over offset.
Response 200
Successful response · application/json
data- EquityMetrics
Equity metrics response with per-metric metadata.
2 fields in data
latestDate- string (date) | null
Most recent observation date across all metrics
Example:
2025-09-27metrics- array of object
Array of individual metric entries
10 fields in metrics
metricId- string
Metric identifier (camelCase)
Example:
peRatiodate- string (date) | null
Observation date of this metric value
Example:
2025-09-27metricName- string
Raw metric name from the data source
Example:
pe_ratiovalue- number (double) | null
Metric value (null if unavailable)
Example:
32.13valid- boolean
Whether the metric value is available
Example:
truereason- string | null
Reason if value is null or flagged
rootCause- string | null
Root cause for null or anomalous values
description- string | null
Human-readable metric description
Example:
Price to earnings ratiounit- string | null
Metric unit (e.g., ratio, USD, percent)
Example:
ratiocurrency- string | null
Currency of monetary values (ISO 4217)
Example:
USD
meta- ResponseMeta
Response metadata for paginated endpoints. Offset pagination returns
page/pageSize/totalPages/totalCount; cursor pagination returnspageSize/hasMore/nextCursorandtotalCountonly when known.8 fields in meta
time- integer
Server-side processing time in milliseconds
Example:
17parameters- object
Echo of the request parameters the endpoint resolved
page- integer
Current page number (offset pagination)
Example:
1pageSize- integer
Number of results per page
Example:
50totalPages- integer
Total number of pages (offset pagination)
Example:
2totalCount- integer
Total number of results across all pages
Example:
100hasMore- boolean
Whether more results follow (cursor pagination)
nextCursor- string | null
Cursor for the next page (cursor pagination), null on the last page
Errors
- 400 Invalid request parameters. Returned when required query parameters are missing, have invalid types, or violate constraints (e.g., providing both symbol and isin when they are mutually exclusive).
- 401 Missing or invalid API key.
- 404 Resource not found.
- 429 Rate limit exceeded. Retry after the `Retry-After` header interval.
- 500 An unexpected error occurred on the server. If the issue persists, contact support with the X-Request-Id header value.
- 502 Upstream data provider returned an error or is temporarily unavailable. Retry after a short delay.
- 504 The request timed out waiting for a response from the upstream data provider. This may occur for complex queries or during peak load.
- default An unexpected error occurred on the server. If the issue persists, contact support with the X-Request-Id header value.
403from the gateway: the API key is invalid or switched off.429with messageLimit Exceeded: the monthly quota of the key is used up. WithToo Many Requests: the key is throttled, or this route is not in the key's plan. Wait forRetry-Afterwhen it is sent.

