Skip to main content
POST
Carbon Footprint Estimator

Authorizations

Authorization
string
header
required

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

Body

application/json
ioShortFlightKm
number

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

Required range: x >= 0
ioLongFlightKm
number

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

Required range: x >= 0
ioCarDistance
number

Car travel (per year)

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

Distance unit

Available options:
km,
mi
ioCarType
enum<string>

Car type

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

Electricity (kWh/yr)

Required range: x >= 0
ioNaturalGasTherms
number

Natural gas (therms/yr)

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

Grid region

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

Diet

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

Goods & services ($/yr)

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

Compare to

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

Response

Tool output

tool
string
required
tool_version
string
required

Output-contract version for this tool. Currently "1" for all tools.

outputs
object
required
credits_used
integer
required

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

request_id
string
credits_remaining
integer | null

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