Skip to main content
POST
/
quotes
/
ground-transport
Get Quote for Ground Transport Emissions
curl --request POST \
  --url https://api.cnaught.com/v1/quotes/ground-transport \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "distance_km": 500.5,
  "vehicle_type": "school_bus"
}
'
{
  "amount_kg": 15,
  "price_usd_cents": 2350
}

Authorizations

​
Authorization
string
header
required

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

Headers

​
X-Subaccount-Id
string

If present, will use pricing appropriate for the subaccount with given id.

Body

application/json

Quote Parameters

​
distance_km
number
required

Distance of ground transportation, in km

Example:

100

​
vehicle_type
string
required

The type of vehicle used. Must be one of passenger_car_van_or_suv, small_bus, school_bus, or coach_bus.

Example:

"passenger_car_van_or_suv"

​
portfolio_id
string | null

Optional ID of the portfolio to use for the quote. The quote will be for an order fulfilled from this portfolio. If not specified, the account's default portfolio will be used.

Example:

"a23bF6"

​
source
string | null

Optional source of the quote. Defaults to api if not specified, otherwise must be one of api or checkout. Use api if the eventual order will be placed via the Order API. Use checkout if the order will be placed using the Checkout Session API.

Examples:

"api"

"checkout"

Response

Quote Details

​
amount_kg
number

Amount of carbon credits the quote is for, in kilograms

Example:

10.5

​
price_usd_cents
number

Price charged for the credits, in USD cents

Example:

2350