No logo available for ImprovMX to DuckDB connector icon

Load ImprovMX data to DuckDB

Build a ImprovMX to DuckDB pipeline with your coding agent. One prompt scaffolds it with the dltHub AI harness, plus the ImprovMX API base URL, auth, endpoints, and incremental loading.

SourceImprovMXImprovMX API DocumentationDestinationDuckDBIn-process analytical database. The default local destination for dlt pipelines.

ImprovMX provides an API for programmatically managing email forwarding domains and aliases. Everything needed to build a working ImprovMX → DuckDB pipeline is on this page: the API's base URL, authentication, endpoints, pagination and incremental field — plus a prompt that hands the whole job to your coding agent.


Build your ImprovMX to DuckDB pipeline

Paste this prompt into Claude, Codex, or Cursor. The agent does the rest.

Prompt
Run uvx dlthub-init@latest to build a pipeline from ImprovMX to DuckDB and run it on dltHub

That scaffolds a dltHub workspace and installs the dltHub AI harness — the project rules, the secrets-management skill, and the dlt MCP server your agent needs to work safely. From there it reads the ImprovMX API, proposes the endpoints to load, then writes, runs and validates the pipeline while you review rather than type. Credentials are inspected through MCP tools, so your agent never reads secrets.toml itself. How the LLM-native workflow works →

Prefer to write it yourself? Every fact the agent uses is below.


ImprovMX API at a glance

Base URLhttps://api.improvmx.com/v3
Example endpointGET domains
Records found atdomains
AuthenticationAll requests require HTTP Basic authentication using 'api' as the username and the API key as the password — sent in the Authorization header, prefixed Basic api:
Also requiredContent-Type
PaginationCursor-based via next_cursor, next cursor at (not specified; token is returned as next_cursor and passed back as next_cursor query param), page size via limit (default 50, max 100). Pagination uses cursor-based log pagination for the endpoint that mentions next_cursor: 'Load logs after this log id... Pass next_cursor from the previous response to paginate.' The docs also describe page-number pagination (page, 1-based default 1) and limit (default 50, max 100) for list endpoints like GET /domains and others; however, the next_cursor token is explicitly for logs pagination.
API referencehttps://improvmx.com/api/

These values come from the ImprovMX API reference — the authoritative source if anything here looks out of date.


How do I authenticate with the ImprovMX API?

ImprovMX uses HTTP Basic Authentication. You must provide a header named 'Authorization' with the value 'Basic base64_encoded_string', where the string is 'api:YOUR_API_KEY'.

1. Get your credentials

  1. Log in to your ImprovMX account at https://improvmx.com. 2. Navigate to Settings -> API or the Account -> API Keys section. 3. Click Create New API Key (or retrieve your existing key). 4. Use 'api' as the HTTP Basic Authentication username and your API key as the password.

2. Add them to .dlt/secrets.toml

[sources.improvmx_source] api_key = "your_api_key_here"

dlt reads this file automatically at runtime. With the harness, the setup-secrets skill prompts you for the values and never handles the raw credential in chat. For production, see setting up credentials with dlt.


What ImprovMX data can I load into DuckDB?

These are the ImprovMX endpoints dlt can load into DuckDB:

ResourceEndpointMethodData selectorDescription
domains/domainsGETdomainsList all domains
account/accountGETGet account details
whitelabels/account/whitelabelsGETwhitelabelsList whitelabel domains
aliases/domains/{domain}/aliasesGETaliasesList aliases for a domain
rules/domains/{domain}/rulesGETrulesList rules for a domain

How do I load only new ImprovMX records?

The ImprovMX API reference does not document a timestamp or sequence field for these endpoints, so there is nothing to advertise here as verified. Pick a field from the endpoints table above that increases with every write, then set it as the cursor_path.

{"name": "domains", "endpoint": { "path": "domains", # Replace with a field that increases on every write. "incremental": {"cursor_path": "REPLACE_ME", "initial_value": "2024-01-01T00:00:00Z"}, }}

On the first run dlt loads everything from initial_value; on every run after that it requests only what changed and appends with write_disposition="merge" if you set a primary key. See incremental loading.


What does the generated ImprovMX pipeline look like?

A standard dlt REST API pipeline — the same code you would write by hand, loading /account and /domains from the ImprovMX API into DuckDB:

import dlt from dlt.sources.rest_api import RESTAPIConfig, rest_api_resources @dlt.source def improvmx_source(api_key=dlt.secrets.value): config: RESTAPIConfig = { "client": { "base_url": "https://api.improvmx.com/v3", "auth": {"type": "http_basic", "username": "REPLACE_ME", "password": api_key}, }, "resources": [ {"name": "domains", "endpoint": {"path": "domains", "data_selector": "domains"}}, {"name": "aliases", "endpoint": {"path": "domains/{domain}/aliases", "data_selector": "aliases"}} ], } yield from rest_api_resources(config) def load_improvmx_to_duckdb() -> None: pipeline = dlt.pipeline( pipeline_name="improvmx_pipeline", destination="duckdb", dataset_name="improvmx_data", ) load_info = pipeline.run(improvmx_source()) print(load_info) if __name__ == "__main__": load_improvmx_to_duckdb()

Run it with python improvmx_pipeline.py. The agent iterates on this until it loads cleanly — you review and approve, rather than write it from scratch.


How do I query ImprovMX data in DuckDB?

dlt creates one table per resource. Query the loaded data with Python or SQL — or ask your agent to, through the MCP server's execute_sql_query tool.

Python (pandas DataFrame):

import dlt data = dlt.pipeline("improvmx_pipeline").dataset() df = data.domains.df() print(df.head())

SQL:

SELECT * FROM improvmx_data.domains LIMIT 10;

See querying your data with dataset and exploring it in marimo notebooks.


How do I deploy the ImprovMX to DuckDB pipeline in production?

The pipeline runs locally, which is ideal for prototyping and one-off analysis. When you need it on a schedule, monitored on every load, and shared with your team, deploy the same dlt code on the dltHub platform — no infrastructure to maintain. The prompt above already ends with "run it on dltHub", so your agent can take it there directly.

  • Deploy & schedule — run the pipeline as a managed job with automatic retries.
  • Monitor — observable job queues, alerting, and load metrics for every run.
  • Transform — promote raw ImprovMX loads into governed, documented models.
  • Visualize & share — explore data in notebooks and publish live dashboards instead of static screenshots.

Book a demo →


What other destinations can I load ImprovMX data to?

dlt loads into any of these — only the destination argument changes:

DestinationExample value
PostgreSQL"postgres"
BigQuery"bigquery"
Snowflake"snowflake"
Redshift"redshift"
Databricks"databricks"
Filesystem (S3, GCS, Azure)"filesystem"

Set dlt.pipeline(destination="snowflake") and add credentials in .dlt/secrets.toml. On the dltHub platform the same pipeline runs against a managed Iceberg lakehouse. See the full destinations list.


Next steps

Was this page helpful?

Community Hub

Need more dlt context for ImprovMX to DuckDB?

Request dlt skills, commands, AGENT.md files, and AI-native context.