ETFs

ETF Documents Catalog

GET/v2/etfs/documents/catalog

Returns a paginated catalog of all available ETF documents (KID/KIID) for a given language. Use the download_path to fetch each document via /v2/etfs/kid.

Included in: Pro, Growth.

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

Optional, at most one of isin, symbol.

NameInTypeRequiredDescription
languagequerystringyes

ISO 639-1 language code (e.g. en, de, fr)

Example en

isinquerystringno (at most one of isin, symbol)

Only this fund's documents (e.g., IE00B4L5Y983). Omit for the whole catalog. Provide at most one of isin or symbol.

symbolquerystringno (at most one of isin, symbol)

Only the documents of this listing's fund, resolved to its ISIN (e.g., IWDA.AS). An unknown symbol is 404. Omit for the whole catalog.

typequerystringno

Filter by document type. Omit to return both KID and KIID.

One of KID KIID

limitqueryinteger (int32)no

Maximum number of results to return (default 100, max 1000)

Default 100

offsetqueryinteger (int32)no

Number of results to skip for pagination (default 0)

Default 0

cursorquerystringno

Opaque cursor for cursor-based pagination. When provided, returns results after the cursor position. Takes precedence over offset.

Try it

ISO 639-1 language code (e.g. en, de, fr)

Only this fund's documents (e.g., `IE00B4L5Y983`). Omit for the whole catalog. Provide at most one of isin or symbol.

Only the documents of this listing's fund, resolved to its ISIN (e.g., `IWDA.AS`). An unknown symbol is 404. Omit for the whole catalog.

GET /v2/etfs/documents/catalog?language=en

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

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

Response 200

Successful response · application/json

  • dataarray of ETFDocumentCatalogItem
    • isinstring | nullrequired

      ETF ISIN code

      Example IE00B4L5Y983

    • languagestringrequired

      ISO 639-1 language code

      Example en

    • typestringrequired

      Document type

      One of KID KIID

    • download_pathstringrequired

      API path to download the document via /v2/etfs/kid

      Example /v2/etfs/kid?isin=IE00B4L5Y983&language=en

  • metaResponseMeta

    Response metadata for paginated endpoints. Offset pagination returns page/pageSize/totalPages/totalCount; cursor pagination returns pageSize/hasMore/nextCursor and totalCount only when known.

    • timeinteger

      Server-side processing time in milliseconds

      Example 17

    • parametersobject

      Echo of the request parameters the endpoint resolved

    • pageinteger

      Current page number (offset pagination)

      Example 1

    • pageSizeinteger

      Number of results per page

      Example 50

    • totalPagesinteger

      Total number of pages (offset pagination)

      Example 2

    • totalCountinteger

      Total number of results across all pages

      Example 100

    • hasMoreboolean

      Whether more results follow (cursor pagination)

    • nextCursorstring | null

      Cursor for the next page (cursor pagination), null on the last page

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.

For AI agents: this page as Markdown at /docs/v2_etfs_documents_catalog.md, every route in /llms.txt, the OpenAPI spec at /openapi.json.