IBANTEST Python API Docs | dltHub
Build a IBANTEST-to-database pipeline in Python using dlt with AI Workbench support for Claude Code, Cursor, and Codex.
Last updated:
The IBANTEST REST API documentation is available at api.ibantest.com. The API allows for IBAN validation and calculation. Register for a free API key with 100 credits at www.ibantest.com. The REST API base URL is https://api.ibantest.com/v1 and all requests require a Bearer API key (or token query param) for authentication.
dlt is an open-source Python library that handles authentication, pagination, and schema evolution automatically. dlthub provides AI context files that enable code assistants to generate production-ready pipelines. Install with uv pip install "dlt[workspace]" and start loading IBANTEST data in under 10 minutes.
What data can I load from IBANTEST?
Here are some of the endpoints you can load from IBANTEST:
| Resource | Endpoint | Method | Data selector | Description |
|---|---|---|---|---|
| validate_iban | v1/validate_iban/ | GET | (top-level object) | Validate an IBAN and return checks, ibanData, bankData, countryData |
| validate_iban_alt | v1/validate-iban/ | GET | (top-level object) | Alternate path variant for IBAN validation (docs show both _ and - forms) |
| calculate_iban | v1/calculate_iban/<country_code>/<bank_code>/ | GET | (top-level object) | Calculate IBAN and return same structure as validation (ibanData, bankData, checks) |
| validate_bic | v1/validate_bic/ | GET | (top-level array) | Validate BIC/SWIFT and return list of matching bank records (array of objects) |
| validate_swiftcode | v1/validate_swiftcode/ | GET | (top-level array) | Alternate endpoint that returns array of bank records for a SWIFT code |
| find_bank | v1/find_bank/<country_code>/<bank_code> | GET | (top-level array) | Find bank information by country code and domestic bank code; returns array of bank records |
How do I authenticate with the IBANTEST API?
API key sent as a Bearer token in the Authorization header. Alternatively the key may be provided as a token GET parameter (e.g. ?token=YOUR_API_KEY). Use Accept: application/json for JSON responses.
1. Get your credentials
- Visit https://www.ibantest.com and register for a developer account.
- In the dashboard / developer section obtain your API key (new accounts are granted 100 free credits).
- Use that key as the Bearer token in Authorization headers or as the token GET parameter.
2. Add them to .dlt/secrets.toml
[sources.ibantest_source] token = "YOUR_API_KEY"
dlt reads this automatically at runtime — never hardcode tokens in your pipeline script. For production environments, see setting up credentials with dlt for environment variable and vault-based options.
How do I set up and run the pipeline?
Set up a virtual environment and install dlt:
uv venv && source .venv/bin/activate uv pip install "dlt[workspace]"
1. Install the dlt AI Workbench:
dlt ai init --agent <your-agent> # <agent>: claude | cursor | codex
This installs project rules, a secrets management skill, appropriate ignore files, and configures the dlt MCP server for your agent. Learn more →
2. Install the rest-api-pipeline toolkit:
dlt ai toolkit rest-api-pipeline install
This loads the skills and context about dlt the agent uses to build the pipeline iteratively, efficiently, and safely. The agent uses MCP tools to inspect credentials — it never needs to read your secrets.toml directly. Learn more →
3. Start LLM-assisted coding:
Use /find-source to load data from the IBANTEST API into DuckDB.
The rest-api-pipeline toolkit takes over from here — it reads relevant API documentation, presents you with options for which endpoints to load, and follows a structured workflow to scaffold, debug, and validate the pipeline step by step.
4. Run the pipeline:
python ibantest_pipeline.py
If everything is configured correctly, you'll see output like this:
Pipeline ibantest_pipeline load step completed in 0.26 seconds 1 load package(s) were loaded to destination duckdb and into dataset ibantest_data The duckdb destination used duckdb:/ibantest.duckdb location to store data Load package 1749667187.541553 is LOADED and contains no failed jobs
Inspect your pipeline and data:
dlt pipeline ibantest_pipeline show
This opens the Pipeline Dashboard where you can verify pipeline state, load metrics, schema (tables, columns, types), and query the loaded data directly.
Python pipeline example
This example loads validate_iban and validate_bic from the IBANTEST API into DuckDB. It mirrors the endpoint and data selector configuration from the table above:
import dlt from dlt.sources.rest_api import RESTAPIConfig, rest_api_resources @dlt.source def ibantest_source(token=dlt.secrets.value): config: RESTAPIConfig = { "client": { "base_url": "https://api.ibantest.com/v1", "auth": { "type": "bearer", "token": token, }, }, "resources": [ {"name": "validate_iban", "endpoint": {"path": "v1/validate_iban/<iban>"}}, {"name": "validate_bic", "endpoint": {"path": "v1/validate_bic/<bic>"}} ], } yield from rest_api_resources(config) def get_data() -> None: pipeline = dlt.pipeline( pipeline_name="ibantest_pipeline", destination="duckdb", dataset_name="ibantest_data", ) load_info = pipeline.run(ibantest_source()) print(load_info)
To add more endpoints, append entries from the resource table to the "resources" list using the same name, path, and data_selector pattern.
How do I query the loaded data?
Once the pipeline runs, dlt creates one table per resource. You can query with Python or SQL.
Python (pandas DataFrame):
import dlt data = dlt.pipeline("ibantest_pipeline").dataset() sessions_df = data.validate_iban.df() print(sessions_df.head())
SQL (DuckDB example):
SELECT * FROM ibantest_data.validate_iban LIMIT 10;
In a marimo or Jupyter notebook:
import dlt data = dlt.pipeline("ibantest_pipeline").dataset() data.validate_iban.df().head()
See how to explore your data in marimo Notebooks and how to query your data in Python with dataset.
What destinations can I load IBANTEST data to?
dlt supports loading into any of these destinations — only the destination parameter changes:
| Destination | Example value |
|---|---|
| DuckDB (local, default) | "duckdb" |
| PostgreSQL | "postgres" |
| BigQuery | "bigquery" |
| Snowflake | "snowflake" |
| Redshift | "redshift" |
| Databricks | "databricks" |
| Filesystem (S3, GCS, Azure) | "filesystem" |
Change the destination in dlt.pipeline(destination="snowflake") and add credentials in .dlt/secrets.toml. See the full destinations list.
Next steps
Continue your data engineering journey with the other toolkits of the dltHub AI Workbench:
data-exploration— Build custom notebooks, charts, and dashboards for deeper analysis with marimo notebooks.dlthub-runtime— Deploy, schedule, and monitor your pipeline in production.
dlt ai toolkit data-exploration install dlt ai toolkit dlthub-runtime install
Was this page helpful?
Community Hub
Need more dlt context for IBANTEST?
Request dlt skills, commands, AGENT.md files, and AI-native context.