Queries and filtering

When retrieving a list of DOIs, the REST API supports several parameters that can be used to refine, sort, and change the presentation of the results. This guide provides more detail on the available options.

Applying filter parameters

The API supports filter parameters that refine the list of results.

This includes the following frequently used filters:

FilterExample valuesDescription
provider-idcernDOIs associated with a specific DataCite provider (Direct Member, Consortium, or Consortium Organization)
client-idcern.zenodoDOIs associated with a specific DataCite client (repository)
consortium-iddcanDOIs associated with a specific DataCite consortium
resource-type-idoutput-management-planDOIs that use a specific resourceTypeGeneral
prefix10.5061DOIs with a specific prefix
registered2016DOIs with a specific year of DOI registration (registered in global handle server)
created2020DOIs with a specific year of DOI creation (created in DataCite system)
schema-version4DOIs using a specific schema version for the associated metadata

For example, this request retrieves all DOIs registered by a specific Repository account:

curl https://api.datacite.org/dois?client-id=datacite.datacite

For a full list of parameters, please see the API Reference.

Using the "query" parameter

You can search DOI metadata using the “query” parameter. The REST API uses Elasticsearch query string syntax.

The full specifics of query string queries are discussed in the Elasticsearch documentation. This guide contains selected examples to get you started with querying DataCite DOI metadata.

Building an Elasticsearch query string

Field names

A specific field can be provided in the query. For example:

curl https://api.datacite.org/dois?query=publicationYear:2016

Nested fields are joined by a .. For example:

curl https://api.datacite.org/dois?query=creators.nameIdentifiers.nameIdentifierScheme:ORCID

Nested fields use the same structure as in the REST API response for a DOI metadata record. You can also refer to the DataCite XML to JSON mapping for a full list of how DataCite metadata is represented in JSON.

When a field is not specified, the query by default searches commonly queried fields (including title, creator name, creator nameIdentifier, publisher, description, subject, and relatedIdentifier).


The wildcards * and ? are supported, e.g.:

curl https://api.datacite.org/dois?query=creators.nameIdentifiers.nameIdentifier:*
curl https://api.datacite.org/dois?query=creators.familyName:mil*

* matches zero or more characters and ? matches any single character.

Boolean operators

By default, all terms are optional, as long as one term matches. Use + or - to specify terms that have to match or not match, respectively. For example, to search for DOIs containing both "climate" and "change" in the title field:

curl https://api.datacite.org/dois?query=titles.title:(climate%20+change)

The boolean operators AND, OR and NOT (case-sensitive) are also supported.

When multiple operators are used together, use parentheses to combine them. For example:
(titles.title:(climate AND change) OR descriptions.description:(climate AND change)) AND (publicationYear:2023)

curl https://api.datacite.org/dois?query=(titles.title:(climate%20AND%20change)%20OR%20descriptions.description:(climate%20AND%20change))%20AND%20(publicationYear:2023)

Query examples

1. Publisher

Search for a specific publisher.


curl https://api.datacite.org/dois?query=publisher:DataCite

2. DOI

Search for a specific DOI.


curl https://api.datacite.org/dois?query=doi:10.11570/18.0006

3. Affiliation

Combine the parent and child elements to construct the search for an affiliation.

  "creators": [
      "name": "Bloggs, Jane",
      "nameType": "Personal",
      "givenName": "Jane",
      "familyName": "Bloggs",
      "affiliation": [
             "name": "DataCite",
             "schemeUri": "https://ror.org",
             "affiliationIdentifier": "https://ror.org/04wxnsj81",
             "affiliationIdentifierScheme": "ROR"
curl https://api.datacite.org/dois?affiliation=true&query=creators.affiliation.name:DataCite

To include affiliation identifier details, add &affiliation=true to your requests. See our FAQ for more information.


Search the exact string enclosed in the quotes.

titles.title:"CrowdoMeter Tweets"

curl https://api.datacite.org/dois?query=titles.title:"CrowdoMeter Tweets"

5. Boolean operators

Search using the "AND" boolean.

types.resourceTypeGeneral:Software AND types.resourceType:XML

curl https://api.datacite.org/dois?query=types.resourceTypeGeneral:Software%20AND%20types.resourceType:XML

Search using the "AND" and "OR" booleans.

publisher:DataCite AND types.resourceTypeGeneral:(Text OR Dataset)

curl https://api.datacite.org/dois?query=publisher:DataCite%20AND%20types.resourceTypeGeneral:(Text%20OR%20Dataset)

6. Wildcards

Search using a wildcard *.


curl https://api.datacite.org/dois?query=subjects.subject:robot*

7. Longer queries

Combine more than one element to limit the search results. In this example, the creators and the relatedIdentifier properties are used to build the query.

creators.name:"Fenner, Martin" AND relatedIdentifiers.relationType:HasPart


"creators": [
      "name": "Fenner, Martin",
      "nameType": "Personal",
      "givenName": "Martin",
      "familyName": "Fenner",
      "affiliation": [],
      "nameIdentifiers": [
          "nameIdentifier": "https://orcid.org/0000-0003-1419-2405",
          "nameIdentifierScheme": "ORCID"


"relatedIdentifiers": [
      "relationType": "HasPart",
      "relatedIdentifier": "10.5438/6423",
      "relatedIdentifierType": "DOI"
curl https://api.datacite.org/dois?query=creators.name:"Fenner, Martin" AND relatedIdentifiers.relationType:HasPart

Sorting results

The sort parameter is used to reorder the results. For example, this request retrieves all DOIs sorted by the updated date (from most to least recent):

curl https://api.datacite.org/dois?sort=-updated

The sort parameter accepts the following options:

nameDOI name alphabetical ascending
-nameDOI name alphabetical descending
createdcreated date ascending
-createdcreated date descending
updatedupdated date ascending
-updatedupdated date descending
publishedpublished date ascending
-publishedpublished date descending
view-countviewCount ascending
-view-countviewCount descending
download-countdownloadCount ascending
-download-countdownloadCount descending
citation-countcitationCount ascending
-citation-countcitationCount descending
titlefirst title alphabetical ascending
-titlefirst title alphabetical descending
relevancerelevance score descending

Additional parameters

Additional parameters can be used to control the results returned by the DataCite REST API. They can be passed as normal URI parameters or as JSON in the body of the request.

Selecting which metadata fields to retrieve

Affiliation identifiers (supported in Metadata Schema 4.3+) and publisher identifiers (supported in Metadata Schema 4.5+) are not included in REST API responses by default. See our FAQ for more information.

  • To include affiliation identifier details, add &affiliation=true to your requests.
  • To include publisher identifier details, add &publisher=true to your requests.
  • To include additional attributes in a list of DOIs (prefix, suffix, viewsOverTime, citationsOverTime, provider, references, citations. parts, partOf, versions, versionOf, xml, alternateIdentifiers), add &detail=true to your requests.

It is also possible to specify which fields are returned using the fields[dois] parameter. For example, fields[dois]=titles,subjects will only return titles and subjects:

curl https://api.datacite.org/dois?fields[dois]=titles,subjects


The page[number], page[size], and page[cursor] parameters are used for pagination. See the Pagination guide for more information.


The REST API also supports retrieving a random sample of results with the random, sample, and sample-group parameters. The next section of this guide covers sampling (see Retrieving a random sample of DOIs).