PySTAC Python API Docs | dltHub

PySTAC API reference provides documentation for Python classes and methods. It includes a base class for dealing with links and extensions. The stac_io module handles file reading and serialization. The REST API base URL is (user‑supplied STAC API root URL, e.g. https://demo.stacserver.org or any STAC API root). PySTAC/pystac-client do not provide a single fixed API host; the client opens any STAC Catalog/API root href provided by the user. and No required built‑in auth; auth (if needed) is provided via request headers or a request_modifier—e.g., Bearer token or custom signing..

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

---

What data can I load from PySTAC?

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

---

How do I authenticate with the PySTAC API?

PySTAC/pystac-client do not mandate a specific auth scheme. When an API requires authentication, pass credentials via the Client headers parameter or use a request_modifier to inject Authorization headers or perform request signing (e.g., AWS SigV4).

1. Get your credentials

Obtain credentials from the STAC API provider's dashboard (varies by provider). Then either (1) set an Authorization header (e.g. 'Authorization: Bearer ') when creating the Client, or (2) implement a request_modifier that attaches required headers or signs requests.

2. Add them to .dlt/secrets.toml

Copy
[sources.pystac_source]
api_token = "your_bearer_token_here"
# or raw header mapping if preferred
authorization_header = "Bearer your_bearer_token_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 PySTAC 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 pystac_pipeline.py

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

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

Inspect your pipeline and data:

Copy
dlt pipeline pystac_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 collections and items from the PySTAC 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 pystac_source(api_token=dlt.secrets.value):
    config: RESTAPIConfig = {
        "client": {
            "base_url": "(user‑supplied STAC API root URL, e.g. https://demo.stacserver.org or any STAC API root). PySTAC/pystac-client do not provide a single fixed API host; the client opens any STAC Catalog/API root href provided by the user.",
            "auth": {
                "type": "bearer",
                "token": api_token,
            },
        },
        "resources": [
            {"name": "collections", "endpoint": {"path": "collections", "data_selector": "collections"}},
            {"name": "items", "endpoint": {"path": "collections/{collection_id}/items", "data_selector": "features"}}
        ],
    }
    yield from rest_api_resources(config)


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

SQL (DuckDB example):

Copy
SELECT * FROM pystac_data.collections LIMIT 10;

In a marimo or Jupyter notebook:

Copy
import dlt

data = dlt.pipeline("pystac_pipeline").dataset()
data.collections.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 PySTAC 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 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