NIMH Data Archive Web Services

The NIMH Data Archive (NDA) provides a variety of web services to support computational scientists, and to facilitate efficient integration between research systems. These direct system-to-system interfaces can be used to both deposit and access NDA data and metadata.  

Below you can find a short description of each available service, and a link that will allow you to access these resources.  These services provide RESTful interfaces, and we are actively updating each to follow the Open API Specification using the Swagger API Framework, including a browser-based User Interface.

In addition to the more modern RESTful services, we provide a legacy SOAP-based service for issuing temporary credentials that can be used with Amazon Web Services S3 API to access content from data files (i.e., raw and analyzed Omics and Neurosignal Recordings data).  More detail on this can be found in the Cloud section of our Tools page.

As new services become available they will be documented here.  If you have feedback on an existing service, or ideas for improvements or new services please send them to NDAHelp@mail.nih.gov

 

Service Name

Description

Response Formats

Data Dictionary

Provides metadata about all of the measures (data structures) available within the NDA Data Dictionary; including details on the data elements that make up each data structure.

 

This service does not require authentication.

 

https://data-archive.nimh.nih.gov/api/datadictionary

application/json
application/xml

Experiment

Provides metadata on all fMRI, Eye Tracking, and EEG experiments that have been defined by researchers submitting those data for sharing in NDA.

 

This service does not require authentication.

 

https://data-archive.nimh.nih.gov/api/experiment

application/json
application/xml

Search

NDA search uses this service to provide search across the entire platform.

Provides the ability to query publicly available content across all of NDA, including Studies, Collections, the Data Dictionary, experiments, and web pages.

 

This service also supports custom Elasticsearch queries against the same search index.

 

This service does not require authentication.

 

https://data-archive.nimh.nih.gov/api/search

application/json

 

GUID

Provides a list of all data structures (organized by type) for which the provided GUID has data shared, with an additional operation to retrieve all data for the GUID that the user has access to.

 

Requires HTTP basic authentication.

 

https://data-archive.nimh.nih.gov/api/guid

application/json
application/xml