Sign in

v1

latestOpenAPI 3.1.02026-07-1342111193.6 KB
Spark

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.

post/spark/tariff_rates

Headers

Arcadia-Versionstring required

The Arcadia-Version for the request

Request body

utility_account_idinteger

(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.

main_tariff_idstring

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.

start_timestring date-time required

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

end_timestring 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

time_block_resolution'5m' | '10m' | '15m' | '30m' | '1h'

Requested time resolution

Example request

{
  "main_tariff_id": "gen_mtid_3331108",
  "start_time": "2021-03-18T22:00:00-07:00",
  "end_time": "2021-03-19T08:00:00-07:00"
}

Response

Success

Example response

{
  "tariff": {
    "main_tariff_id": "gen_mtid_3331108",
    "property_inputs": [
      {
        "id": "territoryId"
      }
    ],
    "supplier_name": "East Bay Community Energy",
    "tariff_code": "EV-2A-TOU",
    "tariff_name": "Residential - Time of Use - Plug-In Electric Vehicle 2",
    "utility_name": "Pacific Gas & Electric"
  }
}