Get DataCite citation
datacite_get_citationRead-onlyIdempotent
Render one DataCite DOI as a formatted citation in a CSL style and locale (APA in US English by default), or as a machine-readable record: CSL JSON, BibTeX, RIS, DataCite JSON or XML, Schema.org JSON-LD, Codemeta, or JATS. A style the upstream renderer does not support — an unknown id or a dependent journal style — is rejected instead of silently rendered as APA. Formatted text comes back as plain text alongside the upstream HTML markup. A DOI DataCite does not hold returns found: false naming the registration agency that does.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| doi | Yes | The DataCite DOI, e.g. 10.5061/dryad.234. Accepted bare, with doi: or info:doi/ prefixes, as a doi.org / dx.doi.org URL, or %2F-encoded; case-insensitive. | |
| style | No | CSL style id for format text, e.g. apa (default), ieee, chicago-author-date, modern-language-association, vancouver, nature. Lowercased. A style that would silently fall back to APA is rejected. Verified ids: datacite_list_reference topic citation_styles. | |
| format | No | text (formatted citation, default), csl_json, bibtex, ris, datacite_json, datacite_xml, schema_org, codemeta, or jats. | |
| locale | No | CSL locale for format text, e.g. en-GB, de-DE, fr-FR, or a bare language (de → de-DE); any case. Omitted: en-US. List: datacite_list_reference topic citation_locales. |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| cap | No | The character cap applied: 100,000. | |
| doi | No | The DOI, lowercase. | |
| error | No | Present when the call failed. Absent on success. | |
| found | No | True when DataCite holds the DOI and rendered it; false when it holds no public record (the miss fields explain). | |
| shown | No | Characters of DataCite's payload kept; for text, citation and citationHtml derive from them. | |
| style | No | CSL style applied (text only). | |
| format | No | The format requested. | |
| locale | No | CSL locale applied (text only; absent means en-US). | |
| notice | No | Set when the style could not be confirmed as distinct from APA, or when the payload was cut (its full length and the cut). | |
| citation | No | text: the citation as plain text (tags stripped, entities decoded); machine formats: the payload verbatim. A payload over 100,000 characters is cut to its first 100,000 (truncated: true). | |
| guidance | No | The next step for this miss. Miss arm only. | |
| mediaType | No | Media type negotiated. Found only. | |
| truncated | No | True when the payload ran past 100,000 characters and was cut. | |
| missReason | No | Why DataCite holds no public record: another agency registered it, no agency did, it is a DataCite DOI without public (Findable) metadata, or the agency lookup did not answer. Miss arm only. | |
| citationHtml | No | text only: the upstream HTML markup verbatim (<i>, &, small caps), cut like citation. | |
| registrationAgency | No | Registration agency that holds the DOI (e.g. Crossref, mEDRA, DataCite), when known. Miss arm only. |