OpenSanctions Python API Docs | dltHub
Build a OpenSanctions-to-database pipeline in Python using dlt with AI Workbench support for Claude Code, Cursor, and Codex.
Last updated:
OpenSanctions API provides access to sanctions lists and data; free for non-commercial use; requires license for commercial use. The REST API base URL is https://api.opensanctions.org and All requests require an API key (provided in Authorization header or ?api_key= query string)..
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 OpenSanctions data in under 10 minutes.
What data can I load from OpenSanctions?
Here are some of the endpoints you can load from OpenSanctions:
| Resource | Endpoint | Method | Data selector | Description |
|---|---|---|---|---|
| entities | /entities/{entity_id} | GET | Fetch full entity record by id | |
| entities_list | /entities | GET | items | Search / list entities (persons & organizations); supports query, schema, datasets, pagination |
| search | /search/{dataset} | GET | items | Text-based search over dataset scope (supports query, filters, pagination) |
| statements | /statements | GET | items | Statement-level, granular assertions and source records |
| catalog | /catalog | GET | items | Data catalog / datasets listing |
| datasets | /datasets | GET | items | List available datasets and source metadata |
| healthz | /healthz | GET | Health check | |
| readyz | /readyz | GET | Search index readiness | |
| match | /match/{dataset} | POST | responses..results | Query‑by‑example matcher (returns match results) — POST but core for screening |
How do I authenticate with the OpenSanctions API?
Provide your API key in the Authorization header as: Authorization: ApiKey <YOUR_KEY> or pass ?api_key=<YOUR_KEY> on the URL.
1. Get your credentials
- Go to https://www.opensanctions.org/api/ or the account page linked on the documentation.\n2) Sign up or log in with a business email address.\n3) In your dashboard, locate the section for API keys and create a new key (trial keys are generated automatically for business emails).\n4) Copy the generated key and store it securely; use it in requests as described in the auth_info section.
2. Add them to .dlt/secrets.toml
[sources.opensanctions_source] api_key = "your_opensanctions_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 OpenSanctions 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 opensanctions_pipeline.py
If everything is configured correctly, you'll see output like this:
Pipeline opensanctions_pipeline load step completed in 0.26 seconds 1 load package(s) were loaded to destination duckdb and into dataset opensanctions_data The duckdb destination used duckdb:/opensanctions.duckdb location to store data Load package 1749667187.541553 is LOADED and contains no failed jobs
Inspect your pipeline and data:
dlt pipeline opensanctions_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 entities and search from the OpenSanctions 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 opensanctions_source(api_key=dlt.secrets.value): config: RESTAPIConfig = { "client": { "base_url": "https://api.opensanctions.org", "auth": { "type": "api_key", "api_key": api_key, }, }, "resources": [ {"name": "entities", "endpoint": {"path": "entities"}}, {"name": "search", "endpoint": {"path": "search/default", "data_selector": "items"}} ], } yield from rest_api_resources(config) def get_data() -> None: pipeline = dlt.pipeline( pipeline_name="opensanctions_pipeline", destination="duckdb", dataset_name="opensanctions_data", ) load_info = pipeline.run(opensanctions_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("opensanctions_pipeline").dataset() sessions_df = data.entities.df() print(sessions_df.head())
SQL (DuckDB example):
SELECT * FROM opensanctions_data.entities LIMIT 10;
In a marimo or Jupyter notebook:
import dlt data = dlt.pipeline("opensanctions_pipeline").dataset() data.entities.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 OpenSanctions 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 OpenSanctions?
Request dlt skills, commands, AGENT.md files, and AI-native context.