input | string | object | Input The search query or identifier this record belongs to. |
recordType | string | Record type paper (one paper; charged) or summary (one per search query: counts, sources, warnings; never charged). |
position | integer | Position Rank of the paper in its query's results (1 = first). |
status | string | Status ok | not_found | error | skipped_invalid | skipped_budget | skipped_free_plan | skipped_unmetered e.g. "ok" |
charged | boolean | Charged Whether this record incurred a pay-per-event charge. |
chargedEvent | string | Charged event Pay-per-event event charged for this record (present only when charged). |
chargedCount | integer | Events charged Events actually charged when the charge came back short of the requested count (present only then; a warning explains it). |
source | string | Source Paper rows: the sources searched (crossref+arxiv+pubmed+europepmc); lookups: the source that answered (crossref, arxiv, pubmed, europepmc, doi). |
fetchedAt | string | Fetched at ISO timestamp. |
title | string | null | Title Paper title. |
authors | array | Authors Author names as published, in order. |
year | integer | null | Year Publication year. |
publishedDate | string | null | Published Publication date: YYYY-MM-DD, YYYY-MM or YYYY (earliest of online and print). |
venue | string | null | Venue Journal, proceedings, book or preprint server (arXiv: the journal reference when published, else arXiv). |
publisher | string | null | Publisher Publisher (from Crossref or OpenAlex). |
type | string | null | Type journal-article, preprint, review, conference-paper, book, book-chapter, dataset, dissertation, report or other. |
doi | string | null | DOI DOI in lower case, without https://doi.org/. |
arxivId | string | null | arXiv id arXiv identifier without version (e.g. 1706.03762). |
pmid | string | null | PMID PubMed id. |
pmcid | string | null | PMCID PubMed Central id (free full text). |
openAlexId | string | null | OpenAlex id OpenAlex work id (W…), when OpenAlex was used. |
abstract | string | null | Abstract Abstract as plain text, when a source provides it. |
citationCount | integer | null | Citations Times cited: Crossref is-referenced-by-count, else OpenAlex or Europe PMC. |
openAccess | boolean | null | Open access Free to read: open-access licence, arXiv, PubMed Central or Europe PMC full text. null = unknown. |
pdfUrl | string | null | PDF Best free PDF link (arXiv, Europe PMC, publisher under an open licence). |
url | string | null | URL Landing page: where the paper can be read when it is open access, else the publisher's page. |
subjects | array | Subjects MeSH headings and keywords (PubMed, Europe PMC), arXiv categories, OpenAlex topics. |
language | string | null | Language Language code, when a source states it. |
sources | array | Found in Sources that returned this paper (crossref, pubmed, europepmc, arxiv, openalex, doi). |
idType | string | Identifier type Lookups: doi, arxiv, pmid or pmcid. |
lookupId | string | Identifier Lookups: the identifier in canonical form. |
query | string | Query Summary records: the search query. |
resultsDelivered | integer | Papers delivered Summary records: papers delivered (and charged) for the query. |
stopReason | string | Stop reason Summary records: limit, free_plan, end, budget, aborted, deadline or error. |
sourcesSearched | array | Sources searched Summary records: the sources asked. |
sourceTotals | object | Hits per source Summary records: total matches each source reported (null when unknown or failed). |
duplicatesSkipped | integer | Duplicates skipped Summary records: papers skipped because an earlier query of the run delivered them (not charged). |
error | object | Error { code, message, provider?, status? } when status is not ok. Codes set by the runtime: budget_exhausted, free_plan_limit, unmetered, aborted, charge_failed, record_too_large, invalid_record, dataset_push_failed; upstream codes: http_error (with the source's HTTP status), timeout, network, tls_error, invalid_json, too_large, rate_limit, server, client, invalid_response, not_found; invalid_input for an identifier that is not a DOI, arXiv id, PMID or PMCID. |
warnings | array | Warnings Notes about this record: sources that failed or were skipped, free-plan or budget limits, skipped duplicates. |
raw | object | Raw Each source's unmodified record, keyed by source (only with includeRaw). |