Get Diseases (batch)
get_disease_batchRead-onlyIdempotent
Retrieve multiple rare disease records in a single API call using ORPHAcodes, labels, or cross-reference identifiers. Supports sparse field projection to return only needed data.
Instructions
Fetch many disease records in one call (partial success per item: each row is the record or its own ok=false/error_code/message). Each term accepts an ORPHAcode, label, or xref CURIE; pass fields=[...] for a sparse projection. Max 50 items; compact per item. Signature: get_disease_batch(terms, response_mode=, fields=).
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| terms | Yes | 1..50 ids/labels/xrefs. | |
| fields | No | Sparse fieldset: return ONLY these top-level keys (dot into a grouped object, e.g. 'xrefs.OMIM'). Identity anchors (orpha_code, name, orphanet_version) are always included. Omit for the full payload. | |
| response_mode | No | Verbosity: minimal|compact|standard|full (default compact). | compact |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| hint | No | ||
| _meta | No | ||
| count | No | ||
| field | No | ||
| message | No | ||
| results | No | ||
| success | No | ||
| retryable | No | ||
| candidates | No | ||
| error_code | No | ||
| allowed_values | No | ||
| recovery_action | No |