Bank of Canada Valet API - Ismena website

info@ismena.com

Bank of Canada Valet API Connector

Connector Details

Type

Virtual machines, Single VM , BYOL

Runs on

Google Compute Engine

Last Update

24 October, 2024

Category

Overview

The Bank of Canada Valet API Connector facilitates seamless integration with the Bank of Canada Valet Web Services, providing access to global financial data, including exchange rates, economic statistics, and other financial reports. This connector acts as a proxy to streamline data retrieval, supporting actions for listing series or groups, retrieving series or group details, fetching observations by series or group, and accessing foreign exchange rates in RSS format. It supports JSON, CSV, XML, and RSS response formats.

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 Google Cloud Platform (GCP).

listSeries: Retrieves a list of available series.
listGroups: Retrieves a list of available groups.
getSeriesDetails: Retrieves details associated with a specific series.
getGroupDetails: Retrieves details associated with a specific group, including the series it contains.
getObservationsBySeries: Retrieves observations filtered by one or more series names.
getObservationsByGroup: Retrieves observations for a group of series, filtered by group name.
getForeignExchangeRates: Retrieves the most recent exchange rate observations in RSS format.
getForeignExchangeRatesBySeries: Retrieves exchange rate observations filtered by specific series names in RSS format.

Detailed Integration Documentation

List Series Retrieval

Action	listSeries
Purpose	Retrieves a comprehensive list of available series. This serves as the primary entry point for accessing series data, useful for building selection interfaces or discovering available financial metrics.
Parameters	Required: format (string, enum: [json, csv, xml], default: json) Optional: None
Configuration	Ensure the connector is configured with the base URL via CONNECTOR_ENV_BOC_VALET_BASE_URL environment variable.
Output	Successful: Returns a JSON, CSV, or XML object with: terms: Link to terms of use (object) series: Object containing series names as keys with details (e.g., {IEXE0102: {label: "USD_CLOSE", description: "U.S. dollar (close)"}}) Failure: Returns error details (e.g., {message: "An error has occurred"})
Workflow Example	Configure the connector with the appropriate base URL. Execute the listSeries action with format=json. Process the response to populate a series selection dropdown in a GCP-hosted application.

List Groups Retrieval

Action	listGroups
Purpose	Retrieves a comprehensive list of available groups. This serves as the primary entry point for accessing grouped data, useful for discovering collections of related series.
Parameters	Required: format (string, enum: [json, csv, xml], default: json) Optional: None
Configuration	Ensure the connector is configured with the base URL via CONNECTOR_ENV_BOC_VALET_BASE_URL environment variable.
Output	Successful: Returns a JSON, CSV, or XML object with: terms: Link to terms of use (object) groups: Object containing group names as keys with details (e.g., {sdp-2012-8: {label: "Staff Discussion Paper 2012-8", description: "This file contains data based on the Bank of Canada research paper..."}}) Failure: Returns error details (e.g., {message: "An error has occurred"})
Workflow Example	Configure the connector with the appropriate base URL. Execute the listGroups action with format=json. Process the response to populate a group selection interface in a GCP-hosted application.

Get Series Details Retrieval

Action	getSeriesDetails
Purpose	Retrieves detailed information for a specific series, useful for understanding the context and metadata of a financial metric.
Parameters	Required: seriesName: Name of the series (string, e.g., FXUSDCAD) format: Response format (string, enum: [json, csv, xml], default: json) Optional: None
Configuration	Ensure the connector is configured with the base URL via CONNECTOR_ENV_BOC_VALET_BASE_URL environment variable.
Output	Successful: Returns a JSON, CSV, or XML object with: terms: Link to terms of use (object) seriesDetails: Object containing series metadata (e.g., {name: "FXUSDCAD", label: "CAD/USD", description: "Canadian dollar to US dollar daily exchange rate"}) Failure: Returns error details (e.g., {message: "Series FXUSDCAD not found."})
Workflow Example	Execute the getSeriesDetails action with seriesName=FXUSDCAD and format=json. Review the response to obtain series metadata. Use the data to display series information in a GCP-hosted financial dashboard.

Get Group Details Retrieval

Action	getGroupDetails
Purpose	Retrieves detailed information for a specific group, including the series it contains, useful for exploring collections of related financial metrics.
Parameters	Required: groupName: Name of the group (string, e.g., FX_RATES_DAILY) format: Response format (string, enum: [json, csv, xml], default: json) Optional: None
Configuration	Ensure the connector is configured with the base URL via CONNECTOR_ENV_BOC_VALET_BASE_URL environment variable.
Output	Successful: Returns a JSON, CSV, or XML object with: terms: Link to terms of use (object) groupDetails: Object containing group metadata and series (e.g., {name: "FX_RATES_DAILY", label: "Daily exchange rates", description: "Daily average exchange rates...", groupSeries: {FXAUDCAD: {label: "AUD/CAD"}}}) Failure: Returns error details (e.g., {message: "Group FX_RATES_DAILY not found."})
Workflow Example	Execute the getGroupDetails action with groupName=FX_RATES_DAILY and format=json. Review the response to obtain group metadata and associated series. Use the data to populate a group overview in a GCP-hosted application.

Get Observations by Series Retrieval

Action	getObservationsBySeries
Purpose	Retrieves observations filtered by one or more series names, enabling applications to fetch historical or recent financial data for specific metrics.
Parameters	Required: seriesNames: Comma-separated list of series names (string, e.g., FXUSDCAD,FXEURCAD) format: Response format (string, enum: [json, csv, xml], default: json) Optional: start_date: Filters observations on or after the specified date (string, YYYY-MM-DD) end_date: Filters observations on or before the specified date (string, YYYY-MM-DD) recent: Returns the most recent X observations per series (integer) recent_weeks: Returns the last X weeks of observations (integer) recent_months: Returns the last X months of observations (integer) recent_years: Returns the last X years of observations (integer) order_dir: Order of observations (string, enum: [asc, desc])
Configuration	Ensure the connector is configured with the base URL via CONNECTOR_ENV_BOC_VALET_BASE_URL environment variable.
Output	Successful: Returns a JSON, CSV, or XML object with: terms: Link to terms of use (object) seriesDetail: Object containing series metadata (e.g., {FXUSDCAD: {label: "CAD/USD", description: "Canadian dollar to US dollar daily exchange rate"}}) observations: Array of observation objects (e.g., [{d: "2017-01-03", FXUSDCAD: {v: "0.7443"}}]) Failure: Returns error details (e.g., {message: "Series FXUSDCAD not found."})
Workflow Example	Execute the getObservationsBySeries action with seriesNames=FXUSDCAD and format=json. Save the observations for analysis or visualization. Use the data in a GCP-hosted application for financial reporting.

Get Observations by Group Retrieval

Action	getObservationsByGroup
Purpose	Retrieves observations for a group of series filtered by group name, enabling applications to fetch data for related financial metrics.
Parameters	Required: groupName: Name of the group (string, e.g., FX_RATES_DAILY) format: Response format (string, enum: [json, csv, xml], default: json) Optional: start_date: Filters observations on or after the specified date (string, YYYY-MM-DD) end_date: Filters observations on or before the specified date (string, YYYY-MM-DD) recent: Returns the most recent X observations per series (integer) recent_weeks: Returns the last X weeks of observations (integer) recent_months: Returns the last X months of observations (integer) recent_years: Returns the last X years of observations (integer) order_dir: Order of observations (string, enum: [asc, desc])
Configuration	Ensure the connector is configured with the base URL via CONNECTOR_ENV_BOC_VALET_BASE_URL environment variable.
Output	Successful: Returns a JSON, CSV, or XML object with: terms: Link to terms of use (object) groupDetail: Object containing group metadata (e.g., {label: "Daily exchange rates", description: "Daily average exchange rates..."}) seriesDetail: Object containing series metadata (e.g., {FXUSDCAD: {label: "CAD/USD", description: "Canadian dollar to US dollar daily exchange rate"}}) observations: Array of observation objects (e.g., [{d: "2017-01-03", FXUSDCAD: {v: "0.7443"}}]) Failure: Returns error details (e.g., {message: "Group FX_RATES_DAILY not found."})
Workflow Example	Execute the getObservationsByGroup action with groupName=FX_RATES_DAILY and format=json. Save the observations for analysis or visualization. Use the data in a GCP-hosted application for financial reporting.

Get Foreign Exchange Rates Retrieval

Action	getForeignExchangeRates
Purpose	Retrieves the most recent exchange rate observations in RSS format, useful for applications requiring up-to-date exchange rate data.
Parameters	Required: None Optional: None
Configuration	Ensure the connector is configured with the base URL via CONNECTOR_ENV_BOC_VALET_BASE_URL environment variable.
Output	Successful: Returns an RSS (XML) object with: rss: RSS namespace (string) channel: Channel metadata (object, e.g., {title: "Daily exchange rates"}) item: Exchange rate observation (object, e.g., {title: "CA: 1.3206 CAD = 1 USD 2023-06-19", description: "1 AUD = 0.8674 CAD...", statistics: {exchangeRate: {value: "0.8674", baseCurrency: "CAD", targetCurrency: "AUD"}}}) Failure: Returns error details (e.g., {message: "An error has occurred"})
Workflow Example	Execute the getForeignExchangeRates action. Parse the RSS response to extract exchange rate data. Display the rates in a GCP-hosted financial dashboard.

Get Foreign Exchange Rates by Series Retrieval

Action	getForeignExchangeRatesBySeries
Purpose	Retrieves exchange rate observations filtered by specific series names in RSS format, useful for applications requiring targeted exchange rate data.
Parameters	Required: seriesNames: Comma-separated list of series names (string, e.g., FXAUDCAD,FXUSDCAD) Optional: None
Configuration	Ensure the connector is configured with the base URL via CONNECTOR_ENV_BOC_VALET_BASE_URL environment variable.
Output	Successful: Returns an RSS (XML) object with: rss: RSS namespace (string) channel: Channel metadata (object, e.g., {title: "Daily exchange rates"}) item: Exchange rate observation for specified series (object, e.g., {title: "CA: 1.3206 CAD = 1 USD 2023-06-19", description: "1 AUD = 0.8674 CAD...", statistics: {exchangeRate: {value: "0.8674", baseCurrency: "CAD", targetCurrency: "AUD"}}}) Failure: Returns error details (e.g., {message: "Series FXAUDCAD not found."})
Workflow Example	Execute the getForeignExchangeRatesBySeries action with seriesNames=FXUSDCAD. Parse the RSS response to extract exchange rate data for the specified series. Display the rates in a GCP-hosted financial dashboard.

Workflow Creation with the Connector

Example Workflow: Financial Data Retrieval and Display

Retrieve Available Series	Use the listSeries action with format=json to fetch a list of available series. Identify target series (e.g., FXUSDCAD, FXEURCAD).
Query Series Details	Execute the getSeriesDetails action with seriesName=FXUSDCAD and format=json to fetch series metadata. Process the response to display series information in a GCP-hosted interface.
Fetch Observations	Use the getObservationsBySeries action with seriesNames=FXUSDCAD and recent=5 to fetch recent observations. Integrate the observation data into a GCP-hosted financial reporting application.
Workflow Outcome	This workflow enables GCP-hosted applications to provide users with accurate financial data, enhancing capabilities for financial analysis and reporting.

This workflow enables applications to collect, store, and analyze sensor data within GCP, supporting real-time monitoring and geospatial analysis.

Pricing

bill-and-calculator-2023-11-27-05-25-06-utc 1

Request a Quote

Support

For Technical support please contact us on

custom-connectors-support@isolutions.sa

A tech solution company dedicated to providing innovation thus empowering businesses to thrive in the digital age.

Register to IBM x iSolution Event