The Cancer Imaging Archive (TCIA) Public Access

Space shortcuts

Child pages
  • NBIA Search with Authentication REST API Guide

Versions Compared

Old Version 4

changes.mady.by.user Carolyn Klinger

Saved on

compared with

New Version 5

changes.mady.by.user Carolyn Klinger

Saved on

Key

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

...

Info
titleOther NBIA REST APIs
  • If you do not require access to restricted collections you can use the NBIA Search REST API Guide, which provides the same functionality, but does not require requesting a security token.
  • The NBIA Advanced REST API Guide provides advanced features geared towards developers seeking to integrate searching and downloading TCIA data into their own web and desktop applications.

NBIA Search with Authentication REST API Base URL, Format, and Return Values

...

We can break this down as follows.

ObjectExample
Tokencd2b2895-85d0-49c5-bd75-804f162da942
BaseURL

https://services.cancerimagingarchive.net

Resource/nbia-api/services/v2
EndpointgetModalityValues
Query ParametersCollection=TCGA-BRCA

See Image Download APIs and Image Metadata APIs for more information about each NBIA Search with Authentication REST API.

...

Code Block
titleStructure of a Request for a Token
curl -d username=<username>&password=<password>&client_id=<theClientIDFromHelpDesk>&client_secret=<theClientSecretFromHelpDesk>&grant_type=password" -X POST -k httpsk https://services.cancerimagingarchive.net/nbia-api/oauth/token


DataUsernamePassword
Public and RestrictedYour usernameYour password
Publicnbia_guestLeave blank

Request a token by interacting with the application in the following way.

...