Interface Valet

Les services Web Valet de la Banque du Canada permettent d’accéder, moyennant une simple programmation informatique, aux données financières internationales diffusées par l’entremise de l’interface de programmation d’applications (API) Valet.

Cette API permet aux usagers d’extraire les données et informations financières publiées par la Banque du Canada, telles que le taux de change quotidien dollar canadien/euro.

Formats

Les données sont fournies aux formats JSON, XML et CSV.

Routes

Vous trouverez dans Valet les routes suivantes : Observations, Groupes d’observations, et Taux de change – fils RSS.

L’URL racine (préfixe) de chaque route est :

https://www.banqueducanada.ca/valet

Toutes les routes indiquées ci-après doivent être précédées de l’URL racine. Aucune distinction n’est faite entre les majuscules et les minuscules. Chaque route nécessite au moins un nom de série (seriesNames) ou un nom de groupe (groupName). Toutefois, le format et les paramètres de la requête (query) correspondants à ces routes sont facultatifs.

Formats

Exemple de résultats au format JSON (Formats):

On entend par format le format de présentation des données regroupées par Valet dans le fichier de résultats. Il est indiqué dans l’extension du nom de fichier. Valet peut présenter les données au format JSON, XML ou CSV. Le format implicite est JSON. Pour préciser le format désiré, il suffit d’ajouter l’extension correspondante à la fin de la requête.

/observations/IEXE0102/json
/observations/group/FX_RATES_DAILY/xml
/fx_rss/FXUSDCAD/csv

Exemple de requête : /observations/FXCADUSD/json

Observations

Description

La route des observations permet d’obtenir des résultats filtrés selon le nom de la série (seriesNames). Une observation comprend la date d’enregistrement et la valeur de la série en question.

Syntaxe

Il faut indiquer au moins un nom de série (seriesNames) pour obtenir les observations de la série requise. Si l’on ne précise pas de format, les données seront présentées implicitement au format JSON. On peut aussi poser comme requête (query) un paramètre comme la période concernée, à l’aide de la syntaxe suivante :

/observations/seriesNames/format?query

Exemple de résultats au format JSON (Observations):

Exemple de requête : /observations/FXUSDCAD/json?recent=5

Paramètres

Formats

Les observations sont présentées au format JSON, XML ou CSV. /observations/FXUSDCAD/json
/observations/FXUSDCAD/xml
/observations/FXUSDCAD/csv

Noms de série

Le paramètre seriesNames donne une liste des noms de série séparés par une virgule. /observations/FXUSDCAD
/observations/FXUSDCAD,A.AGRI


Requête

Une requête (query) comprend une date de début ou une date de fin, ou une combinaison des deux, ce qui permet de limiter le nombre de résultats. Par exemple, la requête start_date=2016-05-09&end;_date=2016-05-12 produirait comme résultats toutes les observations d’une série enregistrées du 5 au 12 mai 2016 inclusivement.

Dates de début et de fin :

• start_date: Date au format AAAA-MM-JJ. Ce paramètre permet de filtrer les résultats de sorte qu’ils ne comprennent que les observations enregistrées à partir de la date précisée.
• end_date: Date au format AAAA-MM-JJ. Ce paramètre permet de filtrer les résultats de sorte qu’ils ne comprennent que les observations enregistrées jusqu’à la date précisée.

query : start_date, end_date ou une combinaison des deux /observations/FXUSDCAD?start_date=2016-05-09
/observations/FXUSDCAD?end_date=2016-05-12
/observations/FXUSDCAD?start_date=2016-05-09&end;_date=2016-05-12


Une requête peut aussi représenter une période récente (exprimée en semaines, mois ou années). Par exemple, la requête recent_weeks=10 produirait comme résultats toutes les données enregistrées pendant les dix dernières semaines.

Intervalle récent :

• recent_[intervalle]=X : intervalle de temps exprimé de la façon suivante : recent_[intervalle], où l’intervalle correspond à des semaines, des mois ou des années, et X est un nombre entier. Cela permet de filtrer les résultats de sorte que les observations correspondent seulement aux X derniers [intervalles] précisés (date de requête incluse).

query : recent_[intervalle]

Exemple d’utilisation pour obtenir les X observations les plus récentes d’une série donnée : /observations/FXUSDCAD?recent=X

Exemple d’utilisation pour obtenir les observations des X dernières semaines d’une série donnée : /observations/FXUSDCAD?recent_weeks=X

Exemple d’utilisation pour obtenir les observations des X derniers mois d’une série donnée : /observations/FXUSDCAD?recent_months=X

Exemple d’utilisation pour obtenir les observations des X dernières années d’une série donnée : /observations/FXUSDCAD?recent_years=X

Nota : dans une requête, le paramètre recent _[intervalle] ne peut pas être utilisé en même temps que les paramètres start_date et end_date.

Réponse

Les réponses à ce type de requête correspondent aux observations présentées au format JSON, XML ou CSV, accompagnées des précisions suivantes :

• Modalités :
  • url : L’url des modalités d’utilisation du contenu produit par la Banque du Canada
• Détails sur la série :
  • id : id de la série
  • label : étiquette (label) de la série
  • description : description de la série
• Observations :
  • date : date d’enregistrement de l’observation
  • value : valeur de l’observation

Groupes d’observations

Description

La route des groupes d’observations permet d’obtenir un groupe de séries filtrées selon le nom de groupe (groupName). Un groupe de séries comprend toutes les observations relevant de ce groupe.

Syntaxe

Il faut indiquer au moins un nom de groupe (groupName) pour obtenir les observations du groupe requis. Si l’on ne précise pas de format, les données seront présentées implicitement au format JSON. On peut aussi poser comme requête (query) un paramètre comme la période concernée, à l’aide de la syntaxe suivante :

/observations/group/groupName/format?query

Exemple de résultats au format JSON (Groupes d’observations):

Exemple de requête : /observations/group/FX_RATES_DAILY/json?recent=5

Paramètres

Formats

Les groupes d’observations sont présentées au format JSON, XML ou CSV. /observations/FX_RATES_DAILY/json
/observations/FX_RATES_DAILY/xml
/observations/FX_RATES_DAILY/csv

Nom de groupe

Un nom de groupe (groupName) correspond à un groupe de séries réunies pour faciliter le traitement. /observations/group/FX_RATES_DAILY
/observations/group/sdp-2012-8

Requête

Pour de plus amples renseignements, veuillez vous reporter à la section Observations.

Réponse

Les réponses à ce type de requête correspondent aux groupes d’observations présentées au format JSON, XML ou CSV, accompagnées des précisions suivantes :

• Détails sur le groupe:
  • label : titre du groupe
  • description : description du groupe ou de la source d’information correspondante
  • link : lien vers de plus amples renseignements sur le groupe en question
• Modalités :
  • url : L’url des modalités d’utilisation du contenu produit par la Banque du Canada
• Détails sur les séries :
  • id : id de chaque série relevant du groupe en question
  • label : étiquette (label) de chaque série
  • description : description de chaque série
• Observations :
  • date : date de l’observation
  • value : valeur de l’observation

Taux de change – fils RSS

Description

La route des taux de change – fils RSS permet d’obtenir des observations sur les taux de change filtrés selon le nom de série (seriesNames). Les taux de change sont bilatéraux, c’est-à-dire que les observations d’une série donnée concernent les taux de change entre deux monnaies spécifiques.

Syntaxe

Il faut indiquer au moins un nom de série (seriesNames) pour obtenir les taux de change de la série requise sous forme de fil RSS. Cette route renvoie toujours la dernière observation de la série précisée. La syntaxe est la suivante :

/fx_rss/seriesNames

Exemple de résultats RSS (Taux de change – fils RSS):

Exemple de requête : /fx_rss/FXUSDCAD

Paramètres

Noms de série

Le paramètre seriesNames donne une liste des noms de série séparés par une virgule, sous la forme FX[monnaie1][monnaie2]. /fx_rss/FXUSDCAD
/fx_rss/FXUSDCAD,FXEURCAD


Ce paramètre facultatif permet de limiter les résultats à une série de taux de change donnée. S’il n’est pas précisé, la route produira comme résultats la plus récente observation pour chaque série existante.

Réponse

Les réponses à ce type de requête comprennent les renseignements suivants :

• title : titre du fil RSS
• link : lien vers la page Web de la Banque du Canada relative aux taux de change
• description : description du fil RSS
• items : liste des taux de change observés
  • title : taux de change exprimé sous forme d’équation
  • link : lien vers la page Web de la Banque du Canada relative aux taux de change
  • description : description du taux de change bilatéral (entre deux monnaies précisées)
  • dc:date : date d’observation
  • dc:language : langue dans laquelle sont présentés les renseignements
  • cb:statistics : précisions sur les données observées
    • cb:country : pays concerné
    • cb:exchangeRate : information sur le taux de change
      • cb:value : taux de change bilatéral
      • cb:baseCurrency : monnaie de base
      • cb:targetCurrency : monnaie cible
      • cb:rateType : type de taux de change
      • cb:observationPeriod : date d’observation et fréquence de la série

Erreurs

Exemple de résultats (Erreurs):