TABLE OF CONTENTS:

CURRENT VERSION: v1.1

This is the documentation page for the trip to carbon API. Version 1 of the trip to carbon API is made up of one endpoint.

/footprint - GET

This endpoint calculates the carbon footprint based on available fuel usage or distance travelled information.

Query parameters:

activity (required) - This parameter can contain the fuel consumption of the vehicle in US gallons OR the distance travelled in miles. What this parameter represents depends on the information you have available.

It is recommended to make this parameter the fuel consumption in gallons if you have access to this information and want to be more specific. Note that this number is not allowed to be 0(or else an error is returned).

activityType (required) - This refers to the type of activity value chosen above. Below are the valid values for this parameter.

fuelType (optional) - Please set this If your activity and activityType represents fuel consumption in gallons. This represents the type of fuel the vehicle is using.