...
This document describes v3 of the TCIA programmatic Interface or REST API implementation. This API is designed for use by developers of image analysis and data mining tools to directly query the public resources of TCIA and retrieve information into their applications. The API complements the existing web interface but eliminates the need for users to visit the TCIA web pages to select and download images then upload them into their viewing and analysis applications. The TCIA Programmatic Interface is based on a middleware platform called Project Bindaas, developed by Emory University and uses REST web service technologies.
The API is a RESTful interface, accessed through web URLs. There is no software that an application developer needs to download in order to use the API. The application developer can build their own access routines using just the API documentation provided. The The interface employs a set of predefined query functions (see REST API Directory) that access TCIA databases.
If you are interested in using the API and have any questions, please contact us at help@cancerimagingarchive.net.
Note that
...
Previously access to the APIs required an API-KEY. An API-KEY is no longer required to access the public TCIA collections.
What's new
The following characteristics apply to all TCIA APIs:.
Version 3
- Two new APIs have been added (/getSingleImage, /getSOPInstanceUIDs).
- Three new APIs have been added (/NewPatientsInCollection, /NewStudiesInPatientsCollection, /PatientsByModality).
- The getSeries API has been modified to include new query parameters.
- Bug Fixesfixes
Version 2 (Documentation for Version 2 . can be found here)
- You can access the metadata of an API by appending /metadata to the end of a QueryEndpoint, without any QueryParameters (See below). The metadata is in JSON format and conforms to this schema.
- Most APIs can return results as CSV/JSON/XML/HTML. You can specify the return format by including the query parameter format.
Getting Started with the TCIA API
Getting access to the API:
- Every request must contain an Previously access to the APIs required an API-KEY. An API-KEY is no longer required to access the public TCIA collections. Simply call the RESTful endpoints.
- To support existing code without changes, an API-KEY The key can be included in the url by adding an extra query parameter api_key or it can be included in the HTTP headers.
You can obtain one API-KEY and use that for your application; you do not need a separate API-KEY for each user of your software. - To obtain an API-Key:
- If you don't have a TCIA account, please create one by visiting https://public.cancerimagingarchive.net/ncia/login.jsf
- If you already have a TCIA account, please send a request to help@cancerimagingarchive.net
- Since the API-KEY is no longer needed, the underlying service will simply ignore it.
The following characteristics apply to all TCIA APIs:
...
| BaseURL | https://services.cancerimagingarchive.net/services/v3 | The BaseURL includes the version number of this API (v3 in this example) | |
|---|---|---|---|
| Resource | /TCIA | ||
| QueryEndpoint | /query/getPatientStudy | ||
| Query Parameters | Collection=TCGA-GBM & PatientID=GBM-0123 | ||
| Format | format=csv | Some APIs support CSV/HTML/XML/JSON, while others only support a single return type. Therefore this is required only in instances where multiple return types are supported. |
...
| Resource | QueryEndpoint | Query Parameters All query parameters areoptional unless stated otherwise | Format | Description | ||||
|---|---|---|---|---|---|---|---|---|
| /TCIA |
| |||||||
| /query/getCollectionValues | None | CSV/HTML/XML/JSON | Set of all collection names | |||||
| /query/getModalityValues | Collection / BodyPartExamined | CSV/HTML/XML/JSON | Set of all modality values (CT, MR, ...) filtered by query keys | |||||
| /query/getBodyPartValues | Collection / Modality | CSV/HTML/XML/JSON | Set of all body part names filtered by query keys | |||||
| /query/getManufacturerValues | Collection / Modality / BodyPartExamined | CSV/HTML/XML/JSON | Set of all manufacturer names filtered by query keys | |||||
| /query/getPatient | Collection | CSV/HTML/XML/JSON | Set of patient objects filtered by query keys | |||||
| /query/PatientsByModality | Collection (R) Modality (R) | CSV/HTML/XML/JSON | Returns a list of PatientIDs, given a specific Collection Name and Modality | |||||
| /query/getPatientStudy | Collection / PatientID / StudyInstanceUID | CSV/HTML/XML/JSON | Set of patient/study objects filtered by query keys | |||||
| /query/getSeries | Collection / StudyInstanceUID / | CSV/HTML/XML/JSON | Set of series objects filtered by query keys | |||||
| /query/getSeriesSize | SeriesInstanceUID (R) | CSV/HTML/XML/JSON | Set of total byte size and object count filtered by query key | |||||
| /query/getImage | SeriesInstanceUID (R) | ZIP | Set of images in a zip file | |||||
| /query/NewPatientsInCollection | Date (R) | CSV/HTML/XML/JSON | Returns a set of Patients that have been added to a specified collection since a specified date. | |||||
| /query/NewStudiesInPatientCollection | Date (R) Collection (R) PatientID | CSV/HTML/XML/JSON | Returns a set of Studies that have been added to a specified collection, and optionally to a patient since a specified date Date is specified as (YYYY-MM-DD)Use the getCollectionValues to get the list of available collections | |||||
| /query/getSOPInstanceUIDs | SeriesInstanceUID (R) | CSV/HTML/XML/JSON | Return a list of SOPInstanceUID for a given series using the SeriesInstanceUID | |||||
| /query/getSingleImage | SeriesInstanceUID (R) SOPInstanceUID (R) | Raw DICOM Object | Returns a SINGLE DICOM Object that is identified by its SeriesInstanceUID and SOPInstanceUID. This API will always be used following the /getSOPInstanceUIDs | |||||
| /SharedList | ||||||||
| /query/ContentsByName | name (R) | JSON | Given the name of a shared list return its contents. |
...
Click here to see more details on the return values.