Zyte Python API Docs | dltHub

Zyte API provides web scraping and data extraction capabilities including automatic extraction and HTTP request handling. The REST API base URL is https://api.zyte.com/v1 and all requests require HTTP Basic authentication using an API key.

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 Zyte data in under 10 minutes.

---

What data can I load from Zyte?

Here are some of the endpoints you can load from Zyte:

---

How do I authenticate with the Zyte API?

All requests require HTTP Basic Authentication, where the Zyte API key is used as the username and no password is provided (e.g., 'API_KEY:'). This requires an 'Authorization' header with the value 'Basic <base64_encoded_key_plus_colon>'.

1. Get your credentials

To obtain your Zyte API credentials, log in to your account at https://app.zyte.com. Navigate to 'Settings' and then 'API access' (or directly visit https://app.zyte.com/o/zyte-api/api-access). Copy the Zyte API key displayed there; this key acts as the username for HTTP Basic authentication, with an empty password.

2. Add them to .dlt/secrets.toml

Copy
[sources.zyte_source]
api_key = "your_zyte_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 Zyte 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 zyte_pipeline.py

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

Copy
Pipeline zyte_pipeline load step completed in 0.26 seconds
1 load package(s) were loaded to destination duckdb and into dataset zyte_data
The duckdb destination used duckdb:/zyte.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 requests and items from the Zyte 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 zyte_source(api_key=dlt.secrets.value):
    config: RESTAPIConfig = {
        "client": {
            "base_url": "https://api.zyte.com/v1",
            "auth": {"type": "http_basic", "username": "REPLACE_ME", "password": api_key},
        },
        "resources": [
            {"name": "items", "endpoint": {"path": "items", "data_selector": "items"}},
            {"name": "requests", "endpoint": {"path": "requests", "data_selector": "requests"}}
        ],
    }
    yield from rest_api_resources(config)


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

SQL (DuckDB example):

Copy
SELECT * FROM zyte_data.items LIMIT 10;

In a marimo or Jupyter notebook:

Copy
import dlt

data = dlt.pipeline("zyte_pipeline").dataset()
data.items.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 Zyte 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