Données WEBSTAT - Banque de France FR
Paths
/v1/catalogue
Récupération de la liste des datasets
Format de sortie des données
{
"enum": [
"json",
"csv",
"xml"
],
"default": "json"
}operation complétée
Valeur format incorrect
Erreur interne serveur
Request Timeout
Gateway Timeout
/v1/catalogue/{datasetName}
Récupération de la liste des séries d'un dataset
Identifiant du dataset
Format de sortie des données
{
"enum": [
"json",
"csv",
"xml"
],
"default": "json"
}operation complétée
Valeur format incorrect
Dataset non trouvé ou le dataset est en cours d'indexation
Erreur interne serveur
Request Timeout
Gateway Timeout
/v1/data/{datasetName}
Récupération des observations d'un dataset
Cet API requête l'ensemble des données d'un dataset. Certains datasets contiennent plusieurs centaines de milliers d'observations. En cas d'erreur (timeout) ou de temps de chargement excessif, il sera nécessaire de restreindre le nombre d'observations demandé à l'aide des différents paramètres ou d'utiliser l'API de requête par séries.
Identifiant du dataset
Format de sortie des données
{
"enum": [
"json",
"csv",
"xml"
],
"default": "json"
}Niveau de détail des données
{
"enum": [
"dataonly"
],
"default": "dataonly"
}Période de début des observations. Sa valeur doit respecter les 6 formats : YYYY-MM-DD, YYYY-W[01-53], YYYY-MM , YYYY-Q[1-4] , YYYY-S[1-2], YYYY
Periode de fin des observations. Sa valeur doit respecter les 6 formats : YYYY-MM-DD, YYYY-W[01-53], YYYY-MM , YYYY-Q[1-4] , YYYY-S[1-2], YYYY
Nombre des observations à récupérer en partant de la plus récente disponible
{
"minimum": 1
}Nombre des observations à récupérer en partant de la plus ancienne disponible
{
"minimum": 1
}operation complétée
Valeur format incorrect, le dataset est obligatoire'Valeur détail incorrect'Format de la période incorrect'Valeur firstNObservation et/ou Valeur lastNObservation doivent être des nombres entiers
client Id non valide
firstNObservation et lastNObservation ne peuvent pas être combinés dans la même requête
Dataset non trouvé ou le dataset est en cours d'indexation
Erreur interne serveur
Format non implémenté
Request Timeout
Gateway Timeout
/v1/data/{datasetName}/{seriesKey}
Récupération des observations d'une ou plusieurs séries
Cet API autorise l'utilisation de jokers en remplaçant une dimension par le caractère *. (Par exemple, /EXR/D.*.EUR.SP00.A renverra les taux de changes quotidiens pour toutes les devises en euros). Il est possible d'utiliser plusieurs jokers dans une même requête.
Identifiant du dataset
Format de sortie des données
{
"enum": [
"json",
"csv",
"xml"
],
"default": "json"
}Niveau de détail des données
{
"enum": [
"dataonly"
],
"default": "dataonly"
}Période de début des observations. Sa valeur doit respecter les 6 formats : YYYY-MM-DD, YYYY-W[01-53], YYYY-MM , YYYY-Q[1-4] , YYYY-S[1-2], YYYY
Periode de fin des observations. Sa valeur doit respecter les 6 formats : YYYY-MM-DD, YYYY-W[01-53], YYYY-MM , YYYY-Q[1-4] , YYYY-S[1-2], YYYY
Nombre des observations à récupérer en partant de la plus récente disponible
{
"minimum": 1
}Nombre des observations à récupérer en partant de la plus ancienne disponible
{
"minimum": 1
}Code de la série pour laquelle on récupère les observations
operation complétée
Valeur format incorrect, le dataset est obligatoire'Valeur détail incorrect'Format de la période incorrect'Valeur firstNObservation et/ou Valeur lastNObservation doivent être des nombres entiers
client Id non valide
firstNObservation et lastNObservation ne peuvent pas être combinés dans la même requête
Dataset non trouvé ou le dataset est en cours d'indexation
Erreur interne serveur
Format non implémenté
Request Timeout
Gateway Timeout
/v1/datastructure/{datasetName}
Récupération de la structure d'un dataset
Cet API renvoie le nombre et la liste des dimensions du dataset demandé et optionnellement la liste des codes autorisés pour chaque dimension
Identifiant du dataset
Format de sortie des données
{
"enum": [
"json",
"xml"
],
"default": "json"
}Niveau de détail des données
{
"enum": [
"light",
"full"
],
"default": "full"
}operation complétée
Valeur format incorrect, le dataset est obligatoire'Valeur détail incorrect
client Id non valide
Dataset non trouvé ou le dataset est en cours d'indexation
Erreur interne serveur
Format non implémenté
Request Timeout
Gateway Timeout
Definitions
{
"type": "object",
"properties": {
"datasetName": {
"type": "string",
"example": "EXR"
},
"instanceId": {
"type": "integer",
"example": 248
},
"id": {
"type": "number",
"example": 180
},
"seriesObs": {
"type": "array",
"items": {
"$ref": "#/definitions/ObservationsSerie"
}
}
}
}
{
"type": "object",
"properties": {
"seriesKey": {
"type": "string",
"example": "EXR.M.DKK.EUR.SP00.A"
},
"title": {
"type": "string",
"example": "Couronne danoise (DKK)"
},
"titleCompl": {
"type": "string",
"example": "Cours de change de l'euro contre couronne danoise (DKK) - source BCE (14:15 CET)"
},
"frequency": {
"type": "string",
"example": "M"
},
"periodName": {
"type": "string",
"example": "Nov 2018"
},
"periodID": {
"type": "string",
"example": 2192
},
"periodFirstDate": {
"type": "string",
"example": "01-11-2018 00:00:00"
},
"value": {
"type": "string",
"example": 7.4611
}
}
}
{
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "EXR"
},
"description": {
"type": "string",
"example": "Taux d'intérêt - France"
}
}
}
{
"type": "object",
"properties": {
"seriesKey": {
"type": "string",
"example": "EXR.M.DKK.EUR.SP00.A"
},
"dataset": {
"type": "string",
"example": "EXR"
},
"title": {
"type": "string",
"example": "Couronne danoise (DKK)"
},
"titleCompl": {
"type": "string",
"example": "Cours de change de l'euro contre couronne danoise (DKK) - source BCE (14:15 CET)"
},
"extTitle": {
"type": "string",
"example": "Danish krone (DKK)"
},
"natTitle": {
"type": "string",
"example": "ECB reference exchange rate, Danish krone/Euro, 2:15 pm (C.E.T.)"
},
"sourceAgency": {
"type": "string",
"example": "4F0"
},
"from": {
"type": "string",
"example": "01/01/1999"
},
"to": {
"type": "string",
"example": "01/11/2018"
},
"dimensionsValues": {
"type": "object",
"items": {
"$ref": "#/definitions/DimensionValue"
}
}
}
}
{
"type": "object",
"properties": {
"code": {
"type": "string",
"example": "FREQ"
},
"value": {
"type": "string",
"example": "D"
}
}
}
{
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string",
"example": "EXR"
},
"description": {
"type": "string",
"example": "Taux de change"
},
"hasTitle": {
"type": "boolean",
"example": true
},
"defaultSortDimensionId": {
"type": "number",
"example": 0
},
"defaultSortDimensionOrder": {
"type": "string",
"example": "A"
},
"defaultArea": {
"type": "string",
"example": "REF_AREA"
},
"isoA2": {
"type": "boolean",
"example": true
},
"keyFamily": {
"type": "object",
"items": {
"$ref": "#/definitions/KeyFamilyDescription"
}
}
}
}
{
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"dimensions": {
"type": "array",
"items": {
"$ref": "#/definitions/DimensionDescription"
}
}
}
}
{
"type": "object",
"properties": {
"key": {
"type": "string"
},
"name": {
"type": "string"
},
"position": {
"type": "number"
},
"isFilter": {
"type": "boolean"
},
"dimensionValues": {
"type": "array",
"items": {
"$ref": "#/definitions/DimensionValue"
}
}
}
}