Sign in

v5

OpenAPI 3.1.0Proprietary2026-08-031,5423,1505.5 MB
Central Banks & Monetary

Passthrough for any Valet series

Fetch observations for any Bank of Canada Valet series by code. Accepts any series published at /observations/<seriesCode>/json. To request multiple codes in one call, comma-separate them (practical Valet limit is about 10 to 15 codes per request).

See /boc/catalog for recommended codes. Time-window parameters mirror the Valet API.

get/api/v1/boc/series/{seriesCode}

Path parameters

seriesCodestring required

Valet series code, optionally comma-separated for multiple series.

Valet series code, optionally comma-separated for multiple series.

Query parameters

recentinteger nullable

Return the last N observations.

Return the last N observations.

recent_weeksinteger nullable

Return observations for the last N weeks.

Return observations for the last N weeks.

recent_monthsinteger nullable

Return observations for the last N months.

Return observations for the last N months.

recent_yearsinteger nullable

Return observations for the last N years.

Return observations for the last N years.

start_datestring nullable

Start date (YYYY-MM-DD).

Start date (YYYY-MM-DD).

end_datestring nullable

End date (YYYY-MM-DD). Defaults to today.

End date (YYYY-MM-DD). Defaults to today.

Response

Observation rows for the requested series with metadata.

Example response

{
  "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": "sugra_crypto",
    "attribution": "Short interest and Reg SHO daily short volume data is owned by and sourced from FINRA (Financial Industry Regulatory Authority).",
    "fallback_chain": [
      "sugra_crypto",
      "sugra_finance"
    ]
  }
}