Data Virtuality LDW Python API Docs | dltHub

Build a Data Virtuality LDW-to-database pipeline in Python using dlt with AI harness support for Claude Code, Cursor, and Codex.

Last updated:

Data Virtuality Logical Data Warehouse (LDW) is a data virtualization platform that provides a REST API for executing SQL queries and managing data integration tasks. The REST API base URL is https://<host>/<token>/rest/api/ or http://<host>:8080/rest/api/ and Uses Basic Authentication or token-based path authentication depending on the deployment (on-premise vs SaaS)..

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 Data Virtuality LDW data in under 10 minutes.


What data can I load from Data Virtuality LDW?

Here are some of the endpoints you can load from Data Virtuality LDW:

ResourceEndpointMethodData selectorDescription
status/rest/api/statusGETChecks API status
sources/rest/api/sourceGETLists all data sources
source_content/rest/api/source/{name}GETLists tables/views in a source
table_content/rest/api/source/{source-name}/{table-name}GETRetrieves content of a table
query/rest/api/queryPOSTExecutes SQL query

How do I authenticate with the Data Virtuality LDW API?

For on-premise, Basic Authentication is used with database username and platform password. For SaaS, token-based authentication involves including a token in the URL path (e.g., https://

//rest/api/...).

1. Get your credentials

  1. Log in to the Data Virtuality Platform Web UI. 2. Navigate to the Preferences section. 3. Locate the Proxy configurations and Database Username section. 4. Toggle the switch next to REST to enable it. 5. Click the Copy button to retrieve your REST API link, which contains your unique token in the format: https:////rest. The database username found in the same section is also required for authentication.

2. Add them to .dlt/secrets.toml

[sources.data_virtuality_ldw_source] username = "REPLACE_ME"

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 harness:

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:

dlthub 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 Data Virtuality LDW 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 data_virtuality_ldw_pipeline.py

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

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

Inspect your pipeline and data:

dlt pipeline data_virtuality_ldw_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 /rest/api/status/ and /rest/api/query from the Data Virtuality LDW 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 data_virtuality_ldw_source(username=dlt.secrets.value): config: RESTAPIConfig = { "client": { "base_url": "https://<host>/<token>/rest/api/ or http://<host>:8080/rest/api/", "auth": {"type": "http_basic", "username": "REPLACE_ME", "password": username}, }, "resources": [ {"name": "sources", "endpoint": {"path": "rest/api/source"}}, {"name": "query", "endpoint": {"path": "rest/api/query"}} ], } yield from rest_api_resources(config) def get_data() -> None: pipeline = dlt.pipeline( pipeline_name="data_virtuality_ldw_pipeline", destination="duckdb", dataset_name="data_virtuality_ldw_data", ) load_info = pipeline.run(data_virtuality_ldw_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("data_virtuality_ldw_pipeline").dataset() sessions_df = data.status.df() print(sessions_df.head())

SQL (DuckDB example):

SELECT * FROM data_virtuality_ldw_data.status LIMIT 10;

In a marimo or Jupyter notebook:

import dlt data = dlt.pipeline("data_virtuality_ldw_pipeline").dataset() data.status.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 Data Virtuality LDW 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 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.
dlthub ai toolkit data-exploration install dlthub ai toolkit dlthub-platform install

Was this page helpful?

Community Hub

Need more dlt context for Data Virtuality LDW?

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

Available Pipelines