/opencitations/authors/works

POST /api/opencitations/authors/works

Price: 10 credits

List the works OpenCitations Meta attributes to one author. Each result is a full bibliographic record with title, coauthors, publication date, journal or book, volume, issue, pages, publisher and every identifier the work is known by

How to use it

Attribution here follows the ORCID or agent id a publisher deposited, so it covers only the works where that author was credited with one and is not a complete bibliography — an author with no deposited ORCID returns nothing at all. An `omid:ra/` agent id, which every result carries inside its `authors`, reaches authors who have no ORCID.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• id string required — ORCID of the author, or the OpenCitations Meta agent id, written with its prefix. An orcid.org address is accepted too (examples: "orcid:0000-0002-4189-3154", "omid:ra/065021087"; minLength: 1)
• published_in string nullable — Keep only works whose publication date starts with this text, so `2020` takes a whole year and `2020-03` one month (examples: "2020"; minLength: 1)
• work_type string nullable — Keep only works whose type contains this text, spelled as the `type` field of a result and matched without regard to case, so `journal article` keeps exactly that type while `article` keeps journal and proceedings articles alike (examples: "journal article", "book chapter"; minLength: 1)
• sort_by string nullable — Field to order the works by (one of: "pub_date", "title", "venue", "type")
• sort_order string nullable — Order direction, ascending unless stated (one of: "asc", "desc")
• count integer required — Number of works to return (examples: 100; min: 1)

Response

• @type string (default: "OpenCitationsWork")
• omid string nullable
• doi string nullable
• pmid string nullable
• pmcid string nullable
• openalex string nullable
• isbns array (default: [])
• other_ids array (default: [])
• type string nullable
• pub_date string nullable
• pub_year integer nullable
• volume string nullable
• issue string nullable
• page string nullable
• authors array (default: [])
  • @type string (default: "OpenCitationsAgent")
  • name string required
  • omid string nullable
  • orcid string nullable
  • crossref string nullable
  • other_ids array (default: [])
• editors array (default: [])
  • @type string (default: "OpenCitationsAgent")
  • name string required
  • omid string nullable
  • orcid string nullable
  • crossref string nullable
  • other_ids array (default: [])
• venue object nullable
  • @type string (default: "OpenCitationsVenue")
  • name string required
  • omid string nullable
  • issns array (default: [])
  • isbns array (default: [])
  • other_ids array (default: [])
• publisher object nullable
  • @type string (default: "OpenCitationsAgent")
  • name string required
  • omid string nullable
  • orcid string nullable
  • crossref string nullable
  • other_ids array (default: [])

Errors

• 422 — 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.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-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.