Custom Connector
Bank of Canada Valet API Connector
Canada
The Bank of Canada Valet API Connector integrates with the Bank of Canada Valet Web Services, providing access to financial data — exchange rates, economic statistics, and reports. It acts as a proxy for listing series or groups, retrieving series/group details, fetching observations, and accessing foreign-exchange rates in RSS, with JSON, CSV, XML, and RSS responses.
Overview
Integration Overview
This document provides a detailed guide for each integration point, its purpose, configuration, and workflow support using the Bank of Canada Valet API Connector for GCP.
- listSeries / listGroups. Retrieve a list of available series or groups.
- getSeriesDetails / getGroupDetails. Retrieve details for a specific series or group (with its series).
- getObservationsBySeries / getObservationsByGroup. Retrieve observations filtered by series names or a group name.
- getForeignExchangeRates / getForeignExchangeRatesBySeries. Retrieve recent exchange-rate observations in RSS format, optionally by series.
Documentation
Detailed Integration Documentation
List Series / List Groups
| Action | listSeries / listGroups |
|---|---|
| Purpose | Retrieves a comprehensive list of available series or groups — the primary entry point for discovering financial metrics or collections of related series. |
| Configuration | Configure the base URL via CONNECTOR_ENV_BOC_VALET_BASE_URL. |
| Parameters | Required: format (json, csv, xml; default json). |
| Output | Successful: JSON/CSV/XML with terms and a series or groups object (name keys with label and description). Failure: {message: “An error has occurred”}. |
| Workflow example | Execute listSeries with format=json to populate a series-selection dropdown, or listGroups for a group-selection interface. |
Get Series / Group Details
| Action | getSeriesDetails / getGroupDetails |
|---|---|
| Purpose | Retrieves detailed metadata for a specific series, or for a group including the series it contains. |
| Configuration | Configure the base URL via CONNECTOR_ENV_BOC_VALET_BASE_URL. |
| Parameters | Required: seriesName (e.g. FXUSDCAD) or groupName (e.g. FX_RATES_DAILY); format (json, csv, xml; default json). |
| Output | Successful: JSON/CSV/XML with terms and seriesDetails or groupDetails (name, label, description; groups include groupSeries). Failure: {message: “… not found.”}. |
| Workflow example | Execute getSeriesDetails with seriesName=FXUSDCAD, or getGroupDetails with groupName=FX_RATES_DAILY, to display metadata in a dashboard. |
Get Observations by Series / Group
| Action | getObservationsBySeries / getObservationsByGroup |
|---|---|
| Purpose | Retrieves observations filtered by one or more series names, or for a group of series — for historical or recent financial data. |
| Configuration | Configure the base URL via CONNECTOR_ENV_BOC_VALET_BASE_URL. |
| Parameters | Required: seriesNames (comma-separated, e.g. FXUSDCAD,FXEURCAD) or groupName; format (json, csv, xml). Optional: start_date, end_date (YYYY-MM-DD); recent; recent_weeks; recent_months; recent_years; order_dir (asc, desc). |
| Output | Successful: JSON/CSV/XML with terms, seriesDetail (and groupDetail for the group variant), and an observations array (e.g. [{d:“2017-01-03”, FXUSDCAD:{v:“0.7443”}}]). Failure: {message: “… not found.”}. |
| Workflow example | Execute getObservationsBySeries with seriesNames=FXUSDCAD and recent=5 for a financial report, or getObservationsByGroup with groupName=FX_RATES_DAILY. |
Get Foreign Exchange Rates (RSS)
| Action | getForeignExchangeRates / getForeignExchangeRatesBySeries |
|---|---|
| Purpose | Retrieves the most recent exchange-rate observations in RSS format, optionally filtered by specific series names. |
| Configuration | Configure the base URL via CONNECTOR_ENV_BOC_VALET_BASE_URL. |
| Parameters | getForeignExchangeRatesBySeries required: seriesNames (comma-separated, e.g. FXAUDCAD,FXUSDCAD). Base variant: none. |
| Output | Successful: RSS (XML) with rss, channel metadata, and item(s) carrying exchangeRate statistics (value, baseCurrency, targetCurrency). Failure: {message: “… not found.”}. |
| Workflow example | Execute getForeignExchangeRatesBySeries with seriesNames=FXUSDCAD, parse the RSS, and display rates in a dashboard. |
Example Workflow: Financial Data Retrieval
| Retrieve series | Use listSeries with format=json and identify targets (e.g. FXUSDCAD, FXEURCAD). |
|---|---|
| Query details | Execute getSeriesDetails with seriesName=FXUSDCAD to fetch metadata. |
| Fetch observations | Use getObservationsBySeries with seriesNames=FXUSDCAD and recent=5, then integrate into a financial-reporting application. |
Support
For technical support, contact custom-connectors-support@isolutions.sa.