Palmetto Bem API
The Bem API from Palmetto — 1 operation(s) for bem.
Palmetto Bem API is one of 4 APIs that Palmetto publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Bem. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, API documentation, and a getting-started guide.
This API exposes 1 operation across 1 path, and defines 254 schemas. It is described by OpenAPI 3.1.0, at version v0.32.2-19a9666.
Requests are made against a single base URL, https://ei.palmetto.com.
1 operations
1 paths
254 schemas
1 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Palmetto Bem API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as X-API-Key (APIKeyHeader).
Paths & Operations 1
Across 1 path, the API surfaces 1 operation — 1 POST. Each is listed below with its method, path, parameters, and response codes.
Bem 1
POST
/api/v0/bem/calculate
Calculate
Schemas 254
The contract defines 254 schemas that model the data the API accepts and returns. The most detailed are WideInterval (69 properties), Units (13 properties), Rate (12 properties), Tariff (10 properties). Each schema is shown below with its type and property counts.
FreezerExtraEfficiency
object
Extra Freezer Annual Energy Consumption [kWh]
2 properties
1 required
HeatingFuelTypeEnum
string
ConsumptionCalibration
object
Payload Schema for Consumption Calibration
6 properties
HVACAirDistributionEfficiency
object
HVAC Ducts Efficiency as a fraction of the total energy consumed due to poor supply and return duct design and/or improper air balancing Ignored when hvacheati…
2 properties
1 required
StorageElectricityStateOfCharge
number
COPEfficiencyCurve1
number
Temparature-based Parameter Curve
ConsumptionElectricityHotWater
number
Value1
number
ConsumptionFossilFuelHeating
number
ProductionAttributesList1
UsageLevelEnum
string
ConsumptionElectricityEv
number
HVACDuctsInsulation
object
R-Value of HVAC Ducts Insulation Ignored when hvacheatingducts and hvaccoolingducts are False
2 properties
1 required
ThermalDemandCoolingUnutilized
number
CapacityCurve1
number
Temparature-based Parameter Curve
UtilityRatesInput
object
Utility energy rates information
4 properties
Pool
object
Pool Type
2 properties
1 required
ClothesWasherHotWaterUsage
object
Clothers Washer Hot Water usage as a fraction of all loads using a hot water setting
2 properties
1 required
ThermalDemandHeatingUnmet
number
FoundationTypeEnum
string
BatteryDispatchStrategy
object
Dispatch Strategy
2 properties
1 required
ClothesDryerFuelEnum
string
Variable
string
WiringLoss
object
Resistive power losses in DC and AC wiring; combined multiplicatively with other DC losses.
2 properties
Setpoint1
number
HVAC Setpoint Temperature or 24-hr Schedule
Limit
number
Upper limit of this band (e.g. kWh for consumption, kW for demand)
WindowToWallRatio
object
Window to Wall Ratio
2 properties
1 required
GridElectricityExport
number
Vintage
object
Vintage Year
2 properties
1 required
CalculateResponse
object
Payload Schema for a Calculate Response
4 properties
2 required
StorageElectricityCharge
number
CeilingFan
object
Ceiling Fan Rated Annual Energy Consumption [kWh]
2 properties
1 required
Timezone
string
BatteryCyclePenaltyPerKwh
object
Penalty on battery throughput, incurred on both charge and discharge. The default (~0.001) is a sensible choice for most cases — small enough that the battery…
2 properties
1 required
ConsumptionFossilFuelCookingRange
number
SnowLoss
object
Power losses from snow covering the array; combined multiplicatively with other DC losses.
2 properties
Setpoint
HVAC Setpoint Temperature or 24-hr Schedule
EIAFuelType
string
Value
number
AtticTypeEnum
string
Coordinates
object
Geographical coordinates for a building's location. An approximation is sufficient.
2 properties
2 required
DcToAcRatio
object
PV array DC capacity divided by inverter AC rating; values 1 can increase yield but cause clipping at peaks.
2 properties
ChargePeriod
string
The period over which the charge is applied. Its effect depends on ratetype: fixed/pvcapacity: the frequency at which the charge is incurred. energy (imports,…
CookingRange
object
Cooking Range Type Reference: https://www.energystar.gov/products/electriccookingproducts/keyproductcriteria
2 properties
1 required
ThermalDemandCoolingUnmet
number
ClimateZoneEnum
string
ActualProduction
array
List of actual production intervals
Orientation
object
Orientation of the front of the dwelling unit as it faces the street
2 properties
1 required
ConsumptionFossilFuelPool
number
ThermalDemandHeating
number
BatteryCapacity
object
Battery Capacity [AC kWh]
2 properties
1 required
HorizontalLocation
object
Horizontal Location in a Single-Family Attached or Multi-Family building
2 properties
1 required
CalculateRequest
object
Payload Schema for a Calculate Request with optional address input
6 properties
2 required
BatteryCapacityRecommendationQuantile
object
Battery Capacity Recommendation Quantile Used for automatic sizing. A value of 0.5 will recommend a capacity that meets the 50th percentile of daily load.
2 properties
NameplateRatingLoss
object
Field measurements of the electrical characteristics of photovoltaic modules in the array may show that they differ from their nameplate rating; combined multi…
2 properties
HVACHeatingSetpoint
object
HVAC Heating Setpoint [°C]
2 properties
1 required
FloorAreaSourceModel
string
ClothesWasherEfficiency
object
Clothes Washer Efficiency
2 properties
1 required
IntervalFrequency
string
Timestep frequency for interval data. PERIOD collapses the entire requested window into a single bucket — useful when you want a single total over a span that…
Capacity
object
HVAC Capacity [kBtu/hr] at a specific outdoor dry bulb temperature [°C]
2 properties
2 required
ClothesDryerFuel
object
Clothes Dryer Fuel
2 properties
1 required
EnsembleAggregationMethod
string
Method for aggregating a building ensemble. - 'nearest' elects a single building from the ensemble. When actuals are provided, it selects the building with the…
EIAUtilityElectricRateMeta
object
Average electricity rate for a specific utility. Electricity rates are sourced from EIA source: https://www.eia.gov/electricity/data/eia861/
5 properties
2 required
ConsumptionElectricityClothesWasher
number
WallExteriorFinishEnum
string
WallTypeEnum
string
ProductionScenarios
object
Payload Schema for Production Scenarios - 'baseline' specifies any known and existing production attributes that are used for calibration. - 'hypothetical' spe…
2 properties
HotTubEnum
string
HVACHeatingEfficiency
object
HVAC Heating Efficiency as COP (Coefficient of Performance) COP = Energy Delivered / Energy Consumed
2 properties
1 required
RoofMaterialEnum
string
WaterHeaterOutletTemperature
object
Water Heater Temperature [°C]
2 properties
1 required
ConsumptionFossilFuelHotTub
number
FossilFuelEmissionRateMeta
object
3 properties
2 required
HVACCooling
object
HVAC Cooling is used
2 properties
1 required
WaterFixturesUsage
object
Water fixtures usage as a fraction of the national average
2 properties
1 required
UtilityFlatRateInput
object
3 properties
1 required
EmissionsElectricity
number
NumStories
object
Number of stories
2 properties
1 required
TariffMeta
object
2 properties
1 required
WaterHeaterEnum
string
ConsumptionElectricityClothesDryer
number
PanelArray
object
Panel Array Configuration
3 properties
1 required
BuildingTypeSource
string
Costs
object
3 properties
2 required
EGRIDEmissionRateMeta
object
Energy emission intensity information source: https://www.epa.gov/egrid
2 properties
1 required
HVACCoolingDucts
object
HVAC Ducts are used for Cooling
2 properties
1 required
PoolEnum
string
StorageAttributesList
array
Payload Schema for Storage Attributes
WindowPanesEnum
string
Consumption1
number
StorageScenarios
object
Payload Schema for Storage Scenarios - 'baseline' specifies any known and existing storage attributes that are used for calibration. - 'hypothetical' specifies…
2 properties
ConsumptionScenarios
object
Payload Schema for Consumption Scenarios - 'baseline' specifies any known and existing building attributes that are used for calibration. - 'hypothetical' spec…
2 properties
BuildingLocation
object
10 properties
9 required
NetMeteringPolicyType
string
General policy descriptor. Reference individual rate types for more specific application details.
LongInterval
object
4 properties
4 required
Consumption
object
Payload Schema for consumption data
3 properties
EmissionRatesInput
object
Energy emission intensity information
2 properties
HVACCoolingPartialSpaceConditioning
object
HVAC Cooling Partial Space Conditioning as a fraction of the total floor area Ignored when hvaccooling is False
2 properties
1 required
RefrigeratorExtraEfficiency
object
Extra Refrigerator Rated Annual Energy Consumption [kWh] - EnergyStar: 400 kWh/year Reference: https://www.energystar.gov/products/refrigerators/keyproductcrit…
2 properties
1 required
HTTPValidationError
object
1 property
HVACSecondaryHeatingCapacity
object
HVAC Secondary Heating Capacity [kBtu/hr] Ignored when hvacheatpump is False
2 properties
1 required
GridFossilFuelImport
number
WaterHeater
object
Water Heater Efficiency
2 properties
1 required
ConsumptionFossilFuel
number
Storage
object
Payload Schema for a Storage data
1 property
ProductionAttributesList
array
Payload Schema for Production Attributes
ClothesWasherEfficiencyEnum
string
HVACHeatPump
object
HVAC Heat Pump is used Only active when hvacheatingefficiency exceeds hvacsecondaryheatingefficiency
2 properties
1 required
PowerTempCoefficient
object
Multiplicative rate of change coefficient (1/°C) at which a PV module loses efficiency for each degree above 25 °C (typically negative).
2 properties
AtticType
object
Attic Type
2 properties
1 required
StorageAttributesList1
NumOccupants
object
Number of building occupants
2 properties
1 required
InverterEfficiency
object
Ratio of AC output to DC input under nominal conditions; unitless fraction indicating conversion efficiency (<1).
2 properties
RimJoistInsulation
object
R-Value of Rim Joist Insulation Ignored when Foundation Type is Ambient or Slab Set to 1 for Uninsulated
2 properties
1 required
PlugLoads
object
Plug Loads usage as a fraction of the national average
2 properties
1 required
ConsumptionElectricityHeating
number
ConsumptionFossilFuelClothesDryer
number
ConsumptionElectricityCooling
number
ConsumptionAttributesList
array
UtilityRateClass
string
Utility rate class for energy consumption
ThermalDemandHeatingDelivered
number
FoundationWallInsulation
object
R-Value of Foundation Wall Insulation Ignored when Foundation Type is Ambient or Slab Set to 1 for Uninsulated
2 properties
1 required
GridElectricityImport
number
FoundationType
object
Foundation Type
2 properties
1 required
HVACCoolingSetpoint
object
HVAC Cooling Setpoint [°C]
2 properties
1 required
ProductionElectricity
number
ProductionElectricityUtilized
number
HVACCoolingEfficiency
object
HVAC Cooling Efficiency as COP (Coefficient of Performance) COP = Energy Delivered / Energy Consumed Ignored when hvaccooling is False
2 properties
1 required
SoilingLoss
object
Power losses from dirt or debris blocking sunlight; location- and weather-dependent; combined multiplicatively with other DC losses.
2 properties
EVChargingEfficiency
object
EV Charger Efficiency as a fraction of the total energy consumed Ignored when evcharging is False
2 properties
1 required
RoofMaterial
object
Roof Material
2 properties
1 required
CalculateRequestParameters
object
Parameters for a Calculate Response
7 properties
3 required
GroundThermalConductivity
object
Ground Thermal Conductivity [Btu/hr-ft-F]
2 properties
1 required
ValidationError
object
3 properties
3 required
Setpoint2
array
HVAC Setpoint Temperature or 24-hr Schedule
LightInducedDegradationLoss
object
Effect of the reduction in the array's power during operation caused by light-induced degradation of photovoltaic cells; combined multiplicatively with other D…
2 properties
BuildingTypeEnum
string
Address
object
Location specified by address, which will be geocoded to coordinates
1 property
1 required
EVChargingStrategy
object
EV Charging Strategy (at home) - 'immediatefast': Immediate as fast as possible upon arrival - 'immediateslow': Immediate as slow as possible upon arrival (eve…
2 properties
1 required
Meta
object
Meta data for a Calculate Response
4 properties
3 required
MismatchLoss
object
Power losses from electrical differences between PV modules; combined multiplicatively with other DC losses.
2 properties
EmissionRate
object
3 properties
1 required
ThermalDemandCoolingLatent
number
VariableModel
string
Variables available for interval data. Note: costs.electricity. component variables are experimental and subject to change. costs.electricity.minimumadjustment…
DispatchStrategy
string
Dispatch Strategy for battery. - RETAILRATEDISPATCH — minimize net electricity cost (pure arbitrage). - SELFCONSUMPTION — minimize grid import: store surplus P…
HorizontalLocationEnum
string
Units
object
13 properties
ActualConsumptionInterval
object
Interval for actual known consumption data
4 properties
4 required
ThermalDemandCooling
number
FossilFuelType
string
Fossil fuel types for energy consumption
ConsumptionAttributesList1
ConnectionsLoss
object
Resistive losses in electrical connectors in the system; combined multiplicatively with other DC losses.
2 properties
Units1
string
Carryover ledger units for excess generation.
EmissionRateInput
object
2 properties
1 required
AgeLoss
object
Effect of weathering of the photovoltaic modules on the array's performance over time; combined multiplicatively with other DC losses.
2 properties
Tariff
object
10 properties
1 required
CapacityCurve
Temparature-based Parameter Curve
ProductionElectricityCurtailed
number
ConsumptionFossilFuelHotWater
number
CookingRangeEnum
string
IntervalFormat
string
Shape format for intervals data. - 'long' format will return multiple intervals for each time step (based on number of variables) e.g. [{variable: , value: , .…
VintageSource
string
DataSourcesMeta
object
8 properties
VerticalLocationEnum
string
HVACSecondaryHeatingFuel
object
HVAC Secondary Heating Fuel Type Ignored when hvacheatpump is False
2 properties
1 required
UtilityFlatRate
object
4 properties
1 required
ClothesDryerEfficiencyEnum
string
HVACHeatingFuel
object
HVAC Heating Fuel Type
2 properties
1 required
Garage
object
Garage Present
2 properties
1 required
ConsumptionElectricityCeilingFan
number
HVACDuctsLocation
object
HVAC Ducts Location Ignored when hvacheatingducts and hvaccoolingducts are False
2 properties
1 required
HVACDuctsLeakage
object
HVAC Ducts Leakage as a fraction of the total air flow Ignored when hvacheatingducts and hvaccoolingducts are False
2 properties
1 required
EVMiles
object
EV Miles Driven per year Ignored when evcharging is False
2 properties
1 required
COPEfficiencyCurve2
array
Temparature-based Parameter Curve
COPEfficiencyCurve
Temparature-based Parameter Curve
Setpoint2Item
number
WideInterval
object
69 properties
2 required
PanelArrays
object
Panel Arrays Configuration
2 properties
1 required
ConsumptionElectricityHotTub
number
NumBedrooms
object
Number of bedrooms
2 properties
1 required
Band
object
different tiers or levels based on the quantity of electricity consumed
4 properties
1 required
WindowLowE
object
Windows are Low-E
2 properties
1 required
InfiltrationACH50
object
Infiltration ACH50
2 properties
1 required
NumStoriesSource
string
WindowStorm
object
Windows have additional Exterior Storm Windows
2 properties
1 required
ConsumptionElectricityDishwasher
number
Lighting
object
Lighting Type
2 properties
1 required
ConsumptionElectricityLighting
number
ConsumptionElectricityPool
number
HVACSecondaryHeatingEfficiency
object
HVAC Secondary Heating Efficiency as COP (Coefficient of Performance) COP = Energy Delivered / Energy Consumed Secondary heating is used when a heat pump is no…
2 properties
1 required
ActualProductionInterval
object
Interval for actual known production data
4 properties
4 required
WallExteriorFinish
object
Wall Exterior Finish
2 properties
1 required
EmissionRates
object
2 properties
2 required
RoofOrCeilingInsulation
object
R-Value of Roof or Ceiling Insulation Set to 1 for Uninsulated
2 properties
1 required
FloorArea
object
Total floor area in square meters
2 properties
1 required
StorageElectricityDischarge
number
ClothesDryerEfficiency
object
Clothes Dryer Efficiency
2 properties
1 required
RefrigeratorEfficiency
object
Refrigerator Rated Annual Energy Consumption [kWh] - EnergyStar: 400 kWh/year Reference: https://www.energystar.gov/products/refrigerators/keyproductcriteria
2 properties
1 required
AvailabilityLoss
object
Reduction in the system's output cause by scheduled and unscheduled system shutdown for maintenance, grid outages, and other operational factors; combined mult…
2 properties
RateType
string
Identifies the type of bill line item a rate produces. Each category determines what quantity (if any) the rate's amount is applied to and where it fits in the…
UtilityRates
object
Utility energy rates information
4 properties
1 required
CalibrationMethod
string
Method for calibrating energy consumption. After the building ensemble is selected and the initial loads are estimated, the calibration process will scale the…
Period
object
a range of days within a week and times within a day (exclusive of end hour:minute). When starthour == endhour, the period covers all 24 hours of the specified…
7 properties
4 required
COPEfficiency
object
Coefficient of Performance at a specific outdoor dry bulb temperature [°C] COP = Energy Delivered / Energy Consumed Commonly rated at: Heating: 5°F (-15°C) and…
2 properties
2 required
EVChargingStrategyEnum
string
OrientationEnum
string
ActualConsumption
array
List of actual consumption intervals
ConsumptionElectricityPlugLoads
number
TrueUpMonth
integer
Month (1-12) in which any remaining excess generation credits are forfeited or cashed out. If null, credits carry over indefinitely until fully used.
BatteryPower
object
Battery Power [AC kW]
2 properties
1 required
HVACHeatingDucts
object
HVAC Ducts are used for Heating
2 properties
1 required
FloorAreaSource
string
NeighborsDistance
object
Distance to neighboring buildings [m] If there are no immediate neighbors in any direction, set to the max 30.0 meters.
2 properties
1 required
Rate
object
12 properties
4 required
Emissions
number
HeatingFuelSource
string
EVEfficiency
object
EV Efficiency as kWh per mile Ignored when evcharging is False
2 properties
1 required
FloorOrSlabInsulation
object
R-Value of Floor or Slab Insulation Set to 1 for Uninsulated
2 properties
1 required
Production
object
Payload Schema for a Production data
3 properties
ConsumptionElectricityDuctFan
number
ConsumptionElectricity
number
ShadingLoss
object
Power losses from shadows cast by nearby objects or self-shading; combined multiplicatively with other DC losses.
2 properties
DishwasherEfficiency
object
Dishwasher Rated Annual Energy Consumption [kWh] - Inefficient: 318 kWh/year - Standard: 290 kWh/year - EnergyStar: 240 kWh/year - EnergyStar Compact: 155 kWh/…
2 properties
1 required
ProductionCalibration
object
Payload Schema for Consumption Calibration
2 properties
HVACHeatingCapacity
object
HVAC Heating Capacity [kBtu/hr] at a specific outdoor dry bulb temperature [°C]
2 properties
1 required
ThermalDemandHeatingUnutilized
number
CostsInput
object
Payload Schema for Monetary and Emission Costs
4 properties
NetMeteringOptions
object
Tariff-wide net metering policy.
5 properties
2 required
EmissionsFossilFuel
number
ThermalDemandCoolingDelivered
number
HVACDuctsLocationEnum
string
VerticalLocation
object
Vertical Location in a Multi-Family building
2 properties
1 required
Citation
object
Source reference for extracted data.
4 properties
2 required
NominalOperatingCellTemp
object
Reference temperature (°C) of a solar cell under standard conditions; higher (lower) NOCT means hotter (colder) operation and lower (higher) power output.
2 properties
EVCharging
object
EV Charging is used
2 properties
1 required
ThermalDemandCoolingSensible
number
WindowPanes
object
Number of Window Panes
2 properties
1 required
CapacityCurve2
array
Temparature-based Parameter Curve
WindowMetalFraming
object
Windows have Metal Framing
2 properties
1 required
Data
object
Meta data for a Calculate Response
6 properties
6 required
HVACCoolingCapacity
object
HVAC Cooling Capacity [kBtu/hr] at a specific outdoor dry bulb temperature [°C] Ignored when hvaccooling is False
2 properties
1 required
BuildingType
object
Building Type
2 properties
1 required
HotTub
object
Hot Tub Type
2 properties
1 required
VintageEnum
string
Periods
array
LightingEnum
string
WallType
object
Wall Construction Type
2 properties
1 required
EIAResidentialStateRateMeta
object
Average fuel rate for a state, sourced from EIA
4 properties
3 required
WallInsulation
object
R-Value of Wall Insulation Set to 1 for Uninsulated
2 properties
1 required
Season
object
a range of months and days within a year (inclusive of start and end days)
5 properties
4 required
ClipBy
string
ClipBy allows control over how the data is clipped to the specified time range. For example, a request for monthly data (Interval='month') from April 15, 2012…
UsageLevel
object
Usage Level of major appliances and plug loads relative to the national average
2 properties
1 required
ConsumptionElectricityCookingRange
number
ConsumptionElectricityRefrigerator
number
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Palmetto 3
Other APIs Palmetto publishes across the network.
Palmetto Energy Platform API
Palmetto Finance (LightReach) API
Palmetto Health API
#Bem
Where this information came from
This is an independent, third-party profile of Palmetto Bem API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.