L'OCDE offre un accès programmatique à ses via une interface de programmation d'application (API) basée sur la norme SDMX.
Ces APIs sont gratuites et proposées sous réserve de votre acceptation des Conditions d'utilisation de l'OCDE.
Récupération de contenu via le générateur de requêtes API
Sélectionnez les données dont vous avez besoin dans l'Explorateur des données de l'OCDE, puis cliquez sur l'icône API pour développeur située au-dessus du tableau de données. Cela affichera les requêtes API pour les Données ainsi que pour leur Structure.
Pour les utiliser, cliquez simplement sur Copier le code et incluez la syntaxe dans vos appels API.
La Requête des données récupère les données réelles de l'ensemble de données, tandis que la Requête de la structure fournit des détails descriptifs, tels que les dimensions et les attributs de l'ensemble de données, également appelés métadonnées structurelles.
Syntaxe de la requête de données de l'API
La requête de données de l'API est une URL composée des éléments suivants :
{URL de l’hôte}/{Identifiant de l’agence},{Identifiant du jeu de données},{Version du jeu de données}/{Sélection des données}?{autres paramètres optionnels}
Les éléments composant la requête de données de l'API
Paramètres requis :
| Nom du paramètre | Utilisation |
|---|---|
| URL de l’hôte | Partie fixe de la requête liée au site hôte. |
| Identifiant de l'agence | Identifiant de l’agence possédant le jeu de données à interroger. |
| Identifiant du jeu de données | Identifiant du jeu de données à interroger. |
Paramètres optionnels :
| Nom du paramètre | Utilisation |
|---|---|
| Version du jeu de données | Version de la définition structurelle du jeu de données à interroger. Si laissé vide, la version la plus récente est utilisée. Cela permet souvent d'obtenir des données plus récentes, mais il faut noter que les nouvelles versions peuvent contenir des changements structurels incompatibles (ex. dimensions ajoutées/supprimées/renommées). |
| Sélection des données | Liste des valeurs dimensionnelles désirées à inclure dans la réponse, identifiées par leurs identifiants. Elles sont séparées par un point (“.”) et, pour chaque dimension, les valeurs sont séparées par le signe plus (“+”). Si aucune valeur n'est spécifiée pour une dimension, toutes les valeurs disponibles seront renvoyées. Pour obtenir du contenu non filtré, utilisez le mot-clé “all”. Exemples :
Pour obtenir la liste des dimensions et valeurs dimensionnelles, utilisez une requête structurelle comme expliqué ci-dessous. The Time period parameter is not included here. |
| Paramètres de période temporelle | startPeriod La période de début pour laquelle les résultats doivent être fournis (inclusivement). Si non spécifié, les données sont renvoyées à partir de la première période disponible. endPeriod La période de fin pour laquelle les résultats doivent être fournis (inclusivement). Si non spécifié, les données sont renvoyées jusqu'à la dernière période disponible. Pour ces deux paramètres, la valeur peut être exprimée en utilisant les périodes de temps grégoriennes, les périodes de rapport SDMX ou le format dateTime. Exemples : (‘2015’, ‘2015-A1’, ‘2015-S1’, ‘2015-Q1’, ‘2015-M01’, ‘2015-01’, ‘2015-01-01’, ‘2015-01-01T00:00:00’) |
Référez-vous à la documentation complète de l'API (en anglais) pour plus de détails sur les paramètres optionnels supplémentaires.
Syntaxe de la requête de structure de l'API
{URL de l’hôte}/{Identifiant de l’agence},{Identifiant du jeu de données},{Version du jeu de données}?Paramètres de structure de données
Pour obtenir la liste complète des jeux de données, utilisez la syntaxe suivante :
Accès aux données avec R et Python
Exemple R : télécharger des données CSV depuis l'API
Cet exemple montre comment télécharger et lire un fichier CSV en tant que DataFrame en R, y compris les étiquettes et les identifiants de séries, directement depuis une API.
url = "https://sdmx.oecd.org/public/rest/data/OECD.SDD.STES,DSD_STES@DF_CLI/.M.LI...AA...H?startPeriod=2023-02&dimensionAtObservation=AllDimensions&format=csvfilewithlabels" df<-read.csv(url)
Exemple Python : télécharger des données CSV depuis l'API
Cet exemple montre comment télécharger et lire un fichier CSV en tant que DataFrame en Python, y compris les étiquettes et les identifiants de séries, directement depuis une API.
import pandas as pd
url = 'https://sdmx.oecd.org/public/rest/data/OECD.SDD.STES,DSD_STES@DF_CLI/.M.LI...AA...H?startPeriod=2023-02&dimensionAtObservation=AllDimensions&format=csvfilewithlabels' df = pd.read_csv(url)
Formats de réponse : XML, JSON ou CSV
XML
Pour télécharger des données au format XML, ajoutez format=genericdata à votre appel d'API :
https://sdmx.oecd.org/public/rest/data/OECD.SDD.NAD,DSD_NAAG@DF_NAAG_I?format=genericdata
JSON
Pour télécharger des données au format XML, ajoutez format=genericdata à votre appel d'API :
CSV
Pour télécharger des données au format CSV, ajoutez format=csvfile à votre appel d'API. Si vous souhaitez inclure à la fois les étiquettes et les codes d'identification dans le téléchargement, utilisez format=csvfilewithlabels à la place :
https://sdmx.oecd.org/public/rest/data/OECD.SDD.NAD,DSD_NAAG@DF_NAAG_I?format=csvfile