Webservice-Schnittstelle Daten
Bundesbank SDMX Web Service API
Alle in der Bundesbank-Zeitreihendatenbank gespeicherten Daten können mit der unten beschriebenen Abfragezeichenfolge abgerufen werden.
-
Beschreibung: Der Endpunkt gibt Zeitreihen aus dem angegebenen Dataflow (z.B. BBEX3) mit dem angegebenen Schlüssel (z.B. A.AED.DEM.CA.AA.A04) zurück.
Protokoll https Pfad /data/{flowRef}/{key} Basispfad https://api.statistiken.bundesbank.de/rest Rückgabeformat - BBK-CSV
- SDMX-CSV
- SDMX-ML 2.1
- SDMX-JSON
Parameter
Name Beschreibung Beispiel flowRef DSI (Data Set Identifier), ein Verweis auf den Dataflow. BBEX3
BBK01
key Abruf der Daten eines Zeitreihenschlüssels.
Die Kombination der Dimensionen erlaubt es, statistische Daten eindeutig zu identifizieren. Eine solche Kombination wird als Zeitreihenschlüssel bezeichnet.
Ausnahme: Der Zeitreihenschlüssel bei BBK01 besteht genau aus einer Dimension.
Wildcarding wird unterstützt.
SDMX-Zeitreihenschlüssel: D.USD.EUR.BB.AC.000
BBK01-Zeitreihenschlüssel:
ST0304
Wildcarding spezifisch für SDMX-Zeitreihenschlüssel
Durch Auslassen einer der Schlüsselkomponenten soll für die entsprechende Dimension eine Wildcard gesetzt werden, d.h., es sollen alle Zeitreihen zurückgegeben werden, die mit dem Rest des Zeitreihenschlüssels übereinstimmen.
Beispielsweise können mit dem folgenden Zeitreihenschlüssel die Daten für alle täglichen Währungen gegen den Euro abgerufen werden: D..EUR.BB.AC.000
Es soll auch möglich sein, in einer Anfrage mehrere Wildcards zu setzen.
Wildcarding spezifisch für BBK01
Der Zeitreihenschlüssel bei BBK01 besteht genau aus einer Dimension.
Das Platzhalterzeichen * soll 0-N beliebige Zeichen symbolisieren. Das Platzhalterzeichen kann an jeder Position im Wort (auch am Anfang) verwendet werden.
Die Angabe von mehreren *-Angaben ist zulässig.
Eine Voraussetzung ist, dass in der Dimension min. ein nicht Platzhalterzeichen angegeben werden muss. Zum Beispiel: W* (gefunden werden alle Zeitreihen die mit W beginnen).
Wildcarding – ODER-Operator
Zusätzlich zum Wildcarding unterstützt der Endpunkt /data für den Pfadparameter key auch den ODER-Operator. Der ODER-Operator wird durch das Zeichen „+“ dargestellt.
Bei den SDMX-Zeitreihen kann man durch die Verwendung des ODER-Operators innerhalb einer Schlüsselkomponente mehrere Angaben machen. Es werden alle Zeitreihen zurückgegeben, die eine dieser angegebenen Schlüsselkomponenten enthält.
Bei den BBK01 Zeitreihen wird der Zeitreihenschlüssel wie eine Schlüsselkomponente behandelt.
Beispiel für SDMX-Zeitreihenschlüssel:
Request
api.statistiken.bundesbank.de/rest/data/BBEX3/M.ISK.EUR+USD.CA.AC.A01
zurückgegebene Zeitreihen:
BBEX3.M.ISK.EUR.CA.AC.A01 und BBEX3.M.ISK.USD.CA.AC.A01
Beispiel für BBK01:
Request
api.statistiken.bundesbank.de/rest/data/BBK01/TTA032+TTA010
zurückgegebene Zeitreihen:
BBK01.TTA032 und BBK01.TTA010
Rückgabeformat-Parameter
Mit dem „format“-Parameter ist es möglich, den Webdienst anzuweisen, Daten in verschiedenen Formaten zurückzugeben. Wenn kein "format"-Parameter angegeben ist, wird beim Rückgabeformat der Eintrag "Accept-Header“ berücksichtigt.
Der "format"-Parameter hat Vorrang gegenüber dem "Accept-Header".
Rückgabetyp Parameterwert Media type BBK-CSV bbk_csv
zip
application/vnd.bbk.data+csv
application/vnd.bbk.data+csv-zip
SDMX-CSV csv
text_csv
application/vnd.sdmx.data+csv
text/csv
SDMX-ML 2.1 xml
application_xml
text_xml
application/vnd.sdmx.genericdata+xml
application/xml
text/xml
SDMX-JSON application_json
json
application/json
application/vnd.sdmx.data+json
Abfrageparameter
Über Abfrageparameter kann die Antwort des Webservice näher spezifiziert oder eingeschränkt werden. Alle Parameter sind optional.
Abfrageparameter Beschreibung startPeriod
endPeriod
Mit der Übergabe eines Datumsbereichs mit dem Abfrageparameter „startPeriod“/“endPeriod“ ist es möglich den Zeitraum der Beobachtungen einzugrenzen. Die unterstützten Formate sind:
YYYY für Jahresdaten (z. B. 2019)
YYYY-S[1-2] für halbjährliche Daten (z.B. 2019-S1)
YYYY-Q [1-4] für vierteljährliche Daten (z. B. 2019-Q1)
YYYY-MM für monatliche Daten (z. B. 2019-01)
YYYY-W[01-53] für wöchentliche Daten (z.B. 2019-W01)
YYYY-MM-DD für Tages- und Geschäftsdaten (z. B. 2019-01-01)
detail Mit dem „detail“-Parameter ist es möglich, die gewünschte Menge an Informationen anzugeben, die vom Webservice zurückgegeben werden soll. Mögliche Optionen sind:
full: Alle Datenwerte und die Attribute werden zurückgegeben. Dies ist die Voreinstellung „default“.
Beispiel:
https://api.statistiken.bundesbank.de/rest/data/BBEX3/D.USD.EUR.BB.AC.000?detail=fulldataonly: Nur Datenwerte werden zurückgegeben, ohne Attribute.
Beispiel:
https://api.statistiken.bundesbank.de/rest/data/BBEX3/D.USD.EUR.BB.AC.000?detail=dataonlyserieskeyonly: Zeitreihenschlüssel, ohne Attribute und Datenwerte.
Bespiel:
https://api.statistiken.bundesbank.de/rest/data/BBEX3/D.USD.EUR.BB.AC.000?detail=serieskeyonlynodata: Zeitreihenschlüssel, einschließlich der Attribute, aber ohne Datenwerte.
Beispiel:
https://api.statistiken.bundesbank.de/rest/data/BBEX3/D.USD.EUR.BB.AC.000?detail=nodatafirstNObservations Der firstNObservations Parameter ermöglicht es, die Maximalanzahl der zurückzugebenden Beobachtungen für jede angefragte Zeitreihe zu spezifizieren, beginnend mit der ersten Beobachtung.
lastNObservations Der lastNObservations Parameter ermöglicht es, die Maximalanzahl der zurückzugebenden Beobachtungen für jede angefragte Zeitreihe zu spezifizieren, absteigend von der letzten Beobachtung aus.
Kombination der Abfrageparameter
In der folgenden Tabelle werden die erlaubten Parameterkombinationen gezeigt:
startPeriod – endPeriod – firstNObservations – lastNObservations
Zeitreihe mit den N ersten Observations aus dem angegebenen Zeitraum (Startdatum-Enddatum).
Zeitreihe mit den N letzten Observations aus dem angegebenen Zeitraum (bis Enddatum).
Zeitreihe mit den N letzten Observations aus dem angegebenen Zeitraum (Startdatum-Enddatum).
Zeitreihe mit den N ersten Observations aus dem angegebenen Zeitraum (ab Startdatum).
Zeitreihe aus dem angegebenen Zeitraum (Startdatum-Enddatum).
Zeitreihe mit den N1 ersten Observations und N2 letzten Observations. Bei Überschneidung, alle Observations innerhalb des angegebenen Zeitraums.
Rückgabeformat
Rückgabetyp Media type / Accept-Header Beschreibung BBK-CSV application/vnd.bbk.data+csv
application/vnd.bbk.data+csv-zip
Beim Rückgabetyp „bbk.data+csv“ dürfen max. 200 Zeitreihen einer Periodizität abgerufen werden, sonst folgt eine Fehlermeldung.
Sollen mehr als 200 Zeitreihen oder Zeitreihen mit unterschiedlicher Periodizität im CSV-Format abgerufen werden, muss der Rückgabetyp „bbk.data+csv-zip“ gewählt werden. Es wird anschließend genau eine ZIP-Datei zurückgegeben, deren Inhalt aus mehreren CSV-Dateien besteht.
Wenn durch eine Anfrage Zeitreihen verschiedener Periodizitäten angefragt wurden, werden die Zeitreihen je Periodizität in mehrere CSVs geschrieben, die in dem ZIP zurückgeliefert werden.
Bei verschiedenen Periodizitäten gibt es pro Periodizität eine eigene Laufnummer.
Dateiname-ZIP: flowRef.(Key oder WildcardingKey)_CSV.ZIPBeispiel:
BBDE1.M...ACP.._CSV.ZIP
CSV-Dateinamen: flowRef.Periodizität(laufende Nummer).csv
Beispiel:
BBDE1.M(01).csv
BBDE1.M(02).csv
BBDE1.A(01).csv
BBDE1.Q(01).csv
BBDE1.Q(02).csv
BBDE1.Q(03).csvSDMX-CSV application/vnd.sdmx.data+csv
text/csv
Das SDMX-CSV-Format entspricht der RFC 4180-Standardspezifikation und unterstützt das SDMX 2.1 - Informationsmodell. SDMX-ML 2.1 application/vnd.sdmx.genericdata+xml
application/xml
text/xml
Beim Rückgabetyp "sdmx.genericdata+xml" können Zeitreihen mit verschiedenen Periodizitäten abgerufen werden. SDMX-JSON application/vnd.sdmx.daa+json
application/json
SDMX-JSON entspricht der JSON-Standardspezifikation und unterstützt das SDMX 2.1-Informationsmodell. Rückgabesprache
Die Sprachrückgabe ist abhängig von der Angabe im „header“:
Sprachangabe Beschreibung „de“ bzw. Varianten
davon (z.B. „de-DE“)Es werden nur deutsche Attribute zurückgegeben. Bei fehlenden deutschen Attributen wird als Fallback die englische Entsprechung verwendet. „en“ bzw. Varianten
davon (z.B. „en-US“)Es werden nur englische Attribute zurückgegeben. Bei fehlenden englischen Attributen wird als Fallback die deutsche Entsprechung verwendet. Keine Angabe für Language Header
oder andere LanguageEs wird das vollständige Dokument zurückgegeben. -
Beschreibung: Der Endpunkt gibt alle Zeitreihen zurück, die mit der angegebenen Liste von Zeitreihenschlüsseln gefunden werden (z.B. ["BBEX3.M.DKK.EUR.BB.AC.A01", "BBEX3.M.DKK.EUR.BB.AC.A02"]) zurück. Bei diesem Endpunkt erfolgt die Anfrage über die Methode POST.
Protokoll
https
Pfad
/data/tsIdList
Basispfad
https://api.statistiken.bundesbank.de/rest
Rückgabeformat
application/bbk-csv+zip
Request body
[
"BBEX3.M.DKK.EUR.BB.AC.A01",
"BBEX3.M.DKK.EUR.BB.AC.A02",
"BBEX3.M.DKK.EUR.BB.AC.A03"
]
Zu beachten: Das Abrufen aller Daten ist abhängig von der Größe des Datenflusses und kann viel Zeit in Anspruch nehmen.
Beispiel: POST https://api.statistiken.bundesbank.de/rest/data/tsIdList
accept: application/bbk-csv+zip
Content-Type: application/json
[
"BBEX3.M.DKK.EUR.BB.AC.A01",
"BBEX3.M.DKK.EUR.BB.AC.A02",
"BBEX3.M.DKK.EUR.BB.AC.A03"
]
-
Beschreibung: Der Endpunkt gibt alle Zeitreihen aus dem angegebenen Dataflow (z.B. BBEX3) zurück.
Protokoll https Pfad /data/{flowRef} Basispfad https://api.statistiken.bundesbank.de/rest Rückgabeformat - application/vnd.sdmx.genericdata+xml;version=2.1
- application/xml
- text/xml
- application/vnd.bbk.data+csv;version=1.0.0
- application/vnd.bbk.data+csv-zip;version=1.0.0
- text/csv
Zu beachten: Das Abrufen aller Daten ist abhängig von der Größe des Datenflusses und kann viel Zeit in Anspruch nehmen.
Beispiel: https://api.statistiken.bundesbank.de/rest/data/BBDE1
Rückgabeformat-Parameter
Mit dem „format“-Parameter ist es möglich, den Webdienst anzuweisen, Daten in verschiedenen Formaten zurückzugeben. Wenn kein "format"-Parameter angegeben ist, wird beim Rückgabeformat der Eintrag "Accept-Header“ berücksichtigt.
Der "format"-Parameter hat Vorrang gegenüber dem "Accept-Header".
Rückgabetyp Parameterwert Media type BBK-CSV bbk_csv
zip
application/vnd.bbk.data+csv
application/vnd.bbk.data+csv-zip
SDMX-CSV text_csv text/csv SDMX-ML 2.1 xml
application_xml
text_xml
application/vnd.sdmx.genericdata+xml
application/xml
text/xml
Rückgabeformat
Rückgabetyp Beschreibung data+csv und
data+csv-zipBeim Rückgabetyp „data+csv“ dürfen max. 200 Zeitreihen einer Periodizität abgerufen werden, sonst folgt eine Fehlermeldung.
Sollen mehr als 200 Zeitreihen oder Zeitreihen mit unterschiedlicher Periodizität im CSV-Format abgerufen werden, muss der Rückgabetyp „data+csv-zip“ gewählt werden. Es wird anschließend genau eine ZIP-Datei zurückgegeben, deren Inhalt aus mehreren CSV-Dateien besteht.
Wenn durch eine Anfrage Zeitreihen verschiedener Periodizitäten angefragt wurden, werden die Zeitreihen je Periodizität in mehrere CSVs geschrieben, die in dem ZIP zurückgeliefert werden.
Bei verschiedenen Periodizitäten gibt es pro Periodizität eine eigene Laufnummer.
Dateiname-ZIP: flowRef_CSV.ZIP
Beispiel:
BBDE1_CSV.ZIP
CSV-Dateinamen: flowRef.Periodizität(laufende Nummer).csv
Beispiel:
BBDE1.M(01).csv
BBDE1.M(02).csv
BBDE1.A(01).csv
BBDE1.Q(01).csv
BBDE1.Q(02).csv
BBDE1.Q(03).csvgenericdata+xml Beim Rückgabetyp „genericdata+xml“ können Zeitreihen mit verschiedenen Periodizitäten abgerufen werden.
Rückgabesprache
Die Sprachrückgabe ist abhängig von der Angabe im „header“:
Sprachangabe Beschreibung „de“ bzw. Varianten
davon (z.B. „de-DE“)Es werden nur deutsche Attribute zurückgegeben. Bei fehlenden deutschen Attributen wird als Fallback die englische Entsprechung verwendet. „en“ bzw. Varianten
davon (z.B. „en-US“)Es werden nur englische Attribute zurückgegeben. Bei fehlenden englischen Attributen wird als Fallback die deutsche Entsprechung verwendet. Keine Angabe für Language Header
oder andere LanguageEs wird das vollständige Dokument zurückgegeben.