How do I use the Data Center Archive Search API?

Owned by Anastasia Alexov (Unlicensed)
Last updated: Apr 20, 2022
2 min read

Summary

The DKIST Data Center Archive provides a search REST API for users who would like to integrate a search function into code modules or other software to which the users have access. The search REST API is universal in that it it the the same API that the DKIST Data Portal, the User Tools, and the Virtual Solar Observatory (VSO) utilize to search for data (see figure 1). Users that desire a graphical user interface (GUI) should access the Search API via the DKIST Data Portal or the VSO. Those that desire a high level Python API can utilize the User Tools package. If access to the low level Search API is desired (e.g. for access via a different programming language) then the Search API can be accessed via a REST API.

figure 1

Instructions

The REST API documentation can be found at https://api.dkistdc.nso.edu/datasets/docs. The API will return search results, including metadata, but will not return actual datasets. In order to automate the download of returned datasets, users can additionally leverage the Globus API. Alternatively, the functionality of search and download are already joined and exposed through the high level API provided by the User Tools package.

Note that the Search API does not require the user to have a Globus account, though one may optionally be passed in the authorization headers. Downloads of data however, require Globus account authentication prior to the download of any data.

 

If you run into errors or issues with the Data Center Archive API, please submit a Help Desk ticket including the error message.