WEBSTAT Data - Banque de France (EN)
Paths
/v1/catalogue
Retrieving the list of datasets
Data output format
{
"enum": [
"json",
"csv",
"xml"
],
"default": "json"
}successful operation
Invalid status value
Internal error
Request Timeout
Gateway Timeout
/v1/catalogue/{datasetName}
Retrieving the list of series from a dataset
Dataset identifier
Data output format
{
"enum": [
"json",
"csv",
"xml"
],
"default": "json"
}successful operation
Invalid status value
Internal error
Request Timeout
Gateway Timeout
/v1/data/{datasetName}
Retrieving the observations from a dataset
This API queries all data from a dataset. Some datasets can contain hundred of thousands observations. In case of error (timeout) or excessive loading time, it will be necessary to restrict the number of observations requested using the different parameters or to use the API used to query series.
Dataset identifier
Data output format
{
"enum": [
"json",
"csv",
"xml"
],
"default": "json"
}Level of detail of data
{
"enum": [
"dataonly"
],
"default": "dataonly"
}Observations start period. Its value must respect one of the 6 formats : YYYY-MM-DD, YYYY-W[01-53], YYYY-MM , YYYY-Q[1-4] , YYYY-S[1-2], YYYY
Observations end period. Its value must respect one of the 6 formats : YYYY-MM-DD, YYYY-W[01-53], YYYY-MM , YYYY-Q[1-4] , YYYY-S[1-2], YYYY
Number of observations to retrieve counting from the most recent one available
{
"minimum": 1
}Number of observations to retrieve counting from the oldest one available
{
"minimum": 1
}successful operation
Format value incorrect, dataset value have to be set'Detail value incorrect'Period format incorrect'FirstNObservation value and/or lastNObservation value must be an integer
Invalid client Id
firstNObservation and lastNObservation cannot be combined in the same query
Dataset not found or the dataset is being indexed
Internal error
Format not available yet
Request Timeout
Gateway Timeout
/v1/data/{datasetName}/{seriesKey}
Retrieving observations from one or several series
The DATA API supports wildcarding by replacing a dimension with *. (For example, /EXR/D.*.EUR.SP00.A will return exchange rates for all available currencies in Euros. Multiples wildcards can be used in a same query.
Dataset identifier
Data output format
{
"enum": [
"json",
"csv",
"xml"
],
"default": "json"
}Level of detail of data
{
"enum": [
"dataonly"
],
"default": "dataonly"
}Observations start period. Its value must respect one of the 6 formats : YYYY-MM-DD, YYYY-W[01-53], YYYY-MM , YYYY-Q[1-4] , YYYY-S[1-2], YYYY
Observations end period. Its value must respect one of the 6 formats : YYYY-MM-DD, YYYY-W[01-53], YYYY-MM , YYYY-Q[1-4] , YYYY-S[1-2], YYYY
Number of observations to retrieve counting from the most recent one available
{
"minimum": 1
}Number of observations to retrieve counting from the oldest one available
{
"minimum": 1
}Code of the data series for which observations are retrieved
successful operation
Format value incorrect, dataset value have to be set'Detail value incorrect'Period format incorrect'FirstNObservation value and/or lastNObservation value must be an integer
Invalid client Id
firstNObservation and lastNObservation cannot be combined in the same query
Dataset not found or the dataset is being indexed
Internal error
Format not available yet
Request Timeout
Gateway Timeout
/v1/datastructure/{datasetName}
Retrieving the dataset structure
This API returns the number and list of dimensions of the requested dataset and optionally the list of all allowed codes for each dimension
Dataset identifier
Data output format
{
"enum": [
"json",
"xml"
],
"default": "json"
}Level of detail of data
{
"enum": [
"light",
"full"
],
"default": "full"
}successful operation
Format value incorrect, dataset value have to be set 'Inccorect detail
Invalid client Id
Dataset not found or the dataset is being indexed
Internal error
Format not available yet
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": "Danish krone (DKK)"
},
"titleCompl": {
"type": "string",
"example": "ECB reference exchange rate, Danish krone/Euro, 2:15 pm (C.E.T.)"
},
"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": "Exchange Rates"
}
}
}
{
"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": "Exchange Rates"
},
"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"
}
}
}
}