/dryad/datasets

POST /api/dryad/datasets

Price: 1 credit

Get one Dryad dataset by DOI. Returns the title, abstract, methods and usage notes, every author with ORCID, affiliation and contact email, the funding awards, the licence, the keywords and study locations, the related publication, the current version and its stored size, and the view, download and citation counts.

How to use it

Dryad holds the data behind a published paper, so `related_works` with relationship `primary_article` is the paper this dataset belongs to, and `related_publication_issn` is that journal. The DOI is the only identifier that resolves here — the numeric `internal_id` in the body addresses nothing public. This returns the metadata only; call /dryad/datasets/files for the file names, sizes and download links. `download_url` answers 401 anonymously, the same as the per-file download links. `abstract` is null when the depositor filled none, rather than carrying Dryad's own placeholder text, and `metrics` moves between calls because the counters are live.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• dataset string required — Dryad dataset DOI, with or without the 'doi:' prefix, or the address of its Dryad page (examples: "10.5061/dryad.qbzkh190b", "doi:10.5061/dryad.qbzkh190b", "https://datadryad.org/dataset/doi:10.5061/dryad.qbzkh190b"; minLength: 1)

Response

• @type string (default: "DryadDataset")
• id string required
• url string required
• download_url string nullable
• abstract string nullable
• methods string nullable
• usage_notes string nullable
• human_subjects_statement string nullable
• publication_date string nullable
• last_modification_date string nullable
• license_url string nullable
• field_of_science string nullable
• curation_status string nullable
• version_status string nullable
• version_number integer nullable
• version_changes string nullable
• version_id string nullable
• visibility string nullable
• storage_size integer nullable
• related_publication_issn string nullable
• internal_id string nullable
• keywords array (default: [])
• locations array (default: [])
• authors array (default: [])
  • @type string (default: "DryadAuthor")
  • full_name string required
  • first_name string nullable
  • last_name string nullable
  • orcid string nullable
  • email string nullable
  • order integer nullable
  • affiliations array (default: [])
    • @type string (default: "DryadAffiliation")
    • name string required
    • ror_url string nullable
• funders array (default: [])
  • @type string (default: "DryadFunder")
  • name string nullable
  • identifier string nullable
  • identifier_type string nullable
  • award_number string nullable
  • award_title string nullable
  • award_description string nullable
  • award_url string nullable
  • order integer nullable
• related_works array (default: [])
  • @type string (default: "DryadRelatedWork")
  • identifier string required
  • identifier_type string nullable
  • relationship string nullable
• metrics object nullable
  • @type string (default: "DryadMetrics")
  • view_count integer nullable
  • download_count integer nullable
  • citation_count integer 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 Dryad dataset carries this DOI 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.