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
oldWatts
number

Old Bulb Wattage (W)

Required range: x >= 0.1
newWatts
number

New Bulb Wattage (W)

Required range: x >= 0.1
oldBulbCost
number

Old Bulb Price ($)

Required range: x >= 0
newBulbCost
number

New Bulb Price ($)

Required range: x >= 0
oldLifespanHours
number

Old Bulb Lifespan (hours)

Required range: x >= 1
newLifespanHours
number

New Bulb Lifespan (hours)

Required range: x >= 1
hoursPerDay
number

Hours Used Per Day

Required range: 0.01 <= x <= 24
numberOfBulbs
number

Number of Bulbs

Required range: 1 <= x <= 100
electricityRate
number

Electricity Rate ($/kWh)

Required range: x >= 0.001
years
number

Analysis Period (years)

Required range: 1 <= x <= 50
co2PerKwh
number

Grid CO2 Factor (lbs/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.