Equities

Equity Metric Names

GET/v2/equities/metrics/names

Returns registered equity metric names with their unit, description and -- per name -- which reporting bases GET /equities/metrics/history can actually serve. Every name here is available as a latest value on GET /equities/metrics; bases is narrower, because history is materialized per basis. Filter with hasHistory or basis to get only the names a history integration can rely on. No security identifier required.

Free in every plan, including the trial.

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 · Authentication guide

Parameters

Name	In	Type	Required	Description
hasHistory	query	boolean	no	When true, return only names with at least one materialized basis; when false, only names without one. Omit for all names.
basis	query	string	no	Return only names materialized on this reporting basis. A basis that is valid but not yet materialized returns an empty list with count 0 rather than an error, mirroring how the history endpoint answers with a warning instead of a 404. One of `FY` `Q1` `Q2` `Q3` `Q4` `H1` `H2` `TTM`

Try it

GET /v2/equities/metrics/names

API key

Sent only to api.bavest.co for this request; not stored.

Sign in to send Get an API keySends with the key above, or sign in to use your account's key. Each request counts as one API call.

curl 'https://api.bavest.co/v2/equities/metrics/names' \
  -H "x-api-key: $BAVEST_API_KEY"

Samples read your key from BAVEST_API_KEY and follow the form.

Example response 200

{
  "data": {
    "count": 192,
    "metrics": [
      {
        "name": "10y_dividend_growth",
        "unit": "percentage",
        "description": "Dividend Growth (10Y)",
        "bases": [],
        "hasHistory": false
      },
      {
        "name": "10y_equity_growth",
        "unit": "percentage",
        "description": "Equity Growth (10Y)",
        "bases": [
          "FY"
        ],
        "hasHistory": true
      }
    ]
  },
  "meta": {
    "time": 2106
  }
}

From the docs, not your data. Long lists are cut to 3 items.

Response 200

Successful response · application/json

dataobject
- countinteger
  Number of metric names in this response, after any hasHistory/basis filter.
  Example 103
- metricsarray of object
metaResponseMeta
Response envelope metadata. Always present on a 200: time is set by core/response.py on every successful response. Errors carry the same block, built by the same code, so a client parses one meta shape whether the call succeeded or failed.
- timeinteger
  Server-side processing time in milliseconds
  Example 17
- parametersobject
  Echo of the request parameters the endpoint resolved

Errors

400Invalid 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).
401Missing or invalid API key.
404Resource not found.
429Rate limit exceeded. Retry after the `Retry-After` header interval.
500An unexpected error occurred on the server. If the issue persists, contact support with the X-Request-Id header value.
502Upstream data provider returned an error or is temporarily unavailable. Retry after a short delay.
504The request timed out waiting for a response from the upstream data provider. This may occur for complex queries or during peak load.
defaultAn unexpected error occurred on the server. If the issue persists, contact support with the X-Request-Id header value.