Skip to main content
GET
Get Simplified Tariff

Authorizations

Authorization
string
header
required

Path Parameters

tariff_id
string<uuid>
required

Query Parameters

start_time
string<date-time>
required

ISO 8601 timezone-aware datetime at which the range begins (inclusive).

end_time
string<date-time>
required

ISO 8601 timezone-aware datetime at which the range ends (exclusive). Must be strictly greater than start_time.

Response

Successful Response

Indicative, simplified view of a Tariff's rates over a time range.

component_rates
ComponentRate · object[]
required

Per-component rate timeseries, for components that can be projected onto a per-kWh or per-kW rate. Empty if the tariff has no projectable components.

dataset_rates
RateTimeseries · object[]
required

Summed rate timeseries per (dataset_id, unit) group, across all projectable components contributing to that group. Empty if the tariff has no projectable components.

unprojectable_components
ComponentIdentity · object[]
required

Tariff components present on the tariff that could not be projected onto a rate timeseries. Listed by name and applicability window only; see Get Tariff for full component definitions.