...
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 Fixes
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
...
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.