DataCite REST API Guide

🚧

REST 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.

Purpose of the DataCite REST API

The DataCite REST API allows any user to retrieve, query and browse DataCite DOI metadata records. In addition, DataCite Repositories can register DOIs and DataCite Members can manage Repositories and prefixes via the API.

The API is generally RESTful and returns results in JSON, as the API follows the JSONAPI specification. The retrieve, query and browse functions do not require authentication, but the DataCite Member and Repository functions do require authentication with your DataCite Member or Repository ID.

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, and DataCite Search – which uses the DataCite REST API under the hood – provides a web interface to retrieve, query and browse DataCite metadata records.

This guide will walk you through the basic operations of the DataCite REST API (all examples use the test endpoint):

📘

Examples

All examples use the test endpoint. The production endpoint is https://api.datacite.org

Member Vs Public API

As of December 2019 the REST API is split into two versions: a Public API and a Member API. These two APIs use exactly the same URLs (starting with https://api.datacite.org), run exactly the same code, and provide exactly the same public data, the only difference being that traffic is directed to a different set of servers if users authenticate as a member.

The DataCite status page page reflects this change, you can now see separate metrics (both response time and request count) for the Public API and Member API.

More information in this blog post

📘

Would you like to know more?

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


Did this page help you?