ESS-DIVE Dataset API

The ESS-DIVE Dataset API is a service that enables users to programmatically submit and manage datasets with ESS-DIVE. This guide provides an overview of the API, resources, and how to get started.

Quickstart

First time using APIs? Click on an action below to see complete tutorials that walkthrough each Dataset API operation! No coding experience is required to try out a tutorial.

Search for Datasets

Submit Datasets

Project Dataset Metrics

Share Datasets

Getting started with ESS-DIVE Dataset API (Package Service API version 1)

ESS-DIVE's Dataset API is a REST API with a variety of operations available that allow you to programmatically manage datasets using HTTP requests. This is an alternative to using the ESS-DIVE Online form for managing data.

This service encodes metadata using the JSON-LD specification. JSON-LD is a schema to encode linked Data using JSON, and is used by Google to index metadata for searches. The use of the standardized JSON-LD schema dramatically increases the visibility of datasets, and also enable projects to create one-time code that can be reused for periodic uploads of datasets to ESS-DIVE.

ESS-DIVE has a variety of resources available to help you get started with the Dataset API. We have example code and usage documentation available for new and experienced coders. In addition to the linked resources below, you'll also find user-friendly introductions to specific API operations within this documentation! Find these under the relevant Submit, Manage, and Search sections.

Dataset API Tutorials

Browse through all ESS-DIVE's Jupyter Notebook Tutorials.

Technical Example Scripts

Interested in building scripts to automate your publication workflow? Our GitHub repo has all example code available in R, Python and Java.

Technical API Documentation

Experienced coders can come here to see all available HTTP operations and find details on expected schema for building custom scripts.

Provide feedback on this service to [email protected].

Get Authentication Token

1. Visit ESS-DIVE

   1. Search & Download: https://data.ess-dive.lbl.gov

   2. Submit & Manage Datasets: https://data-sandbox.ess-dive.lbl.gov

2. Sign in with Orcid

3. Click your Name in the right hand corner and select My Profile (Figure 1)

4. Now Click the Settings>Authentication Token (Figure 2)

5. Scroll down and click Copy on the “Token” tab to get your authentication token (Figure 2)

Figure 1. Hover over your name and click on My Profile

Figure 2. Click on Authentication Token under Settings and copy the token