Web service interface: Metadata
Bundesbank SDMX Web Service API
All the metadata stored in the Bundesbank time series database can be retrieved using the query string described below.
-
Description: The endpoint returns the specified data structure (e.g. BBK_ERX).
Protocol https Path /metadata/datastructure/BBK/{resourceID} Base path https://api.statistiken.bundesbank.de/rest Return format application/vnd.sdmx.structure+xml;version=2.1
application/xml
text/xml
Parameters
Name Description Example resourceID The ID of the requested data structure. BBK_QFS Example: https://api.statistiken.bundesbank.de/rest/metadata/datastructure/BBK/BBK_QFS
Return format parameter
With the "format" parameter, it is possible to instruct the web service to return data in various formats. If no "format" parameter is specified, the return format will consider the entry "Accept-Header".
The "format" parameter takes precedence over the "Accept-Header".
Return type Parameter value Media type SDMX-ML 2.1 struct_xml
application_xml
text_xml
application/vnd.sdmx.structure+xml
application/xml
text/xml
Query Parameters
Name Description detail The “detail” parameter can be used to narrow down the desired amount of information.
full: All available information is returned. This is the default setting.
Example:
https://api.statistiken.bundesbank.de/rest/metadata/datastructure/BBK/BBK_QFS?detail=fullallstubs: All artefacts are returned as stubs.
Example:
https://api.statistiken.bundesbank.de/rest/metadata/datastructure/BBK/BBK_QFS?detail=allstubsreferencestubs: The referenced artefacts are returned as stubs.
Example:
https://api.statistiken.bundesbank.de/rest/metadata/datastructure/BBK/BBK_QFS?detail=referencestubsreferences Using the “references” parameter, the web service can also be instructed to return the artefacts referenced by the requested data structure (code lists and concept schemes). The artefacts that refer to the requested data structure (dataflows) can also be retrieved.
none: No references are returned. This is the default value.
Example:
https://api.statistiken.bundesbank.de/rest/metadata/datastructure/BBK/BBK_QFS?references=noneparents: The dataflow is returned.
Example:
https://api.statistiken.bundesbank.de/rest/metadata/datastructure/BBK/BBK_QFS?references=parentschildren: The artefacts to which the data structure refers are returned.
Example:
https://api.statistiken.bundesbank.de/rest/metadata/datastructure/BBK/BBK_QFS?references=childrendescendants: All references, up to each level, are also returned.
Example:
https://api.statistiken.bundesbank.de/rest/metadata/datastructure/BBK/BBK_QFS?references=descendantsall: The total amount of metadata.
Example:
https://api.statistiken.bundesbank.de/rest/metadata/datastructure/BBK/BBK_QFS?references=allcodelist: The code lists to which the data structure refers are returned.
Example:
https://api.statistiken.bundesbank.de/rest/metadata/datastructure/BBK/BBK_QFS?references=codelistconceptscheme: The concept schemes to which the data structure refers are returned.
-
Description: The endpoint returns all data structures.
Protocol https Path /metadata/datastructure/BBK Base path https://api.statistiken.bundesbank.de/rest Return format application/vnd.sdmx.structure+xml;version=2.1
application/xml
text/xml
Example: https://api.statistiken.bundesbank.de/rest/metadata/datastructure/BBK
Return format parameter
With the "format" parameter, it is possible to instruct the web service to return data in various formats. If no "format" parameter is specified, the return format will consider the entry "Accept-Header".
The "format" parameter takes precedence over the "Accept-Header".
Return type Parameter value Media type SDMX-ML 2.1 struct_xml
application_xml
text_xml
application/vnd.sdmx.structure+xml
application/xml
text/xml
-
Description: The endpoint returns the specified dataflow (e.g. BBEX3).
Protocol https Path /metadata/dataflow/BBK/{resourceID} Base path https://api.statistiken.bundesbank.de/rest Return format application/vnd.sdmx.structure+xml;version=2.1
application/xml
text/xml
Parameters
Name Description Example resourceID The ID of the requested dataflow. BBEX3 Example: https://api.statistiken.bundesbank.de/rest/metadata/dataflow/BBK/BBEX3
Return format parameter
With the "format" parameter, it is possible to instruct the web service to return data in various formats. If no "format" parameter is specified, the return format will consider the entry "Accept-Header".
The "format" parameter takes precedence over the "Accept-Header".
Return type Parameter value Media type SDMX-ML 2.1 struct_xml
application_xml
text_xml
application/vnd.sdmx.structure+xml
application/xml
text/xml
Query parameters
Name Description detail The “detail” parameter can be used to narrow down the desired amount of information.
full: All available information is returned. This is the default setting.
Example:
https://api.statistiken.bundesbank.de/rest/metadata/dataflow/BBK/BBEX3?detail=fullallstubs: All artefacts are returned as stubs.
Example:
https://api.statistiken.bundesbank.de/rest/metadata/dataflow/BBK/BBEX3?detail=referencestubsreferences Using the “references” parameter, you can instruct the web service to return (or not return) the artefacts that are referenced by the requested dataflow.
none: No references are returned. This is the default value.
children: The artefacts to which the dataflow refers are returned.
descendants: All references, up to each level, are also returned.
all: The total amount of metadata.
datastructure: The data structure to which the dataflow refers is returned.
-
Description: The endpoint returns all available dataflows.
Protocol https Path /metadata/dataflow/BBK Base path https://api.statistiken.bundesbank.de/rest Return format application/vnd.sdmx.structure+xml;version=2.1
application/xml
text/xml
Example: https://api.statistiken.bundesbank.de/rest/metadata/dataflow/BBK
Return format parameter
With the "format" parameter, it is possible to instruct the web service to return data in various formats. If no "format" parameter is specified, the return format will consider the entry "Accept-Header".
The "format" parameter takes precedence over the "Accept-Header".
Return type Parameter value Media type SDMX-ML 2.1 struct_xml
application_xml
text_xml
application/vnd.sdmx.structure+xml
application/xml
text/xml
-
Description: The endpoint returns the selected code list (e.g. CL_BBK_ERX_RATE_TYPE).
Protocol https Path /metadata/codelist/BBK/{resourceID} Base path https://api.statistiken.bundesbank.de/rest Return format application/xml
application/vnd.sdmx.structure+xml;version=2.1
text/xml
application/vnd.sdmx.structure+json;version=1.0.0
Parameters
Name Description Example resourceID The ID of the requested code list. CL_BBK_ERX_RATE_TYPE Example: https://api.statistiken.bundesbank.de/rest/metadata/codelist/BBK/CL_BBK_ERX_RATE_TYPE
Return format parameter
With the "format" parameter, it is possible to instruct the web service to return data in various formats. If no "format" parameter is specified, the return format will consider the entry "Accept-Header".
The "format" parameter takes precedence over the "Accept-Header".
Return type Parameter value Media type SDMX-ML 2.1 struct_json
struct_xml
application_xml
text_xml
application/vnd.sdmx.structure+json
application/vnd.sdmx.structure+xml
application/xml
text/xml
Query parameters
Name Description detail The “detail” parameter can be used to narrow down the desired amount of information.
full: All available information is returned. This is the default setting.
Example:
https://api.statistiken.bundesbank.de/rest/metadata/codelist/BBK/CL_BBK_ERX_RATE_TYPE?detail=fullallstubs: All artefacts are returned as stubs.
referencestubs: The referenced artefacts are returned as stubs.
references Using the “references” parameter, you can instruct the web service to return (or not return) the artefacts that are referenced by the requested code list.
none: No references are returned. This is the default value.
all: The total amount of metadata.
parents: The artefacts that use the code list are returned.
parentsandsiblings: The artefacts that use the code list and the code lists referenced by these artefacts are returned.
-
Description: The endpoint returns all selected code lists.
Protocol https Path /metadata/codelist/BBK Base path https://api.statistiken.bundesbank.de/rest Return format application/xml
application/vnd.sdmx.structure+xml;version=2.1
text/xml
application/vnd.sdmx.structure+json;version=1.0.0
Example: https://api.statistiken.bundesbank.de/rest/metadata/codelist/BBK
Return format parameter
With the "format" parameter, it is possible to instruct the web service to return data in various formats. If no "format" parameter is specified, the return format will consider the entry "Accept-Header".
The "format" parameter takes precedence over the "Accept-Header".
Return type Parameter value Media type SDMX-ML 2.1 struct_json
struct_xml
application_xml
text_xml
application/vnd.sdmx.structure+json
application/vnd.sdmx.structure+xml
application/xml
text/xml
-
Description: The endpoint returns the selected concept scheme (e.g. CS_BBK_ERX).
Protocol https Path /metadata/conceptscheme/BBK/{resourceID} Base path https://api.statistiken.bundesbank.de/rest Return format application/vnd.sdmx.structure+xml;version=2.1
application/xml
text/xml
Parameters
Name Description Example resourceID The ID of the requested concept scheme. CS_BBK_ERX Example: https://api.statistiken.bundesbank.de/rest/metadata/conceptscheme/BBK/CS_BBK_ERX
Return format parameter
With the "format" parameter, it is possible to instruct the web service to return data in various formats. If no "format" parameter is specified, the return format will consider the entry "Accept-Header".
The "format" parameter takes precedence over the "Accept-Header".
Return type Parameter value Media type SDMX-ML 2.1 struct_xml
application_xml
text_xml
application/vnd.sdmx.structure+xml
application/xml
text/xml
Query parameters
Name Description detail The “detail” parameter can be used to narrow down the desired amount of information.
full: All available information is returned. This is the default setting.
Example:
https://api.statistiken.bundesbank.de/rest/metadata/conceptscheme/BBK/CS_BBK_ERX?detail=fullallstubs: All artefacts are returned as stubs.
Example:
https://api.statistiken.bundesbank.de/rest/metadata/conceptscheme/BBK/CS_BBK_ERX?detail=allstubsreferencestubs: The referenced artefacts are returned as stubs.
references Using the “references” parameter, you can instruct the web service to return (or not return) the artefacts that are referenced by the requested concept scheme.
none: No references are returned. This is the default value.
all: The total amount of metadata.
parents: The artefacts that use the concept scheme are returned.
parentsandsiblings: The artefacts that use the concept scheme and the concept schemes referenced by these artefacts are returned.
children: The artefacts to which the concept scheme refers are returned.
descendants: All references, up to each level, are also returned.
codelist: The code lists to which the concept scheme refers are returned.
-
Description: The endpoint returns all selected concept schemes.
Protocol https Path /metadata/conceptscheme/BBK Base path https://api.statistiken.bundesbank.de/rest Return format application/vnd.sdmx.structure+xml;version=2.1
application/xml
text/xml
Example: https://api.statistiken.bundesbank.de/rest/metadata/conceptscheme/BBK
Return format parameter
With the "format" parameter, it is possible to instruct the web service to return data in various formats. If no "format" parameter is specified, the return format will consider the entry "Accept-Header".
The "format" parameter takes precedence over the "Accept-Header".
Return type Parameter value Media type SDMX-ML 2.1 struct_xml
application_xml
text_xml
application/vnd.sdmx.structure+xml
application/xml
text/xml