Typical Baseline API

zipCode

string

The zip code or postal code we will use to look up local buildings.

country

string

The ISO country code. Use in conjunction with zipCode | postCode parameters.

addressString

string

The address string we will geo-tag (isolate latitude & longitude) to look up local buildings.

lat

double

Latitude to look up. Use in concert with lng if you choose this method.

lng

double

Longitude to look up. Use in concert with lat if you choose this method.

customerClass

string

The class of customer, which is one of RESIDENTIAL, GENERAL, or SPECIAL_USE.

buildingType

string

The building type that best describes this building. Use RESIDENTIAL for a residential default or one of the more explicit choices returned from the property key buildingTypeResidential or buildingTypeCommercial.

serviceType

string

This is currently limited to ELECTRICITY.

buildingArea

int64

If you have the site footprint, pass in size of the building in square feet. If this is not passed directly we will default to the average for the region and buildingType.

buildingVintage

string

The construction year of the building, options include Pre1980, Post1980 (1980 - 2003), or New (2003+).

excludeMeasures

boolean

Setting to true will omit the measures (makes the call faster if you don't need this data). Defaults to false.

measuresUnit

string

By default, we will return total usage per interval. If you ask for intensity we'll convert this into energy intensity (e.g. per square foot or meter). Your final choice is proportion which means that each value in the year will add up to 100.

groupBy

string

When supplied the response will roll up measures into this period. Possible values are MONTH, DAY, YEAR.

sizingKeyName

string

Pass this parameter when you want to adjust the size of the load. Currently supports loadSize. Used in concert with sizingDataValue and sizingUnit.

sizingDataValue

int32

This should be set to the quantity to size (e.g. 12000 for 12,000 kWh). (See sizingKeyName above)

sizingUnit

string

This denotes the unit of measure for the accompanying sizingDataValue. Currently, we support only kWh. (See sizingKeyName above)

intervalFromDateTime

date

Pass this parameter when you want the "intervals" to be populated from a certain date (e.g. 2024-01-01).

intervalToDateTime

date

Pass this parameter when you want the "intervals" to be populated to a certain date (e.g. 2025-01-01).

200200

400400