ESS-DIVE Documentation
  • ESS-DIVE Documentation
  • Frequently Asked Questions
  • Submit Data
    • Get Started
      • Large Data Support
    • Register to Submit Data
    • Data Reporting Formats
    • Submit Data with Online Form
    • Submit Data with Dataset API
    • Link to External Data Sources
  • Publish Data
    • Check Dataset Metadata Quality
    • Dataset and DOI Status Badges
    • Review Cycle and Criteria
      • Metadata Requirements
      • Reporting Format Requirements
    • Publish your Dataset
      • Request Publication
      • Reserve DOI Before Publication
      • Publish with Existing DOI
      • Troubleshooting
  • Manage Data
    • Register Dataset Citations
    • Create Data Portals
      • How to Create & Publish Portals
    • Share Data Permissions
      • Share Datasets
      • Share Portals
    • Manage Project Data
      • Project Data Managers
      • Project Information
      • Project Teams
  • Search & Download Data
    • Search for Data
    • Download Data
    • Access Data Portals
    • Search with Dataset API
      • Code Examples
    • Search with Deep Dive API
      • How to Query Data
  • Programmatic Tools
    • ESS-DIVE Dataset API
      • R Example
      • Python Example
      • Java Example
      • API Updates and Changes
    • Globus Data Transfer Service
      • Setup Globus
      • Upload Data with Globus
      • FAQs
Powered by GitBook
On this page
  • Dataset API Search Quick Start
  • About Searches with the Dataset API
  • What can you do with the Dataset API Search Capabilities?
  • What's Next?
  1. Search & Download Data

Search with Dataset API

Public datasets can be programmatically searched and downloaded by anyone using the Dataset API. ORCID login is required to use the API.

PreviousAccess Data PortalsNextCode Examples

Last updated 1 month ago

Dataset API Resources: | | |

Dataset API Search Quick Start

Get started with ESS-DIVE's Dataset API right away with our Jupyter Notebook tutorials! No coding knowledge is necessary to run the notebooks. Follow these quick steps to check it out on our GitHub.

1. Visit ESS-DIVE's API Tutorial GitHub

Dataset API search tutorials are currently only offered in Python.

2. Launch the notebooks with the click of a button

You can select the Google Colab or Jupyter+R Binder button to launch the tutorials. We recommend Google Colab for a smoother experience (a Google account is required to use Colab).

3. Open the search_data folder

We recommend starting with the tutorial titled ESS PI Meeting 2025: Using Data - Python.ipynb. Follow the instructions to enter your login information. Click the play icon to run the cells and see the Dataset API in action.


About Searches with the Dataset API

Query Parameters:

  • keywords: Search for datasets that have an exact match for all the given keywords,

  • creator: The creator/submitter of datasets,

  • text: Searches any metadata field that contains the passed text, and

  • datePublished: Dataset publication date

To see examples of what a request query using these parameters looks like, go to our Code Examples page:

What can you do with the Dataset API Search Capabilities?

Once you have multiple metadata and data files in hand, you can perform custom searches and visualizations directly in the notebook. Here's an idea of some of the things you can do that are demonstrated in ESS-DIVE's data search tutorials:

  • Review and download relevant datasets and their files,

  • Preview file sizes,

  • Create publication reports,

  • Look up the view, download, and citation metrics for each dataset,

  • Get data citations,

  • Visualize data directly after finding datasets, and

What's Next?

After you've identified some datasets you're interested in, try out the Deep Dive API to query and explore certain* file contents!

You'll need to login to with your ORCID to search with the Dataset API. See steps 1 and 2 in our for help logging in.

The Dataset API is a great tool for searching through multiple datasets at the same time. Unlike the website (), you can search for exact keyword matches and download multiple datasets at once.

providerName: The ESS project that published the dataset. Exact project names are required, find yours using ,

Leverage the along with the Dataset API for even more powerful file-level search!

*Available for datasets following the and Reporting Formats

ESS-DIVE
registration instructions
https://data.ess-dive.lbl.gov/
Code Examples
DeepDive API
File Level Metadata (FLMD)
CSV Guidelines
Search with Deep Dive API
Technical Reference Docs
Search Tutorials
Search Code Examples
Setup
GitHub - ess-dive/essdive-tutorials: Tutorials for ESS-DIVEGitHub
Click this link to go to the GitHub.
Logo
First: At the top of the Github README, select preferred tool.
Google Colab Option: Select one of the tutorials.
Jupyter Binder Option: Select a folder and then a tutorial.
Preview of the Google Colab interface
ESS-DIVE's Project List