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

Short-haul flights (km/yr, passenger-km)

Required range: x >= 0
longFlightKm
number

Long-haul flights (km/yr, passenger-km)

Required range: x >= 0
carDistance
number

Car travel (per year)

Required range: x >= 0
distanceUnit
enum<string>

Distance unit

Available options:
km,
mi
carType
enum<string>

Car type

Available options:
gasoline,
diesel,
hybrid,
phev,
ev,
none
electricityKwh
number

Electricity (kWh/yr)

Required range: x >= 0
naturalGasTherms
number

Natural gas (therms/yr)

Required range: x >= 0
gridRegion
enum<string>

Grid region

Available options:
us,
ca,
uk,
de,
fr,
au,
cn,
in,
world
diet
enum<string>

Diet

Available options:
heavy,
average,
low,
vegetarian,
vegan
goodsSpending
number

Goods & services ($/yr)

Required range: x >= 0
compareCountry
enum<string>

Compare to

Available options:
us,
ca,
au,
de,
uk,
fr,
cn,
in,
world,
paris

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.