Get Smart Price

get

https://api.genability.com/rest/v1/prices/smart

Retrieve marginal pricing for a location or tariff over a specified time window.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Use this endpoint to retrieve marginal pricing for a location or tariff over a specified time window.

When to use this endpoint

Use GET /rest/v1/prices/smart when you need to:

Retrieve price signals for short-term load management.
Display current or upcoming pricing to end users.
Support device scheduling or automation workflows.
Return price changes over a requested date range.
Request price changes grouped by interval, such as hourly prices.

Date range inputs

Parameter	Type	Description
`fromDateTime`	DateTime	Start date and time for returned prices. Defaults to `now`.
`toDateTime`	DateTime	End date and time for returned prices. Defaults to `fromDateTime` plus 3 days.

Tariff or location inputs

Use either a tariff input or location inputs:

Parameter	Type	Description
`masterTariffId`	Long	Tariff ID used to return its price or applicable Smart Tariff price.
`zipCode` or `postCode`	String	Recommended location input.
`country`	String	ISO country code. Use with `zipCode` or `postCode`.
`addressString`	String	Alternative location input. Ideally includes a ZIP code or postal code.
`customerClass`	String	Customer class used to determine the appropriate tariff or Smart Tariff. Defaults to `RESIDENTIAL`.

Pricing options

Parameter	Type	Description
`endUse`	String	End use for the price signal, such as an appliance, EV, whole home, or thermostat. Values come from the `residentialEndUse` and `commercialEndUse` Property Keys.
`groupBy`	String	Returns price changes grouped by the specified interval. Passing `HOUR` returns hourly prices.
`territoryId`	Long	Overrides the default territory when tariff rates vary by territory.
`consumptionAmount`	Decimal	Monthly consumption in kWh used for banded consumption pricing.
`demandAmount`	Decimal	Monthly demand in kW used for banded demand pricing.

Related endpoints

lightbulb

Smart Price Overview

Learn how Smart Price responses and price changes are modeled.

file-invoice-dollar

List Tariffs

Find the masterTariffId for price requests.

key

List Properties

Retrieve end-use Property Keys such as residentialEndUse and commercialEndUse.

Query Params

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)

Responses

When to use this endpoint

Date range inputs

Tariff or location inputs

Pricing options

Related endpoints

200200

400400