# Compare Carbon Usage

This endpoint allows you to compare carbon quantities to more
recognizable items such as cars, light bulbs, or kettles.

Our list of metrics and comparison units are quite extensive so a list of
accepted combinations has been compiled and is available here


Endpoint: POST /v2/carbon-comparison
Security: Bearer-Auth

## Request fields (application/json):

  - `carbon_quantity` (integer, required)

  - `carbon_unit` (string, required)
    SQUAKE uses The International System of Units (SI), commonly referred to as "metric system".
    Enum: "tonne", "kilogram", "gram"

  - `items` (array, required)
    You can define one or more metrics you want to compare your carbon quantity to.

  - `items.metric` (string, required)

  - `items.comparison_unit` (string)
    If you don't send a comparison unit then SQUAKE will find the best match for the amount of CO2 you send in the

## Response 200 fields (application/json):

  - `carbon_quantity` (integer, required)

  - `carbon_unit` (string, required)
    SQUAKE uses The International System of Units (SI), commonly referred to as "metric system".
    Enum: "tonne", "kilogram", "gram"

  - `items` (array, required)

  - `items.comparison_unit` (string, required)
    The unit used as the comparison, if you passed one in then it will be here. If you didn't send one then this will be the one SQUAKE selected

  - `items.metric` (string, required)

  - `items.amount` (number, required)
    The amount based on the metric, for example if  was  and  was  then that would be half a year

## Response 400 fields (application/json):

  - `errors` (array)

  - `errors.code` (string, required)
    An application-specific error code, expressed as a string value.
    Enum: "field_validation_error", "server_error", "not_authorized", "not_found", "invalid_methodology", "invalid_type"

  - `errors.detail` (string)
    A human-readable explanation specific to this occurrence of the problem. Like title, this field's value can be localized.

  - `errors.source` (object)
    An object containing references to the primary source of the error

  - `errors.source.id` (string)

  - `errors.source.attribute` (string, required)

  - `errors.source.model` (string)