GnistAI GnistAI
Log in

Getting Started with BIS (Bank for International Settlements)

BIS financial statistics — credit/debt, derivatives, banking, property prices, exchange rates, and central bank policy rates.

All Tutorials   |   Overview   |   Playground   |   MCP   |   REST API   |   Home
Finance

Data source: BIS SDMX REST API

Overview

BIS (Bank for International Settlements) wraps BIS SDMX REST API, handling authentication, pagination, and rate limits for you. This tutorial covers all 6 tools with working code examples you can copy and run.

Prerequisites

  1. Sign up at https://context.gnist.ai/signup for a free API key (100 calls/day).
  2. Choose your integration method: MCP protocol or REST API.

Connect via MCP

Add to your MCP client config (Claude Desktop, Cursor, etc.):

MCP Config 
{
  "mcpServers": {
    "gnist-bis": {
      "url": "https://context.gnist.ai/mcp/bis/",
      "headers": {
        "Gnist-API-Key": "YOUR_API_KEY"
      }
    }
  }
}

Tools (6)

search_datasets

Search the BIS dataset catalog by keyword. Returns matching datasets with their dataflow IDs needed for get_data, get_dataset_structure, and compare_countries calls. BIS covers credit/debt, derivatives, banking, property prices, exchange rates, and other financial statistics from central banks worldwide. Args: query: Search term (e.g. "credit", "exchange rates", "property prices"). limit: Number of results to return (1-50, default 20). Returns: List of matching datasets with id, name, agency, and description. Use the 'id' field as the dataflow parameter in other tools.

ParameterTypeRequiredDescription
querystringrequiredSearch term for BIS datasets (e.g. "credit", "exchange rates", "property prices", "banking", "derivatives").
limitintegeroptionalNumber of results to return (1-50, default 20). (default: 20)
curl -X POST "https://context.gnist.ai/mcp/bis/" \
  -H "Content-Type: application/json" \
  -H "Gnist-API-Key: YOUR_API_KEY" \
  -d '{"jsonrpc": "2.0", "method": "tools/call", "id": 1, "params": {"name": "search_datasets", "arguments": {"query": "credit"}}}'
import httpx

resp = httpx.post(
    "https://context.gnist.ai/mcp/bis/",
    headers={"Gnist-API-Key": "YOUR_API_KEY"},
    json={'id': 1,
 'jsonrpc': '2.0',
 'method': 'tools/call',
 'params': {'arguments': {'query': 'credit'}, 'name': 'search_datasets'}},
)
print(resp.json())

list_datasets

List available BIS datasets, optionally filtered by topic. Browse the full BIS data catalog. Use this to discover what datasets exist before querying specific data. Args: topic: Optional topic filter keyword. Omit to list all datasets. limit: Maximum datasets to return (1-100, default 50). Returns: List of datasets with id, name, and description.

ParameterTypeRequiredDescription
topicanyoptionalOptional topic filter (e.g. "banking", "credit", "exchange", "derivatives"). Omit to list all.
limitintegeroptionalMaximum datasets to return (1-100, default 50). (default: 50)
curl -X POST "https://context.gnist.ai/mcp/bis/" \
  -H "Content-Type: application/json" \
  -H "Gnist-API-Key: YOUR_API_KEY" \
  -d '{"jsonrpc": "2.0", "method": "tools/call", "id": 1, "params": {"name": "list_datasets", "arguments": {"topic": "banking"}}}'
import httpx

resp = httpx.post(
    "https://context.gnist.ai/mcp/bis/",
    headers={"Gnist-API-Key": "YOUR_API_KEY"},
    json={'id': 1,
 'jsonrpc': '2.0',
 'method': 'tools/call',
 'params': {'arguments': {'topic': 'banking'}, 'name': 'list_datasets'}},
)
print(resp.json())

get_dataset_structure

Get the dimension structure of a BIS dataset. Shows what dimensions (filters) are available for a dataset and their valid values. Use this before get_data to understand what country codes, frequencies, and other parameters are accepted. Args: dataflow: BIS dataflow identifier from search_datasets. Returns: List of dimensions with their valid codes/values. Each dimension shows its position in the SDMX key and sample values.

ParameterTypeRequiredDescription
dataflowstringrequiredBIS dataflow identifier from search_datasets (e.g. "WS_CBPOL", "WS_SPP", "WS_CREDIT_GAP").
curl -X POST "https://context.gnist.ai/mcp/bis/" \
  -H "Content-Type: application/json" \
  -H "Gnist-API-Key: YOUR_API_KEY" \
  -d '{"jsonrpc": "2.0", "method": "tools/call", "id": 1, "params": {"name": "get_dataset_structure", "arguments": {"dataflow": "WS_CBPOL"}}}'
import httpx

resp = httpx.post(
    "https://context.gnist.ai/mcp/bis/",
    headers={"Gnist-API-Key": "YOUR_API_KEY"},
    json={'id': 1,
 'jsonrpc': '2.0',
 'method': 'tools/call',
 'params': {'arguments': {'dataflow': 'WS_CBPOL'},
            'name': 'get_dataset_structure'}},
)
print(resp.json())

get_data

Fetch data from a BIS dataset. Query any BIS dataset by country and time period. Covers central bank policy rates, credit statistics, property prices, exchange rates, derivatives, and banking statistics worldwide. Args: dataflow: BIS dataflow identifier. Use search_datasets to find IDs. countries: ISO alpha-2 country codes. Omit for all countries. start_period: Start period filter (e.g. "2015"). end_period: End period filter (e.g. "2023"). dimension_filter: Advanced SDMX dimension key. Overrides countries. limit: Maximum observations to return (1-1000, default 200). Returns: Observations with all dimension labels and values.

ParameterTypeRequiredDescription
dataflowstringrequiredBIS dataflow identifier (e.g. "WS_CBPOL", "WS_SPP"). Use search_datasets to find IDs.
countriesanyoptionalISO alpha-2 country codes (e.g. ["US", "DE", "NO"]). Omit for all countries.
start_periodanyoptionalStart period (e.g. "2015", "2020-Q1", "2020-01").
end_periodanyoptionalEnd period (e.g. "2023", "2023-Q4", "2023-12").
dimension_filteranyoptionalAdvanced: SDMX dimension key filter (dot-separated, e.g. "M.US+DE"). Overrides countries param. Use get_dataset_structure to find valid dimension values.
limitintegeroptionalMaximum observations to return (1-1000, default 200). (default: 200)
curl -X POST "https://context.gnist.ai/mcp/bis/" \
  -H "Content-Type: application/json" \
  -H "Gnist-API-Key: YOUR_API_KEY" \
  -d '{"jsonrpc": "2.0", "method": "tools/call", "id": 1, "params": {"name": "get_data", "arguments": {"dataflow": "WS_CBPOL"}}}'
import httpx

resp = httpx.post(
    "https://context.gnist.ai/mcp/bis/",
    headers={"Gnist-API-Key": "YOUR_API_KEY"},
    json={'id': 1,
 'jsonrpc': '2.0',
 'method': 'tools/call',
 'params': {'arguments': {'dataflow': 'WS_CBPOL'}, 'name': 'get_data'}},
)
print(resp.json())

compare_countries

Compare data across countries for a given BIS dataset. Fetches the same indicator for multiple countries side by side. Useful for cross-country analysis of policy rates, credit growth, property prices, and other BIS financial statistics. Args: dataflow: BIS dataflow identifier. country_codes: ISO alpha-2 country codes to compare. Maximum 20. start_period: Start period. Omit for most recent data. end_period: End period. Omit for most recent data. Returns: Data grouped by country for easy comparison.

ParameterTypeRequiredDescription
dataflowstringrequiredBIS dataflow identifier (e.g. "WS_CBPOL", "WS_SPP").
country_codeslist[string]requiredISO alpha-2 country codes to compare (e.g. ["US", "DE", "JP", "NO"]). Maximum 20.
start_periodanyoptionalStart period (e.g. "2020"). Omit for most recent data.
end_periodanyoptionalEnd period (e.g. "2023"). Omit for most recent data.
curl -X POST "https://context.gnist.ai/mcp/bis/" \
  -H "Content-Type: application/json" \
  -H "Gnist-API-Key: YOUR_API_KEY" \
  -d '{"jsonrpc": "2.0", "method": "tools/call", "id": 1, "params": {"name": "compare_countries", "arguments": {"dataflow": "WS_CBPOL", "country_codes": "[\"US\""}}}'
import httpx

resp = httpx.post(
    "https://context.gnist.ai/mcp/bis/",
    headers={"Gnist-API-Key": "YOUR_API_KEY"},
    json={'id': 1,
 'jsonrpc': '2.0',
 'method': 'tools/call',
 'params': {'arguments': {'country_codes': '["US"', 'dataflow': 'WS_CBPOL'},
            'name': 'compare_countries'}},
)
print(resp.json())

report_feedback

Report a bug, feature request, or general feedback for this data source. Use this when something doesn't work as expected, when you'd like a new feature, or when you have suggestions for improvement. Args: feedback: Describe the issue or suggestion. feedback_type: One of 'bug', 'feature_request', or 'general'.

ParameterTypeRequiredDescription
feedbackstringrequired
feedback_typestringoptional (default: general)
curl -X POST "https://context.gnist.ai/mcp/bis/" \
  -H "Content-Type: application/json" \
  -H "Gnist-API-Key: YOUR_API_KEY" \
  -d '{"jsonrpc": "2.0", "method": "tools/call", "id": 1, "params": {"name": "report_feedback", "arguments": {"feedback": "example"}}}'
import httpx

resp = httpx.post(
    "https://context.gnist.ai/mcp/bis/",
    headers={"Gnist-API-Key": "YOUR_API_KEY"},
    json={'id': 1,
 'jsonrpc': '2.0',
 'method': 'tools/call',
 'params': {'arguments': {'feedback': 'example'}, 'name': 'report_feedback'}},
)
print(resp.json())

Common Patterns

Search then retrieve
Use search_datasets to find items, then get_dataset_structure to get full details. This two-step pattern is common for exploring data before drilling down.
Pagination
Several tools support limit, offset, or page parameters. Start with small limits during development, then increase for production queries.

FAQ

What data does BIS (Bank for International Settlements) provide?

BIS financial statistics — credit/debt, derivatives, banking, property prices, exchange rates, and central bank policy rates. It exposes 6 tools: search_datasets, list_datasets, get_dataset_structure, get_data, compare_countries, report_feedback.

What do I need to get started?

A Gnist API key (free tier: 100 calls/day). Sign up at https://context.gnist.ai/signup.

What format does the BIS (Bank for International Settlements) API return?

JSON, via either MCP protocol (JSON-RPC 2.0) or REST API.

Next Steps

Interactive Playground
Try tools in your browser — no setup required.
Full Reference
Complete docs for all 6 tools.

Related Tutorials

Company Intelligence
Tutorial
Financial Markets
Tutorial
ECB & Norges Bank
Tutorial
ECB Statistics
Tutorial
ECB FX Rates
Tutorial
Hvakosterstrommen (Electricity Prices)
Tutorial