Skip to main content
GET
Get citations
This endpoint is in beta, so its request and response schemas may change in the coming days.

Authorizations

x-api-key
string
header
required

Query Parameters

paper_ids
string[]

Seed paper ids from search, Threads, citations or references results (each result's paper_id). Repeat the parameter for several: ?paper_ids=A&paper_ids=B.

dois
string[]

Seed DOIs, with or without a https://doi.org/ or doi: prefix. Repeat the parameter for several. A DOI that names no Consensus paper comes back in unmatched_dois.

year_min
integer | null

Only papers published in or after this year.

Required range: x >= 1
year_max
integer | null

Only papers published in or before this year.

Required range: x >= 1
cite_min
integer | null

Only papers cited at least this many times.

Required range: x >= 0
sort
enum<string>
default:recency_weighted

recency_weighted: papers linked to more of the seeds first, then by how fast they are cited, so new papers are not buried. most_cited: highest citation count first. most_recent: newest first, most cited first within a year.

Available options:
recency_weighted,
most_cited,
most_recent
page
integer
default:0

Zero-indexed page to read.

Required range: x >= 0
page_size
integer | null

Papers per page; 20 when omitted, and at most your plan's page size cap.

Required range: x >= 1

Response

Successful Response

results
CitationResult · object[]
required

The page's papers, ranked by sort. Each paper_id can seed a next call.

page
integer
required

The zero-indexed page returned.

page_size
integer
required

Papers per page actually applied to this response.

is_end
boolean
required

True when no later page holds more papers for these seeds and filters. A page can hold fewer than page_size papers and still not be the end.

credits_charged
integer
required

Credits this request used: one per 100 papers returned, at least one.

next_page
integer | null

Next zero-indexed page to request, if one is available.

unmatched_dois
string[]

Requested DOIs, normalized, that name no Consensus paper.