Skip to main content
POST

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
dailyUsage
number

Average daily energy usage (kWh/day)

Required range: 0.1 <= x <= 100000
peakSunHours
number

Peak sun hours (h/day)

Required range: 0.5 <= x <= 12
panelWattage
number

Solar panel wattage (W)

Required range: 50 <= x <= 700
systemEfficiency
number

System derate factor (%)

Required range: 50 <= x <= 95
dcAcRatio
number

DC:AC (inverter loading) ratio

Required range: 1 <= x <= 1.5
mode
enum<string>

System type

Available options:
grid-tied,
off-grid
autonomyDays
number

Days of autonomy (battery reserve)

Required range: 0.5 <= x <= 14
depthOfDischarge
number

Battery depth of discharge (%)

Required range: 10 <= x <= 100
batteryVoltage
enum<string>

Battery bank voltage

Available options:
12,
24,
48

Response

Tool output

outputs
object
required
tool
string
required

The tool's slug, echoing the {slug} in the request path.

tool_version
string
required

Output-contract version for this tool.

credits_used
integer
required

Credits this call consumed, after any settlement refund. 0 when metering is disabled.

credits_remaining
integer | null
required

Credits left in the current monthly allowance, or null when metering is disabled.

request_id
string

Correlation id, also sent as x-request-id.