XNAT Web Services Client Tools

The original suite of XNAT Command Line tools has been deprecated. You can download an archival copy here, but these tools are not being updated and we cannot guarantee functionality against modern versions of XNAT.

The XNAT REST API can be used by any number of external client tools and bash scripts. A number of well-supported and well-documented tools have been developed by external XNAT collaborators and community members. We recommend experimenting with these options and using the one that best suits your needs.


Author: IMAGEN - David Just

pyxnat is a Python library to communicate with XNAT which is an extensible database system for imaging and related data. pyxnat uses the RESTful Web Services provided by XNAT and aims to ease communications with an XNAT server to plug-in external tools or python scripts by exposing a simple and consistent API.

Documentation: https://pyxnat.github.io/pyxnat/index.html

Source Code: https://github.com/pyxnat/pyxnat


Author: Erasmus_MC - Hakim Achterberg

xnatpy is an XNAT client that exposes XNAT objects/functions as python objects/functions. The aim is to abstract as much of the REST API away as possible and make xnatpy feel like native Python code.

Documentation: https://xnat.readthedocs.io

Source Code: https://gitlab.com/radiology/infrastructure/xnatpy 

XNAT Data Client (XDC)

Author: NRG - Rick Herrick

The XNAT Data Client supports data transfer operations to and from the XNAT server. The XNAT Data Client jar ships with XNAT, but this version of the XDC tool has been broken out on its own so that it can be placed anywhere on the user’s system path and used as a command line tool.


Source Code / Documentation: https://bitbucket.org/xnatdev/data-client


Author: Harvard - Timothy O'Keefe

Yaxil is an XNAT interface library that started a long time ago in a galaxy far, far away. It works with Python 2 and 3 and XNAT 1.4 through 1.7. As part of its set of tools, it contains a Python-coded version of ArcGet, one of the original XNAT Client Tools.

Documentation: https://yaxil.readthedocs.io

Source Code: https://github.com/harvard-nrg/yaxil