Byteplant-address-validator Python API Docs | dltHub

Byteplant Address Validator is an address validation, correction, autocomplete and geocoding REST API for global addresses. The REST API base URL is https://api.address-validator.net and all requests require an API key passed as query parameter APIKey.

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 Byteplant-address-validator data in under 10 minutes.

---

What data can I load from Byteplant-address-validator?

Here are some of the endpoints you can load from Byteplant-address-validator:

---

How do I authenticate with the Byteplant-address-validator API?

Authentication is done with a per‑account API key. Include APIKey=your_api_key in the query string (or in POST body parameters) for each request.

1. Get your credentials

1. Sign up or log in at https://www.byteplant.com/address-validator/. 2) In your account dashboard or API/account section copy the API key shown. 3) Use that key as the value for the APIKey query parameter in requests.

2. Add them to .dlt/secrets.toml

Copy
[sources.byteplant_address_validator_source]
api_key = "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 venv && source .venv/bin/activate
uv pip install "dlt[workspace]"

1. Install the dlt AI Workbench:

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

Copy
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 Byteplant-address-validator 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
python byteplant_address_validator_pipeline.py

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

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

Inspect your pipeline and data:

Copy
dlt pipeline byteplant_address_validator_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 verify and search from the Byteplant-address-validator 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 byteplant_address_validator_source(api_key=dlt.secrets.value):
    config: RESTAPIConfig = {
        "client": {
            "base_url": "https://api.address-validator.net",
            "auth": {
                "type": "api_key",
                "api_key": api_key,
            },
        },
        "resources": [
            {"name": "verify", "endpoint": {"path": "api/verify"}},
            {"name": "search", "endpoint": {"path": "api/search", "data_selector": "results"}}
        ],
    }
    yield from rest_api_resources(config)


def get_data() -> None:
    pipeline = dlt.pipeline(
        pipeline_name="byteplant_address_validator_pipeline",
        destination="duckdb",
        dataset_name="byteplant_address_validator_data",
    )
    load_info = pipeline.run(byteplant_address_validator_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("byteplant_address_validator_pipeline").dataset()
sessions_df = data.verify.df()
print(sessions_df.head())

SQL (DuckDB example):

Copy
SELECT * FROM byteplant_address_validator_data.verify LIMIT 10;

In a marimo or Jupyter notebook:

Copy
import dlt

data = dlt.pipeline("byteplant_address_validator_pipeline").dataset()
data.verify.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 Byteplant-address-validator 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.

---

Troubleshooting

Authentication failures

If APIKey is missing or invalid, the response includes status codes/messages like API_KEY_INVALID_OR_DEPLETED and the request will fail. Ensure APIKey is provided as a query parameter or in the POST body.

Rate limits

The default rate limit is 100 API requests per 300 seconds. Responses contain ratelimit_remain and ratelimit_seconds. When the limit is exceeded the API returns RATE_LIMIT_EXCEEDED.

Error/result status codes

Common status values in the JSON response are VALID, SUSPECT, INVALID, DELAYED, NO_COUNTRY, RATE_LIMIT_EXCEEDED, API_KEY_INVALID_OR_DEPLETED, RESTRICTED, INTERNAL_ERROR. Use the status field to handle results and errors appropriately.

Ensure that the API key is valid to avoid 401 Unauthorized errors. Also, verify endpoint paths and parameters to avoid 404 Not Found errors.

---

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.

Copy
dlt ai toolkit data-exploration install
dlt ai toolkit dlthub-runtime install

• 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