Passthrough for any Valet group

GET

/api/v1/boc/group/{groupName}

Last modified:2026-08-10 07:19:46

Maintainer:Not configured

OperationId:boc_group_groupname

Fetch observations for any Bank of Canada Valet group by name. Accepts any group published at /observations/group/<groupName>/json - the Valet catalog currently exposes over 2,000 groups including monetary aggregates, FX baskets, bond yields, auctions, surveys, and Financial Vulnerability Index panels.

See /boc/catalog for a curated starter list. Time-window parameters mirror the Valet API (only one of recent, recent_weeks, recent_months, recent_years or start_date/end_date should be specified).

Request

Authorization

API Key

Add parameter in header

x-api-key

Example:

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

Path Params

Query Params

Header Params

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location 'https://sugra.ai/api/v1/boc/group/bond_yields_benchmark?recent=30&recent_weeks=4&recent_months=6&recent_years=5&start_date=2025-01-01&end_date=2026-04-17' \
--header 'x-api-key: <api-key>'

Responses

🟢200OK

application/json

Observation rows for the requested group with series metadata.

Bodyapplication/json

Example

{
    "data": {
        "seriesDetail": {
            "property1": {
                "label": "string",
                "description": "string",
                "frequency": "string",
                "unit": "string",
                "decimals": 0
            },
            "property2": {
                "label": "string",
                "description": "string",
                "frequency": "string",
                "unit": "string",
                "decimals": 0
            }
        },
        "count": 0,
        "observations": [
            {
                "d": "string",
                "property1": "string",
                "property2": "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",
        "attribution": "string",
        "fallback_used": true,
        "fallback_chain": [
            "string"
        ],
        "cached": true,
        "stale": true
    }
}

🟠401Unauthorized

🟠422Parameter Error

🟠429

🔴503Service Unavailable

Modified at 2026-08-10 07:19:46

Curated Bank of Canada catalog

Passthrough for any Valet series