Curated Bank of Canada catalog

GET

/api/v1/boc/catalog

Last modified:2026-05-10 09:22:39

Maintainer:Not configured

OperationId: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.

Request

Authorization

API Key

Add parameter in header

x-api-key

Example:

x-api-key: ********************

Header Params

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200

application/json

Curated series and group catalog for Bank of Canada discovery.

Bodyapplication/json

Example

{
    "data": {
        "series_count": 0,
        "group_count": 0,
        "series": [
            {
                "code": "string",
                "category": "string",
                "description": "string"
            }
        ],
        "groups": [
            {
                "group": "string",
                "description": "string"
            }
        ]
    },
    "meta": {
        "endpoint": "/api/v1/fred/us/cpi",
        "data_time": "2026-04-16T14:30:00Z",
        "response_time": "2026-04-16T14:30:12Z",
        "provider": "Sugra API v1.0.1",
        "source": "string",
        "fallback_used": true,
        "fallback_chain": [
            "string"
        ],
        "cached": true
    }
}

🟠401

🟠429

🔴503

Modified at 2026-05-10 09:22:39

Climate transition scenario data

Passthrough for any Valet group