Docs
View as Markdown

zenodo.search

stable Advanced

Search Zenodo research records (datasets, papers, software).

GET /v1/zenodo/search

What you get#

A list of Zenodo results in Onekey's unified shape, in data (an array). An empty array is a normal, successful answer and is charged like any other; a source that reports "nothing found" as an error returns a free 404 not_found instead.

What it costs#

  • Advanced · 5 credits for a fresh fetch, charged only when it succeeds.
  • Free when served from cache (0.2 credit for a cached response over 100 KB).
  • Free if the request is invalid (never charged) or the source fails or reports not found (refunded).

Parameters#

NameTypeRequiredDefaultWhat it isConstraints
qstringyes(required)Search querymax 200 chars; must match [^\x00-\x1f\x7f]{1,200}; trimmed, repeated spaces collapsed

Request#

curl "https://api.onekey.dev/v1/zenodo/search?q=climate" \
  -H "x-api-key: YOUR_API_KEY"

Try it

Add your key to run this call right here. No key? Get one free. The key stays in this tab.

Recorded response#

A real Zenodo response, recorded and returned in Onekey's shape. Fields the platform does not provide are null.

json
{
  "success": true,
  "data": [
    {
      "content": {
        "id": "16537543",
        "title": "SYMBA D6.1 - Report on system mapping and SYMBA forum activities",
        "text": "A report summarizing the SYMBA forum and cross-exchange activities with ongoing EU projects and initiatives such as elaboration of a collaborative strategy, organization of 2 interactive workshops.",
        "createdAt": "2025-07-28T00:00:00Z",
        "url": "https://zenodo.org/records/16537543"
      },
      "paper": {
        "doi": "10.5281/zenodo.16537543"
      },
      "engagement": {
        "views": 90
      },
      "entity": {
        "stats": {
          "downloads": 327
        }
      }
    },
    {
      "content": {
        "id": "16537726",
        "title": "SYMBA D6.3 - 1st Report on summary of New European Bauhaus activities",
        "text": "A 1st draft report with summary of the networking activities carried with the New European Bauhaus Community. It also includes the outcomes of 4 virtual meetings to share NEB updates, opportunities, events and guidance; 3 trainings/webinar sessions on awareness and NEB; and 3 sessions of NEB coaching to SYMBA.",
        "createdAt": "2025-07-28T00:00:00Z",
        "url": "https://zenodo.org/records/16537726"
      },
      "paper": {
        "doi": "10.5281/zenodo.16537726"
      },
      "engagement": {
        "views": 55
      },
      "entity": {
        "stats": {
          "downloads": 291
        }
      }
    }
  ],
  "metadata": {
    "platform": "zenodo",
    "endpoint": "search",
    "cached": false,
    "stale": false,
    "age_s": 0,
    "fetched_at": "2026-01-01T12:00:00+00:00",
    "credits_charged": 5,
    "request_id": "7f3a9c2e5b1d4c8fa2e6d0b9c4f18e37"
  },
  "error": null
}

Field mapping#

How this endpoint's source fields become Onekey's unified schema. Fields the source lacks come back as null.

Source pathOnekey fieldTransform
idcontent.idtoString
metadata.titlecontent.title-
metadata.descriptioncontent.textstripHtml
doipaper.doi-
metadata.publication_datecontent.createdAttoIsoDate
links.self_htmlcontent.urlsafeUrl
stats.unique_viewsengagement.viewstoNumber
stats.unique_downloadsentity.stats.downloadstoNumber

Caching and freshness#

  • Fresh for about 2 minutes. Repeat calls in that window are served from cache and are free.
  • Between 2 minutes and 15 minutes the cached copy is still served instantly and marked stale: true while Onekey refreshes it in the background.
  • If the source is down when a refresh is needed, the last copy can be served for up to 1 hour more (marked stale).
  • A "not found" is remembered for 1 minute and is free.
  • The cache is shared across all customers, which is what keeps repeat calls cheap.

What can go wrong#

StatusCodeWhat to do
401unauthorizedCheck the x-api-key header.
402insufficient_creditsAdd credits; your balance must cover the price.
404not_foundUnknown endpoint path.
422invalid_paramsFix the parameters using the table above. Free.
429rate_limitedWait Retry-After seconds, then retry.
502upstream_errorThe source failed. Refunded; retry with backoff.

See Errors for the full list and retry guidance.

Status: stable (verified against the live source).