Skip to main content
POST
/
v1
/
homes
/
{id}
/
battery
/
estimate_savings
get battery estimated savings
curl --request POST \
  --url https://api.example.com/v1/homes/{id}/battery/estimate_savings \
  --header 'Content-Type: application/json' \
  --header 'x-ws-api-key: <api-key>' \
  --data '
{
  "days": 123,
  "solarCapacity": 123,
  "maxCapacityKiloWattHours": 123,
  "chargingPowerKiloWatts": 123,
  "dischargingPowerKiloWatts": 123,
  "chargingEfficiency": 123,
  "dischargingEfficiency": 123,
  "currentSOC": 123,
  "minPreferredSOC": 123,
  "maxPreferredSOC": 123,
  "months": [
    123
  ],
  "dispatchHoursPerDay": [
    [
      {
        "hour": 123,
        "price": 123
      }
    ]
  ],
  "numBiddingHours": 123,
  "leap": "CAISO"
}
'

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
days
number
required
solarCapacity
number | null
required
maxCapacityKiloWattHours
number
required
chargingPowerKiloWatts
number
required
dischargingPowerKiloWatts
number
required
chargingEfficiency
number
required
dischargingEfficiency
number
required
currentSOC
number
required
minPreferredSOC
number
required
maxPreferredSOC
number
required
months
number[] | null
required
dispatchHoursPerDay
object[][] | null
numBiddingHours
number | null
leap
enum<string> | null
Available options:
CAISO,
NYISO

Response

201 - undefined