IBM IMS Python API Docs | dltHub

IBM IMS REST API allows programmatic access to IMS database and transaction resources through z/OS Connect or IBM File Manager services. The REST API base URL is The base URL is constructed as {scheme}://{hostname}:{port}/{base_path}, specific to the z/OS Connect or IMS Connect server deployment. and Initial authentication uses HTTP Basic, followed by optional token-based session management..

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

---

What data can I load from IBM IMS?

Here are some of the endpoints you can load from IBM IMS:

---

How do I authenticate with the IBM IMS API?

Authentication typically begins with an HTTP Basic Authorization header containing a Base64-encoded 'userid

' string. Subsequent calls can use a returned session token to avoid passing credentials repeatedly.

1. Get your credentials

IBM IMS REST APIs are typically exposed via IBM z/OS Connect. There is no centralized public dashboard for generating API keys. Instead, credentials are managed at the infrastructure level by your z/OS system administrator. To obtain access: 1. Contact your z/OS Connect or IMS system administrator to request a valid user ID and password (for Basic Authentication) or a client certificate. 2. If your organization uses API keys, the administrator must configure the API key definition within the z/OS Connect build toolkit or server configuration. 3. For programmatic access, you will typically use an HTTP Authorization header (e.g., 'Authorization: Basic <base64_encoded_credentials>') or provide a client certificate in your request. 4. Refer to your organization's specific z/OS Connect server.xml configuration for the required authentication method (Basic Auth, PassTickets, or TLS certificates).

2. Add them to .dlt/secrets.toml

Copy
[sources.ibm_ims_source]
api_username = "your_zos_user_id"
api_password = "your_zos_password"
# If using Basic Auth, use these in your dlt source configuration.
# For TLS, you would instead point to your certificate and key files.

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 IBM IMS 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 ibm_ims_pipeline.py

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

Copy
Pipeline ibm_ims_pipeline load step completed in 0.26 seconds
1 load package(s) were loaded to destination duckdb and into dataset ibm_ims_data
The duckdb destination used duckdb:/ibm_ims.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 region and tran from the IBM IMS 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 ibm_ims_source(api_key=dlt.secrets.value):
    config: RESTAPIConfig = {
        "client": {
            "base_url": "The base URL is constructed as {scheme}://{hostname}:{port}/{base_path}, specific to the z/OS Connect or IMS Connect server deployment.",
            "auth": {"type": "http_basic", "username": "REPLACE_ME", "password": api_key},
        },
        "resources": [
            {"name": "pgm", "endpoint": {"path": "ims/apis/v1/{imsplex}/pgm"}},
            {"name": "tran", "endpoint": {"path": "ims/apis/v1/{imsplex}/tran"}}
        ],
    }
    yield from rest_api_resources(config)


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

SQL (DuckDB example):

Copy
SELECT * FROM ibm_ims_data.pgm LIMIT 10;

In a marimo or Jupyter notebook:

Copy
import dlt

data = dlt.pipeline("ibm_ims_pipeline").dataset()
data.pgm.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 IBM IMS 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