Skip to main content
POST
get battery estimated savings

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
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
dispatchHoursPerDay
object[][] | null
numBiddingHours
number | null
leap
enum<string> | null
Available options:
CAISO,
NYISO
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

Validation failure

request_id
string
required
Example:

"req_123"

error_code
enum<string>
required
Available options:
AUTH_MISSING_API_KEY,
AUTH_INVALID_API_KEY,
AUTH_EXPIRED_CREDENTIAL,
AUTH_REVOKED_CREDENTIAL,
AUTH_INSUFFICIENT_SCOPE,
VALIDATION_FAILED,
RATE_LIMITED,
NOT_FOUND,
FORBIDDEN,
PRODUCTION_ACCESS_DENIED,
INTERNAL_ERROR
Example:

"VALIDATION_FAILED"

message
string
required
Example:

"Request validation failed."

recovery_action
string
Example:

"Provide the x-ws-api-key header. If this contradicts the public docs, submit feedback through /v1/feedback."

field_errors
object[]
retry_after_seconds
number
Example:

3600