Derived Spread
spread.getCompute a derived spread observation: 3-2-1 crack, soybean crush, WTI-Brent basis, or calendar (calendar requires licensed curve data and may return available=false). Prefer crack/crush/basis for live derived values with formula and inputs.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| root | No | Optional root symbol for calendar spreads. Example: CL. Ignored for crack/crush/basis. | |
| type | Yes | Spread type to compute. Example: crack for 3-2-1 gasoline/distillate crack. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | Stable observation id | |
| name | No | Human-readable instrument name | |
| note | No | Explanation when unavailable or partially degraded | |
| root | No | Calendar root when type=calendar | |
| unit | No | Unit of measure | |
| as_of | No | As-of date for the observation | |
| value | No | Observed numeric value | |
| inputs | No | Input series ids when derived | |
| source | No | Primary source provenance | |
| derived | No | True when value is derived | |
| formula | No | Derivation formula when derived | |
| quality | No | Data quality label | |
| raw_hash | No | Hash of raw source payload | |
| available | No | False when the spread cannot be computed | |
| series_id | No | Underlying series id | |
| instrument | No | Instrument code, e.g. CL | |
| provenance | No | Retrieval / cache provenance | |
| license_tag | No | License / redistribution tag | |
| observed_at | No | ISO timestamp when observed | |
| legs_quality | No | Per-leg quality when inputs are mixed | |
| freshness_class | No | Freshness class for the series |