Email usContact us
  • Getting started
    • Welcome
    • Authentication and Certificates
  • API Reference
LogoLogo
Email usContact us
API ReferenceGAF

Perform Cotton calculation

POST
https://emissionscalculator-mtls.production.aiaapi.com/calculator/2.0.0/cotton
POST
/calculator/2.0.0/cotton
1curl -X POST https://emissionscalculator-mtls.production.aiaapi.com/calculator/2.0.0/cotton \
2 -H "Authorization: Bearer <token>" \
3 -H "Content-Type: application/json" \
4 -d '{
5 "state": "nsw",
6 "crops": [
7 {
8 "state": "nsw",
9 "averageCottonYield": 1.1,
10 "areaSown": 1.1,
11 "averageWeightPerBaleKg": 1.1,
12 "cottonLintPerBaleKg": 1.1,
13 "cottonSeedPerBaleKg": 1.1,
14 "wastePerBaleKg": 1.1,
15 "ureaApplication": 1.1,
16 "otherFertiliserApplication": 1.1,
17 "singleSuperPhosphate": 1.1,
18 "rainfallAbove600": true,
19 "herbicideUse": 1.1,
20 "glyphosateOtherHerbicideUse": 1.1,
21 "electricityAllocation": 1.1,
22 "limestone": 1.1,
23 "limestoneFraction": 1.1,
24 "dieselUse": 1.1,
25 "petrolUse": 1.1,
26 "lpg": 1.1
27 }
28 ],
29 "electricityRenewable": 1.1,
30 "electricityUse": 1.1,
31 "vegetation": [
32 {
33 "vegetation": {
34 "region": "South West",
35 "treeSpecies": "Mixed species (Environmental Plantings)",
36 "soil": "Loams & Clays",
37 "area": 1.1,
38 "age": 1.1
39 },
40 "allocationToCrops": [
41 1.1
42 ]
43 }
44 ]
45}'
Try it
200Successful
1{
2 "scope1": {
3 "fuelCO2": 1.1,
4 "fuelCH4": 1.1,
5 "fuelN2O": 1.1,
6 "ureaCO2": 1.1,
7 "limeCO2": 1.1,
8 "fertiliserN2O": 1.1,
9 "atmosphericDepositionN2O": 1.1,
10 "leachingAndRunoffN2O": 1.1,
11 "cropResidueN2O": 1.1,
12 "fieldBurningN2O": 1.1,
13 "fieldBurningCH4": 1.1,
14 "totalCO2": 1.1,
15 "totalCH4": 1.1,
16 "totalN2O": 1.1,
17 "total": 1.1
18 },
19 "scope2": {
20 "electricity": 1.1,
21 "total": 1.1
22 },
23 "scope3": {
24 "fertiliser": 1.1,
25 "herbicide": 1.1,
26 "electricity": 1.1,
27 "fuel": 1.1,
28 "lime": 1.1,
29 "total": 1.1
30 },
31 "carbonSequestration": {
32 "total": 1.1,
33 "intermediate": [
34 1.1
35 ]
36 },
37 "intermediate": [
38 {
39 "id": "id",
40 "scope1": {
41 "fuelCO2": 1.1,
42 "fuelCH4": 1.1,
43 "fuelN2O": 1.1,
44 "ureaCO2": 1.1,
45 "limeCO2": 1.1,
46 "fertiliserN2O": 1.1,
47 "atmosphericDepositionN2O": 1.1,
48 "leachingAndRunoffN2O": 1.1,
49 "cropResidueN2O": 1.1,
50 "fieldBurningN2O": 1.1,
51 "fieldBurningCH4": 1.1,
52 "totalCO2": 1.1,
53 "totalCH4": 1.1,
54 "totalN2O": 1.1,
55 "total": 1.1
56 },
57 "scope2": {
58 "electricity": 1.1,
59 "total": 1.1
60 },
61 "scope3": {
62 "fertiliser": 1.1,
63 "herbicide": 1.1,
64 "electricity": 1.1,
65 "fuel": 1.1,
66 "lime": 1.1,
67 "total": 1.1
68 },
69 "intensities": {
70 "cottonYieldProducedTonnes": 1.1,
71 "balesProduced": 1.1,
72 "lintProducedTonnes": 1.1,
73 "seedProducedTonnes": 1.1,
74 "tonnesCropExcludingSequestration": 1.1,
75 "tonnesCropIncludingSequestration": 1.1,
76 "balesExcludingSequestration": 1.1,
77 "balesIncludingSequestration": 1.1,
78 "lintIncludingSequestration": 1.1,
79 "lintExcludingSequestration": 1.1,
80 "seedIncludingSequestration": 1.1,
81 "seedExcludingSequestration": 1.1,
82 "lintEconomicAllocation": 1.1,
83 "seedEconomicAllocation": 1.1
84 },
85 "net": {
86 "total": 1.1
87 },
88 "carbonSequestration": {
89 "total": 1.1
90 }
91 }
92 ],
93 "net": {
94 "total": 1.1,
95 "crops": [
96 1.1
97 ]
98 },
99 "intensities": [
100 {
101 "cottonYieldProducedTonnes": 1.1,
102 "balesProduced": 1.1,
103 "lintProducedTonnes": 1.1,
104 "seedProducedTonnes": 1.1,
105 "tonnesCropExcludingSequestration": 1.1,
106 "tonnesCropIncludingSequestration": 1.1,
107 "balesExcludingSequestration": 1.1,
108 "balesIncludingSequestration": 1.1,
109 "lintIncludingSequestration": 1.1,
110 "lintExcludingSequestration": 1.1,
111 "seedIncludingSequestration": 1.1,
112 "seedExcludingSequestration": 1.1,
113 "lintEconomicAllocation": 1.1,
114 "seedEconomicAllocation": 1.1
115 }
116 ]
117}
Retrieve a simple JSON response
Was this page helpful?
Previous

Perform Dairy calculation

Next
Built with
Perform Dairy calculation
Retrieve a simple JSON response

Headers

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

Request

This endpoint expects an object.
stateenumRequired
What state the location is in. Note: Western Australia is split up into two regions, `wa_nw` is North-West Western Australia, `wa_sw` is South-West Western Australia
cropslist of objectsRequired
electricityRenewabledoubleRequired>=0<=1
Percent of total electricity usage that is drawn from renewable sources, between 0 and 1. Unused if `electricitySource` is `Renewable`
electricityUsedoubleRequired
Electricity use in KWh (kilowatt hours)
vegetationlist of objectsRequired

Response

This endpoint returns an object.
scope1object

Scope 1 greenhouse gas emissions are the emissions released to the atmosphere as a direct result of an activity, in tonnes-CO2e (tonnes of carbon dioxide equivalent)

scope2object
Scope 2 greenhouse gas emissions are the emissions released to the atmosphere from the indirect consumption of an energy commodity, in tonnes-CO2e (tonnes of carbon dioxide equivalent)
scope3object
Scope 3 emissions are indirect greenhouse gas emissions other than scope 2 emissions that are generated in the wider economy, in tonnes-CO2e (tonnes of carbon dioxide equivalent)
carbonSequestrationobject
Carbon sequestration, in tonnes-CO2e
intermediatelist of objects
netobject
Net emissions for each crop (in order)
intensitieslist of objects
Emissions intensity for each crop (in order)

Errors

Scope 2 greenhouse gas emissions are the emissions released to the atmosphere from the indirect consumption of an energy commodity, in tonnes-CO2e (tonnes of carbon dioxide equivalent)

Scope 3 emissions are indirect greenhouse gas emissions other than scope 2 emissions that are generated in the wider economy, in tonnes-CO2e (tonnes of carbon dioxide equivalent)

Carbon sequestration, in tonnes-CO2e

Net emissions for each crop (in order)

Emissions intensity for each crop (in order)

What state the location is in. Note: Western Australia is split up into two regions, wa_nw is North-West Western Australia, wa_sw is South-West Western Australia

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

Percent of total electricity usage that is drawn from renewable sources, between 0 and 1. Unused if electricitySource is Renewable

Electricity use in KWh (kilowatt hours)