---
title: "Curated Bank of Canada catalog"
method: GET
path: "/api/v1/boc/catalog"
tags: ["Central Banks & Monetary"]
---

# Curated Bank of Canada catalog

`GET /api/v1/boc/catalog`

Curated index of Bank of Canada series and groups recommended by Sugra, grouped by theme (rates and monetary policy, yields, FX, inflation, money and credit, commodities, surveys, auctions, stability, balance sheet, climate). Useful as a discovery surface before calling `/boc/series/{seriesCode}` or `/boc/group/{groupName}` directly.

For the full (about 2,300 groups, tens of thousands of series) upstream catalog, call `fetch_series_list()` or `fetch_groups_list()` in the client module.

## Response `200`

Curated series and group catalog for Bank of Canada discovery.

- EnvelopeBocCatalogData
  - `data` BocCatalogData, required — Curated Sugra catalog of recommended BoC series and groups.
    - `series_count` integer, required — Number of curated series.
    - `group_count` integer, required — Number of curated groups.
    - `series` BocCatalogSeriesEntry[], required — Curated series with category and description.
      - `code` string, required — Series code used in Valet `/observations/{code}/json`.
      - `category` string, required — Curated category label (e.g. 'Inflation', 'Foreign exchange').
      - `description` string, required — Human-readable description.
    - `groups` BocCatalogGroupEntry[], required — Curated groups with description.
      - `group` string, required — Group name used in Valet `/observations/group/{group}/json`.
      - `description` string, required — Human-readable description.
  - `meta` SugraMeta, required — Metadata attached to every /api/v1/* response envelope.
    - `endpoint` string, required — Requested endpoint path.
    - `data_time` string, required — ISO 8601 UTC timestamp of the source data, not of the request.
    - `response_time` string, required — ISO 8601 UTC timestamp when this response was produced.
    - `provider` string, required — API name and version.
    - `source` string, nullable — Identifier of the primary upstream source used for this response.
    - `attribution` string, nullable — Human-readable attribution mandated by an upstream source (e.g. a securities regulator or self-regulatory organization). Present only on responses whose source requires the owner and source to be clearly identified. Do not remove or alter it when using the response.
    - `fallback_used` boolean, nullable — True when the primary source failed and a fallback produced the data.
    - `fallback_chain` string[], nullable — Ordered list of sources attempted, in the order they were tried.
    - `cached` boolean, nullable — True when this response was served from the internal cache.
    - `stale` boolean, nullable — True when the cached response was returned after the upstream rate-limited or errored. Clients can use this to detect degraded data.

## Other responses

- `401` — Missing or invalid `x-api-key` header. JSON body with a stable `code` distinguishing `missing_api_key` (no header sent) from `invalid_api_key` (header sent, key not accepted); any other 401 source carries the generic `unauthorized` with its detail as `reason`. Plus `hint`. `plan` is always null on 401 - an unauthenticated request has no plan; quota exhaustion is 429, not 401.
- `429` — Daily rate limit exceeded. Check `X-RateLimit-Reset` for the next window.
- `503` — Upstream source is temporarily unavailable. Retry after a short delay.

---

[API](https://skmtc.net/sugra/apis/sugra-api.md) · [All operations](https://skmtc.net/sugra/apis/sugra-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/sugra/sugra-api/versions/4c4530760ba1/schema)