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

Fuel Economy

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

Unit

Available options:
mpg_us,
mpg_uk,
l100km,
kml
currency
string

Currency Symbol

tripDistance
number

Distance

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

Distance Unit

Available options:
km,
miles
tripFuelEconomy
number

Fuel Economy

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

Economy Unit

Available options:
mpg_us,
mpg_uk,
l100km,
kml
tripFuelPrice
number

Fuel Price

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

Price Unit

Available options:
liter,
gallon_us,
gallon_uk
compareVehicle1
number

Vehicle 1 Economy

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

Vehicle 1 Unit

Available options:
mpg_us,
mpg_uk,
l100km,
kml
compareVehicle2
number

Vehicle 2 Economy

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

Vehicle 2 Unit

Available options:
mpg_us,
mpg_uk,
l100km,
kml
compareDistance
number

Distance

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

Distance Unit

Available options:
km,
miles
compareFuelPrice
number

Fuel Price (per Liter)

Required range: x >= 0
annualMileage
number

Annual Distance

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

Distance Unit

Available options:
km,
miles
annualFuelEconomy
number

Fuel Economy

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

Economy Unit

Available options:
mpg_us,
mpg_uk,
l100km,
kml
annualFuelPrice
number

Fuel Price

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

Price Unit

Available options:
liter,
gallon_us,
gallon_uk
annualFuelType
enum<string>

Fuel Type

Available options:
gasoline,
diesel

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.