/reactome/pathways

POST /api/reactome/pathways

Price: 1 credit

Get one Reactome event — a pathway or a reaction — with its curation record and related events

How to use it

Three identifier forms name one record - the stable id, its numeric dbId and a versioned stable id - so pass whichever of those you hold rather than converting first. A retired REACT_ id is accepted too, but it names a record of its own and is never an alias of a modern id. Reactome models one biological process once per species, so R-HSA- and R-MMU- ids are different records - `orthologous_events` is how you cross between them. Check `schema_class` before assuming a pathway: a reaction id resolves here too and comes back with `inputs` and `outputs` instead of `has_events`. `has_events` gives only the immediate children, so walking a whole tree means recursing, or asking pathways/events for one species at once.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• pathway string required — Reactome stable id, numeric dbId, versioned stable id, or a legacy REACT_ id, which resolves to its own current record rather than to the modern id beside it (examples: "R-HSA-9612973", "9612973", "R-HSA-9612973.4", "REACT_1698"; minLength: 1)

Response

• @type string (default: "ReactomePathway")
• id string required
• db_id integer nullable
• st_id_version string (default: "")
• display_name string (default: "")
• names array (default: [])
• species_name string (default: "")
• species array (default: [])
  • @type string (default: "ReactomeSpecies")
  • id integer required
  • display_name string (default: "")
  • tax_id string (default: "")
  • abbreviation string (default: "")
  • names array (default: [])
• schema_class string (default: "")
• display_class string (default: "")
• category string (default: "")
• is_in_disease boolean nullable
• is_inferred boolean nullable
• has_diagram boolean nullable
• has_ehld boolean nullable
• max_depth integer nullable
• release_date string (default: "")
• release_status string (default: "")
• last_updated_date string (default: "")
• review_status string (default: "")
• review_status_definition string (default: "")
• evidence_type string (default: "")
• summaries array (default: [])
  • @type string (default: "ReactomeSummary")
  • id integer required
  • text string (default: "")
• literature_references array (default: [])
  • @type string (default: "ReactomeLiteratureReference")
  • id integer required
  • article_title string (default: "")
  • journal string (default: "")
  • year integer nullable
  • volume integer nullable
  • pages string (default: "")
  • pub_med_id integer nullable
  • isbn string (default: "")
  • chapter_title string (default: "")
  • url string (default: "")
• go_biological_process object nullable
  • @type string (default: "ReactomeOntologyTerm")
  • id integer required
  • display_name string (default: "")
  • name string (default: "")
  • accession string (default: "")
  • database_name string (default: "")
  • definition string (default: "")
  • url string (default: "")
• compartments array (default: [])
  • @type string (default: "ReactomeOntologyTerm")
  • id integer required
  • display_name string (default: "")
  • name string (default: "")
  • accession string (default: "")
  • database_name string (default: "")
  • definition string (default: "")
  • url string (default: "")
• figure_urls array (default: [])
• created object nullable
  • @type string (default: "ReactomeCurationEvent")
  • id integer required
  • display_name string (default: "")
  • date_time string (default: "")
  • note string (default: "")
• modified object nullable
  • @type string (default: "ReactomeCurationEvent")
  • id integer required
  • display_name string (default: "")
  • date_time string (default: "")
  • note string (default: "")
• authored array (default: [])
  • @type string (default: "ReactomeCurationEvent")
  • id integer required
  • display_name string (default: "")
  • date_time string (default: "")
  • note string (default: "")
• edited array (default: [])
  • @type string (default: "ReactomeCurationEvent")
  • id integer required
  • display_name string (default: "")
  • date_time string (default: "")
  • note string (default: "")
• reviewed array (default: [])
  • @type string (default: "ReactomeCurationEvent")
  • id integer required
  • display_name string (default: "")
  • date_time string (default: "")
  • note string (default: "")
• has_events array (default: [])
  • @type string (default: "ReactomeObjectRef")
  • id string required
  • db_id integer nullable
  • display_name string (default: "")
  • names array (default: [])
  • species_name string (default: "")
  • schema_class string (default: "")
  • display_class string (default: "")
  • category string (default: "")
  • definition string (default: "")
  • doi string (default: "")
  • max_depth integer nullable
  • release_date string (default: "")
  • last_updated_date string (default: "")
  • is_in_disease boolean nullable
  • is_inferred boolean nullable
  • is_chimeric boolean nullable
  • has_diagram boolean nullable
  • has_ehld boolean nullable
  • url string (default: "")
• event_of array (default: [])
  • @type string (default: "ReactomeObjectRef")
  • id string required
  • db_id integer nullable
  • display_name string (default: "")
  • names array (default: [])
  • species_name string (default: "")
  • schema_class string (default: "")
  • display_class string (default: "")
  • category string (default: "")
  • definition string (default: "")
  • doi string (default: "")
  • max_depth integer nullable
  • release_date string (default: "")
  • last_updated_date string (default: "")
  • is_in_disease boolean nullable
  • is_inferred boolean nullable
  • is_chimeric boolean nullable
  • has_diagram boolean nullable
  • has_ehld boolean nullable
  • url string (default: "")
• orthologous_events array (default: [])
  • @type string (default: "ReactomeObjectRef")
  • id string required
  • db_id integer nullable
  • display_name string (default: "")
  • names array (default: [])
  • species_name string (default: "")
  • schema_class string (default: "")
  • display_class string (default: "")
  • category string (default: "")
  • definition string (default: "")
  • doi string (default: "")
  • max_depth integer nullable
  • release_date string (default: "")
  • last_updated_date string (default: "")
  • is_in_disease boolean nullable
  • is_inferred boolean nullable
  • is_chimeric boolean nullable
  • has_diagram boolean nullable
  • has_ehld boolean nullable
  • url string (default: "")
• inferred_from array (default: [])
  • @type string (default: "ReactomeObjectRef")
  • id string required
  • db_id integer nullable
  • display_name string (default: "")
  • names array (default: [])
  • species_name string (default: "")
  • schema_class string (default: "")
  • display_class string (default: "")
  • category string (default: "")
  • definition string (default: "")
  • doi string (default: "")
  • max_depth integer nullable
  • release_date string (default: "")
  • last_updated_date string (default: "")
  • is_in_disease boolean nullable
  • is_inferred boolean nullable
  • is_chimeric boolean nullable
  • has_diagram boolean nullable
  • has_ehld boolean nullable
  • url string (default: "")
• preceding_events array (default: [])
  • @type string (default: "ReactomeObjectRef")
  • id string required
  • db_id integer nullable
  • display_name string (default: "")
  • names array (default: [])
  • species_name string (default: "")
  • schema_class string (default: "")
  • display_class string (default: "")
  • category string (default: "")
  • definition string (default: "")
  • doi string (default: "")
  • max_depth integer nullable
  • release_date string (default: "")
  • last_updated_date string (default: "")
  • is_in_disease boolean nullable
  • is_inferred boolean nullable
  • is_chimeric boolean nullable
  • has_diagram boolean nullable
  • has_ehld boolean nullable
  • url string (default: "")
• following_events array (default: [])
  • @type string (default: "ReactomeObjectRef")
  • id string required
  • db_id integer nullable
  • display_name string (default: "")
  • names array (default: [])
  • species_name string (default: "")
  • schema_class string (default: "")
  • display_class string (default: "")
  • category string (default: "")
  • definition string (default: "")
  • doi string (default: "")
  • max_depth integer nullable
  • release_date string (default: "")
  • last_updated_date string (default: "")
  • is_in_disease boolean nullable
  • is_inferred boolean nullable
  • is_chimeric boolean nullable
  • has_diagram boolean nullable
  • has_ehld boolean nullable
  • url string (default: "")
• inputs array (default: [])
  • @type string (default: "ReactomeObjectRef")
  • id string required
  • db_id integer nullable
  • display_name string (default: "")
  • names array (default: [])
  • species_name string (default: "")
  • schema_class string (default: "")
  • display_class string (default: "")
  • category string (default: "")
  • definition string (default: "")
  • doi string (default: "")
  • max_depth integer nullable
  • release_date string (default: "")
  • last_updated_date string (default: "")
  • is_in_disease boolean nullable
  • is_inferred boolean nullable
  • is_chimeric boolean nullable
  • has_diagram boolean nullable
  • has_ehld boolean nullable
  • url string (default: "")
• outputs array (default: [])
  • @type string (default: "ReactomeObjectRef")
  • id string required
  • db_id integer nullable
  • display_name string (default: "")
  • names array (default: [])
  • species_name string (default: "")
  • schema_class string (default: "")
  • display_class string (default: "")
  • category string (default: "")
  • definition string (default: "")
  • doi string (default: "")
  • max_depth integer nullable
  • release_date string (default: "")
  • last_updated_date string (default: "")
  • is_in_disease boolean nullable
  • is_inferred boolean nullable
  • is_chimeric boolean nullable
  • has_diagram boolean nullable
  • has_ehld boolean nullable
  • url string (default: "")
• url string (default: "")

Errors

• 422 — Not a Reactome identifier 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 — Pathway not found 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.