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
panels
number
required

Number of Panels

Required range: 1 <= x <= 10000
wattage
number
required

Panel Wattage (W)

Required range: 1 <= x <= 1000
sunHours
number
required

Peak Sun Hours per Day

Required range: 0.1 <= x <= 12
systemLoss
number
required

System Losses (%)

Required range: 0 <= x <= 50
rate
number
required

Electricity Rate ($/kWh)

Required range: x >= 0.001
dailyUsage
number

Daily Usage (kWh)

Required range: x >= 0

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.