Load What3Words data to DuckDB

what3words is an addressing system and API service that converts geographic coordinates to three-word addresses and vice versa. Everything needed to build a working What3Words → 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 What3Words to DuckDB pipeline

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

PromptCopy prompt
Run uvx dlthub-init@latest to build a pipeline from What3Words 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 What3Words 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.

---

What3Words API at a glance

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

---

How do I authenticate with the What3Words API?

The API key can be supplied as a query parameter named 'key' or as an HTTP request header named 'X-Api-Key'.

1. Get your credentials

To obtain your API credentials, navigate to the what3words 'plans & pricing' page (https://accounts.what3words.com/select-plan). Select a plan that meets your needs, sign up or log in to your account, and complete the registration details. Once your account is set up, your API key will be generated and available within your what3words account dashboard.

2. Add them to .dlt/secrets.toml

Copy
[sources.what3words_source]
what3words_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 What3Words data can I load into DuckDB?

These are the What3Words endpoints dlt can load into DuckDB:

---

How do I load only new What3Words records?

The What3Words 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.

Copy
{"name": "autosuggest", "endpoint": {
    "path": "autosuggest",
    # 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 What3Words pipeline look like?

A standard dlt REST API pipeline — the same code you would write by hand, loading /convert-to-coordinates and /convert-to-3wa from the What3Words API into DuckDB:

Copy
import dlt
from dlt.sources.rest_api import RESTAPIConfig, rest_api_resources

@dlt.source
def what3words_source(key=dlt.secrets.value):
    config: RESTAPIConfig = {
        "client": {
            "base_url": "https://api.what3words.com/v3",
            "auth": {"type": "api_key", "api_key": key, "name": "X-Api-Key", "location": "header"},
        },
        "resources": [
            {"name": "autosuggest", "endpoint": {"path": "autosuggest"}},
            {"name": "available_languages", "endpoint": {"path": "available-languages"}}
        ],
    }
    yield from rest_api_resources(config)


def load_what3words_to_duckdb() -> None:
    pipeline = dlt.pipeline(
        pipeline_name="what3words_pipeline",
        destination="duckdb",
        dataset_name="what3words_data",
    )
    load_info = pipeline.run(what3words_source())
    print(load_info)


if __name__ == "__main__":
    load_what3words_to_duckdb()

Run it with python what3words_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 What3Words 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):

Copy
import dlt

data = dlt.pipeline("what3words_pipeline").dataset()
df = data.autosuggest.df()
print(df.head())

SQL:

Copy
SELECT * FROM what3words_data.autosuggest LIMIT 10;

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

---

How do I deploy the What3Words 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 What3Words 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 What3Words data to?

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

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

• Ready for production? Book a demo of the dltHub platform →
• dlt LLM-native workflow docs
• REST API source reference
• Join the dlt community on Slack