Banque de France’s API

Data - BDF

Author

François Geerolf

Info

source dataset .html .RData

bdf

api

 2024-06-23 NA

List of APIs

source dataset .html .RData

bdf

api

 2024-06-23 NA

bea

api

 2024-06-19 NA

bis

api

 2024-04-19 NA

bls

api

 2024-06-17 NA

ecb

api

 2024-06-19 NA

eurostat

api

 2024-06-08 NA

imf

api

 2024-06-20 NA

insee

api

 2024-06-18 NA

oecd

api

 2024-05-07 2024-04-16

rdb

api

 NA NA

wdi

api

 2024-04-14 NA

LAST_COMPILE

LAST_COMPILE
2024-06-30

Info

https://developer.webstat.banque-france.fr/product/7553/api/4304#/WEBSTATBanquedeFranceFRV1_100_4701/operation/%2Fv1%2Fdata%2F{datasetName}%2F{seriesKey}/get

https://api.webstat.banque-france.fr/webstat-fr/v1/data/REPLACE_DATASETNAME?format=json&detail=dataonly&startPeriod=REPLACE_THIS_VALUE&endPeriod=REPLACE_THIS_VALUE&lastNObservations=REPLACE_THIS_VALUE&firstNObservations=REPLACE_THIS_VALUE

https://api.webstat.banque-france.fr/webstat-fr/v1/data/REPLACE_DATASETNAME/REPLACE_SERIESKEY?format=json&detail=dataonly&startPeriod=REPLACE_THIS_VALUE&endPeriod=REPLACE_THIS_VALUE&lastNObservations=REPLACE_THIS_VALUE&firstNObservations=REPLACE_THIS_VALUE

Exemple: RPP

Datastructure

Code 
RPP_datastructure <- "RPP" %>%
  paste0("https://api.webstat.banque-france.fr/webstat-en/v1/datastructure/", .) %>%
  paste0(., "?client_id=", webstat_client_ID, "&format=json&detail=full") %>%
  httr::GET() %>%
  httr::content(., "text") %>%
  jsonlite::fromJSON() %>%
  pluck("keyFamily", "dimensions", "DimensionDescription")

RPP_datastructure %>%
  select(1:3) %>%
  print_table_conditional()
key name position
FREQ Frequency 1
REF_AREA Reference area - ISO2 2
ADJUSTMENT Adjustment 3
RPP_DWELLING Type of residential property 4
RPP_GEO_COV Geographical coverage 5
RPP_SOURCE RPP source 6
RPP_SUFFIX Series variation -RPP context 7

Catalogue

Code 
RPP_catalogue <- paste0("https://api.webstat.banque-france.fr/webstat-fr/v1/catalogue/RPP?format=json&client_id=", webstat_client_ID) %>%
  httr::GET() %>%
  httr::content(., "text") %>%
  jsonlite::fromJSON()

RPP_catalogue %>%
  print_table_conditional()
seriesKey dataset title titleCompl extTitle natTitle sourceAgency from to dimensionsValues
RPP.Q.FR.N.ED.00.1.00 RPP Indices des prix des logements anciens, Ensemble des logements, France métropolitaine Indice des prix des logements anciens - France métropolitaine - Ensemble - Base 100 en moyenne annuelle 2015 - Série brute Price index in existing dwellings, all dwellings, France (na) Price index of second-hand dwellings - Metropolitan France - All items - Base 100 = annual average of year 2015 - Raw series FR2 01/01/1996 01/07/2023 FREQ , REF_AREA , ADJUSTMENT , RPP_DWELLING, RPP_GEO_COV , RPP_SOURCE , RPP_SUFFIX , Q , FR , N , ED , 00 , 1 , 00
RPP.Q.FR.N.EF.CC.1.00 RPP Indices des prix des logements anciens, Appartements, Paris Indice des prix des logements anciens - Paris - Appartements - Base 100 en moyenne annuelle 2015 - Série brute Price index in existing flats, Paris (na) Price index of second-hand dwellings - Paris - Flats - Base 100 = annual average of year 2015 - Raw series FR2 01/01/1992 01/07/2023 FREQ , REF_AREA , ADJUSTMENT , RPP_DWELLING, RPP_GEO_COV , RPP_SOURCE , RPP_SUFFIX , Q , FR , N , EF , CC , 1 , 00
RPP.Q.FR.N.EF.CS.1.00 RPP Indices des prix des logements anciens, Appartements, Ile de France Petite Couronne Indice des prix des logements anciens - ??le-de-France : Petite couronne - Appartements - Base 100 en moyenne annuelle 2015 - Série brute Price index in existing flats, Paris with suburbs (na) Price index of second-hand dwellings - ??le-de-France: Inner suburbs - Flats - Base 100 = annual average of year 2015 - Raw series FR2 01/01/1992 01/07/2023 FREQ , REF_AREA , ADJUSTMENT , RPP_DWELLING, RPP_GEO_COV , RPP_SOURCE , RPP_SUFFIX , Q , FR , N , EF , CS , 1 , 00
RPP.Q.FR.N.NF.00.1.00 RPP Prix au mètre carré des appartements neufs, France entière Prix au mètre carré des appartements neufs, France entière Price of new flats, France (na) Price of new flats, France (non adjusted) FR2 01/01/1995 01/10/2023 FREQ , REF_AREA , ADJUSTMENT , RPP_DWELLING, RPP_GEO_COV , RPP_SOURCE , RPP_SUFFIX , Q , FR , N , NF , 00 , 1 , 00
RPP.Q.FR.N.NF.CR.1.00 RPP Prix au mètre carré des appartements neufs, Ile de France Prix au mètre carré des appartements neufs, Ile de France Price of new houses, per dwelling, France (na) Price of new houses, per dwelling, France (non adjusted) FR2 01/01/2005 01/10/2023 FREQ , REF_AREA , ADJUSTMENT , RPP_DWELLING, RPP_GEO_COV , RPP_SOURCE , RPP_SUFFIX , Q , FR , N , NF , CR , 1 , 00
RPP.Q.FR.N.NH.00.1.00 RPP Prix de vente moyen d'une maison neuve, France entière Prix de vente moyen d'une maison neuve, France entière Price of new flats, Paris region (na) Price of new flats, Paris region (non adjusted) FR2 01/01/1995 01/10/2023 FREQ , REF_AREA , ADJUSTMENT , RPP_DWELLING, RPP_GEO_COV , RPP_SOURCE , RPP_SUFFIX , Q , FR , N , NH , 00 , 1 , 00
RPP.Q.FR.N.NH.CR.1.00 RPP Prix de vente moyen d'une maison neuve, Ile de France Prix de vente moyen d'une maison neuve, Ile de France Price of new houses, per dwelling, Paris region (na) Price of new houses, per dwelling, Paris region (non adjusted) FR2 01/01/2005 01/10/2023 FREQ , REF_AREA , ADJUSTMENT , RPP_DWELLING, RPP_GEO_COV , RPP_SOURCE , RPP_SUFFIX , Q , FR , N , NH , CR , 1 , 00

Data

Code 
RPP_data <- paste0("https://api.webstat.banque-france.fr/webstat-fr/v1/data/RPP?format=json&client_id=", webstat_client_ID) %>%
    httr::GET() %>%
  httr::content(., "text") %>%
  jsonlite::fromJSON() %>%
         pluck("seriesObs") %>%
         pluck("ObservationsSerie") %>%
         unnest %>%
         unnest

RPP_data %>%
  print_table_conditional()
Code 
RPP_data2 <- paste0("https://api.webstat.banque-france.fr/webstat-fr/v1/data/RPP/RPP.Q.FR.N.ED.00.1.00?format=json&client_id=", webstat_client_ID) %>%
    httr::GET() %>%
  httr::content(., "text") %>%
  jsonlite::fromJSON() %>%
         pluck("seriesObs") %>%
         pluck("ObservationsSerie") %>%
         unnest %>%
         unnest %>%
         mutate(date = as.POSIXlt(periodFirstDate, format = "%d-%m-%Y %H:%M:%S"),
                date = as.Date(date))

RPP_data2 %>%
  print_table_conditional()
Code 
RPP_data3 <- paste0("https://api.webstat.banque-france.fr/webstat-fr/v1/data/RPP/RPP.Q.FR.N.ED.00.1.00+RPP.Q.FR.N.EF.CC.1.00?format=json&client_id=", webstat_client_ID) %>%
    httr::GET() %>%
  httr::content(., "text") %>%
  jsonlite::fromJSON() %>%
         pluck("seriesObs") %>%
         pluck("ObservationsSerie") %>%
         unnest %>%
         unnest %>%
         mutate(date = as.POSIXlt(periodFirstDate, format = "%d-%m-%Y %H:%M:%S"),
                date = as.Date(date))

Example 1

All

Code 
paste0("https://api.webstat.banque-france.fr/webstat-fr/v1/data/RPP/",
       "RPP.Q.FR.N.ED.00.1.00+RPP.Q.FR.N.EF.CC.1.00?format=json&client_id=",
       webstat_client_ID) %>%
  httr::GET() %>%
  httr::content(., "text") %>%
  jsonlite::fromJSON() %>%
  pluck("seriesObs") %>%
  pluck("ObservationsSerie") %>%
  unnest %>%
  unnest %>%
  mutate(date = as.POSIXlt(periodFirstDate, format = "%d-%m-%Y %H:%M:%S"),
         date = as.Date(date)) %>%
  group_by(title) %>%
  mutate(value = 100*value/value[date == as.Date("2008-01-01")]) %>%
  ggplot + geom_line(aes(x = date, y = value, color = title)) +
  theme_minimal()  + xlab("") + ylab("Indice des prix des logements anciens") +
  scale_x_date(breaks = as.Date(paste0(seq(1960, 2030, 2), "-01-01")),
               labels = date_format("%Y")) +
  theme(legend.position = c(0.4, 0.93),
        legend.title = element_blank()) +
  scale_y_log10(breaks = seq(0, 7000, 10))

2008-

Code 
paste0("https://api.webstat.banque-france.fr/webstat-fr/v1/data/RPP/",
       "RPP.Q.FR.N.ED.00.1.00+RPP.Q.FR.N.EF.CC.1.00?format=json&client_id=",
       webstat_client_ID) %>%
  httr::GET() %>%
  httr::content(., "text") %>%
  jsonlite::fromJSON() %>%
  pluck("seriesObs") %>%
  pluck("ObservationsSerie") %>%
  unnest %>%
  unnest %>%
  mutate(date = as.POSIXlt(periodFirstDate, format = "%d-%m-%Y %H:%M:%S"),
         date = as.Date(date)) %>%
  filter(date >= as.Date("2008-01-01")) %>%
  group_by(title) %>%
  mutate(value = 100*value/value[date == as.Date("2008-01-01")]) %>%
  ggplot + geom_line(aes(x = date, y = value, color = title)) +
  theme_minimal()  + xlab("") + ylab("Indice des prix des logements anciens") +
  scale_x_date(breaks = as.Date(paste0(seq(1960, 2030, 2), "-01-01")),
               labels = date_format("%Y")) +
  theme(legend.position = c(0.4, 0.93),
        legend.title = element_blank()) +
  scale_y_log10(breaks = seq(0, 7000, 10))

Datastructure

Information

  • Package rwebstat not maintained. html
  • Archived on 2023-04-07 for policy violation.

https://developer.webstat.banque-france.fr/node/295

Example

BSI1.M.FR.Y.R.A220Z.A.4.U6.2254FR.Z01.E

Catalogue

FM

Code 
"https://api.webstat.banque-france.fr/webstat-fr/v1/catalogue/FM?format=json&client_id=627e7c99-888f-46dd-902d-1161ee501a21" %>%
    httr::GET() %>%
  httr::content(., "text") %>%
  jsonlite::fromJSON() %>%
  print_table_conditional()

RPP

Code 
RPP_catalogue <- "https://api.webstat.banque-france.fr/webstat-fr/v1/catalogue/RPP?format=json&client_id=627e7c99-888f-46dd-902d-1161ee501a21" %>%
    httr::GET() %>%
  httr::content(., "text") %>%
  jsonlite::fromJSON()

RPP_catalogue %>%
  print_table_conditional()
seriesKey dataset title titleCompl extTitle natTitle sourceAgency from to dimensionsValues
RPP.Q.FR.N.ED.00.1.00 RPP Indices des prix des logements anciens, Ensemble des logements, France métropolitaine Indice des prix des logements anciens - France métropolitaine - Ensemble - Base 100 en moyenne annuelle 2015 - Série brute Price index in existing dwellings, all dwellings, France (na) Price index of second-hand dwellings - Metropolitan France - All items - Base 100 = annual average of year 2015 - Raw series FR2 01/01/1996 01/07/2023 FREQ , REF_AREA , ADJUSTMENT , RPP_DWELLING, RPP_GEO_COV , RPP_SOURCE , RPP_SUFFIX , Q , FR , N , ED , 00 , 1 , 00
RPP.Q.FR.N.EF.CC.1.00 RPP Indices des prix des logements anciens, Appartements, Paris Indice des prix des logements anciens - Paris - Appartements - Base 100 en moyenne annuelle 2015 - Série brute Price index in existing flats, Paris (na) Price index of second-hand dwellings - Paris - Flats - Base 100 = annual average of year 2015 - Raw series FR2 01/01/1992 01/07/2023 FREQ , REF_AREA , ADJUSTMENT , RPP_DWELLING, RPP_GEO_COV , RPP_SOURCE , RPP_SUFFIX , Q , FR , N , EF , CC , 1 , 00
RPP.Q.FR.N.EF.CS.1.00 RPP Indices des prix des logements anciens, Appartements, Ile de France Petite Couronne Indice des prix des logements anciens - ??le-de-France : Petite couronne - Appartements - Base 100 en moyenne annuelle 2015 - Série brute Price index in existing flats, Paris with suburbs (na) Price index of second-hand dwellings - ??le-de-France: Inner suburbs - Flats - Base 100 = annual average of year 2015 - Raw series FR2 01/01/1992 01/07/2023 FREQ , REF_AREA , ADJUSTMENT , RPP_DWELLING, RPP_GEO_COV , RPP_SOURCE , RPP_SUFFIX , Q , FR , N , EF , CS , 1 , 00
RPP.Q.FR.N.NF.00.1.00 RPP Prix au mètre carré des appartements neufs, France entière Prix au mètre carré des appartements neufs, France entière Price of new flats, France (na) Price of new flats, France (non adjusted) FR2 01/01/1995 01/10/2023 FREQ , REF_AREA , ADJUSTMENT , RPP_DWELLING, RPP_GEO_COV , RPP_SOURCE , RPP_SUFFIX , Q , FR , N , NF , 00 , 1 , 00
RPP.Q.FR.N.NF.CR.1.00 RPP Prix au mètre carré des appartements neufs, Ile de France Prix au mètre carré des appartements neufs, Ile de France Price of new houses, per dwelling, France (na) Price of new houses, per dwelling, France (non adjusted) FR2 01/01/2005 01/10/2023 FREQ , REF_AREA , ADJUSTMENT , RPP_DWELLING, RPP_GEO_COV , RPP_SOURCE , RPP_SUFFIX , Q , FR , N , NF , CR , 1 , 00
RPP.Q.FR.N.NH.00.1.00 RPP Prix de vente moyen d'une maison neuve, France entière Prix de vente moyen d'une maison neuve, France entière Price of new flats, Paris region (na) Price of new flats, Paris region (non adjusted) FR2 01/01/1995 01/10/2023 FREQ , REF_AREA , ADJUSTMENT , RPP_DWELLING, RPP_GEO_COV , RPP_SOURCE , RPP_SUFFIX , Q , FR , N , NH , 00 , 1 , 00
RPP.Q.FR.N.NH.CR.1.00 RPP Prix de vente moyen d'une maison neuve, Ile de France Prix de vente moyen d'une maison neuve, Ile de France Price of new houses, per dwelling, Paris region (na) Price of new houses, per dwelling, Paris region (non adjusted) FR2 01/01/2005 01/10/2023 FREQ , REF_AREA , ADJUSTMENT , RPP_DWELLING, RPP_GEO_COV , RPP_SOURCE , RPP_SUFFIX , Q , FR , N , NH , CR , 1 , 00

New

Code 
"https://webstat.banque-france.fr/ws_wsfr/ng/exportApi/file?node=5384670&DATASET=BSI1&DATASET=MIR1&periodSortOrder=DESC&SERIES_KEY=BSI1.M.FR.Y.R.A220Z.A.4.U6.2254FR.Z01.E&exportType=sdmx" %>%
  httr::GET() %>%
  httr::content(., "text") %>%
  XML::xmlToDataFrame()
#           ID  Test             Prepared
# 1 IREF000001 false 2024-06-30T22:36:19Z
# 2       <NA>  <NA>                 <NA>
#                                                                            Sender
# 1 Banque de FranceStatistiques et Enquêtesmailto:support.webstat@banque-france.fr
# 2                                                                            <NA>
#              Extracted Group Series
# 1 2024-06-30T22:36:19Z  <NA>   <NA>
# 2                 <NA>

BSI1

Datastructure

Code 
BSI1_datastructure <- "BSI1" %>%
  paste0("https://api.webstat.banque-france.fr/webstat-en/v1/datastructure/", .) %>%
  paste0(., "?client_id=", webstat_client_ID, "&format=json&detail=full") %>%
  httr::GET() %>%
  httr::content(., "text") %>%
  jsonlite::fromJSON() %>%
  pluck("keyFamily", "dimensions", "DimensionDescription")

BSI1_datastructure %>%
  select(1:3) %>%
  print_table_conditional()
key name position
FREQ Frequency 1
REF_AREA Reference area - ISO2 2
ADJUSTMENT Adjustment 3
BS_REP_SECTOR Reference sector breakdown 4
BS_ITEM Balance sheet item 5
MATURITY_ORIG Maturity origin 6
DATA_TYPE Data type 7
COUNT_AREA Counterpart area 8
BS_COUNT_SECTOR Counterpart sector 9
CURRENCY_TRANS Currency of transaction 10
BS_SUFFIX Balance sheet suffix 11

https://api.webstat.banque-france.fr/webstat-fr/v1/data/DIREN?format=json&detail=dataonly&