Parameters

Parameters are values passed into the API in order to produce emissions estimations. Click below to find out more about parameters for each unit type.

Unit Types Unit types describe the categories of units available to be queried by the API for an emission factor. Each emission factor accepts a particular unit type, such as money or volume; any unit described for the unit type is acceptable, as the API will handle conversions.

Available Unit Types

Note: "Unit Types Endpoint" Earthemission provides a Unit Types endpoint to help you get all available unit types and their supported units. Learn how to use it here.

Area Calculate emissions produced by an area, such as spraying fields, expressed in hectares (ha), square kilometers (km2), square meters (m2) or square foot (ft2).

Attribute	Required	Default	Description
area	required		Area size in the defined unit.
area_unit	optional	km2	Unit of area. One of m2, km2, ft2, ha. Default is km2.

{
    //...
    "parameters": {
        "area": 30,
        "area_unit": "ha"
    }
    //...
}

AreaOverTime Calculate emissions produced by area over time

Attribute	Required	Default	Description
area	required		Area size in the defined unit.
area_unit	optional	km2	Unit of area. One of m2, km2, ft2, ha. Default is km2.
time	required		Time amount.
time_unit	optional	h	Unit of time. One of ms, s, m, h, day, year. Default is h.

{
    //...
    "parameters": {
        "area": 30,
        "area_unit": "ha",
        "time": 365,
        "time_unit": "day"
    }
    //...
}

EXPAND MORE