Skip to main content
POST
get HVAC estimated savings (monthly or annual)

Authorizations

x-ws-api-key
string
header
required

WattShift API key

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
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
integer[] | null

Optional calendar months to include, using 1-12 month numbers. Omit or pass null for all months.

Calendar month number, 1-12 where 1 = January and 12 = December.

Required range: 1 < x < 12

Response

200

Returns monthly or annual estimated savings based on type parameter