Palmetto Energy Intelligence API (v0.32.2-19a9666)

Download OpenAPI specification: Download

operation/health_api_v0_health_get Health

Check the health of the service

Responses

200

Successful Response

get/api/v0/health

https://ei.palmetto.com/api/v0/health

Response samples

• 200

Content type

application/json

Copy

null

operation/calculate_api_v0_bem_calculate_post Calculate

Calculate energy consumption, production, costs and emissions

Authorizations:

APIKeyHeader

Request Body schema: application/json required

Responses

200

Successful Response

422

Validation Error

post/api/v0/bem/calculate

https://ei.palmetto.com/api/v0/bem/calculate

Request samples

• Payload

Content type

application/json

Copy Expand all Collapse all

`{"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"\n ]

},

"consumption": {"actuals": [{"from_datetime": "2023-01-01T00:00:00",\n "to_datetime": "2024-01-01T00:00:00",\n "value": 3774,\n "variable": "consumption.electricity"\n }\n ],

"attributes": {"baseline": [{"name": "building_type",\n "value": "Single-Family Detached"\n }\n ],

"hypothetical": [{"name": "building_type",\n "value": "Single-Family Detached"\n }\n ]

},

"calibration": {"apply_residuals": true,

"method": "uniform-mean",

"sample_size": 35

}

},

"production": {"actuals": [{"from_datetime": "2023-01-01T00:00:00",\n "to_datetime": "2024-01-01T00:00:00",\n "value": 7.3,\n "variable": "production.electricity"\n }\n ],

"attributes": {"baseline": [{"name": "panel_arrays",\n "value": [{"azimuth": 180,\n "capacity": 10,\n "tilt": 30\n }\n ]\n }\n ],

"hypothetical": [ ]

},

"calibration": {"method": "uniform-mean"

}

},

"storage": {"attributes": {"baseline": [{"name": "capacity",\n "value": 10\n },\n {"name": "power",\n "value": 5\n },\n {"name": "capacity_recommendation_quantile",\n "value": 0.5\n }\n ],

"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

}

}

}

}`

Response samples

• 200
• 422

Content type

application/json

Copy Expand all Collapse all

`{"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": "hour",

"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"\n ],

"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": "b487ddcb-f6b0-4afd-9295-f02be394f94a"

}

},

"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",\n "value": "Single-Family Detached"\n }\n ],

"hypothetical": [{"name": "building_type",\n "value": "Single-Family Detached"\n }\n ]

},

"production": {"baseline": [{"name": "panel_arrays",\n "value": [{"tilt": 20,\n "azimuth": 180,\n "capacity": 0\n }\n ]\n }\n ],

"hypothetical": [{"name": "panel_arrays",\n "value": [{"tilt": 20,\n "azimuth": 180,\n "capacity": 0\n }\n ]\n }\n ]

},

"storage": {"baseline": [{"name": "capacity",\n "value": 0\n }\n ],

"hypothetical": [{"name": "capacity",\n "value": 0\n }\n ]

},

"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": "2019-08-24T14:15:22Z",\n "to_datetime": "2019-08-24T14:15:22Z",\n "variable": "consumption",\n "value": 0\n }\n ]

}

}`