HomeGuidesAPI ReferenceChangelog
Log In
API Reference

Tariff Optimize - Calculate Tariff-Scenario Cost

Calculates the “what-if” cost of a single tariff-scenario, or combination of tariff, load curve and qualifying criteria. A tariff-scenario can simulate additional devices with various operational schedules. For example, we can simulate the cost of adding an EV with basic charging, and we can compare that to another tariff-scenario where the cost on the same tariff is simulated with an EV using smart charging.

Either utility_account_id or zip_code/main_tariff_id must be specified.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
integer

(Beta - due to limited coverage) The unique ID of the utility account that this calculation is being run against. Optional if calculating costs by Genability main_tariff_id/zip_code.

string

The Genability 'masterTariffId' unique identifier for this tariff. See Genability documentation for details. Must be provided if calculating costs by Genability main_tariff_id/zip_code.

string

The zip code of the scenario. Must be provided if calculating costs by Genability main_tariff_id/zip_code.

applicability_answers
array of objects

Answers to tariff applicability questions

applicability_answers
string
enum
required
Defaults to TYPICALS

A TYPICALS baseline_load uses the typical hourly energy usage for the end-user's zip code.

Allowed:
device_loads
array
required

List of device simulations to add additional synthetic load curves on top of the baseline_load

device_loads*
Headers
string
required
Defaults to 2022-10-13

The Arcadia-Version for the request

Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json