Load ICICI Direct Breeze data to DuckDB

ICICI Direct Breeze is an API platform for trading, order management, and market data retrieval. Everything needed to build a working ICICI Direct Breeze → DuckDB pipeline is on this page: the API's base URL, authentication, endpoints, pagination and incremental field — plus a prompt that hands the whole job to your coding agent.

---

Build your ICICI Direct Breeze to DuckDB pipeline

Paste this prompt into Claude, Codex, or Cursor. The agent does the rest.

PromptCopy prompt
Run uvx dlthub-init@latest to build a pipeline from ICICI Direct Breeze to DuckDB and run it on dltHub

That scaffolds a dltHub workspace and installs the dltHub AI harness — the project rules, the secrets-management skill, and the dlt MCP server your agent needs to work safely. From there it reads the ICICI Direct Breeze API, proposes the endpoints to load, then writes, runs and validates the pipeline while you review rather than type. Credentials are inspected through MCP tools, so your agent never reads secrets.toml itself. How the LLM-native workflow works →

Prefer to write it yourself? Every fact the agent uses is below.

---

ICICI Direct Breeze API at a glance

These values come from the ICICI Direct Breeze API reference — the authoritative source if anything here looks out of date.

---

How do I authenticate with the ICICI Direct Breeze API?

Authentication requires per-request headers: X-AppKey, X-SessionToken, X-Timestamp (ISO8601 UTC with 0 milliseconds), and X-Checksum. The checksum is a SHA256 hash of the string 'timestamp + payload + secret_key', prefixed with the string 'token '.

1. Get your credentials

1. Log in to the Breeze API Portal using your ICICI Direct trading account credentials.
2. Navigate to the 'Register an App' section to create a new application by providing an App Name and a Redirect URL (e.g., https://127.0.0.1).
3. Once registered, navigate to the 'View Apps' section in your dashboard to retrieve your unique 'App Key' (API Key) and 'Secret Key'.
4. To obtain a session token required for authenticated requests, navigate to https://api.icicidirect.com/apiuser/login?api_key=YOUR_ENCODED_API_KEY in your browser.
5. Log in again when prompted. After a successful login, the URL will redirect you to your specified Redirect URL. Inspect the network logs (or the URL parameters) to extract the 'API_Session' value, which serves as your session token. Note that this session token typically expires daily.

2. Add them to .dlt/secrets.toml

Copy
[sources.icici_direct_breeze_source]
api_key = "YOUR_APP_KEY_HERE"
api_secret = "YOUR_SECRET_KEY_HERE"
session_token = "YOUR_SESSION_TOKEN_HERE"

dlt reads this file automatically at runtime. With the harness, the setup-secrets skill prompts you for the values and never handles the raw credential in chat. For production, see setting up credentials with dlt.

---

What ICICI Direct Breeze data can I load into DuckDB?

These are the ICICI Direct Breeze endpoints dlt can load into DuckDB:

---

How do I load only new ICICI Direct Breeze records?

The ICICI Direct Breeze API reference does not document a timestamp or sequence field for these endpoints, so there is nothing to advertise here as verified. Pick a field from the endpoints table above that increases with every write, then set it as the cursor_path.

Copy
{"name": "order_list", "endpoint": {
    "path": "breezeapi/api/v1/orderlist",
    # Replace with a field that increases on every write.
    "incremental": {"cursor_path": "REPLACE_ME", "initial_value": "2024-01-01T00:00:00Z"},
}}

On the first run dlt loads everything from initial_value; on every run after that it requests only what changed and appends with write_disposition="merge" if you set a primary key. See incremental loading.

---

What does the generated ICICI Direct Breeze pipeline look like?

A standard dlt REST API pipeline — the same code you would write by hand, loading customer/customerdetails and apiuser/tradelogin from the ICICI Direct Breeze API into DuckDB:

Copy
import dlt
from dlt.sources.rest_api import RESTAPIConfig, rest_api_resources

@dlt.source
def icici_direct_breeze_source(api_key=dlt.secrets.value):
    config: RESTAPIConfig = {
        "client": {
            "base_url": "https://api.icicidirect.com/breezeapi/api/v1",
            "auth": {"type": "api_key", "api_key": api_key, "name": "X-Checksum"},
        },
        "resources": [
            {"name": "order_list", "endpoint": {"path": "breezeapi/api/v1/orderlist", "data_selector": "Success"}},
            {"name": "trade_list", "endpoint": {"path": "breezeapi/api/v1/tradelist", "data_selector": "Success"}}
        ],
    }
    yield from rest_api_resources(config)


def load_icici_direct_breeze_to_duckdb() -> None:
    pipeline = dlt.pipeline(
        pipeline_name="icici_direct_breeze_pipeline",
        destination="duckdb",
        dataset_name="icici_direct_breeze_data",
    )
    load_info = pipeline.run(icici_direct_breeze_source())
    print(load_info)


if __name__ == "__main__":
    load_icici_direct_breeze_to_duckdb()

Run it with python icici_direct_breeze_pipeline.py. The agent iterates on this until it loads cleanly — you review and approve, rather than write it from scratch.

---

How do I query ICICI Direct Breeze data in DuckDB?

dlt creates one table per resource. Query the loaded data with Python or SQL — or ask your agent to, through the MCP server's execute_sql_query tool.

Python (pandas DataFrame):

Copy
import dlt

data = dlt.pipeline("icici_direct_breeze_pipeline").dataset()
df = data.order_list.df()
print(df.head())

SQL:

Copy
SELECT * FROM icici_direct_breeze_data.order_list LIMIT 10;

See querying your data with dataset and exploring it in marimo notebooks.

---

How do I deploy the ICICI Direct Breeze to DuckDB pipeline in production?

The pipeline runs locally, which is ideal for prototyping and one-off analysis. When you need it on a schedule, monitored on every load, and shared with your team, deploy the same dlt code on the dltHub platform — no infrastructure to maintain. The prompt above already ends with "run it on dltHub", so your agent can take it there directly.

• Deploy & schedule — run the pipeline as a managed job with automatic retries.
• Monitor — observable job queues, alerting, and load metrics for every run.
• Transform — promote raw ICICI Direct Breeze loads into governed, documented models.
• Visualize & share — explore data in notebooks and publish live dashboards instead of static screenshots.

Book a demo →

---

What other destinations can I load ICICI Direct Breeze data to?

dlt loads into any of these — only the destination argument changes:

Set dlt.pipeline(destination="snowflake") and add credentials in .dlt/secrets.toml. On the dltHub platform the same pipeline runs against a managed Iceberg lakehouse. See the full destinations list.

---

Next steps

• Ready for production? Book a demo of the dltHub platform →
• dlt LLM-native workflow docs
• REST API source reference
• Join the dlt community on Slack