API Reference
Parameters

Parameters

The Parameters model represent parameters passed into a given emission factors. Parameters can represent e.g. money spent, kilometers traveled, energy consumed, or fuel burned. Parameters are used together with an emission factor to produce emissions estimations.

Parameters can take multiple different unit types, depending on the emission factors. 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

Unit Types Endpoint

Climatiq 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).

AttributeRequiredDefault
area float
Area size in the defined unit
required
area_unit string
Unit of area. One of m2, km2, ft2, ha
optionalkm2
{
//...
"parameters": {
"area": 30,
"area_unit": "ha"
}
//...
}

AreaOverTime

Calculate emissions produced by area over time.

AttributeRequiredDefault
area float
Area size in the defined unit
required
area_unit string
Unit of area. One of m2, km2, ft2, ha
optionalkm2
time float
Time amount
required
time_unit string
Unit of time. One of ms, s, min, hour, day, year
optionalhour
{
//...
"parameters": {
"area": 30,
"area_unit": "ha",
"time": 365,
"time_unit": "day"
}
//...
}

ContainerOverDistance

Calculate emissions produced by moving goods inside a certain amount of twenty-foot-equivalent (opens in a new tab) containers over a distance (in kilometers, miles, nautical miles, meters or feet).

AttributeRequiredDefault
twenty_foot_equivalent float
The amount of twenty-foot-equivalent containers moved
required
distance float
Distance in the defined unit
required
distance_unit string
Unit of distance. One of m, km, ft, mi, nmi
optionalkm
{
//...
"parameters": {
"twenty_foot_equivalent": 2,
"distance": 100,
"distance_unit": "km"
}
//...
}

Data

Calculate emissions produced by a data amount, such as by transfer, expressed in megabytes (MB), gigabytes (GB) or Terabytes (TB).

AttributeRequiredDefault
data float
Data size in the defined unit
required
data_unit string
Unit of data. One of MB or GB, TB
optionalMB
{
//...
"parameters": {
"data": 3,
"data_unit": "GB"
}
//...
}

DataOverTime

Calculate emissions produced by data over time, such as storing data for some duration.

AttributeRequiredDefault
data float
Data size in the defined unit
required
data_unit string
Unit of data. One of MB, GB or TB
optionalMB
time float
Time amount
required
time_unit string
Unit of time. One of ms, s, min, hour, day, year
optionalhour
{
//...
"parameters": {
"data": 3,
"data_unit": "GB",
"time": 1,
"time_unit": "h"
}
//...
}

Distance

Calculate emissions produced by moving a vehicle in kilometers, miles, nautical miles, meters or feet.

AttributeRequiredDefault
distance float
Distance in the defined unit
required
distance_unit string
Unit of distance. One of m, km, ft, mi, nmi
optionalkm
{
//...
"parameters": {
"distance": 100,
"distance_unit": "mi"
}
//...
}

DistanceOverTime

Calculate emissions produced by distance over time, such as road maintenance.

AttributeRequiredDefault
distance float
Distance in the defined unit
required
distance_unit string
Unit of distance. One of m, km, ft, mi, nmi
optionalkm
time float
Time amount
required
time_unit string
Unit of time. One of ms, s, min, hour, day, year
optionalhour
{
//...
"parameters": {
"distance": 100,
"distance_unit": "mi"
"time": 365,
"time_unit": "days"
}
//...
}

Energy

Calculate emissions produced by consumption of energy in kWh, terajoules, gigajoules, megajoules or MMBTU (opens in a new tab).

AttributeRequiredDefault
energy float
Energy in the defined unit
required
energy_unit string
Unit of energy. One of Wh, kWh, MWh, MJ, GJ, TJ, therm or MMBTU
optionalkWh
{
//...
"parameters": {
"energy": 30,
"energy_unit": "TJ"
}
//...
}

Money

Calculate upstream emissions produced by purchase of goods or services, for example food, clothing or services, expressed in any of the supported currencies.

Where exchange rates are applied, these are aggregated from a variety of sources, but primarily from the UN Treasury Operational Rates (opens in a new tab) and the IRS average exchange rates (opens in a new tab) for the year that the source judges the emission factor is most valid for.

Due to varying exchange rates and inflation, calculating emissions based on money spent is most accurate when the year for the emission factor is the same as the year you spent the money.

AttributeRequiredDefault
money float
Money amount in the defined unit
required
money_unit string
ISO code of currency, such as usd, eur or gbp. See the list of all supported currencies.
optionalusd
{
//...
"parameters": {
"money": 100,
"money_unit": "eur"
}
//...
}

Supported currencies

This table list all currencies that the Climatiq API supports. Pass in the ISO Currency Code into the API to use a specific currency.

ISO Currency CodeCountryCurrency name
aedUnited Arab EmiratesUAE dirham
afnAfghanistanAfghan afghani
allAlbaniaAlbanian lek
amdArmeniaArmenian dram
angCuraçaoNetherlands Antillean gulden
aoaAngolaAngolan kwanza
arsArgentinaArgentine peso
audAustraliaAustralian dollar
awgArubaAruban florin
aznAzerbaijanAzerbaijani manat
bamBosnia and HerzegovinaBosnia and Herzegovina konvertibilna marka
bbdBarbadosBarbadian dollar
bdtBangladeshBangladeshi taka
bgnBulgariaBulgarian lev
bhdBahrainBahraini dinar
bifBurundiBurundi franc
bmdBermudaBermudian dollar
bndBrunei DarussalamBrunei dollar
bobPlurinational State of BoliviaBolivian boliviano
brlBrazilBrazilian real
bsdBahamasBahamian dollar
bwpBotswanaBotswana pula
bynBelarusBelarusian ruble
cadCanadaCanadian dollar
chfSwitzerland & LiechtensteinSwiss franc
clpChileChilean peso
cnyChinaChinese/Yuan renminbi
copColombiaColombian peso
crcCosta RicaCosta Rican colon
cveCape VerdeCape Verdean escudo
czkCzechiaCzech koruna
djfDjiboutiDjiboutian franc
dkkDenmarkDanish krone
dopDominican RepublicDominican peso
dzdAlgeriaAlgerian dinar
egpEgyptEgyptian pound
etbEthiopiaEthiopian birr
eurEuro ZoneEuropean Euro
fjdFijiFijian dollar
gbpUnited KingdomBritish pound
gelGeorgiaGeorgian lari
ghsGhanaGhanaian cedi
gipGibraltarGibraltar pound
gmdGambiaGambian dalasi
gtqGuatemalaGuatemalan quetzal
gydGuyanaGuyanese dollar
hkdHong KongHong Kong dollar
hnlHondurasHonduran lempira
hrkCroatiaCroatian kuna
hufHungaryHungarian forint
idrIndonesiaIndonesian rupiah
ilsIsraelIsraeli new sheqel
inrIndiaIndian rupee
iqdIraqIraqi dinar
irrIranIranian rial
iskIcelandIcelandic króna
jmdJamaicaJamaican dollar
jodJordanJordanian dinar
jpyJapanJapanese yen
kesKenyaKenyan shilling
kgsKyrgyzstanKyrgyzstani som
khrCambodiaCambodian riel
kmfComorosComorian franc
krwSouth KoreaSouth Korean won
kwdKuwaitKuwaiti dinar
kydCayman IslandsCayman Islands dollar
kztKazakhstanKazakhstani tenge
lakLao People's Democratic RepublicLao kip
lbpLebanonLebanese lira
lslLesothoLesotho loti
lydLibyaLibyan dinar
madMoroccoMoroccan dirham
mdlMoldova, Republic ofMoldovan leu
mgaMadagascarMalagasy ariary
mkdNorth MacedoniaMacedonian denar
mopMacaoMacanese pataca
murMauritiusMauritian rupee
murMauritiusMauritian rupee
mvrMaldivesMaldivian rufiyaa
mxnMexicoMexican peso
myrMalaysiaMalaysian ringgit
mznMozambiqueMozambican metical
nadNamibiaNamibian dollar
nioNicaraguaNicaraguan córdoba
nokNorwayNorwegian krone
nprNepalNepalese rupee
nzdNew ZealandNew Zealand dollar
omrOmanOmani rial
pabPanamaPanamanian balboa
penPeruPeruvian nuevo sol
phpThe PhilippinesPhilippine peso
pkrPakistanPakistani rupee
plnPolandPolish zloty
pygParaguayParaguayan guarani
qarQatarQatari riyal
ronRomaniaRomanian leu
rsdSerbiaSerbian dinar
rubRussian FederationRussian ruble
rwfRwandaRwandan franc
sarSaudi ArabiaSaudi riyal
scrSeychellesSeychellois rupee
sekSwedenSwedish krona
sgdSingaporeSingapore dollar
sllSierra LeoneSierra Leonean leone
srdSurinameSurinamese dollar
stdSao Tome and PrincipeSão Tomé and Príncipe dobra
svcEl SalvadorSalvadoran Colon
szlEswatiniSwazi lilangeni
thbThailandThai baht
tjsTajikistanTajikistani somoni
tndTunisiaTunisian dinar
tryTurkeyTurkish new lira
ttdTrinidad and TobagoTrinidad and Tobago dollar
twdTaiwanNew Taiwan dollar
uahUkraineUkrainian hryvnia
ugxUgandaUgandan shilling
usdAmerican SamoaUnited States dollar
uyuUruguayUruguayan peso
uzsUzbekistanUzbekistani som
vndVietnamVietnamese dong
wstSamoaSamoan tala
xafCameroonCentral African CFA franc
xcdAntigua and BarbudaEast Caribbean dollar
xofBeninWest African CFA franc
xpfFrench PolynesiaCFP franc
yerYemenYemeni rial
zarSouth AfricaSouth African rand
zmwZambiaZambian kwacha

Number

This method works as a fallback for units without conversions like Hotel nights.

AttributeRequired
number float
Unit amount
required
{
//...
"parameters": {
"number": 3
}
//...
}

NumberOverTime

Calculate emissions by a number in a given time expressed in days, hours, minutes, seconds or milliseconds. The numbers are multiplied together, so doubling the number or the time will yield the same results.

AttributeRequiredDefault
number float
The number
required
time float
The time amount
required
time_unit string
Unit of time. One of ms, s, min, hour, day, year
optionalhour
{
//...
"parameters": {
"number": 15,
"time": 3,
"time_unit": "m"
}
//...
}

PassengerOverDistance

Calculate emissions produced by moving a number of passengers over a given distance in kilometers, miles, nautical miles, meters or feet.

AttributeRequiredDefault
passengers integer
Number of passengers
optional1
distance float
Distance in the defined unit
required
distance_unit string
Unit of distance. One of m, km, ft, mi, nmi
optionalkm
{
//...
"parameters": {
"passengers": 4,
"distance": 100,
"distance_unit": "mi"
}
//...
}

Time

Calculate emissions in a given time expressed in (average) years, days, hours, minutes, seconds or milliseconds.

AttributeRequiredDefault
time float
Time amount
required
time_unit string
Unit of time. One of ms, s, min, hour, day, year
optionalhour
{
//...
"parameters": {
"time": 3,
"time_unit": "m"
}
//...
}

Volume

Calculate emissions produced by volume of material consumed or utilized in a process or activity; for example diesel, expressed in liters, milliliters, cubic meters, standard cubic foot or US gallons.

AttributeRequiredDefault
volume float
Volume in the defined unit
required
volume_unit string
Unit of volume. One of ml, l, m3, standard_cubic_foot, gallons_us, bbl
optionall
{
//...
"parameters": {
"volume": 15,
"volume_unit": "l"
}
//...
}

Weight

Calculate emissions produced by total weight of material consumed, utilized or transported in a process or activity, expressed in kilograms, tonnes (metric tons) or US short tons.

AttributeRequiredDefault
weight float
Weight in the defined unit
required
weight_unit string
Unit of weight. One of g, kg, t (metric ton), lb, ton (US short ton)
optionalkg
{
//...
"parameters": {
"weight": 80,
"weight_unit": "t"
}
//...
}

WeightOverDistance

Calculate emissions produced by moving goods of a certain weight (expressed in kilograms, tonnes (metric tons) or US short tons) over a distance (in kilometers, miles, nautical miles, meters or feet).

AttributeRequiredDefault
weight float
Weight in the defined unit
required
weight_unit string
Unit of weight. One of g, kg, t (metric ton), lb, ton (US short ton)
optionalkg
distance float
Distance in the defined unit
required
distance_unit string
Unit of distance. One of m, km, ft, mi, nmi
optionalkm
{
//...
"parameters": {
"weight": 80,
"weight_unit": "t",
"distance": 100,
"distance_unit": "mi"
}
//...
}

WeightOverTime

Calculate emissions produced by weight over time.

AttributeRequiredDefault
weight float
Weight in the defined unit
required
weight_unit string
Unit of weight. One of g, kg, t (metric ton), lb, ton (US short ton)
optionalkg
time float
Time amount
required
time_unit string
Unit of time. One of ms, s, min, hour, day, year
optionalhour
{
//...
"parameters": {
"weight": 80,
"weight_unit": "t",
"time": 20,
"time_unit": "days"
}
//...
}