/reactome/pathways/events

POST /api/reactome/pathways/events

Price: 20 credits

Walk the whole event hierarchy of one species, flattened from its top-level pathways down

How to use it

One call returns the species' entire tree already flattened, so use it instead of walking `has_events` from reactome/pathways one record at a time. Rebuild the tree from `parent_id` and `depth`, where a root carries an empty `parent_id`. The same event comes back under every parent it sits under and can also repeat under one parent, so neither `id` nor the `parent_id` plus `id` pair is unique: deduplicate on `id` to count distinct events, and on the whole row when rebuilding the tree. Only the sixteen species Reactome curates directly have a tree, and anything else is rejected; a taxonomy id and the species name are both accepted. Turning `pathways_only` off adds every individual reaction under the pathways.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• species string required — Species the event tree belongs to, as an NCBI taxonomy id or a Reactome species name (examples: "9606", "Homo sapiens", "10090", "Mus musculus"; minLength: 1)
• pathways_only boolean — Keep pathways only, leaving out the individual reactions under them (default: true)
• count integer required — Max number of results (min: 1)

Response

• @type string (default: "ReactomeEventNode")
• id string required
• display_name string (default: "")
• event_type string (default: "")
• species string (default: "")
• parent_id string (default: "")
• depth integer (default: 0)
• has_diagram boolean nullable
• total_entity integer nullable
• total_entity_and_interactors integer nullable
• child_ids array (default: [])
• url string (default: "")

Errors

• 422 — Species outside the curated set 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 — The entity was not found, or a precondition failed 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.