/osf/preprints

POST /api/osf/preprints

Price: 5 credits

Get one OSF preprint by its GUID. Returns the title, abstract, the preprint DOI and any publisher DOI, the preprint server it was posted to, the version and whether it is the latest, the moderation state and the dates it moved through it, the licence, the subject taxonomy and tags, the open-data and preregistration declarations, and every named author with ORCID and affiliation history.

How to use it

Both a bare GUID and the versioned `guid_vN` form resolve; the bare form gives the version OSF considers current, so read `version` and `is_latest_version` rather than assuming. `doi` is the journal's DOI once the preprint is published somewhere and is usually null before that; it is never the OSF-minted DOI, which `preprint_doi_url` carries instead. `provider_id` names the preprint server (osf, psyarxiv, socarxiv and so on) and decides which moderation vocabulary `reviews_state` uses. `has_data_links` and `has_prereg_links` are three-valued words such as `available` or `not_applicable`, not booleans. A project GUID answers 412 here — use /osf/nodes for it.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• preprint string required — OSF preprint GUID, with or without a version suffix, or the address of its OSF page (examples: "7vzg9", "7vzg9_v2", "https://osf.io/preprints/psyarxiv/vuax2_v2/"; minLength: 1)

Response

• @type string (default: "OsfPreprint")
• id string required
• url string required
• description string nullable
• doi string nullable
• preprint_doi_url string nullable
• provider_id string nullable
• version string nullable
• created_at string nullable
• modified_at string nullable
• published_at string nullable
• withdrawn_at string nullable
• last_transitioned_at string nullable
• original_publication_date string nullable
• preprint_doi_created_at string nullable
• reviews_state string nullable
• tags array (default: [])
• subjects array (default: [])
  • @type string (default: "OsfSubject")
  • id string required
  • text string required
  • path array (default: [])
• license_record object nullable
  • @type string (default: "OsfLicenseRecord")
  • year string nullable
  • copyright_holders array (default: [])
• license object nullable
  • @type string (default: "OsfLicense")
  • id string nullable
  • name string nullable
  • url string nullable
  • required_fields array (default: [])
• contributors array (default: [])
  • @type string (default: "OsfContributor")
  • id string nullable
  • full_name string required
  • given_name string nullable
  • family_name string nullable
  • middle_names string nullable
  • suffix string nullable
  • orcid string nullable
  • profile_url string nullable
  • image string nullable
  • permission string nullable
  • index integer nullable
  • is_bibliographic boolean nullable
  • is_registered boolean nullable
  • is_active boolean nullable
  • is_curator boolean nullable
  • locale string nullable
  • timezone string nullable
  • registered_at string nullable
  • employment array (default: [])
    • @type string (default: "OsfPosition")
    • institution string required
    • department string nullable
    • degree string nullable
    • start_year integer nullable
    • start_month integer nullable
    • end_year integer nullable
    • end_month integer nullable
    • is_ongoing boolean nullable
  • education array (default: [])
    • @type string (default: "OsfPosition")
    • institution string required
    • department string nullable
    • degree string nullable
    • start_year integer nullable
    • start_month integer nullable
    • end_year integer nullable
    • end_month integer nullable
    • is_ongoing boolean nullable
  • social object nullable
    • @type string (default: "OsfSocialProfiles")
    • github string nullable
    • linkedin string nullable
    • twitter string nullable
    • google_scholar string nullable
    • research_gate string nullable
    • researcher_id string nullable
    • impact_story string nullable
    • academia_profile_id string nullable
    • academia_institution string nullable
    • baidu_scholar string nullable
    • ssrn string nullable
    • websites array (default: [])
• affiliated_institutions array (default: [])
  • @type string (default: "OsfInstitution")
  • id string required
  • name string nullable
  • url string nullable
  • ror_url string nullable
• node_id string nullable
• primary_file_id string nullable
• custom_publication_citation string nullable
• conflict_of_interest_statement string nullable
• withdrawal_justification string nullable
• data_links array (default: [])
• prereg_links array (default: [])
• prereg_link_info string nullable
• why_no_data string nullable
• why_no_prereg string nullable
• has_coi boolean nullable
• has_data_links string nullable
• has_prereg_links string nullable
• is_latest_version boolean nullable
• is_published boolean nullable
• is_public boolean nullable
• is_orphan boolean nullable
• default_license_id 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 — No public OSF preprint carries this GUID 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.