Skip to main content

ADIT Client

About

ADIT Client is the official Python client of ADIT (Automated DICOM Transfer). It wraps the DICOMweb API of an ADIT server (QIDO-RS, WADO-RS, STOW-RS and the NIfTI extension). Transfer jobs (selective/batch transfer) are not managed through this client.

Installation

Requires Python 3.12 or newer.

pip install adit-client
# or
uv add adit-client

Usage

Prerequisites

  • Generate an API token in your ADIT profile.
  • Make sure you have the permissions to access the ADIT API.
  • Also make sure you have access to the DICOM nodes you want query.

Code

from adit_client import AditClient

server_url = "https://adit" # The host URL of the ADIT server
auth_token = "my_token" # The authentication token generated in your profile
client = AditClient(server_url=server_url, auth_token=auth_token)

# Search for studies. The first parameter is the AE title of the DICOM server
# you want to query.
studies = client.search_for_studies("ORTHANC1", {"PatientName": "Doe, John"})

# The client returns pydicom datasets.
study_descriptions = [study.StudyDescription for study in studies]

Client options

AditClient(server_url, auth_token, verify=True, trial_protocol_id=None, trial_protocol_name=None)

  • verify: True/False to enable/disable TLS verification, or the path to a CA bundle.
  • trial_protocol_id / trial_protocol_name: sent along with every retrieve request so the server can set the corresponding DICOM tags on the retrieved data.

Methods

Every method takes the AE title of the DICOM server as first argument.

Query (QIDO-RS), results are pydicom datasets:

  • search_for_studies(ae_title, query=None)
  • search_for_series(ae_title, study_uid, query=None)
  • search_for_images(ae_title, study_uid, series_uid, query=None)

Retrieve (WADO-RS), the retrieve_* methods return lists of pydicom datasets, the *_metadata methods return the DICOM JSON metadata and the iter_* methods stream the datasets one by one. They accept an optional pseudonym that makes the server pseudonymize the data before sending it:

  • retrieve_study(ae_title, study_uid, pseudonym=None), retrieve_study_metadata(...), iter_study(...)
  • retrieve_series(ae_title, study_uid, series_uid, pseudonym=None), retrieve_series_metadata(...), iter_series(...)
  • retrieve_image(ae_title, study_uid, series_uid, image_uid, pseudonym=None), retrieve_image_metadata(...)

Store (STOW-RS):

  • store_images(ae_title, images): uploads a list of pydicom datasets.

NIfTI, returns (filename, BytesIO) tuples (the iter_* variants stream them):

  • retrieve_nifti_study(ae_title, study_uid), iter_nifti_study(...)
  • retrieve_nifti_series(ae_title, study_uid, series_uid), iter_nifti_series(...)
  • retrieve_nifti_image(ae_title, study_uid, series_uid, image_uid), iter_nifti_image(...)

License

  • AGPL 3.0 or later

Metadata

Release files for adit-client 0.53.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for adit-client 0.53.0
File Size Uploaded Provenance Actions
adit_client-0.53.0.tar.gz 36.2 kB With provenance Details for adit_client-0.53.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for adit-client 0.53.0
File Interpreter ABI Platform Actions
adit_client-0.53.0-py3-none-any.whl Python 3 none any Details for adit_client-0.53.0-py3-none-any.whl

Total release size: 41.6 kB

Release files / adit_client-0.53.0.tar.gz

Download URL adit_client-0.53.0.tar.gz
Size 36.2 kB
Tags Source
SHA-256 checksum
How to use checksums
1f9b6e7dac178c0eb5676379ade50e2bc52177e29cb36834d1dae5c1f1925e40
BLAKE2b-256 checksum
How to use checksums
2b5bc797f86a40a38ac3cd7883153cad45a88cb6359090d5ad8874b0df79479f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 11, 2026.

Transparency log

Release files / adit_client-0.53.0-py3-none-any.whl

Download URL adit_client-0.53.0-py3-none-any.whl
Size 5.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
cd105b3536ed872246973aa8ad04010470b7bc287a29fc101f904791f621bcb6
BLAKE2b-256 checksum
How to use checksums
c85172e6a5437030e3d079b9617ad57235a7e17528d98648a1a25d58915ccf25
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 11, 2026.

Transparency log

Security for adit-client 0.53.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for adit_client-0.53.0.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 11, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.53.0 This release

2 release files Full provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page