Skip to main content
POST
calculate monthly bill impact

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
usage
number[][]
required

Array of daily usage arrays. Each inner array must have 96 values (15-minute intervals). Number of days must match the number of days in the specified month.

Minimum array length: 1
month
integer
required

Month number (1-12, where 1 = January, 12 = December)

Required range: 1 < x < 12
export
number[][]

Optional array of daily export arrays (solar export to grid). Each inner array must have 96 values (15-minute intervals). Number of days must match usage array length.

year
integer

Year (4 digits). If not provided, defaults to current year.

Required range: 2000 < x < 2100
debug
boolean

Enable debug mode to return additional information

Response

billTotal
number
required

Total bill amount for the calculation.

month
integer
required
Required range: 1 < x < 12
year
integer
required
totalBill
number
gridServicesRev
number

Optional grid services revenue for the calculation.

exportCompensationCredit
number

Optional export compensation credit applied from resolved NEM/NBT export prices.

CO2e
number

Optional carbon dioxide equivalent emissions impact.

debugInfo
any