Search DataCite works
datacite_search_worksRead-onlyIdempotent
Search DataCite DOI metadata for datasets, software, samples, workflows, and other research outputs. Combine plain words (text) or OpenSearch query syntax (query) with filters for resource type, creator (ORCID iD or name), affiliation (ROR ID or name), affiliation country, funder (ROR ID, Crossref Funder ID, or name), subject, field of science, repository, provider, license, language, geographic place, publication-year range, and minimum citation count. Returns the total match count and compact rows — DOI, title, first creators, year, type, repository, licenses, and citation/view/download counts — plus optional top facet counts. Page numbers reach the first 10,000 ranked matches; pass cursor "*" to walk any result set in full, in registration order.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Ranked page number, 1 when omitted. page × limit may not exceed 10,000; not with cursor. | |
| sort | No | relevance, newest, oldest, recently_updated, most_cited, most_viewed, or most_downloaded. Omitted: relevance when text or query is set, else newest. Not with cursor. | |
| text | No | Plain words and phrases, searched literally: every query-syntax character is escaped, so "Climate change: impacts" works and text can never cause a syntax error. Terms are ANDed. | |
| limit | No | Rows per page, 1–100. | |
| place | No | A geographic place phrase, matched against deposited place names. | |
| query | No | OpenSearch query-string syntax — field paths (titles.title:"…", creators.name:…, relatedIdentifiers.relationType:…), AND/OR/NOT, ranges, wildcards. Field paths: datacite_list_reference topic query_syntax. ANDed with text and the filters. | |
| cursor | No | Cursor walk over the full result set in registration order: "*" to start, then the nextCursor of the previous page, unchanged, with the same query and filters. Not with page or sort. | |
| funder | No | A funder ROR ID, a Crossref Funder ID (10.13039/100000001, its doi.org URL, or the bare digits), or a funder name. | |
| creator | No | A creator ORCID iD (0000-0002-1825-0097, 16 digits, or an orcid.org URL; checksum verified) or a name — every name token must appear in one creator field. | |
| subject | No | A subject phrase, matched case-insensitively against subject terms. | |
| language | No | ISO 639-1 language code of the work, any case (en, de). | |
| licenses | No | The work's own license ids (any match), SPDX-style: cc-by-4.0, cc0-1.0, mit. Lowercased, then matched exactly; common ids: datacite_list_reference topic licenses. | |
| affiliation | No | A ROR ID (021nxhr62 or a ror.org URL) — matches creator and contributor affiliations — or an affiliation name phrase. | |
| provider_ids | No | Provider ids (any match), e.g. dryad — the providerId datacite_search_repositories returns. Any case. | |
| published_to | No | Latest publication year (inclusive). Alone, the range is open-ended. | |
| min_citations | No | Only works DataCite records at least this many citations for. | |
| include_facets | No | Add top facet counts (resource types, years, repositories, providers, affiliations, fields of science, licenses). Adds 2–8 s. | |
| published_from | No | Earliest publication year (inclusive). Alone, the range is open-ended. | |
| repository_ids | No | Repository ids (any match), shaped provider.repository — e.g. dryad.dryad or cern.zenodo — as datacite_search_repositories returns them in repositoryId. Any case. | |
| resource_types | No | resourceTypeGeneral values (any match): dataset, software, computational-notebook, workflow, model, physical-object, … PascalCase accepted. Full list: datacite_list_reference topic resource_types. | |
| fields_of_science | No | OECD Fields of Science ids or labels (any match), e.g. computer_and_information_sciences or "Earth and related environmental sciences". List: datacite_list_reference topic fields_of_science. | |
| affiliation_country | No | ISO 3166-1 alpha-2 country of a creator or contributor affiliation, any case (DE, us). Alpha-3 codes and names are rejected. | |
| include_child_funders | No | Also match the ROR funder's child organizations. Only with a ROR funder. |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| error | No | Present when the call failed. Absent on success. | |
| works | No | Matching works on this page. | |
| facets | No | Top facet counts — only with include_facets. | |
| notice | No | Guidance when nothing matched, paging stops short of the total, or the page is past the end. | |
| nextPage | No | Next ranked page number, when more results lie within the 10,000 ceiling. | |
| nextCursor | No | Pass as cursor, unchanged and with the same query and filters, to read the next page of a walk; absent on the last page. | |
| totalCount | No | Total works matching the query and filters. | |
| sortApplied | No | The sort order applied; a cursor walk is always oldest (registration order). | |
| appliedFilters | No | Every applied filter as sent upstream; {} when none. | |
| effectiveQuery | No | The composed query string sent upstream. |