Custom Connector
BIS Data Portal
Switzerland
The BIS Data Portal Connector facilitates seamless integration with the BIS SDMX RESTful API v1.4.0, providing access to statistical data and metadata from the Bank for International Settlements. It supports querying data, availability, dataflows, data structures, and schemes in XML, JSON, CSV, and EDI — leveraging SDMX standards for filtering by flow, key, periods, and detail.
Overview
Integration Overview
This document provides a detailed guide for each integration point, its purpose, configuration, and workflow support using the BIS Data Portal Connector. Its 18 SDMX endpoints are grouped below by area.
- getData. Retrieve data from a dataflow with key filtering (JSON, XML, CSV).
- getDataAvailability. Get information about data availability for components.
- getDataflow / getDataStructure. Retrieve a specific dataflow or data structure definition.
- getCategoryScheme / getCodelist / getConceptScheme / getDataProviderScheme. Retrieve a specific scheme, codelist, or concept scheme.
- getDataflows / getDataStructures / getCategorySchemes / getCodelists / getConceptSchemes / getDataProviderSchemes. Retrieve all of each artefact type in the catalog.
- ...ByAgency. Retrieve dataflows, data structures, category schemes, or codelists maintained by a specific agency.
Documentation
Detailed Integration Documentation
Get Data
| Action | getData |
|---|---|
| Purpose | Retrieves data from a specified dataflow, filtered by key, periods, and detail level — the primary entry point for BIS statistical data. |
| Configuration | Configure the base URL via CONNECTOR_ENV_BIS_BASE_URL. |
| Parameters | Required: flow (e.g. BIS,CC,1.0); key (e.g. all or specific dimension values). Optional: startPeriod (e.g. 2020-Q1); endPeriod; firstNObservations; lastNObservations; detail (full/dataonly/serieskeysonly/nodata). |
| Output | Successful: SDMX-JSON (header, datasets, structure), SDMX-ML XML, or CSV. Failure: 400 bad syntax / 404 not found. |
| Workflow example | Execute getData with flow=BIS,CC,1.0 and key=all to analyze credit to the private non-bank sector. |
Get Data Availability
| Action | getDataAvailability |
|---|---|
| Purpose | Retrieves information about data availability for a specific component in a dataflow — supporting query planning. |
| Configuration | Configure the base URL via CONNECTOR_ENV_BIS_BASE_URL. |
| Parameters | Required: flow; key; componentID (e.g. FREQ). Optional: mode (exact/available, default exact); references (none/all/datastructure/conceptscheme/codelist/dataproviderscheme/dataflow); startPeriod; endPeriod. |
| Output | Successful: a JSON/XML ContentConstraint with available values. Failure: 400 / 404. |
| Workflow example | Execute getDataAvailability with flow=BIS,CC,1.0, key=all, componentID=FREQ to refine queries. |
Dataflow & Data Structure
| Action | getDataflow / getDataStructure |
|---|---|
| Purpose | Retrieves a specific dataflow (name, description, structure reference) or a data structure definition (dimensions, attributes, codelists) by agency and ID. |
| Configuration | Configure the base URL via CONNECTOR_ENV_BIS_BASE_URL. |
| Parameters | Required: agencyID (e.g. BIS); flowID (e.g. CC) or dsID (e.g. DSD_CC). |
| Output | Successful: a JSON/XML Dataflow or DataStructure object. Failure: 404 not found. |
| Workflow example | Execute getDataStructure with agencyID=BIS and dsID=DSD_CC to build query keys. |
Individual Schemes & Codelists
| Action | getCategoryScheme / getCodelist / getConceptScheme / getDataProviderScheme |
|---|---|
| Purpose | Retrieves a specific category scheme, codelist (code-value mappings), concept scheme, or data provider scheme by agency and ID. |
| Configuration | Configure the base URL via CONNECTOR_ENV_BIS_BASE_URL. |
| Parameters | Required: agencyID (e.g. BIS); the corresponding ID (csID / clID / dpsID). |
| Output | Successful: a JSON/XML scheme, codelist, or provider object. Failure: 404 not found. |
| Workflow example | Execute getCodelist with agencyID=BIS and clID=CL_FREQ to map codes to labels in query construction. |
All Artefacts (catalog-wide)
| Action | getDataflows / getDataStructures / getCategorySchemes / getCodelists / getConceptSchemes / getDataProviderSchemes |
|---|---|
| Purpose | Retrieves all dataflows, data structures, category schemes, codelists, concept schemes, or data provider schemes available in the BIS catalog. |
| Configuration | Configure the base URL via CONNECTOR_ENV_BIS_BASE_URL. |
| Parameters | None. |
| Output | Successful: a JSON/XML object with an array of the requested artefact type. Failure: 500 internal server error. |
| Workflow example | Execute getDataflows to list all dataflows for catalog exploration. |
By Agency
| Action | getDataflowsByAgency / getDataStructuresByAgency / getCategorySchemesByAgency / getCodelistsByAgency |
|---|---|
| Purpose | Retrieves dataflows, data structures, category schemes, or codelists maintained by a specific agency. |
| Configuration | Configure the base URL via CONNECTOR_ENV_BIS_BASE_URL. |
| Parameters | Required: agencyID (e.g. BIS). |
| Output | Successful: a JSON/XML object with an array of the artefact type for that agency. Failure: 404 not found. |
| Workflow example | Execute getDataflowsByAgency with agencyID=BIS for agency-specific exploration. |
Example Workflow: Economic Data Analysis
| Retrieve dataflows | Use getDataflows to identify a target (e.g. BIS,CC,1.0). |
|---|---|
| Query structure | Execute getDataStructure with agencyID=BIS and dsID=DSD_CC to understand dimensions and codes. |
| Fetch data | Use getData with flow=BIS,CC,1.0 and key=all, then integrate into an analytics dashboard. |
| Check availability | Use getDataAvailability to confirm data for specific components before historical analysis. |
Support
For technical support, contact custom-connectors-support@isolutions.sa.