Clarity AI Python API Docs | dltHub

Clarity AI is a sustainability data platform providing RESTful access to fund, portfolio, security, and organization level metrics. The REST API base URL is https://api.clarity.ai/clarity/v1 and all requests require a Bearer token.

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

---

What data can I load from Clarity AI?

Here are some of the endpoints you can load from Clarity AI:

---

How do I authenticate with the Clarity AI API?

All requests require an Authorization header with a Bearer token; the token is obtained via a POST request to the /oauth/token endpoint using 'key' and 'secret' fields.

1. Get your credentials

To obtain credentials for the Clarity AI REST API: 1. Sign in to your Clarity AI account at https://go.clarity.ai. 2. Navigate to 'My Account' then 'Account preferences' or 'Developer Settings'. 3. Locate the section for API keys/tokens. 4. Click 'Generate API key' to create a key and secret pair. 5. Copy and save these values securely, as the secret will typically only be displayed once.

2. Add them to .dlt/secrets.toml

Copy
[sources.clarity_ai_source]
api_key = "your_client_key_here"
api_secret = "your_client_secret_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 Clarity AI 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 clarity_ai_pipeline.py

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

Copy
Pipeline clarity_ai_pipeline load step completed in 0.26 seconds
1 load package(s) were loaded to destination duckdb and into dataset clarity_ai_data
The duckdb destination used duckdb:/clarity_ai.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 /oauth/token (for authentication) and /public/securities/sfdr/metric-by-id/async (or other universe-level data endpoints) from the Clarity AI 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 clarity_ai_source(api_key_secret_pair=dlt.secrets.value):
    config: RESTAPIConfig = {
        "client": {
            "base_url": "https://api.clarity.ai/clarity/v1",
            "auth": {"type": "bearer", "token": api_key_secret_pair},
        },
        "resources": [
            {"name": "portfolio_management", "endpoint": {"path": "public/portfolios/{portfolioId}"}},
            {"name": "portfolio_sfdr_values", "endpoint": {"path": "public/portfolios/{portfolioId}/sfdr/metric-by-id"}}
        ],
    }
    yield from rest_api_resources(config)


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

SQL (DuckDB example):

Copy
SELECT * FROM clarity_ai_data.portfolio_management LIMIT 10;

In a marimo or Jupyter notebook:

Copy
import dlt

data = dlt.pipeline("clarity_ai_pipeline").dataset()
data.portfolio_management.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 Clarity AI 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