HomeGuidesRecipesAPI ReferenceChangelog
Log In
Guides

Advanced Tariff Filtering

Advanced Tariff Filtering

Some markets, such as California, have many tariffs to choose from. Customers in these markets should consider using their experience and expertise when faced with longer lists. We will cover some special use cases that require slightly more advanced filtering techniques.

Filtering Tariffs with Additional Eligibility Requirements

Some utilities require customers to switch to a different tariff when they move to solar or have tariffs only open to customers with an electric vehicle. Arcadia captures these additional eligibility criteria in the tariff properties collection, specifically in properties with a propertyType of APPLICABILITY.

These are the three arguments you need to provide when using the Tariff endpoint to filter by eligibility:

  1. populateProperties=true - Ensures the data needed to filter is considered.
  2. filterByApplicability=true - Applies a rule that results should also be filtered by applicability (i.e., additional eligibility properties).
  3. applicabilityFilters[solarPvEligible]=true - Specifies the applicability criteria to filter by.

See an example in this recipe card:

For an Electric Vehicle or EV case, you would supply the parameter hasElectricVehicle=true instead of solarPvEligible=true.

Filtering Tariffs Based on Rate Characteristics

Occasionally, you might want to retrieve a list of tariffs that include rates with a specific characteristic, such as ones that vary by Time of Use. We support the following explicit parameters that you can filter on:

NameTypeDescription
hasNetMeteringBooleanReturn tariffs that have or do not have any net-metered tariff rates (Optional)
hasTimeOfUseRatesBooleanReturn tariffs that have or do not have any time-of-use rates (Optional)
hasTieredRatesBooleanReturn tariffs that have or do not have any tiered rates (Optional)
hasContractedRatesBooleanReturn tariffs that have or do not have any contracted rates (Optional)

Here is an example request for currently effective and open California C&I tariffs with a Direct Access component:

The response will return a list of Direct Access tariffs where hasContractedRates is equal to true. We’ve also included the fields=ext parameter in this request because hasContractedRates is an extended field.

If you execute the same request, but add populateProperties=true, we will be able to explicitly see the Direct Access component.

You can see from the response returned that the property, keyName: isDirectAccessCustomer, has a propertyValue of true, meaning this indeed is a Direct Access customer!

You can learn more in our Tariffs API documentation.

Filtering Out Tariffs That Are Closed to New Enrollment

Sometimes utilities retire tariff rate plans. These retired tariff rate plans are flagged with the date they were closed.

If you are presenting a list of tariffs that customers could change to, you’ll typically want to remove all closed tariffs. To accomplish this:

  • Pass in a date value to the openOn property, which will usually be the same date used for the effectiveOn property.
  • Don’t filter on this property if your use case is to select or choose the existing tariff a customer is on, as they might be grandfathered into a closed tariff.

For an example, see this recipe card:

From analyzing all tariffs that were returned, we can learn a few things.

None of these tariffs have closedDate populated

This was our desired result, and we have successfully filtered out closed tariffs! closedDate is the date on which a tariff became closed to new customers but still available for customers who were on it at the time. This can be null, meaning that the tariff is not closed.

endDate is either not set or occurs after the effectiveDate we have specified

The endDate for each of the tariffs returned is either set to after 01/01/2024 or the endDate is null, meaning its end date is not yet known or ongoing until further notice.

Utility and Tariff Data at Your Fingertips!

You can find more detailed information about each endpoint demonstrated in this tutorial on the API Reference Guide. The reference guide will prove to be a useful resource when you need additional guidance. If there is another utility or particular tariff data you would like to retrieve but don’t see a method of doing so from this tutorial, check out our other Guides and existing How-Tos.