IBAN API Python API Docs | dltHub
Build a IBAN API-to-database pipeline in Python using dlt with AI Workbench support for Claude Code, Cursor, and Codex.
Last updated:
IBANAPI is a freemium REST API that validates IBANs and returns related country and bank information. The REST API base URL is https://api.ibanapi.com/v1 and all requests require an API key (passed as query param, POST form field, or Authorization header).
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 IBAN API data in under 10 minutes.
What data can I load from IBAN API?
Here are some of the endpoints you can load from IBAN API:
| Resource | Endpoint | Method | Data selector | Description |
|---|---|---|---|---|
| validate | /validate/{IBAN} | GET | data | Validates an IBAN and returns detailed bank & country info |
| validate_basic | /validate-basic/{IBAN} | GET | data | Performs basic IBAN validation (no bank details) |
| balance | /balance | GET | data | Returns account balances and expiry information |
| heartbeat | /heartbeat | GET | Service heartbeat/monitoring (requires API key, free) | |
| bulk_validate | /bulk-validate | POST | data | Validate up to 200 IBANs in bulk, returns per‑IBAN results |
How do I authenticate with the IBAN API API?
Authentication uses a provider‑issued API key. Provide it as api_key query parameter (?api_key=KEY), as a POST form field, or include it in the Authorization header.
1. Get your credentials
- Visit https://ibanapi.com and click Sign Up.
- Complete registration and verify email.
- In the dashboard obtain/copy your API key.
- Use that key in requests as described.
2. Add them to .dlt/secrets.toml
[sources.iban_api_source] api_key = "your_api_key_here"
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 IBAN API 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 iban_api_pipeline.py
If everything is configured correctly, you'll see output like this:
Pipeline iban_api_pipeline load step completed in 0.26 seconds 1 load package(s) were loaded to destination duckdb and into dataset iban_api_data The duckdb destination used duckdb:/iban_api.duckdb location to store data Load package 1749667187.541553 is LOADED and contains no failed jobs
Inspect your pipeline and data:
dlt pipeline iban_api_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 and validate_basic from the IBAN API 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 iban_api_source(api_key=dlt.secrets.value): config: RESTAPIConfig = { "client": { "base_url": "https://api.ibanapi.com/v1", "auth": { "type": "api_key", "api_key": api_key, }, }, "resources": [ {"name": "validate", "endpoint": {"path": "validate/{IBAN}", "data_selector": "data"}}, {"name": "validate_basic", "endpoint": {"path": "validate-basic/{IBAN}", "data_selector": "data"}} ], } yield from rest_api_resources(config) def get_data() -> None: pipeline = dlt.pipeline( pipeline_name="iban_api_pipeline", destination="duckdb", dataset_name="iban_api_data", ) load_info = pipeline.run(iban_api_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("iban_api_pipeline").dataset() sessions_df = data.validate.df() print(sessions_df.head())
SQL (DuckDB example):
SELECT * FROM iban_api_data.validate LIMIT 10;
In a marimo or Jupyter notebook:
import dlt data = dlt.pipeline("iban_api_pipeline").dataset() data.validate.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 IBAN API 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.
Troubleshooting
Authentication failures
If you receive result 401 / message "Invalid API Key" or HTTP 403/422, verify the api_key is correct, not expired, and present either as ?api_key=... or in the Authorization header. Check dashboard for plan expiry.
Balance / quota errors
Responses use numeric result codes and may return 400/301/302/303 when balance is exhausted, package expired, or API key invalid. Use /balance to check bank_balance and basic_balance before bulk operations.
Bulk validation limits
Bulk endpoints accept up to 200 IBANs per request. Submitting more will fail; split into multiple requests and respect rate limits.
Ensure that the API key is valid to avoid 401 Unauthorized errors. Also, verify endpoint paths and parameters to avoid 404 Not Found errors.
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 IBAN API?
Request dlt skills, commands, AGENT.md files, and AI-native context.