# ETF Documents Catalog

> Returns a paginated catalog of all available ETF documents (KID/KIID) for a given language.

`GET https://api.bavest.co/v2/etfs/documents/catalog`

Group: ETFs. Route id: `v2_etfs_documents_catalog`. Included in: Pro, Growth.

## Description

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.

## Authentication

Send your API key in the `x-api-key` header on every request. No key yet? Sign up at https://dashboard.bavest.co/sign-up (free trial). The examples read the key from the `BAVEST_API_KEY` environment variable.

## Parameters

| Name | In | Type | Required | Description |
|---|---|---|---|---|
| `language` | query | string | yes | ISO 639-1 language code (e.g. en, de, fr) Example `en`. |
| `isin` | query | string | no (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. |
| `symbol` | query | string | no (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. |
| `type` | query | string | no | Filter by document type. Omit to return both KID and KIID. One of `KID`, `KIID`. |
| `limit` | query | integer (int32) | no | Maximum number of results to return (default 100, max 1000) Default `100`. |
| `offset` | query | integer (int32) | no | Number of results to skip for pagination (default 0) Default `0`. |
| `cursor` | query | string | no | Opaque cursor for cursor-based pagination. When provided, returns results after the cursor position. Takes precedence over offset. |

Optional, at most one of `isin`, `symbol`.

## Response

200 Successful response (`application/json`).

| Field | Type | Always present | Description |
|---|---|---|---|
| `data` | array of ETFDocumentCatalogItem | no |  |
| `data[].isin` | string \| null | yes | ETF ISIN code. Example: `IE00B4L5Y983`. |
| `data[].language` | string | yes | ISO 639-1 language code. Example: `en`. |
| `data[].type` | string | yes | Document type. One of `KID`, `KIID`. |
| `data[].download_path` | string | yes | API path to download the document via /v2/etfs/kid. Example: `/v2/etfs/kid?isin=IE00B4L5Y983&language=en`. |
| `meta` | ResponseMeta | no | Response metadata for paginated endpoints. Offset pagination returns `page`/`pageSize`/`totalPages`/`totalCount`; cursor pagination returns `pageSize`/`hasMore`/`nextCursor` and `totalCount` only when known. |
| `meta.time` | integer | no | Server-side processing time in milliseconds. Example: `17`. |
| `meta.parameters` | object | no | Echo of the request parameters the endpoint resolved. |
| `meta.page` | integer | no | Current page number (offset pagination) Example: `1`. |
| `meta.pageSize` | integer | no | Number of results per page. Example: `50`. |
| `meta.totalPages` | integer | no | Total number of pages (offset pagination) Example: `2`. |
| `meta.totalCount` | integer | no | Total number of results across all pages. Example: `100`. |
| `meta.hasMore` | boolean | no | Whether more results follow (cursor pagination) |
| `meta.nextCursor` | string \| null | no | Cursor for the next page (cursor pagination), null on the last page. |

## Example request

```bash
curl 'https://api.bavest.co/v2/etfs/documents/catalog?language=en' \
  -H "x-api-key: $BAVEST_API_KEY"
```

## Example response

```json
{
  "data": [
    {
      "isin": "ABA1285663C9",
      "language": "en",
      "type": "KID",
      "download_path": "/v2/etfs/kid?isin=ABA1285663C9&language=en&type=KID"
    },
    {
      "isin": "ADEB985A5832",
      "language": "en",
      "type": "KID",
      "download_path": "/v2/etfs/kid?isin=ADEB985A5832&language=en&type=KID"
    }
  ],
  "meta": {
    "page": 1,
    "pageSize": 100,
    "totalPages": 137,
    "totalCount": 13664,
    "parameters": {
      "language": "en",
      "limit": "100"
    },
    "time": 154
  }
}
```

## Errors

| Status | Meaning |
|---|---|
| 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. |

- `403` from the gateway: the API key is invalid or switched off.
- `429` with message `Limit Exceeded`: the monthly quota of the key is used up. With `Too Many Requests`: the key is throttled, or this route is not in the key's plan. Wait for `Retry-After` when it is sent.

## Links

- HTML page: https://dashboard.bavest.co/docs/v2_etfs_documents_catalog
- OpenAPI: https://dashboard.bavest.co/openapi.json (YAML: https://dashboard.bavest.co/openapi.yaml)
- Authentication: https://dashboard.bavest.co/docs/authentication.md
- MCP server for AI agents: https://dashboard.bavest.co/docs/mcp.md
- All routes: https://dashboard.bavest.co/llms.txt
