Introduction to the DataCite REST API

About the DataCite REST API

The DataCite REST API enables retrieval, creation, and update of DataCite DOI metadata records and account information.

The API is generally RESTful and returns results in JSON (following the JSON:API specification).

REST API Reference

📘

Access the REST API Reference to explore all REST API functions and parameters.

REST API Guide

This guide will walk you through the basic operations of the DataCite REST API:

• Retrieving a single DOI
• Retrieving a list of DOIs
• Pagination
• Queries and filtering
• Retrieving a random sample of DOIs
• Creating DOIs with the REST API
• Updating metadata with the REST API
• Tracking metadata provenance

Additional resources

• Our DataCite API Training video walks through the basics of the REST API.
• Fork the DataCite REST API Training collection on Postman to explore examples.

Member vs. Public API

The REST API is split into two versions: a Public API and a Member API. Traffic is directed to a different set of servers if users authenticate:

• Public API: Accessed without authentication.
• Member API: Accessed with authentication.

These two APIs use the same URL (starting with https://api.datacite.org) and run the same code. When users authenticate to access the Member API, they have access to additional functionality, depending on their account type.

Public API (No authentication)

The Public API is accessed without authentication. We recommend using the Public API to retrieve and search for DOI metadata.

The Public API only returns DOIs in Findable state, excluding draft records and Registered DOIs. Learn more about DOI States.

📘

Harvesting DataCite metadata

Members and non-members wishing to harvest DataCite metadata should use the Public API, which does not require authentication.

Other alternatives to retrieve, query and browse DataCite DOI metadata records include the DataCite OAI-PMH service and the DataCite Commons service. OAI-PMH is used primarily for bulk harvesting of metadata.

Member API (Requires authentication)

Authentication provides access to additional functionality to create and update DOIs, view draft records and Registered DOIs, and view contact information.

Users must authenticate with a Repository account to create and update DOIs.

Test vs. Production

The REST API is available in both test and production. Many examples in this guide use the test endpoint.

• Test endpoint: https://api.test.datacite.org
• Production endpoint: https://api.datacite.org

Learn more about the differences between Test and Production in our Testing Guide.

API Versions

The current version of the REST API is version 2. If you are using the endpoints /works, /members, or /data-centers, you are using version 1.

🚧

When making frequent requests to DataCite APIs using a script or integration, include a User-Agent header with 1) an identification of your script or integration and 2) contact information in a mailto: . For example:

 MyCustomScript/1.0 (https://mycustomscript.org; mailto:[email protected])

This information helps DataCite communicate about issues and changes and troubleshoot problems.

📘

Would you like to know more?

If you have any questions, requests or ideas please contact us!