/zenodo/records/search

POST /api/zenodo/records/search

Price: 5 credits

Search Zenodo research records (datasets, software, publications, and more)

How to use it

Search open-access research records on Zenodo. Provide a keyword or a query in 'q', and narrow with filters: resource type, subtype, access right, community, subject, license, file type, and whether to include all versions. Set 'sort' to order by relevance, recency, views, or version. Returns matching records with full metadata.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• q string required — Search query. Plain keywords, or query syntax with fields (title, creators.name, description, keywords, doi, publication_date) and ranges (publication_date:[2020 TO 2024]). (examples: "climate change", "creators.name:\"Smith\" AND machine learning"; minLength: 1)
• type string nullable — Filter by resource type (one of: "publication", "dataset", "software", "image", "presentation", "poster", "video", "model", "lesson", "other")
• subtype string nullable — Filter by resource subtype. Subtypes are tied to 'type'. publication: annotationcollection, book, section, conferencepaper, datamanagementplan, article, patent, preprint, deliverable, milestone, proposal, report, softwaredocumentation, taxonomictreatment, technicalnote, thesis, workingpaper, other. image: figure, plot, drawing, diagram, photo, other. Other types (dataset, software, presentation, poster, video, lesson, model) have no subtypes. (examples: "article", "preprint", "figure")
• access_right string nullable — Filter by access right (one of: "open", "restricted", "embargoed", "metadata-only", "closed")
• communities string nullable — Filter by community ID (examples: "biosyslit", "eu")
• subject string nullable — Filter by subject keyword (examples: "Biodiversity")
• license string nullable — Filter by license ID (examples: "cc-by-4.0")
• file_type string nullable — Filter by file extension (examples: "pdf", "zip", "csv")
• all_versions boolean — Include all versions, not only the latest (default: false)
• sort string — Result ordering (default: "bestmatch"; one of: "bestmatch", "mostrecent", "mostviewed", "version")
• count integer required — Max result count (min: 1; max: 10000)

Response

• @type string (default: "ZenodoRecord")
• id integer required
• url string required
• doi string nullable
• doi_url string nullable
• concept_doi string nullable
• concept_recid string nullable
• swhid string nullable
• description string nullable
• publication_date string nullable
• access_right string nullable
• version string nullable
• language string nullable
• license string nullable
• notes string nullable
• state string nullable
• status string nullable
• created_at string nullable
• updated_at string nullable
• resource_type object nullable
  • @type string (default: "ZenodoResourceType")
  • type string nullable
  • subtype string nullable
• creators array (default: [])
  • @type string (default: "ZenodoCreator")
  • name string required
  • affiliation string nullable
  • orcid string nullable
  • gnd string nullable
  • type string nullable
• contributors array (default: [])
  • @type string (default: "ZenodoCreator")
  • name string required
  • affiliation string nullable
  • orcid string nullable
  • gnd string nullable
  • type string nullable
• keywords array (default: [])
• subjects array (default: [])
  • @type string (default: "ZenodoSubject")
  • term string nullable
  • identifier string nullable
  • scheme string nullable
• communities array (default: [])
• grants array (default: [])
  • @type string (default: "ZenodoGrant")
  • code string nullable
  • acronym string nullable
  • program string nullable
  • url string nullable
  • funder object nullable
    • @type string (default: "ZenodoFunder")
    • name string nullable
    • doi string nullable
    • acronym string nullable
• related_identifiers array (default: [])
  • @type string (default: "ZenodoRelatedIdentifier")
  • identifier string nullable
  • relation string nullable
  • scheme string nullable
  • resource_type string nullable
• references array (default: [])
• dates array (default: [])
  • @type string (default: "ZenodoRecordDate")
  • type string nullable
  • date string nullable
  • description string nullable
• files array (default: [])
  • @type string (default: "ZenodoFile")
  • id string nullable
  • key string nullable
  • size integer nullable
  • checksum string nullable
  • download_url string nullable
• stats object nullable
  • @type string (default: "ZenodoStats")
  • downloads integer nullable
  • unique_downloads integer nullable
  • views integer nullable
  • unique_views integer nullable
  • version_downloads integer nullable
  • version_unique_downloads integer nullable
  • version_views integer nullable
  • version_unique_views integer nullable
• is_latest_version boolean nullable
• version_index integer 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.