UniOne Python API Docs | dltHub
Build a UniOne-to-database pipeline in Python using dlt with AI Workbench support for Claude Code, Cursor, and Codex.
Last updated:
UniOne's REST API allows sending emails via PHP, Python, and Node.js. The API requires an API key and uses JSON for request and response formats. The base endpoint is https://api.unione.io/en/transactional/api/v1/email/send.json. The REST API base URL is https://api.unione.io/en/transactional/api/v1 and Requests require an API key via the X-API-KEY header or the api_key JSON field..
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 UniOne data in under 10 minutes.
What data can I load from UniOne?
Here are some of the endpoints you can load from UniOne:
| Resource | Endpoint | Method | Data selector | Description |
|---|---|---|---|---|
domain_list | domain/list | GET | domains | Returns a list of domains owned by the account. |
domain_get_dns_records | domain/get-dns-records | GET | Retrieves DNS verification records for a specific domain. | |
template_list | template/list | GET | templates | Lists all email templates. |
template_get | template/get | GET | template | Retrieves details of a single template. |
event_list | event/list | GET | events | Returns recent events such as deliveries and bounces. |
How do I authenticate with the UniOne API?
Include the API key in the X-API-KEY header or add an "api_key" field to the JSON payload for each request.
1. Get your credentials
- Log in to your UniOne account at https://app.unione.io.
- Open the user menu and select "API Settings" or "Integration".
- If an API key does not exist, click "Create New API Key".
- Copy the generated API key and store it securely.
- Use this key in the X-API-KEY header or the "api_key" JSON field for API calls.
2. Add them to .dlt/secrets.toml
[sources.uni_one_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 UniOne 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 uni_one_pipeline.py
If everything is configured correctly, you'll see output like this:
Pipeline uni_one_pipeline load step completed in 0.26 seconds 1 load package(s) were loaded to destination duckdb and into dataset uni_one_data The duckdb destination used duckdb:/uni_one.duckdb location to store data Load package 1749667187.541553 is LOADED and contains no failed jobs
Inspect your pipeline and data:
dlt pipeline uni_one_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 domain/list and template/list from the UniOne 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 uni_one_source(api_key=dlt.secrets.value): config: RESTAPIConfig = { "client": { "base_url": "https://api.unione.io/en/transactional/api/v1", "auth": { "type": "api_key", "api_key": api_key, }, }, "resources": [ {"name": "domain_list", "endpoint": {"path": "domain/list", "data_selector": "domains"}}, {"name": "template_list", "endpoint": {"path": "template/list", "data_selector": "templates"}} ], } yield from rest_api_resources(config) def get_data() -> None: pipeline = dlt.pipeline( pipeline_name="uni_one_pipeline", destination="duckdb", dataset_name="uni_one_data", ) load_info = pipeline.run(uni_one_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("uni_one_pipeline").dataset() sessions_df = data.domain_list.df() print(sessions_df.head())
SQL (DuckDB example):
SELECT * FROM uni_one_data.domain_list LIMIT 10;
In a marimo or Jupyter notebook:
import dlt data = dlt.pipeline("uni_one_pipeline").dataset() data.domain_list.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 UniOne 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 UniOne?
Request dlt skills, commands, AGENT.md files, and AI-native context.