The Cancer Imaging Archive (TCIA) Public Access

Space shortcuts

Child pages
  • NBIA Advanced REST API Guide

Versions Compared

Old Version 69

changes.mady.by.user Carolyn Klinger

Saved on

compared with

New Version 70

changes.mady.by.user Carolyn Klinger

Saved on

Key

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

...

The National Biomedical Imaging Archive (NBIA) REST APIs allow you to access the search and download functions used in the TCIA  radiology portalRdiology Portal. 

The NBIA Advanced REST APIs, described on this page, provide capabilities to access restricted collections, which require login authentication. They also provide advanced features that are geared towards developers seeking to integrate searching and downloading TCIA data into their own web and desktop applications.

...

Info
iconfalse
titleExample NBIA Advanced REST API Query


Code Block
curl -H "YOUR_TOKENAuthorization Bearer: cd2b2895-85d0-49c5-bd75-804f162da942" -k "https://services.cancerimagingarchive.net/nbia-api/services/getBodyPartValuesAndCounts?Modality=PT"


...

A successful token request returns a standard access token in JSON format. The value after "access_token" will likely be longer than this example.

Code Block
titleSample Token Return Value
{"access_token":"eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICItRHN0WHE2YXZjVE9uRlJidldZeDFab2Nka0t0cXJVTEdndXFRQl9WM1BZIn0.eyJleHAiOjE2OTE1MzkwNjUsImlhdCI6MTY5MTUzMTg2NSwianRpIjoiMzU2MDgxNjYtZDIzZS00ZjBiLWI0YTEtMzMzYTUzNWI5MDEwIiwiaXNzIjoiaHR0cHM6Ly9rZXljbG9hay5kYm1pLmNsb3VkL2F1dGgvcmVhbG1zL1RDSUEiLCJhdWQiOiJhY2NvdW50Iiwic3ViIjoiZjowMTliNTYzNC1kYWJkLTQyMTEtYTQxZC03MjNjNDRhZmNmZmQ6bmJpYV9ndWVzdCIsInR5cCI6IkJlYXJlciIsImF6cCI6Im5iaWEiLCJzZXNzaW9uX3N0YXRlIjoiZmFhNjMxYmMtNDZjYS00NTA5LTljZjktNjY4MjcwNjM2ZGQzIiwiYWNyIjoiMSIsInJlYWxtX2FjY2VzcyI6eyJyb2xlcyI6WyJvZmZsaW5lX2FjY2VzcyIsImRlZmF1bHQtcm9sZXMtdGNpYSIsInVtYV9hdXRob3JpemF0aW9uIl19LCJyZXNvdXJjZV9hY2Nlc3MiOnsiYWNjb3VudCI6eyJyb2xlcyI6WyJtYW5hZ2UtYWNjb3VudCIsIm1hbmFnZS1hY2NvdW50LWxpbmtzIiwidmlldy1wcm9maWxlIl19fSwic2NvcGUiOiJvcGVuaWQgcHJvZmlsZSBlbWFpbCIsInNpZCI6ImZhYTYzMWJjLTQ2Y2EtNDUwOS05Y2Y5LTY2ODI3MDYzNmRkMyIsImVtYWlsX3ZlcmlmaWVkIjp0cnVlLCJuYW1lIjoiTkJJQSBHdWVzdCIsInByZWZlcnJlZF91c2VybmFtZSI6Im5iaWFfZ3Vlc3QiLCJnaXZlbl9uYW1lIjoiTkJJQSIsImZhbWlseV9uYW1lIjoiR3Vlc3QiLCJlbWFpbCI6Im5iaWFfZ3Vlc3RAY2FuY2VyaW1hZ2luZ2FyY2hpdmUubmV0In0.JiBMbpWD-KYUoXxITFWrbn9OVavU9DkaAdZXBJSATz1LibytBQm7hiv-rdbNZzz5UqhqnYzOlaPDb_yiw6qIxg-Cv4-xqtLTo0FjAGgjJAs82l-9MtopZdtRSJeQ08_6do13PlN_HaAlqbX5qmp1Jj2Pzb5ETceK7TcCwEFI5VtOhBksIZqe4kebqUK-ijmzHRgY_DMsNwPh7eQENVfLL1RjHw27lDwVRmJCUJGPWocOqIXKaLfjVUa9fY4JJLXSTGuF_ncyT9iIxOlF1kd4b0NOoB_FCaWvrwFZ03J5nikNfcCHxn2mWTZyY2Z1YMxkOfG-zlQgkD8Pb8ErnmfQqwcd2b2895-85d0-49c5-bd75-804f162da942","expires_in":7200,"refresh_expires_in":7200,"refresh_token":"eyJhbGciOiJIUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJkZGFhMGY3YS1kZTBmLTRkYWQtYjM1ZS05MjljYjBiMTY3YjgifQ.eyJleHAiOjE2OTE1MzkwNjUsImlhdCI6MTY5MTUzMTg2NSwianRpIjoiNThlOWJjMDMtZWE2Ni00MzQzLWIxNDQtZjVlYTFhOTgzNTE0IiwiaXNzIjoiaHR0cHM6Ly9rZXljbG9hay5kYm1pLmNsb3VkL2F1dGgvcmVhbG1zL1RDSUEiLCJhdWQiOiJodHRwczovL2tleWNsb2FrLmRibWkuY2xvdWQvYXV0aC9yZWFsbXMvVENJQSIsInN1YiI6ImY6MDE5YjU2MzQtZGFiZC00MjExLWE0MWQtNzIzYzQ0YWZjZmZkOm5iaWFfZ3Vlc3QiLCJ0eXAiOiJSZWZyZXNoIiwiYXpwIjoibmJpYSIsInNlc3Npb25fc3RhdGUiOiJmYWE2MzFiYy00NmNhLTQ1MDktOWNmOS02NjgyNzA2MzZkZDMiLCJzY29wZSI6Im9wZW5pZCBwcm9maWxlIGVtYWlsIiwic2lkIjoiZmFhNjMxYmMtNDZjYS00NTA5LTljZjktNjY4MjcwNjM2ZGQzIn0.OUgE5WBH54gCDCZTG2oqG9u6xcqwVj7hiMBBeGQywHg","token_type":"Bearer","id_token":"eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICItRHN0WHE2YXZjVE9uRlJidldZeDFab2Nka0t0cXJVTEdndXFRQl9WM1BZIn0.eyJleHAiOjE2OTE1MzkwNjUsImlhdCI6MTY5MTUzMTg2NSwiYXV0aF90aW1lIjowLCJqdGkiOiJhNDRjNTc5ZC00YWY2LTQwNjUtODY3Ni1hZmMxM2E1M2M2Y2UiLCJpc3MiOiJodHRwczovL2tleWNsb2FrLmRibWkuY2xvdWQvYXV0aC9yZWFsbXMvVENJQSIsImF1ZCI6Im5iaWEiLCJzdWIiOiJmOjAxOWI1NjM0LWRhYmQtNDIxMS1hNDFkLTcyM2M0NGFmY2ZmZDpuYmlhX2d1ZXN0IiwidHlwIjoiSUQiLCJhenAiOiJuYmlhIiwic2Vzc2lvbl9zdGF0ZSI6ImZhYTYzMWJjLTQ2Y2EtNDUwOS05Y2Y5LTY2ODI3MDYzNmRkMyIsImF0X2hhc2giOiIxS25IaXVib1FnSHBQWkR5bS1SSUdRIiwiYWNyIjoiMSIsInNpZCI6ImZhYTYzMWJjLTQ2Y2EtNDUwOS05Y2Y5LTY2ODI3MDYzNmRkMyIsImVtYWlsX3ZlcmlmaWVkIjp0cnVlLCJuYW1lIjoiTkJJQSBHdWVzdCIsInByZWZlcnJlZF91c2VybmFtZSI6Im5iaWFfZ3Vlc3QiLCJnaXZlbl9uYW1lIjoiTkJJQSIsImZhbWlseV9uYW1lIjoiR3Vlc3QiLCJlbWFpbCI6Im5iaWFfZ3Vlc3RAY2FuY2VyaW1hZ2luZ2FyY2hpdmUubmV0In0.dYG9y_SnMIPZsQAgKpj8noO1V7w9UpvWhUGMSHufdjUZ4l3KuP7VaZC1O4uEp3aV5Xc7wudHcgYuG02CPLzp7niab-KONe3Ap6apkvdmZxlqn_TQbLVCeqr1rYCQ_Lg5MnTWj_1Vk_7nzQYyDy1AicDdrUngof9aRWJbUmH_GQcvlgHcrdGRDW5eLlNEqu-an53Mhu2Finja0c4iqFolFPlaPTOE-px6hOpdlT7uG1x1RWL3YGUlAEbkdvYAI7oMsjbaWAPp84j3gg4wa08qD33j6mEuCTM4_TMoegi1ndU5EG9w4SSk0DfU-xIEAg6K7gzhPNoOIkMSjuc8ZwBMTgeyJhbGciOiJIUzI1NiIsInR5cCIgO","not-before-policy":0,"session_state":"faa631bc92a199c6-46ca84ed-450948aa-9cf9a0d2-668270636dd3059bbb99bc90","scope":"openid profile email"}

...

Code Block
titleSample NBIA Advanced REST API Call
# Request for modality values and counts           
curl -H "Authorization:Bearer eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICItRHN0WHE2YXZjVE9uRlJidldZeDFab2Nka0t0cXJVTEdndXFRQl9WM1BZIn0.eyJleHAiOjE2OTE1MzkwNjUsImlhdCI6MTY5MTUzMTg2NSwianRpIjoiMzU2MDgxNjYtZDIzZS00ZjBiLWI0YTEtMzMzYTUzNWI5MDEwIiwiaXNzIjoiaHR0cHM6Ly9rZXljbG9hay5kYm1pLmNsb3VkL2F1dGgvcmVhbG1zL1RDSUEiLCJhdWQiOiJhY2NvdW50Iiwic3ViIjoiZjowMTliNTYzNC1kYWJkLTQyMTEtYTQxZC03MjNjNDRhZmNmZmQ6bmJpYV9ndWVzdCIsInR5cCI6IkJlYXJlciIsImF6cCI6Im5iaWEiLCJzZXNzaW9uX3N0YXRlIjoiZmFhNjMxYmMtNDZjYS00NTA5LTljZjktNjY4MjcwNjM2ZGQzIiwiYWNyIjoiMSIsInJlYWxtX2FjY2VzcyI6eyJyb2xlcyI6WyJvZmZsaW5lX2FjY2VzcyIsImRlZmF1bHQtcm9sZXMtdGNpYSIsInVtYV9hdXRob3JpemF0aW9uIl19LCJyZXNvdXJjZV9hY2Nlc3MiOnsiYWNjb3VudCI6eyJyb2xlcyI6WyJtYW5hZ2UtYWNjb3VudCIsIm1hbmFnZS1hY2NvdW50LWxpbmtzIiwidmlldy1wcm9maWxlIl19fSwic2NvcGUiOiJvcGVuaWQgcHJvZmlsZSBlbWFpbCIsInNpZCI6ImZhYTYzMWJjLTQ2Y2EtNDUwOS05Y2Y5LTY2ODI3MDYzNmRkMyIsImVtYWlsX3ZlcmlmaWVkIjp0cnVlLCJuYW1lIjoiTkJJQSBHdWVzdCIsInByZWZlcnJlZF91c2VybmFtZSI6Im5iaWFfZ3Vlc3QiLCJnaXZlbl9uYW1lIjoiTkJJQSIsImZhbWlseV9uYW1lIjoiR3Vlc3QiLCJlbWFpbCI6Im5iaWFfZ3Vlc3RAY2FuY2VyaW1hZ2luZ2FyY2hpdmUubmV0In0.JiBMbpWD-KYUoXxITFWrbn9OVavU9DkaAdZXBJSATz1LibytBQm7hiv-rdbNZzz5UqhqnYzOlaPDb_yiw6qIxg-Cv4-xqtLTo0FjAGgjJAs82l-9MtopZdtRSJeQ08_6do13PlN_HaAlqbX5qmp1Jj2Pzb5ETceK7TcCwEFI5VtOhBksIZqe4kebqUK-ijmzHRgY_DMsNwPh7eQENVfLL1RjHw27lDwVRmJCUJGPWocOqIXKaLfjVUa9fY4JJLXSTGuF_ncyT9iIxOlF1kd4b0NOoB_FCaWvrwFZ03J5nikNfcCHxn2mWTZyY2Z1YMxkOfG-zlQgkD8Pb8ErnmfQqwcd2b2895-85d0-49c5-bd75-804f162da942" -k "https://services.cancerimagingarchive.net/nbia-api/services/getModalityValuesAndCounts?Collection=LIDC-IDRI"

...

Code Block
titleSample Request for Refreshing the Token
# Request for refreshing the token  

curl -X -v -d "refresh_token=7c2414a1-1f2f-4c9e-82a0-69fcb9fd18ed&client_id=nbiaRestAPIClient&client_secret=ItsBetweenUAndMe&grant_type=refresh_token" -X POST -k https://services.cancerimagingarchive.net/nbia-api/oauth/token
        
/nbia-api/oauth/token"

In the following result, 119 is the seconds before the token expires.

...