The Cancer Imaging Archive (TCIA) Public Access

Space shortcuts

Child pages
  • TCIA Programmatic Interface REST API Guides
9 more child pages

Versions Compared

Old Version 73

changes.mady.by.user Carolyn Klinger

Saved on

compared with

New Version 74

changes.mady.by.user Carolyn Klinger

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This page describes the representational state transfer application programming interface (REST API) implementations that can be used to access TCIA data and resources. The APIs complement the existing web interfaces and enable developers to build direct access to TCIA data into their applications using only the API documentation provided. The application developer must ensure that they and the users of their applications comply with the TCIA Data Usage Policy.

TCIA currently offers two RESTful interfaces:the following RESTful interfaces to the search and download functions enabled by the National Biomedical Imaging Archive (NBIA) software in the TCIA radiology portal.

  • TCIA REST APIs: Originally developed using Project Bindaas with Emory University, these APIs provide access to public collections and do not require authentication or API keys to use them. The TCIA REST API Guide describes these APIs.  
  • National Biomedical Imaging Archive (NBIA ) Search REST APIs: Provided as part of the NBIA software, these APIs provide access to the search and download functions used in the TCIA radiology portal, and allow access to both public and limited access collections. In order to use these APIs, a developer must request a Client ID and Client Secret from the TCIA Help Desk, then use that Client ID and Client Secret to obtain an OAuth2 token. That token must be passed to the server in the https headers of API calls, as described in the NBIA Search REST API Guide.The NBIA Search REST APIs allow you to perform basic queries and download data for image analysis on public collections. The NBIA Search with Authentication REST APIs allow you to perform basic queries on and download data for image analysis from public and restricted collections. The NBIA Advanced REST APIs also allow access to public and restricted collections, but are geared towards developers seeking to integrate searching and downloading TCIA data into their own web and desktop applications. 

Note that new versions of the APIs may introduce new data types that have not yet been documented. If you are interested in using the APIs and have any questions, please contact the TCIA Help Desk.

...