PlaceKit Python API Docs | dltHub
Build a PlaceKit-to-database pipeline in Python using dlt with AI Workbench support for Claude Code, Cursor, and Codex.
Last updated:
PlaceKit is a geocoding API offering address autocomplete, store locator, and geocoding services. It provides a REST API and OpenAPI specification for integration. The service is free for the first 10,000 requests per month. The REST API base URL is https://api.placekit.io and all requests require an API key sent in the x-placekit-api-key request header (public keys for read‑only, private keys for admin)..
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 PlaceKit data in under 10 minutes.
What data can I load from PlaceKit?
Here are some of the endpoints you can load from PlaceKit:
| Resource | Endpoint | Method | Data selector | Description |
|---|---|---|---|---|
| search | /search | POST | results | Geocoding / autocomplete search; returns an object with results array and metadata (resultsCount, maxResults, query). |
| reverse | /reverse | POST | results | Reverse geocoding; returns an object with results array and metadata (resultsCount, maxResults, query). |
| keys | /keys | GET | List API keys for the current app; response is a top‑level JSON array of key objects. | |
| get_key | /keys/{id} | GET | Get a single API key by id; returns a key object. | |
| list_patches | /patch/search | POST | results | List Live Patching records; returns an object with results array and pagination (offset, totalResults, maxResults). |
| get_patch | /patch/{id} | GET | Get one patch record by id; returns a single patch record object. |
How do I authenticate with the PlaceKit API?
Set your API key in the request header 'x-placekit-api-key'. Public keys are read‑only (geocoding); private keys enable admin actions such as live patching and key management.
1. Get your credentials
- Sign in to your PlaceKit account at https://placekit.io.
- Open Developers → API keys (or the Keys section) in the dashboard.
- Click "Create new API key", choose a role (public or private).
- Copy the generated token and store it securely; use it in the
x-placekit-api-keyheader for all requests.
2. Add them to .dlt/secrets.toml
[sources.placekit_source] api_key = "your_placekit_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 PlaceKit 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 placekit_pipeline.py
If everything is configured correctly, you'll see output like this:
Pipeline placekit_pipeline load step completed in 0.26 seconds 1 load package(s) were loaded to destination duckdb and into dataset placekit_data The duckdb destination used duckdb:/placekit.duckdb location to store data Load package 1749667187.541553 is LOADED and contains no failed jobs
Inspect your pipeline and data:
dlt pipeline placekit_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 search and keys from the PlaceKit 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 placekit_source(api_key=dlt.secrets.value): config: RESTAPIConfig = { "client": { "base_url": "https://api.placekit.io", "auth": { "type": "api_key", "api_key": api_key, }, }, "resources": [ {"name": "search", "endpoint": {"path": "search", "data_selector": "results"}}, {"name": "keys", "endpoint": {"path": "keys"}} ], } yield from rest_api_resources(config) def get_data() -> None: pipeline = dlt.pipeline( pipeline_name="placekit_pipeline", destination="duckdb", dataset_name="placekit_data", ) load_info = pipeline.run(placekit_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("placekit_pipeline").dataset() sessions_df = data.search.df() print(sessions_df.head())
SQL (DuckDB example):
SELECT * FROM placekit_data.search LIMIT 10;
In a marimo or Jupyter notebook:
import dlt data = dlt.pipeline("placekit_pipeline").dataset() data.search.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 PlaceKit 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 PlaceKit?
Request dlt skills, commands, AGENT.md files, and AI-native context.