v1

latestOpenAPI 3.1.02026-07-1342111193.6 KB

Spark

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.

post/spark/optimized_tariffs/scenario_cost

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. Optional if calculating costs by Genability main_tariff_id/zip_code.

main_tariff_idstring

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.

zip_codestring

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

baseline_load'TYPICALS' required

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

Example request

{
  "main_tariff_id": "gen_mtid_3331108",
  "zip_code": "94105",
  "applicability_answers": [
    {
      "question_id": "EV",
      "value": true,
      "data_type": "YES_NO"
    },
    {
      "question_id": "SOLAR",
      "value": true,
      "data_type": "YES_NO"
    },
    {
      "question_id": "ELECTRIC_HEAT",
      "value": false,
      "data_type": "YES_NO"
    },
    {
      "question_id": "ELECTRIC_WATER",
      "value": false,
      "data_type": "YES_NO"
    },
    {
      "question_id": "HEAT_PUMP",
      "value": false,
      "data_type": "YES_NO"
    },
    {
      "question_id": "SENIOR_CITIZEN",
      "value": false,
      "data_type": "YES_NO"
    },
    {
      "question_id": "LOW_INCOME",
      "value": false,
      "data_type": "YES_NO"
    },
    {
      "question_id": "CA_CARE_CUSTOMER",
      "value": false,
      "data_type": "YES_NO"
    },
    {
      "question_id": "CA_FERA",
      "value": false,
      "data_type": "YES_NO"
    }
  ],
  "device_loads": [
    {
      "device": "EV_CHARGING",
      "charging_power_kw": 7.2,
      "operation_schedule": "SMART",
      "charging_availability": [
        {
          "start_day_of_week": 1,
          "start_time": "18:00:00",
          "end_day_of_week": 2,
          "end_time": "09:00:00",
          "expected_consumption_kwh": 10.4
        },
        {
          "start_day_of_week": 2,
          "start_time": "18:00:00",
          "end_day_of_week": 3,
          "end_time": "09:00:00",
          "expected_consumption_kwh": 10.4
        },
        {
          "start_day_of_week": 3,
          "start_time": "18:00:00",
          "end_day_of_week": 4,
          "end_time": "09:00:00",
          "expected_consumption_kwh": 10.4
        },
        {
          "start_day_of_week": 4,
          "start_time": "18:00:00",
          "end_day_of_week": 5,
          "end_time": "09:00:00",
          "expected_consumption_kwh": 10.4
        },
        {
          "start_day_of_week": 5,
          "start_time": "18:00:00",
          "end_day_of_week": 6,
          "end_time": "10:00:00",
          "expected_consumption_kwh": 10.4
        },
        {
          "start_day_of_week": 6,
          "start_time": "16:00:00",
          "end_day_of_week": 7,
          "end_time": "10:00:00",
          "expected_consumption_kwh": 5
        },
        {
          "start_day_of_week": 7,
          "start_time": "16:00:00",
          "end_day_of_week": 1,
          "end_time": "09:00:00",
          "expected_consumption_kwh": 5
        }
      ]
    },
    {
      "device": "SOLAR",
      "solar_system_kw": 5
    }
  ]
}

Response

Success

costnumber

Costs from multiple Tariff-Scenarios can be compared to find the optimal combination of tariff and device-scenarios. A baseline Tariff-Scenario cost can be calculated to present potential savings of each what-if Tariff-Scenario. Plug endpoints can be used to further compare to actual utility costs.

start_datestring date

The start date of the calculated simulation. If using baseline_load=TYPICALS, this will be one year in the past.

end_datestring date

The end date of the calculated simulation. If using baseline_load=TYPICALS, this will be the current time.

Example response

{
  "cost": 150,
  "start_date": "2021-02-03",
  "end_date": "2022-02-03"
}