/biorxiv/preprints

POST /api/biorxiv/preprints

Price: 1 credit

Get a bioRxiv / medRxiv preprint by DOI (all posted versions)

How to use it

Get a bioRxiv or medRxiv preprint by its DOI. Returns one record per posted version, each with title, authors, corresponding author and institution, version number, posting date, type, license, subject category, full abstract, funders (with award numbers), the full-text JATS XML link, the DOI of the peer-reviewed published article (if any), the source server and the web URL.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• doi string required — Preprint DOI (examples: "10.1101/2020.09.09.20191205"; minLength: 1)
• server string — Preprint server (default: "biorxiv"; one of: "biorxiv", "medrxiv")

Response

• @type string (default: "BiorxivPreprint")
• doi string required
• authors string nullable
• author_corresponding string nullable
• author_corresponding_institution string nullable
• version integer nullable
• date string nullable
• type string nullable
• license string nullable
• category string nullable
• abstract string nullable
• funders array (default: [])
  • @type string (default: "BiorxivFunder")
  • name string required
  • id string nullable
  • id_type string nullable
  • awards array (default: [])
• jatsxml_url string nullable
• published_doi string nullable
• server string nullable
• web_url string nullable

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 — Preprint not found 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.