Skip to main content
POST
/
api
/
zenodo
/
records
/
search
/zenodo/records/search
curl --request POST \
  --url https://api.anysite.io/api/zenodo/records/search \
  --header 'Content-Type: application/json' \
  --header 'access-token: <api-key>' \
  --data '
{
  "q": "<string>",
  "count": 5000,
  "timeout": 300,
  "subtype": "article",
  "communities": "biosyslit",
  "subject": "Biodiversity",
  "license": "cc-by-4.0",
  "file_type": "pdf",
  "all_versions": false,
  "sort": "bestmatch"
}
'
[
  {
    "id": 123,
    "url": "<string>",
    "@type": "@zenodo_record",
    "doi": "<string>",
    "doi_url": "<string>",
    "concept_doi": "<string>",
    "concept_recid": "<string>",
    "swhid": "<string>",
    "title": "<string>",
    "description": "<string>",
    "publication_date": "<string>",
    "access_right": "<string>",
    "version": "<string>",
    "language": "<string>",
    "license": "<string>",
    "notes": "<string>",
    "state": "<string>",
    "status": "<string>",
    "created_at": "<string>",
    "updated_at": "<string>",
    "resource_type": {
      "@type": "@zenodo_resource_type",
      "type": "<string>",
      "subtype": "<string>",
      "title": "<string>"
    },
    "creators": [],
    "contributors": [],
    "keywords": [],
    "subjects": [],
    "communities": [],
    "grants": [],
    "related_identifiers": [],
    "references": [],
    "dates": [],
    "files": [],
    "stats": {
      "@type": "@zenodo_stats",
      "downloads": 123,
      "unique_downloads": 123,
      "views": 123,
      "unique_views": 123,
      "version_downloads": 123,
      "version_unique_downloads": 123,
      "version_views": 123,
      "version_unique_views": 123
    },
    "is_latest_version": true,
    "version_index": 123
  }
]

Authorizations

access-token
string
header
required

API token from the dashboard

Headers

access-token
string
required

Body

application/json
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]).

Minimum string length: 1
Examples:

"climate change"

"creators.name:\"Smith\" AND machine learning"

count
integer
required

Max result count

Required range: 1 <= x <= 10000
timeout
integer
default:300

Max scrapping execution timeout (in seconds)

Required range: 20 <= x <= 1500
type
enum<string> | null

Filter by resource type

Available options:
publication,
dataset,
software,
image,
presentation,
poster,
video,
model,
lesson,
other
subtype
string | null

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.

Example:

"article"

access_right
enum<string> | null

Filter by access right

Available options:
open,
restricted,
embargoed,
metadata-only,
closed
communities
string | null

Filter by community ID

Example:

"biosyslit"

subject
string | null

Filter by subject keyword

Example:

"Biodiversity"

license
string | null

Filter by license ID

Example:

"cc-by-4.0"

file_type
string | null

Filter by file extension

Example:

"pdf"

all_versions
boolean
default:false

Include all versions, not only the latest

sort
enum<string>
default:bestmatch

Result ordering

Available options:
bestmatch,
mostrecent,
mostviewed,
version

Response

Successful Response

id
integer
required
url
string
required
@type
string
default:@zenodo_record
doi
string | null
doi_url
string | null
concept_doi
string | null
concept_recid
string | null
swhid
string | null
title
string | null
description
string | null
publication_date
string | null
access_right
string | null
version
string | null
language
string | null
license
string | null
notes
string | null
state
string | null
status
string | null
created_at
string | null
updated_at
string | null
resource_type
ZenodoResourceType · object
creators
ZenodoCreator · object[]
contributors
ZenodoCreator · object[]
keywords
string[]
subjects
ZenodoSubject · object[]
communities
string[]
grants
ZenodoGrant · object[]
references
string[]
dates
ZenodoRecordDate · object[]
files
ZenodoFile · object[]
stats
ZenodoStats · object
is_latest_version
boolean | null
version_index
integer | null