/datacite/dois/search

POST /api/datacite/dois/search

Price: 1 credit

Search DataCite DOIs (datasets, software, preprints and more) with filters

How to use it

Search DataCite research outputs. Combine a free-text query with filters by resource type (dataset, software, preprint, text, image, etc.), creation/publication/registration year, provider, repository (client), DOI prefix, SPDX license and language. Sort by creation/publication/update date, relevance, or view/citation/download count. Each result is a full DOI record with titles, creators, publisher, dates, subjects, rights, funding, geolocations and usage counts.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• query string nullable — Free-text search across DOI metadata
• resource_type_id string nullable — Filter by general resource type (one of: "dataset", "text", "software", "publication", "image", "audiovisual", "collection", "model", "workflow", "sound", "physical-object", "event", "service", "interactive-resource", "data-paper", "peer-review", "computational-notebook", "journal-article", "book", "book-chapter", "conference-paper", "report", "dissertation", "preprint", "standard", "other")
• created string nullable — Filter by registration-record creation year or range (YYYY or YYYY-YYYY)
• published string nullable — Filter by publication year or range (YYYY or YYYY-YYYY)
• registered string nullable — Filter by DOI registration year or range (YYYY or YYYY-YYYY)
• provider_id string nullable — Filter by provider (DataCite member) id
• client_id string nullable — Filter by repository (client) id
• prefix string nullable — Filter by DOI prefix
• license string nullable — Filter by SPDX license identifier (e.g. cc0-1.0, cc-by-4.0)
• language string nullable — Filter by language code (e.g. en, de)
• sort string nullable — Sort order (one of: "created", "-created", "published", "-published", "updated", "-updated", "relevance", "view-count", "-view-count", "citation-count", "download-count")
• count integer required — Number of DOIs to return (min: 1)

Response

• @type string (default: "DataciteDoi")
• doi string required
• prefix string nullable
• suffix string nullable
• titles array (default: [])
  • @type string (default: "DataciteTitle")
  • title_type string nullable
  • lang string nullable
• creators array (default: [])
  • @type string (default: "DataciteCreator")
  • name string nullable
  • name_type string nullable
  • given_name string nullable
  • family_name string nullable
  • contributor_type string nullable
  • affiliations array (default: [])
  • name_identifiers array (default: [])
    • @type string (default: "DataciteNameIdentifier")
    • name_identifier string required
    • name_identifier_scheme string nullable
    • scheme_uri string nullable
• contributors array (default: [])
  • @type string (default: "DataciteCreator")
  • name string nullable
  • name_type string nullable
  • given_name string nullable
  • family_name string nullable
  • contributor_type string nullable
  • affiliations array (default: [])
  • name_identifiers array (default: [])
    • @type string (default: "DataciteNameIdentifier")
    • name_identifier string required
    • name_identifier_scheme string nullable
    • scheme_uri string nullable
• publisher string nullable
• publication_year integer nullable
• resource_type string nullable
• resource_type_general string nullable
• schema_org_type string nullable
• bibtex_type string nullable
• citeproc_type string nullable
• ris_type string nullable
• subjects array (default: [])
  • @type string (default: "DataciteSubject")
  • subject string required
  • subject_scheme string nullable
  • scheme_uri string nullable
  • lang string nullable
• dates array (default: [])
  • @type string (default: "DataciteDate")
  • date string required
  • date_type string nullable
  • date_information string nullable
• language string nullable
• descriptions array (default: [])
  • @type string (default: "DataciteDescription")
  • description string required
  • description_type string nullable
  • lang string nullable
• rights_list array (default: [])
  • @type string (default: "DataciteRights")
  • rights string nullable
  • rights_uri string nullable
  • rights_identifier string nullable
  • rights_identifier_scheme string nullable
  • scheme_uri string nullable
• related_identifiers array (default: [])
  • @type string (default: "DataciteRelatedIdentifier")
  • related_identifier string required
  • related_identifier_type string nullable
  • relation_type string nullable
  • resource_type_general string nullable
• funding_references array (default: [])
  • @type string (default: "DataciteFundingReference")
  • funder_name string nullable
  • funder_identifier string nullable
  • funder_identifier_type string nullable
  • award_number string nullable
  • award_title string nullable
  • award_uri string nullable
• geo_locations array (default: [])
  • @type string (default: "DataciteGeoLocation")
  • place string nullable
  • point_latitude number nullable
  • point_longitude number nullable
  • box object nullable
• container object nullable
  • @type string (default: "DataciteContainer")
  • type string nullable
  • identifier string nullable
  • identifier_type string nullable
  • volume string nullable
  • issue string nullable
  • first_page string nullable
  • last_page string nullable
• identifiers array (default: [])
  • @type string (default: "DataciteIdentifier")
  • identifier string required
  • identifier_type string nullable
• alternate_identifiers array (default: [])
  • @type string (default: "DataciteIdentifier")
  • identifier string required
  • identifier_type string nullable
• sizes array (default: [])
• formats array (default: [])
• version string nullable
• url string nullable
• content_url array nullable
• schema_version string nullable
• metadata_version integer nullable
• state string nullable
• is_active boolean nullable
• view_count integer (default: 0)
• download_count integer (default: 0)
• citation_count integer (default: 0)
• reference_count integer (default: 0)
• part_count integer (default: 0)
• part_of_count integer (default: 0)
• version_count integer (default: 0)
• version_of_count integer (default: 0)
• source string nullable
• created_at string nullable
• registered_at string nullable
• published_at string nullable
• updated_at string nullable
• provider_id string nullable
• client_id string nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — The entity was not found, or a precondition failed Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.