Forest Admin Python API Docs | dltHub

Forest Admin offers an API for managing data models and business logic, with support for Node.js and various databases. The Admin Backend API handles data retrieval and business logic. The Admin API is hosted on user servers for privacy. The REST API base URL is `` and Authentication is project‑specific and handled by the Forest Admin agent; no universal public token is required..

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

---

What data can I load from Forest Admin?

Here are some of the endpoints you can load from Forest Admin:

---

How do I authenticate with the Forest Admin API?

Authentication is performed via project‑specific credentials configured in the Forest Liana agent (e.g., environment variables such as FOREST_AUTH_SECRET). No public bearer token is required.

1. Get your credentials

1. Follow the Forest Admin agent installation guide for your stack (e.g., https://forestadmin.github.io/agent-nodejs/).
2. During the installation the CLI creates a forestadmin-schema.json and prints the required environment variables such as FOREST_AUTH_SECRET.
3. Copy the value of FOREST_AUTH_SECRET from your .env file or deployment configuration; this is the token you will supply to dlt as the api_key.
4. If you need access to the public Forest Admin API (which is not self‑service), contact Forest Admin via https://www.forestadmin.com/contact-us to request access.

2. Add them to .dlt/secrets.toml

Copy
[sources.forest_admin_source]
api_key = "your_admin_backend_token_or_secret"

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 Forest Admin 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 forest_admin_pipeline.py

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

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

Inspect your pipeline and data:

Copy
dlt pipeline forest_admin_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 collection and collection_count from the Forest Admin 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 forest_admin_source(api_key=dlt.secrets.value):
    config: RESTAPIConfig = {
        "client": {
            "base_url": "",
            "auth": {
                "type": "api_key",
                "api_key": api_key,
            },
        },
        "resources": [
            {"name": "collection", "endpoint": {"path": "{collection}"}},
            {"name": "collection_count", "endpoint": {"path": "{collection}/count"}}
        ],
    }
    yield from rest_api_resources(config)


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

SQL (DuckDB example):

Copy
SELECT * FROM forest_admin_data.collection LIMIT 10;

In a marimo or Jupyter notebook:

Copy
import dlt

data = dlt.pipeline("forest_admin_pipeline").dataset()
data.collection.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 Forest Admin 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