Smart Price API

Time	Status	User Agent
Retrieving recent requests…

fromDateTime

date

Start date and time to get prices for. (Optional, Defaults to "now".)

toDateTime

date

End date and time to get prices for. (Optional, Defaults to fromDateTime plus 3 days.)

masterTariffId

int64

You can use this rather than a location (addressString or zipCode) and customer class. We will use the tariffs information to return its price, or in the case of a smart price request, its applicable Smart Tariffs price (Optional)

zipCode or postCode

string

Recommended way to pass a location. Make sure it’s just the ZIP code or post code though. (Optional)

country

string

Use when passing in a postCode or zipCode. Set to the ISO Country Code you require (Optional)

addressString

string

An alternate to using postCode or zipCode and can be an address of any kind. Ideally this will contain a ZIP code or post code. (Optional)

customerClass

string

Denotes the type of customer and is used to determine the appropriate tariff or smart tariff. (Optional) Defaults to "RESIDENTIAL"

endUse

string

Primarily used for smart tariffs. You can use this denote what end use (e.g. appliance, EV, whole home, thermostat etc) the price signal is for. (Optional). You can get the actual values that you can pass in from the property keys residentialEndUse and commercialEndUse

groupBy

string

Use to specify the intervals you want the price changes back in. (Optional) When not passed in you get a change record for each actual change in price. Passing in "HOUR" will give hourly prices, even if the price doesn’t change.

territoryId

int64

Rarely needed. This is the for when a tariff has different rates for different territories (so its not for a utility companies service area territory). Only needed when you want to override the default territory. (Optional)

consumptionAmount

double

A monthly consumption in kWh. This is used for banded consumption to determine which pricing to use for the request. By default, the rate amount calculation assumes the highest banded level of consumption. (Optional)

demandAmount

double

A monthly demand in kW. This is used for banded demand to determine which pricing to use for the request. By default, the rate amount calculation assumes the highest banded level of demand. (Optional)

200200

400400