Skip to main content
POST
/
v1
/
homes
/
{id}
/
hvac
/
estimate_savings
get HVAC estimated savings (monthly or annual)
curl --request POST \
  --url https://api.example.com/v1/homes/{id}/hvac/estimate_savings \
  --header 'Content-Type: application/json' \
  --header 'x-ws-api-key: <api-key>' \
  --data '
{
  "type": "monthly",
  "percentageSaved": 123,
  "dollarsSaved": 123,
  "optimizedCost": 123,
  "baselineCost": 123,
  "temperatureData": [
    123
  ],
  "hvacConsumption": [
    123
  ],
  "baselineTemperatureData": [
    123
  ],
  "baselineHvacConsumption": [
    123
  ],
  "length": 123,
  "setPointList": [
    123
  ],
  "targetTemp": "<unknown>",
  "targetCoolSetpoint": null,
  "targetHeatSetpoint": null,
  "minTemp": "<unknown>",
  "maxTemp": "<unknown>",
  "heatTransferCoefficient": 1,
  "irradianceCoefficient": 0.5,
  "coolingRate": 1,
  "heatingRate": 1,
  "chunkSize": 96,
  "start": {
    "month": 123,
    "startTime": "<unknown>"
  },
  "days": 123,
  "timeout": 5,
  "startTime": "<string>",
  "outdoorTemp": [
    "<unknown>"
  ],
  "mode": "OFF",
  "dispatchHoursPerDay": [
    [
      {
        "price": 123,
        "hour": 123
      }
    ]
  ],
  "leap": true,
  "numBiddingHours": 123,
  "months": [
    123
  ]
}
'

Documentation Index

Fetch the complete documentation index at: https://docs.wattshift.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

x-ws-api-key
string
header
required

Headers

x-ws-api-key
string

WattShift API Key

Path Parameters

id
string
required

Body

application/json
type
enum<string>
required
Available options:
monthly,
annual
percentageSaved
number
required
dollarsSaved
number
required
optimizedCost
number
required
baselineCost
number
required
temperatureData
number[]
required
hvacConsumption
number[]
required
baselineTemperatureData
number[]
required
baselineHvacConsumption
number[]
required
length
number
required
setPointList
number[]
required
rateData
object
targetTemp
any
targetCoolSetpoint
unknown
targetHeatSetpoint
unknown
minTemp
any
maxTemp
any
heatTransferCoefficient
number
default:1
irradianceCoefficient
number
default:0.5
coolingRate
number
default:1
heatingRate
number
default:1
chunkSize
number
default:96
start
object
days
number
timeout
number
default:5
startTime
string
outdoorTemp
any[] | null
mode
enum<string>
Available options:
OFF,
HEAT,
COOL,
AUTO
dispatchHoursPerDay
object[][] | null
leap
boolean | null
numBiddingHours
number | null
months
number[] | null

Response

200

Returns monthly or annual estimated savings based on type parameter