...
If you are interested in using the API and have any questions, please contact us at cancerimagingarchive@mail.nih.gov.
What's new
- The API has been expanded and now allows you to access the contents of a shared list (see below)
- You now have the ability to programmatically access the metadata of a query. This will provide you a description of the API, input parameters, supported return types, and the definitions and DICOM tags of the return values. (see below)
- The API is now versioned. Going forward the version number will appear in the baseURL. This version is v2.
Getting Started with the TCIA API
...
- 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
Return Types
Incorporating the TCIA Programmatic Interface into Your Application
...