Streak Python API Docs | dltHub

Streak is a CRM that runs inside Gmail and exposes a REST API to programmatically access pipelines, boxes, fields, stages, tasks, comments, users, teams, and webhooks. The REST API base URL is https://api.streak.com/api/v1 and all requests require HTTP Basic Auth using your API key as the username.

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

---

What data can I load from Streak?

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

---

How do I authenticate with the Streak API?

Streak uses HTTP Basic Authentication. Set the request username to your API key and omit the password (or set it empty). All requests must be made over HTTPS.

1. Get your credentials

1. Sign in to your Streak account at https://www.streak.com.
2. Open Streak settings and navigate to the API section (Get your Streak API key) or visit the API keys area in your account settings.
3. Copy the API key shown.
4. If compromised, delete and regenerate the key from the same settings page.

2. Add them to .dlt/secrets.toml

Copy
[sources.streak_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 Streak 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 streak_pipeline.py

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

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

Inspect your pipeline and data:

Copy
dlt pipeline streak_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 pipelines and boxes from the Streak 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 streak_source(api_key=dlt.secrets.value):
    config: RESTAPIConfig = {
        "client": {
            "base_url": "https://api.streak.com/api/v1",
            "auth": {
                "type": "http_basic",
                "api_key": api_key,
            },
        },
        "resources": [
            {"name": "pipelines", "endpoint": {"path": "pipelines", "data_selector": "pipelines"}},
            {"name": "boxes", "endpoint": {"path": "boxes?pipelineKey={pipelineKey}", "data_selector": "boxes"}}
        ],
    }
    yield from rest_api_resources(config)


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

SQL (DuckDB example):

Copy
SELECT * FROM streak_data.pipelines LIMIT 10;

In a marimo or Jupyter notebook:

Copy
import dlt

data = dlt.pipeline("streak_pipeline").dataset()
data.pipelines.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 Streak 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 you receive 401 Unauthorized, ensure you're using HTTP Basic Auth with the API key as the username and an empty password. All requests must be HTTPS.

Rate limits and large pulls

Streak does not publish a strict rate limit; treat requests conservatively and paginate where applicable. Date fields are in milliseconds since epoch; use incremental pulls with updated timestamps to avoid re‑fetching.

Pagination and list selectors

Many list endpoints return an object containing a top‑level key with the list (e.g. "pipelines", "boxes", "stages", "fields", "users", "webhooks", "tasks", "comments"). Use the exact key shown in the docs when extracting records.

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