Sign in

v1

latestOpenAPI 3.1.02026-07-1342111193.6 KB
Spark

Tariff Optimize - Search for Recommended Applicable Tariffs

Returns a list of applicable tariffs to use in a Tariff-Scenario Cost Calculation given the answers to the submitted Applicability Questions.

The set of recommended tariffs can be specified either by an Arcadia Utility Account ID, or by considering all tariffs in a given zip code served by a specific Genability Load Serving Entity (LSE).

Either utility_account_id or both the zip_code/lse_id must be specified.

post/spark/optimized_tariffs/recommendations

Headers

Arcadia-Versionstring required

The Arcadia-Version for the request

Request body

utility_account_idinteger

The unique ID of the Utility Account for this tariff search. Optional if searching for tariffs by Genability lse_id/zip_code.

zip_codestring

The zip code of the site inside the LSE's territory. Must be provided if searching for tariffs by Genability lse_id/zip_code.

lse_idstring

The ID of the Genability load serving entity prefixed with gen_lse_. Must be provided if searching for tariffs by Genability lse_id/zip_code.

Example request

{
  "utility_account_id": 12345,
  "zip_code": "94706",
  "lse_id": "gen_lse_734",
  "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"
    }
  ]
}

Response

Success

countrystring required

The country used for determining tariff applicability

lse_idstring required

The Genability 'lseId' unique identifier for this load serving entity. See Genability documentation for details.

zip_codestring required

The zip code used for determining tariff applicability

Example response

{
  "country": "US",
  "lse_id": "gen_lse_734",
  "zip_code": "94706",
  "recommendations": [
    {
      "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"
    }
  ]
}