Query a stream
query_streamRead rows from a stream — raw (newest first), each entity's newest, or a rollup.
The result carries `restUrl`: this same request as a plain GET on the
public REST API, ready to put in an app.
Args:
slug: The stream.
node: The entity, whatever the stream calls it (node, zone, station, fuel).
System-level streams have none.
start: Inclusive, ISO-8601 or relative to now (-24h, -7d). UTC.
end: Exclusive, same forms.
interval: Bucket size — 5m, 15m, 1h, 1d, 7d, or all for one bucket.
Absent means raw rows.
agg: How a bucket is reduced.
by: What a rollup splits by: a text column, or none for one series. Default the entity.
where: Filters as column=value on text columns. Repeat a column for OR.
search: column:text, a case-insensitive substring.
vintages: latest is each interval's newest forecast; all keeps every publication.
stamp: noon labels a daily bucket at noon UTC so its date reads right in US zones.
newest: One reading per entity — each one's most recent interval, so "the price
at every hub right now" is one call. Not with interval.
limit: At most this many rows (1–2000).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| by | No | ||
| agg | No | avg | |
| end | No | ||
| node | No | ||
| slug | Yes | ||
| limit | No | ||
| stamp | No | start | |
| start | No | ||
| where | No | ||
| newest | No | ||
| search | No | ||
| interval | No | ||
| vintages | No | latest |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||