List Tariffs

get

https://api.genability.com/rest/public/tariffs

Return tariffs matching the provided filters.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

lseId

int64

Filter tariffs for a specific LSE

masterTariffId

int64

If specified, all versions of a tariff belonging to the master tariff Id are returned.

effectiveOn

date

Only tariffs that are effective on this date

openOn

date

Only tariffs that were open (i.e. were not closed to new customers) on this date.

isActive

boolean

Only the current, active tariff version for the LSE or master tariff Id.

fromDateTime

date

Only include tariffs that are effective on or after this date

toDateTime

date

Only include tariffs that are effective on or before this date

customerClasses

string

Comma separated string that indicates the customer classes to include. Choices are: RESIDENTIAL, GENERAL, SPECIAL_USE

chargeTypes

string

Comma separated string that indicates the charge types to include. Choices are: FIXED_PRICE, CONSUMPTION_BASED, DEMAND_BASED, QUANTITY, MINIMUM, TAX, NET_EXCESS_GENERATION

tariffTypes

string

Comma separated string that indicates the tariff types to include. Choices are: DEFAULT, ALTERNATIVE, OPTIONAL_EXTRA, RIDER

serviceTypes

string

Comma separated string that indicates the service types to include. Choices are: ELECTRICITY, SOLAR_PV, ‘GAS’ (default is all serviceTypes)

privacyFlags

string

Comma separated string that indicates the privacy flags types to include. Only applicable if you publish private tariffs. Choices are: PUBLIC, UNLISTED, PRIVATE

zipCode

string

(Optional but Recommended) Use this to return just the Tariffs that are for this given location. Most Tariffs apply for a regional, not national, geography.

postCode

string

Alias for zipCode. You can use either.

lat

float

(Optional) Represents the latitude of a geographical location. This should be paired with lng when not supplying a zip code or address.

lng

float

(Optional) Represents the longitude of a geographical location. This should be paired with lat when not supplying a zip code or address.

addressString

string

An alternative to using zipCode. Use this if you do not have the address parsed out in your app, but instead have a long string. For the best results this string will contain a zipcode or post code. If you do have the address split out it is better to use postCode.

riderId

int64

When set to the masterTariffId of a Rider, this will return all of the tariffs that the rider is used on

populateProperties

boolean

Populates the properties for the returned tariffs

populateRates

boolean

Populates the rate details for the returned tariffs

populateDocuments

boolean

Populates the document links for the returned tariffs

consumption

double

Return tariffs which are eligible for this consumption amount

demand

double

Return tariffs which are eligible for this demand amount

hasNetMetering

boolean

Return tariffs which have or do not have any net metered tariff rates

hasTimeOfUseRates

boolean

Return tariffs which have or do not have any time-of-use rates

hasTieredRates

boolean

Return tariffs which have or do not have any tiered rates

hasContractedRates

boolean

Return tariffs which have or do not have any contracted rates

bundleRates

boolean

When true (false by default) the rates are summarized (bundled). Note that this only works for tariffs with a customerClass of RESIDENTIAL.

applicableRatesOnly

boolean

When true (false by default) rate applicability criteria will be applied to the rates. You’ll only get back rates that match the requests rate applicability values, or the default rate applicability value as set on the tariff.

filterRiderRates

string

Used in concert with populateRates = true, when filterRiderRates = true (false by default) rider rates will not be returned. However pointers to the riders will be returned. This is used primarily when using and existing tariff’s structure when creating private tariffs

filterByApplicability

boolean

applies a rule that results should also be filtered by applicability (i.e., additional eligibility properties).

applicabilityFilters[solarPvEligible]

boolean

which is the specific applicability criteria to filter by

fields

string

ext to return extended fields

Responses

200200

400400