ADC Connect Python API Docs | dltHub

Build a ADC Connect-to-database pipeline in Python using dlt with AI Workbench support for Claude Code, Cursor, and Codex.

Last updated:

ADC Connect's REST API documentation is available at https://adc-connect.org/reference.html. The API allows seamless connection to programs for calculations based on algebraic-diagrammatic methods. The main entry point for ADC calculations is found in the adc2 module. The REST API base URL is https://<host>/api and All requests require a Bearer token obtained from POST /api/user/login..

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


What data can I load from ADC Connect?

Here are some of the endpoints you can load from ADC Connect:

ResourceEndpointMethodData selectorDescription
load_balance_virtual_serverload_balance_virtual_serverGETpayloadGet list of virtual servers (returns payload array of objects)
platform_resourcesplatform/resourcesGETpayloadGet system resource information (payload object)
platform_disk_statusplatform/disk_statusGETpayloadGet disk status (payload object)
system_time_manual_timesystem_time_manual/timeGETpayloadGet current system time (payload.system_time)
system_dos_preventionsystem_dos_preventionGETpayloadGet DOS protection config (payload object)
user_touchuser/touchGET(none) or payloadTouch/keepalive endpoint (may return token expiry info; examples show GET api/user/touch with Authorization header)
downloader_configdownloader/configGETpayloadDownload configuration file information (payload)
security_waf_json_validation_detectionsecurity_waf_json_validation_detectionGETpayloadGet WAF JSON validation detection list (payload array)
platform_err_msgplatform/errMsgGETpayloadGet system error messages (payload object mapping codes->messages)

How do I authenticate with the ADC Connect API?

Authenticate by POSTing credentials to /api/user/login; the response contains a token which must be sent in the Authorization header as 'Bearer ' for subsequent requests.

1. Get your credentials

  1. POST JSON {"username":"YOUR_USER","password":"YOUR_PASS"} to /api/user/login. 2) Take the 'token' value from the response. 3) Send subsequent requests with header Authorization: Bearer .

2. Add them to .dlt/secrets.toml

[sources.adc_connect_source] token = "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:

uv venv && source .venv/bin/activate uv pip install "dlt[workspace]"

1. Install the dlt AI Workbench:

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:

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 ADC Connect 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:

python adc_connect_pipeline.py

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

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

Inspect your pipeline and data:

dlt pipeline adc_connect_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 load_balance_virtual_server and platform/resources from the ADC Connect API into DuckDB. It mirrors the endpoint and data selector configuration from the table above:

import dlt from dlt.sources.rest_api import RESTAPIConfig, rest_api_resources @dlt.source def adc_connect_source(token=dlt.secrets.value): config: RESTAPIConfig = { "client": { "base_url": "https://<host>/api", "auth": { "type": "bearer", "token": token, }, }, "resources": [ {"name": "load_balance_virtual_server", "endpoint": {"path": "load_balance_virtual_server", "data_selector": "payload"}}, {"name": "platform_resources", "endpoint": {"path": "platform/resources", "data_selector": "payload"}} ], } yield from rest_api_resources(config) def get_data() -> None: pipeline = dlt.pipeline( pipeline_name="adc_connect_pipeline", destination="duckdb", dataset_name="adc_connect_data", ) load_info = pipeline.run(adc_connect_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):

import dlt data = dlt.pipeline("adc_connect_pipeline").dataset() sessions_df = data.load_balance_virtual_server.df() print(sessions_df.head())

SQL (DuckDB example):

SELECT * FROM adc_connect_data.load_balance_virtual_server LIMIT 10;

In a marimo or Jupyter notebook:

import dlt data = dlt.pipeline("adc_connect_pipeline").dataset() data.load_balance_virtual_server.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 ADC Connect data to?

dlt supports loading into any of these destinations — only the destination parameter changes:

DestinationExample value
DuckDB (local, default)"duckdb"
PostgreSQL"postgres"
BigQuery"bigquery"
Snowflake"snowflake"
Redshift"redshift"
Databricks"databricks"
Filesystem (S3, GCS, Azure)"filesystem"

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.
dlt ai toolkit data-exploration install dlt ai toolkit dlthub-runtime install

Was this page helpful?

Community Hub

Need more dlt context for ADC Connect?

Request dlt skills, commands, AGENT.md files, and AI-native context.