Page History

...

• You access a resource by sending an HTTP request to the TCIA API server. The server replies with a response that either contains the data you requested, or a status indicator.
• You can access the metadata of an API by appending /metadata to the end of the query. See examples. 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
• Every request must contain 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 please send a request to help@cancerimagingarchive.net  or contact TCIA's help desk by phone at: +1 314-747-4254. 

• The baseURL for the TCIA API is: 

  Code Block
  language text title TCIA BaseURL
  https://services.cancerimagingarchive.net/services/v2

API Reference

The full API consists of a base URL followed by the api and the query parameters in that order.

For example, in the following URL:

https://services.cancerimagingarchive.net/services/v2/TCIA/query/getSeries?Collection=TCGA-GBM&PatientID=1.2.3&StudyInstanceUID=4.5.6&format=csv

• The base URL is: https://services.cancerimagingarchive.net/services/v2/TCIA/query
• The API endpoint is getSeries
• And the four query parameters are provided as follows:  Collection=TCGA-GBM&PatientID=1.2.3&StudyInstanceUID=4.5.6&format=csv 
  
  
• Data can be obtained in the following formats : CSV,HTML,XML and JSON. 
  

NOTE: The order in which the query parameters are provided does not matter

With the exception of the getImage query, all other queries return one of these data formats : CSV,HTML,XML and JSON  file with results. The first line of the file contains the names of the columns in the response. Each subsequent line corresponds to one row from the TCIA database. The getImage query returns a zip of the images.

Return Types

Incorporating the TCIA Programmatic Interface into Your Application

...