No logo available for Mirakl to DuckDB connector icon

Load Mirakl data to DuckDB

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

SourceMiraklMirakl Developer PortalDestinationDuckDBIn-process analytical database. The default local destination for dlt pipelines.

Mirakl is a marketplace platform providing APIs for managing products, sellers, and invoices within an e-commerce ecosystem. Everything needed to build a working Mirakl → 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 Mirakl 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 Mirakl 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 Mirakl 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.


Mirakl API at a glance

Base URLhttps://your-instance.mirakl.net
Example endpointGET v2/orders
Records found atdata
Authenticationrequests require either an API key or a Bearer token in the Authorization header — sent in the Authorization header, prefixed Bearer
PaginationCursor-based via page_token, next cursor at next_page_token, page size via limit (default 25)
Incremental fieldupdated_at
Record idorder_id
API referencehttps://developer.mirakl.com/content/product/connect-channel-platform/developer-guide/authentication

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


How do I authenticate with the Mirakl API?

Authentication is performed using the 'Authorization' HTTP header. Depending on the API, this requires either an API key or a Bearer token in the format 'Authorization: Bearer ' or 'Authorization: <api_key>'.

1. Get your credentials

To obtain your Mirakl API key, log in to your Mirakl portal using Master Account credentials. Click on your username or profile icon in the top right corner of the dashboard. Select 'My User Settings' (or 'My Settings') from the dropdown menu. Navigate to the 'API Key' tab. If no key exists, click the 'Generate a new API key' button. Copy the generated key securely, as it will be used for authentication.

2. Add them to .dlt/secrets.toml

[sources.mirakl_source] api_key = "REPLACE_ME"

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 Mirakl data can I load into DuckDB?

These are the Mirakl endpoints dlt can load into DuckDB:

ResourceEndpointMethodData selectorDescription
orders/v2/ordersGETdataList Mirakl Connect orders using seek pagination.
returns/v2/orders/returnsGETdataList Mirakl Connect returns using seek pagination.
order_documents/v2/orders/documentsGETdocumentsList documents across orders using seek pagination.
orders_mmp/api/ordersGETordersList orders using offset pagination.
products_mmp/api/productsGETproductsGet products for a list of product references.

How do I load only new Mirakl records?

Mirakl exposes updated_at on v2/orders, so dlt can request only the records that changed since the last run. Set it as the cursor_path and dlt tracks the high-water mark for you between runs.

{"name": "orders", "endpoint": { "path": "v2/orders", "data_selector": "data", "incremental": {"cursor_path": "updated_at", "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 Mirakl pipeline look like?

A standard dlt REST API pipeline — the same code you would write by hand, loading api/products/imports and api/users from the Mirakl API into DuckDB:

import dlt from dlt.sources.rest_api import RESTAPIConfig, rest_api_resources @dlt.source def mirakl_source(api_key=dlt.secrets.value): config: RESTAPIConfig = { "client": { "base_url": "https://your-instance.mirakl.net", "auth": {"type": "bearer", "token": api_key}, }, "resources": [ {"name": "orders", "endpoint": {"path": "v2/orders", "data_selector": "data"}}, {"name": "returns", "endpoint": {"path": "v2/orders/returns", "data_selector": "data"}} ], } yield from rest_api_resources(config) def load_mirakl_to_duckdb() -> None: pipeline = dlt.pipeline( pipeline_name="mirakl_pipeline", destination="duckdb", dataset_name="mirakl_data", ) load_info = pipeline.run(mirakl_source()) print(load_info) if __name__ == "__main__": load_mirakl_to_duckdb()

Run it with python mirakl_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 Mirakl 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("mirakl_pipeline").dataset() df = data.orders.df() print(df.head())

SQL:

SELECT * FROM mirakl_data.orders LIMIT 10;

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


How do I deploy the Mirakl 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 Mirakl 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 Mirakl 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 Mirakl to DuckDB?

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