POST /api/opencitations/works/citation-count
Price: 1 credit
Get how many citations the OpenCitations index records for one work
A work the index does not cover returns zero, exactly as an uncited work does, so a zero here is not evidence that nothing cites the work — confirm it exists with /opencitations/works first. The number counts only citations publishers deposited into the index, so it sits below a Google Scholar or Semantic Scholar count for the same paper and the two are not interchangeable.
access-token string requiredtimeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)id string required — Identifier of the work: a DOI, PubMed id, OpenAlex id or OpenCitations Meta id, written with its prefix. A plain DOI or a doi.org address is accepted too (examples: "doi:10.1038/nature12373", "pmid:23903748", "omid:br/06120344846", "openalex:W2159974629"; minLength: 1)@type string (default: "OpenCitationsCitationCount")id string requiredcitation_count integer required422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.412 — The entity was not found, or a precondition failed Retrying will not help: either the entity does not exist, or the input points at a different one.429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.X-Error — Error message text (present only on error)X-Request-ID — Unique request identifierX-Execution-Time — Execution time in secondsX-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.X-Retry-After — Seconds to wait before retrying. Present only on 429.