Dryad API

Dryad's REST API allows detailed interaction and programmatic interfacing with Dryad contents. The most common case is to use GET requests to retrieve information about datasets, versions, and files.

Examples:

• List datasets
• Search for datasets
• Get information about a dataset
• See versions of a dataset
• Get files from a version
• Download the most recent version of a dataset

When using the API, any DOI included must be URL-encoded (opens in new window) to ensure correct processing. Anonymous users of the API are limited to 30 requests per minute, with a lower limit for downloads of data files.

Detailed documentation

• Basic REST API (see below)
• Search API
• Submission API

API accounts

To access more powerful features, an API account is required. API accounts allow users to:

• Access the API at higher rates (authenticated users may make up to 120 requests per minute)
• Access datasets that are not yet public, but are associated with the account's community (institution, journal, etc.)
• Update datasets associated with the account's community

See the API accounts document (opens in new window) for more information on requesting an API account and using it to access datasets.

Submission

The Submission API is used by institutions that partner closely with Dryad, and use systems to create dataset submissions directly. Please contact us if you are interested in partnering with Dryad, and setting up an API account for submission.

The API submission examples document (opens in new window) gives concrete examples of submission through the Dryad API.

Dryad sandbox

Dryad's sandbox server (opens in new window) allows users to experiment with data submission and the Dryad API, without worrying about the effects on "real" data. Anyone may create an account on the sandbox server for testing purposes. When creating an account, keep in mind that Dryad's sandbox relies on the sandbox version of ORCID (opens in new window), which allows you to make test ORCID accounts. Sandbox ORCID IDs should be used in the Dryad sandbox, while use of Dryad's production system requires a real ORCID ID.

Dryad API methods

Detailed, interactive documentation of all available Dryad request methods:

Created with Swagger UI (opens in new window)