🏳️ FeedbackHomeAll content CC-BY
API Reference
ℹ️ Contact us!

Return a list of DOIs.

get
https://api.test.datacite.org/dois

Support Documentation

Query Params
string

Search DOI metadata fields using OpenSearch query string syntax.

string

Filter by the DOI date created (yyyy). Use commas to filter by multiple years (yyyy,yyyy).

string

Filter by the DOI date registered (yyyy). Use commas to filter by multiple years (yyyy,yyyy).

string

Filter by the DOI date published (yyyy). Use commas to filter by multiple years (yyyy,yyyy).

string

Filter by a specific DataCite provider (Direct Member or Consortium Organization). Use commas to include multiple providers.

string

Filter by a specific DataCite client (repository). Use commas to include multiple repositories.

string

Filter by a specific DataCite consortium.

string

Filter by a specific prefix. Use commas to include multiple prefixes.

string
enum
Allowed:
certificate
array of objects
certificate
string

Search creators.affiliation.affiliationIdentifier and contributors.affiliation.affiliationIdentifier for a ROR ID.

string

Search fundingReferences.funderIdentifier for a ROR ID. Results also include DOIs containing a Crossref Funder ID in fundingReferences.funderIdentifier corresponding to the ROR ID.

boolean

When the funded-by= parameter is set to a ROR ID and include-funder-child-organizations=true, the returned list of DOIs will be filtered to DataCite resources funded by the organization identified by the ROR ID as well as all of its child organizations. Child organizations include direct descendants as well as children of children.

string

Search fundingReferences.funderIdentifier for a Crossref Funder ID.

string

Search creators.nameIdentifiers.nameIdentifier for an ORCID iD.

resource-type-id
array of strings

Filter by the resourceTypeGeneral. Use commas to include multiple values.

resource-type-id
string

Filter by the free text resourceType. Use commas to include multiple values.

string

Filter by the free text Subject. Use commas to include multiple terms.

string
string
string
state
array of objects

Filter by the DOI state. Authentication is required to retrieve registered DOIs and draft records.

state
boolean

Set affiliation=true to see additional affiliation information such as the affiliation identifier.

boolean

Set publisher=true to see additional publisher information such as the publisher identifier.

string
enum
integer

Search the citationCount field for integer values greater than or equal to the inputted value.

integer

Search the referenceCount field for integer values greater than or equal to the inputted value.

integer

Search the partCount field for integer values greater than or equal to the inputted value.

integer

Search the partOfCount field for integer values greater than or equal to the inputted value.

integer

Search the versionCount field for integer values greater than or equal to the inputted value.

integer

Search the versionOfCount field for integer values greater than or equal to the inputted value.

integer

Search the viewCount field for integer values greater than or equal to the inputted value.

integer

Search the downloadCount field for integer values greater than or equal to the inputted value.

boolean

Return DOIs where creators.nameIdentifiers.nameIdentifierScheme has at least one "ORCID" value.

boolean

Return DOIs where either creators.affiliation.affiliationIdentifierScheme or contributors.affiliation.affiliationIdentifierScheme has at least one "ROR" value.

boolean

Return DOIs where either creators.nameIdentifiers.nameIdentifierScheme or contributors.nameIdentifiers.nameIdentifierScheme has at least one "ROR" value.

boolean

Return DOIs where fundingReferences.funderIdentifierType has at least one "Crossref Funder ID" value.

boolean

Retrieve a random sample of DOIs. When true, the page[number] parameter is ignored.

integer
1 to 1000
string
enum
Allowed:
integer

Page number for pagination.

integer
0 to 1000

Page size between 0 and 1,000 for pagination.

string

Use for cursor-based pagination.

string
enum
Allowed:
string
enum

Sort order:

  • relevance - Relevance score descending
  • name - DOI name alphabetical ascending
  • -name - DOI name alphabetical descending
  • created - Created date ascending
  • -created - Created date descending
  • updated - Updated date ascending
  • -updated - Updated date descending
  • published - Published date ascending
  • -published - Published date descending
  • view-count - viewCount ascending
  • -view-count - viewCount descending
  • download-count - downloadCount ascending
  • -download-count - downloadCount descending
  • citation-count - citationCount ascending
  • -citation-count - citationCount descending
  • title - first title alphabetical ascending
  • -title - first title alphabetical descending
boolean

Exclude facets from the response.

boolean

When set to true, will include the following in the response:

  • attributes:
    • prefix
    • suffix
    • viewsOverTime
    • citationsOverTime
    • references
    • citations
    • parts
    • partOf
    • versions
    • versionOf
    • xml
    • alternateIdentifiers
  • relationships:
    • provider
string

Only return the attributes specified. For example, fields[dois]=titles,subjects will only return titles and subjects.

string
enum

The system used to create the DOI.

Allowed:
Response

Updated over 1 year ago

Language
Credentials
:
URL
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/vnd.api+json
Updated over 1 year ago