Raw schema
{
"type": "object",
"properties": {
"query": {
"description": "Free-text search query, e.g. \"CRISPR gene editing\" or \"climate change adaptation\"",
"type": "string"
},
"queryBibliographic": {
"description": "Whole-citation match to resolve a known reference to its DOI. Combine title, author, year, and container into one string, e.g. \"Watson Crick molecular structure of nucleic acids Nature 1953\".",
"type": "string"
},
"queryTitle": {
"description": "Match against work titles only, e.g. \"Array programming with NumPy\".",
"type": "string"
},
"queryAuthor": {
"description": "Match against author names only, e.g. \"Charles R. Harris\".",
"type": "string"
},
"queryContainerTitle": {
"description": "Match against the container title (journal or book name) only, e.g. \"Nature\".",
"type": "string"
},
"filter": {
"description": "Structured filter object using Crossref hyphen-separated keys. All values must be strings. Boolean flag keys (has-abstract, has-references, has-full-text) require string values \"true\" or \"false\". Example: {\"type\":\"journal-article\",\"has-abstract\":\"true\",\"from-pub-date\":\"2023-01-01\",\"directory\":\"DOAJ\"}",
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "string"
}
},
"fields": {
"description": "Fields to return (reduces payload). Names are case-sensitive. Useful set: DOI, title, author, published, type, is-referenced-by-count, abstract, container-title, publisher, score. DOI is always returned whether or not it is listed here, so every result stays resolvable by crossref_get_work.",
"type": "array",
"items": {
"type": "string"
}
},
"rows": {
"default": 20,
"description": "Number of results to return per page (1โ100, default 20)",
"type": "number",
"minimum": 1,
"maximum": 100
},
"authorLimit": {
"default": 25,
"description": "Maximum number of authors to return per work (1โ500, default 25). Ordinary records fit under the default; large-collaboration papers deposit thousands, and a page of them is large enough to exhaust a client context. Each work reports its full deposited total as authorCount โ call crossref_get_work with that work doi to page the authors this cap left out.",
"type": "integer",
"minimum": 1,
"maximum": 500
},
"offset": {
"description": "Zero-based result offset for offset-based paging. Cannot be used with cursor. Capped at ~10K; use cursor for deeper paging.",
"type": "number",
"minimum": 0
},
"cursor": {
"description": "Cursor token for deep paging. Pass \"*\" to start cursor-based paging (required past ~10K results), then pass the nextCursor value from each response until a response omits it, which means the list is exhausted. Cannot be combined with offset.",
"type": "string"
},
"sort": {
"description": "Sort field",
"type": "string",
"enum": [
"relevance",
"score",
"is-referenced-by-count",
"published",
"published-print",
"published-online",
"deposited",
"indexed",
"created",
"updated",
"references-count"
]
},
"order": {
"description": "Sort direction (asc or desc)",
"type": "string",
"enum": [
"asc",
"desc"
]
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}