API ReferenceGAF

Perform a Cotton 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

Percent of total electricity usage that is drawn from renewable sources, between 0 and 100. 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