ETFs

ETF Metric Names

GET/v2/etfs/metrics/names

Returns every metric name available on /v2/etfs/metrics, with the unit and a description for each name.

Use these names with the fields parameter of /v2/etfs/metrics. The vocabulary is versioned with the API. New metric names may be added over time and additions are backward compatible.

No ETF identifier is 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

This route takes no path or query parameters.

Try it

This route takes no parameters.

GET /v2/etfs/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/etfs/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": 104,
    "metrics": [
      {
        "name": "alpha_five_years_category",
        "unit": "RATIO",
        "description": "5-year Jensen's alpha of the fund's category"
      },
      {
        "name": "alpha_five_years_security",
        "unit": "RATIO",
        "description": "5-year Jensen's alpha of the fund"
      }
    ]
  },
  "meta": {
    "time": 57
  }
}

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

Response 200

Successful response · application/json

dataobject
- countinteger
  Total number of registered metric names
  Example 92
- 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

401Missing or invalid API key.
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.