HomeGuidesAPI ReferenceChangelog
Log In
API Reference

Calculate Tariff Rate ($/kWh)

Calculates marginal rate ($/kWh) for a short-term time period on the electric tariff a given utility account is subscribed to. This endpoint will report appropriate costs for TOU periods (daily peak/off-peak hours, weekend schedules, seasonal changes).
This endpoint is not recommended for monthly bill reproduction. Marginal rates generally do not include monthly adjustments or charges such as tiering (costs are generally reported at the base tier), fixed charges, monthly discounts, special event days, etc.

Log in to see full request history
Body Params
integer

(Beta - due to limited coverage) The unique ID of the utility account that this calculation is being run against. Either a utility_account_id or main_tariff_id is required for a valid request.

string

The Genability 'masterTariffId' unique identifier for this tariff. See Genability documentation for details. Either a utility_account_id or main_tariff_id is required for a valid request.

date-time
required

ISO8601 timestamp indicating start time. Note that the timestamp will be rounded down to the start of latest time_block_resolution

date-time

ISO8601 timestamp indicating end of time period. Note that the timestamp will be rounded down to the start of latest time_block_resolution

string
Defaults to 1h

Requested time resolution

Headers
string
required
Defaults to 2022-10-13

The Arcadia-Version for the request

Response

Response body
object
tariff
object
required

Information about a tariff.

string
required

The Genability 'masterTariffId' unique identifier for this tariff. See Genability documentation for details.

property_inputs
array of objects

Properties applied to this tariff which may affect the calculated cost of electricity.

property_inputs
object
string
required
required
string | null

The name of the retail electricity supplier or the community choice aggregator. If there is no retail electricity supplier or community choice aggregator, this field is null.

string
required

Abbreviation code of the tariff used for this calculation.

string
required

Full name of the tariff used for this calculation.

string
required

Name of the utility associated with this tariff

rates_cost_per_kwh
object
required

Timeseries with data array of $/kWh rates

data
array of objects
required

Array of TimeSeriesItems indicating $/kWh rates for each requested time period

data*
object
date-time
required

ISO8601 timestamp indicating time of data collection

number
required

Data value of resource

string
required

The interval of the TimeSeriesItems in the data array

5m 10m 15m 30m 1h

Headers
object
string

The Arcadia-Version for the response

Language
Credentials