energy

Home energy profile for a ZIP

Return the provenance-stamped home energy profile for a 5-digit US ZIP: serving utility, climate, rebate potential, and confidence. Requires X-WattGap-Key. The diagnostic answer does not change by key or payer.

get/api/v1/energy/profile

Request

  • Base URL: https://wattgap.com
  • URL: https://wattgap.com/api/v1/energy/profile
  • Auth: API key in header X-WattGap-Key

Query parameters

zipstring required

Response

Home energy profile. OpenAPI expresses structural and scalar bounds; runtime-only invariants additionally require confidence_tier to equal provenance.confidence, data_sources to have exact ordered equality with provenance.source, each rebate total to equal the nearest-cent additive total of program amounts (ungrouped rows add; mutually exclusive groups contribute their maximum, not the sum), data.zip to equal meta.zip whenever the endpoint data includes a ZIP, and each energy response's serialized data and meta sections to stay within 524272 encoded bytes apiece.

Changes

No recorded changes to this operation across all 1 revision of this API.