Geocode.xyz Python API Docs | dltHub

Geocode.xyz provides worldwide forward and reverse geocoding, batch geocoding, and geoparsing services through an HTTP-based REST API. The REST API base URL is https://geocode.xyz and requests use an API key passed as a query parameter.

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 add "dlt[hub]" and start loading Geocode.xyz data in under 10 minutes.

---

What data can I load from Geocode.xyz?

Here are some of the endpoints you can load from Geocode.xyz:

---

How do I authenticate with the Geocode.xyz API?

Authentication is performed by passing an API key as a query parameter in the request URL (e.g., &auth=YOUR_API_KEY). No specific headers are required for authentication.

1. Get your credentials

1. Navigate to the Geocode.xyz registration page at https://geocode.xyz/new_account.
2. Complete the registration process to create an account and verify your email address.
3. Once registered, log in to your account dashboard on the Geocode.xyz website.
4. Locate your API key (often referred to as an 'auth token' or 'auth code') within your account dashboard or profile settings.
5. Copy this string for use in your API requests via the 'auth' query parameter.

2. Add them to .dlt/secrets.toml

Copy
[sources.geocode_xyz_source]
auth = "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:

Copy
uv init
uv add "dlt[hub]"

1. Install the dlt AI harness:

Copy
uv run dlthub 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:

Copy
uv run dlthub ai toolkit install rest-api-pipeline

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 Geocode.xyz 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:

Copy
uv run python geocode_xyz_pipeline.py

If everything is configured correctly, you'll see output like this:

Copy
Pipeline geocode_xyz_pipeline load step completed in 0.26 seconds
1 load package(s) were loaded to destination duckdb and into dataset geocode_xyz_data
The duckdb destination used duckdb:/geocode_xyz.duckdb location to store data
Load package 1749667187.541553 is LOADED and contains no failed jobs

Inspect your pipeline and data:

Copy
uv run dlthub 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 /?locate={location} (forward geocoding) and /?locate={lat},{lon} (reverse geocoding) from the Geocode.xyz API into DuckDB. It mirrors the endpoint and data selector configuration from the table above:

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

@dlt.source
def geocode_xyz_source(auth=dlt.secrets.value):
    config: RESTAPIConfig = {
        "client": {
            "base_url": "https://geocode.xyz",
            "auth": {"type": "api_key", "api_key": auth, "name": "auth", "location": "query"},
        },
        "resources": [
            {"name": "forward_geocode", "endpoint": {"path": "/?locate={location}&json=1"}},
            {"name": "reverse_geocode", "endpoint": {"path": "/?locate={lat},{lon}&json=1"}}
        ],
    }
    yield from rest_api_resources(config)


def get_data() -> None:
    pipeline = dlt.pipeline(
        pipeline_name="geocode_xyz_pipeline",
        destination="duckdb",
        dataset_name="geocode_xyz_data",
    )
    load_info = pipeline.run(geocode_xyz_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):

Copy
import dlt

data = dlt.pipeline("geocode_xyz_pipeline").dataset()
sessions_df = data.forward_geocode.df()
print(sessions_df.head())

SQL (DuckDB example):

Copy
SELECT * FROM geocode_xyz_data.forward_geocode LIMIT 10;

In a marimo or Jupyter notebook:

Copy
import dlt

data = dlt.pipeline("geocode_xyz_pipeline").dataset()
data.forward_geocode.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 Geocode.xyz data to?

dlt supports loading into any of these destinations — only the destination parameter changes:

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 harness:

• data-exploration — Build custom notebooks, charts, and dashboards for deeper analysis with marimo notebooks.
• dlthub-platform — Deploy, schedule, and monitor your pipeline in production.

Copy
uv run dlthub ai toolkit install data-exploration
uv run dlthub ai toolkit install dlthub-platform

• How to deploy a pipeline
• How to explore your data in marimo Notebooks
• How to query your data in Python with dataset
• Join the dlt community on Slack