Palmetto Energy Intelligence API - Swagger UI

Palmetto Energy Intelligence API

v0.32.2-19a9666

OAS 3.1

Servers

https://ei.palmetto.com

Authorize

default

GET

/api/v0/health

Health

POST

/api/v0/bem/calculate

Calculate

Calculate energy consumption, production, costs and emissions

Parameters

Try it out

No parameters

Request body

application/json

Examples: example_1

{
  "location": {
    "latitude": 37.7749,
    "longitude": -122.4194
  },
  "parameters": {
    "clip_by": "inner",
    "from_datetime": "2023-01-01T00:00:00",
    "group_by": "month",
    "interval_format": "long",
    "to_datetime": "2024-01-01T00:00:00",
    "variables": [
      "consumption.electricity"
    ]
  },
  "consumption": {
    "actuals": [
      {
        "from_datetime": "2023-01-01T00:00:00",
        "to_datetime": "2024-01-01T00:00:00",
        "value": 3774,
        "variable": "consumption.electricity"
      }
    ],
    "attributes": {
      "baseline": [
        {
          "name": "building_type",
          "value": "Single-Family Detached"
        }
      ],
      "hypothetical": [
        {
          "name": "building_type",
          "value": "Single-Family Detached"
        }
      ]
    },
    "calibration": {
      "apply_residuals": true,
      "method": "uniform-mean",
      "sample_size": 35
    }
  },
  "production": {
    "actuals": [
      {
        "from_datetime": "2023-01-01T00:00:00",
        "to_datetime": "2024-01-01T00:00:00",
        "value": 7.3,
        "variable": "production.electricity"
      }
    ],
    "attributes": {
      "baseline": [
        {
          "name": "panel_arrays",
          "value": [
            {
              "azimuth": 180,
              "capacity": 10,
              "tilt": 30
            }
          ]
        }
      ],
      "hypothetical": []
    },
    "calibration": {
      "method": "uniform-mean"
    }
  },
  "storage": {
    "attributes": {
      "baseline": [
        {
          "name": "capacity",
          "value": 10
        },
        {
          "name": "power",
          "value": 5
        },
        {
          "name": "capacity_recommendation_quantile",
          "value": 0.5
        }
      ],
      "hypothetical": []
    }
  },
  "costs": {
    "emission_rates": {
      "electricity": {
        "units": "kgCO2e/kWh",
        "value": 0.47045
      },
      "fossil_fuel": {
        "units": "kgCO2e/kWh",
        "value": 0.1872057318321392
      }
    },
    "utility_rates": {
      "electricity": {
        "units": "$\/kWh",
        "value": 0.29305
      },
      "fossil_fuel": {
        "units": "$\/kWh",
        "value": 0.069771
      },
      "pv_buyback": {
        "units": "$\/kWh",
        "value": 0.2
      },
      "pv_ppa": {
        "units": "$\/kWh",
        "value": 0.26
      }
    }
  }
}

Responses

Code Description Links
200 Successful Response
Media type
application/json
Controls Accept header.
- Example Value
- Schema
```json
{
"version": "v2.46.2-9b9d19f",
"detail": "success",
"meta": {
"parameters": {
"from_datetime": "2019-01-01T00:00:00",
"to_datetime": "2020-01-01T00:00:00",
"interval_format": "long",
"group_by": "year",
"clip_by": "inner",
"variables": "all",
"use_actual_weather": false
},
"units": {
"thermal_demand": "kBtu",
"consumption": "kWh",
"production": "kWh",
"storage": "kWh",
"grid": "kWh",
"emissions": "kgCO2e",
"costs": "$",
"air_temperature": "°C",
"relative_humidity": "%",
"wind_speed": "m/s",
"ghi": "kWh/m²",
"dni": "kWh/m²",
"dhi": "kWh/m²"
},
"warnings": [
"string"
],
"sources": {
"building_type_source": "regrid",
"floor_area_source": "regrid",
"floor_area_source_model": "regressors from glide API w/ num stories",
"heating_fuel_source": "acs",
"vintage_source": "acs",
"num_stories_source": "regrid",
"census_block_group_geoid": "string",
"regrid_parcel_uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
},
"data": {
"location": {
"puma_fips": "string",
"county": "string",
"county_fips": "string",
"state": "string",
"state_fips": "string",
"climate_zone": "1A",
"latitude": 0,
"longitude": 0,
"timezone": "Africa/Abidjan",
"address": "123 Main St, San Francisco, CA 94105"
},
"consumption": {
"baseline": [
{
"name": "building_type",
"value": "Single-Family Detached"
},
{
"name": "vintage",
"value": "<1940"
},
{
"name": "floor_area",
"value": 1
},
{
"name": "garage",
"value": true
},
{
"name": "num_bedrooms",
"value": 1
},
{
"name": "num_occupants",
"value": 1
},
{
"name": "num_stories",
"value": 1
},
{
"name": "horizontal_location",
"value": "Left"
},
{
"name": "vertical_location",
"value": "Top"
},
{
"name": "orientation",
"value": "North"
},
{
"name": "neighbors_distance",
"value": 30
},
{
"name": "lighting",
"value": "Incandescent"
},
{
"name": "refrigerator_efficiency",
"value": 1360
},
{
"name": "refrigerator_extra_efficiency",
"value": 1360
},
{
"name": "freezer_extra_efficiency",
"value": 1000
},
{
"name": "dishwasher_efficiency",
"value": 318
},
{
"name": "clothes_washer_efficiency",
"value": "None"
},
{
"name": "clothes_dryer_efficiency",
"value": "None"
},
{
"name": "clothes_dryer_fuel",
"value": "Electric"
},
{
"name": "cooking_range",
"value": "None"
},
{
"name": "ceiling_fan",
"value": 175
},
{
"name": "plug_loads",
"value": 0.78
},
{
"name": "usage_level",
"value": "Low"
},
{
"name": "water_fixtures_usage",
"value": 0.1
},
{
"name": "water_heater",
"value": "Fossil Fuel Standard"
},
{
"name": "water_heater",
"value": 40
},
{
"name": "clothes_washer_hot_water_usage",
"value": 1
},
{
"name": "hvac_heat_pump",
"value": true
},
{
"name": "hvac_heating_fuel",
"value": "Electric"
},
{
"name": "hvac_heating_efficiency",
"value": 0.1
},
{
"name": "hvac_heating_capacity",
"value": 0
},
{
"name": "hvac_secondary_heating_fuel",
"value": "Electric"
},
{
"name": "hvac_secondary_heating_efficiency",
"value": 0.1
},
{
"name": "hvac_secondary_heating_capacity",
"value": 0
},
{
"name": "hvac_cooling",
"value": true
},
{
"name": "hvac_cooling",
"value": 0.1
},
{
"name": "hvac_cooling",
"value": 0
},
{
"name": "hvac_cooling",
"value": 1
},
{
"name": "hvac_heating_setpoint",
"value": 10
},
{
"name": "hvac_cooling",
"value": 10
},
{
"name": "hvac_heating_ducts",
"value": true
},
{
"name": "hvac_cooling",
"value": true
},
{
"name": "hvac_ducts_leakage",
"value": 0.3
},
{
"name": "hvac_ducts_insulation",
"value": 1
},
{
"name": "hvac_ducts_location",
"value": "Living Space"
},
{
"name": "hvac_air_distribution_efficiency",
"value": 0.1
},
{
"name": "ground_thermal_conductivity",
"value": 0.5
},
{
"name": "infiltration_ach50",
"value": 1
},
{
"name": "window_panes",
"value": "Single"
},
{
"name": "window_metal_framing",
"value": true
},
{
"name": "window_low_e",
"value": true
},
{
"name": "window_storm",
"value": true
},
{
"name": "window_to_wall_ratio",
"value": 0.06
},
{
"name": "roof_material",
"value": "Asphalt Shingles, Medium"
},
{
"name": "roof_or_ceiling_insulation",
"value": 1
},
{
"name": "attic_type",
"value": "Finished Attic or Cathedral Ceilings"
},
{
"name": "wall_type",
"value": "Brick"
},
{
"name": "wall_insulation",
"value": 1
},
{
"name": "wall_exterior_finish",
"value": "None"
},
{
"name": "floor_or_slab_insulation",
"value": 1
},
{
"name": "foundation_type",
"value": "Slab"
},
{
"name": "foundation_wall_insulation",
"value": 1
},
{
"name": "rim_joist_insulation",
"value": 1
},
{
"name": "ev_charging",
"value": true
},
{
"name": "ev_charging",
"value": "immediate_fast"
},
{
"name": "ev_charging",
"value": 0.6
},
{
"name": "ev_miles",
"value": 100000
},
{
"name": "ev_efficiency",
"value": 0.2
},
{
"name": "pool",
"value": "None"
},
{
"name": "hot_tub",
"value": "None"
}
],
"hypothetical": [
{
"name": "building_type",
"value": "Single-Family Detached"
},
{
"name": "vintage",
"value": "<1940"
},
{
"name": "floor_area",
"value": 1
},
{
"name": "garage",
"value": true
},
{
"name": "num_bedrooms",
"value": 1
},
{
"name": "num_occupants",
"value": 1
},
{
"name": "num_stories",
"value": 1
},
{
"name": "horizontal_location",
"value": "Left"
},
{
"name": "vertical_location",
"value": "Top"
},
{
"name": "orientation",
"value": "North"
},
{
"name": "neighbors_distance",
"value": 30
},
{
"name": "lighting",
"value": "Incandescent"
},
{
"name": "refrigerator_efficiency",
"value": 1360
},
{
"name": "refrigerator_extra_efficiency",
"value": 1360
},
{
"name": "freezer_extra_efficiency",
"value": 1000
},
{
"name": "dishwasher_efficiency",
"value": 318
},
{
"name": "clothes_washer_efficiency",
"value": "None"
},
{
"name": "clothes_dryer_efficiency",
"value": "None"
},
{
"name": "clothes_dryer_fuel",
"value": "Electric"
},
{
"name": "cooking_range",
"value": "None"
},
{
"name": "ceiling_fan",
"value": 175
},
{
"name": "plug_loads",
"value": 0.78
},
{
"name": "usage_level",
"value": "Low"
},
{
"name": "water_fixtures_usage",
"value": 0.1
},
{
"name": "water_heater",
"value": "Fossil Fuel Standard"
},
{
"name": "water_heater",
"value": 40
},
{
"name": "clothes_washer_hot_water_usage",
"value": 1
},
{
"name": "hvac_heat_pump",
"value": true
},
{
"name": "hvac_heating_fuel",
"value": "Electric"
},
{
"name": "hvac_heating_efficiency",
"value": 0.1
},
{
"name": "hvac_heating_capacity",
"value": 0
},
{
"name": "hvac_secondary_heating_fuel",
"value": "Electric"
},
{
"name": "hvac_secondary_heating_efficiency",
"value": 0.1
},
{
"name": "hvac_secondary_heating_capacity",
"value": 0
},
{
"name": "hvac_cooling",
"value": true
},
{
"name": "hvac_cooling",
"value": 0.1
},
{
"name": "hvac_cooling",
"value": 0
},
{
"name": "hvac_cooling",
"value": 1
},
{
"name": "hvac_heating_setpoint",
"value": 10
},
{
"name": "hvac_cooling",
"value": 10
},
{
"name": "hvac_heating_ducts",
"value": true
},
{
"name": "hvac_cooling",
"value": true
},
{
"name": "hvac_ducts_leakage",
"value": 0.3
},
{
"name": "hvac_ducts_insulation",
"value": 1
},
{
"name": "hvac_ducts_location",
"value": "Living Space"
},
{
"name": "hvac_air_distribution_efficiency",
"value": 0.1
},
{
"name": "ground_thermal_conductivity",
"value": 0.5
},
{
"name": "infiltration_ach50",
"value": 1
},
{
"name": "window_panes",
"value": "Single"
},
{
"name": "window_metal_framing",
"value": true
},
{
"name": "window_low_e",
"value": true
},
{
"name": "window_storm",
"value": true
},
{
"name": "window_to_wall_ratio",
"value": 0.06
},
{
"name": "roof_material",
"value": "Asphalt Shingles, Medium"
},
{
"name": "roof_or_ceiling_insulation",
"value": 1
},
{
"name": "attic_type",
"value": "Finished Attic or Cathedral Ceilings"
},
{
"name": "wall_type",
"value": "Brick"
},
{
"name": "wall_insulation",
"value": 1
},
{
"name": "wall_exterior_finish",
"value": "None"
},
{
"name": "floor_or_slab_insulation",
"value": 1
},
{
"name": "foundation_type",
"value": "Slab"
},
{
"name": "foundation_wall_insulation",
"value": 1
},
{
"name": "rim_joist_insulation",
"value": 1
},
{
"name": "ev_charging",
"value": true
},
{
"name": "ev_charging",
"value": "immediate_fast"
},
{
"name": "ev_charging",
"value": 0.6
},
{
"name": "ev_miles",
"value": 100000
},
{
"name": "ev_efficiency",
"value": 0.2
},
{
"name": "pool",
"value": "None"
},
{
"name": "hot_tub",
"value": "None"
}
]
},
"production": {
"baseline": [
{
"name": "panel_arrays",
"value": [
{
"tilt": 20,
"azimuth": 180,
"capacity": 0
}
]
},
{
"name": "nominal_operating_cell_temp",
"value": 43
},
{
"name": "power_temp_coefficient",
"value": -0.0047
},
{
"name": "inverter_efficiency",
"value": 0.97
},
{
"name": "dc_to_ac_ratio",
"value": 1.5
},
{
"name": "soiling_loss",
"value": 0.02
},
{
"name": "shading_loss",
"value": 0.03
},
{
"name": "snow_loss",
"value": 0
},
{
"name": "mismatch_loss",
"value": 0.02
},
{
"name": "wiring_loss",
"value": 0.02
},
{
"name": "connections_loss",
"value": 0.005
},
{
"name": "light_induced_degradation_loss",
"value": 0.015
},
{
"name": "nameplate_rating_loss",
"value": 0.01
},
{
"name": "age_loss",
"value": 0
},
{
"name": "availability_loss",
"value": 0.03
}
],
"hypothetical": [
{
"name": "panel_arrays",
"value": [
{
"tilt": 20,
"azimuth": 180,
"capacity": 0
}
]
},
{
"name": "nominal_operating_cell_temp",
"value": 43
},
{
"name": "power_temp_coefficient",
"value": -0.0047
},
{
"name": "inverter_efficiency",
"value": 0.97
},
{
"name": "dc_to_ac_ratio",
"value": 1.5
},
{
"name": "soiling_loss",
"value": 0.02
},
{
"name": "shading_loss",
"value": 0.03
},
{
"name": "snow_loss",
"value": 0
},
{
"name": "mismatch_loss",
"value": 0.02
},
{
"name": "wiring_loss",
"value": 0.02
},
{
"name": "connections_loss",
"value": 0.005
},
{
"name": "light_induced_degradation_loss",
"value": 0.015
},
{
"name": "nameplate_rating_loss",
"value": 0.01
},
{
"name": "age_loss",
"value": 0
},
{
"name": "availability_loss",
"value": 0.03
}
]
},
"storage": {
"baseline": [
{
"name": "capacity",
"value": 0
},
{
"name": "power",
"value": 0
},
{
"name": "capacity",
"value": 1
},
{
"name": "dispatch_strategy",
"value": "peak_shaving"
},
{
"name": "cycle_penalty_per_kwh",
"value": 0
}
],
"hypothetical": [
{
"name": "capacity",
"value": 0
},
{
"name": "power",
"value": 0
},
{
"name": "capacity",
"value": 1
},
{
"name": "dispatch_strategy",
"value": "peak_shaving"
},
{
"name": "cycle_penalty_per_kwh",
"value": 0
}
]
},
"costs": {
"utility_rates": {
"electricity": {
"type": "flat_rate",
"value": 0,
"units": "$/kWh",
"meta": {
"type": "eia_utility_electric_flat_rate",
"eia_id": 0,
"rate_class": "residential",
"utility_name": "string",
"ownership": "string"
}
},
"fossil_fuel": {
"type": "flat_rate",
"value": 0,
"units": "$/kWh",
"meta": {
"type": "eia_utility_electric_flat_rate",
"eia_id": 0,
"rate_class": "residential",
"utility_name": "string",
"ownership": "string"
}
},
"pv_ppa": {
"type": "flat_rate",
"value": 0,
"units": "$/kWh",
"meta": {
"type": "eia_utility_electric_flat_rate",
"eia_id": 0,
"rate_class": "residential",
"utility_name": "string",
"ownership": "string"
}
},
"pv_buyback": {
"type": "flat_rate",
"value": 0,
"units": "$/kWh",
"meta": {
"type": "eia_utility_electric_flat_rate",
"eia_id": 0,
"rate_class": "residential",
"utility_name": "string",
"ownership": "string"
}
}
},
"emission_rates": {
"electricity": {
"value": 0,
"units": "kgCO2e/kWh",
"meta": {
"type": "egrid_electric_emission_rate",
"subregion_name": "string"
}
},
"fossil_fuel": {
"value": 0,
"units": "kgCO2e/kWh",
"meta": {
"type": "egrid_electric_emission_rate",
"subregion_name": "string"
}
}
},
"fossil_fuel_type": "natural_gas"
},
"intervals": [
{
"from_datetime": "2026-07-27T04:56:07.959Z",
"to_datetime": "2026-07-27T04:56:07.959Z",
"variable": "consumption",
"value": 0
}
]
}
}

| 422 | Validation Error
Media type
application/json
- Example Value
- Schema
json<br>{<br> "detail": [<br> {<br> "loc": [<br> "string",<br> 0<br> ],<br> "msg": "string",<br> "type": "string"<br> }<br> ]<br>}<br> | No links |