GET ContentService/exporter/fireworks/{species}.{ext}

reactome.org:reactome-api

Summary: Exports a given pathway overview to the specified image format (png, jpg, jpeg, svg, gif)
Operation ID: diagramImage
Auth: unknown

Parameters (15)

coverage (boolean, query, optional, default: False)

Set to 'true' to overlay analysis coverage values

diagramProfile (string, query, optional)

Diagram Color Profile

Constraints: {'enum': ['Copper', 'Copper plus', 'Barium Lithium', 'Calcium Salts']}

expColumn (integer, query, optional)

Expression column. When the token is associated to an expression analysis, this parameter allows specifying the expression column for the overlay

ext (string, path, required)

File extension (defines the image format)

Constraints: {'enum': ['png', 'jpg', 'jpeg', 'svg', 'gif']}

flg (string, query, optional)

Gene name, protein or chemical identifier or Reactome identifier used to flag elements in the diagram

flgInteractors (boolean, query, optional, default: True)

Defines whether to take into account interactors for the flagging

includeRef (boolean, query, optional, default: False)

Global parameter - If true, replace element ref to dbId by standard JSOG object {@ref}

margin (integer, query, optional, default: 15)

Defines the image margin between [0 - 20] (Default 15)

quality (integer, query, optional, default: 5)

Result image quality between [1 - 10]. It defines the quality of the final image (Default 5)

resource (string, query, optional, default: TOTAL)

The <a href="/dev/analysis" target="_blank">analysis</a> resource for which the results will be overlaid on top of the given pathways overview

sel (array, query, optional)

Highlight element(s) selection in the diagram. CSV line.

species (string, path, required)

Species identifier (it can be the taxonomy id, species name or dbId)

title (boolean, query, optional, default: True)

Sets whether the name of the pathway is shown below

token (string, query, optional)

The <a href="/dev/analysis" target="_blank">analysis</a> token with the results to be overlaid on top of the given pathways overview

view (string, query, optional, default: flatten)

Global parameter - Customise the view to be more concise and/or aggregate relationships

Constraints: {'enum': ['flatten', 'nested', 'nested-aggregated']}

Examples (1)

TitleTypeURLAction
Exports a given pathway overview to the specified image format (png, jpg, jpeg, svg, gif) openapi-spec https://reactome.org/ContentService/exporter/fireworks/9606.svg?quality=5&title=True&margin=15&diagramProfile=Copper

Probe History

Latency

Status Codes

TimeStatusLatencySize
2026-03-23 10:50:46.715920 406 333ms