Sector API

Authentication

You will need to get in touch with us to obtain an API key to authenticate when you make the calls above.

Once you have an API key you will need to set the api-key header to contain the API key value you receive.

API Endpoints

The Sector API provides two endpoints you can use to calculate emissions.

/api/v1/emission accepts HTTP POST requests, whose body should contain an API Request object in JSON format. It returns a API Response object.

Sample request:

{
 "id": "Test Field",
 "area": 1000,
 "country": "USA",
 "city": "San Diego",
 "length": 112,
 "yield": 5,
 "efch4": 1.32,
 "sfpre": 1,
 "sfw": 1,
 "nfert": 100,
 "efburn": 0.259,
 "strawburn": 5,
 "cfoa1": 1,
 "roa1": 0.8,
 "cfoa2": 0.17,
 "roa2": 2
}

Sample response:

{
  "requestId": "Test Field",
  "emissions": 6564.263045334104,
  "ghgIntensity": 1.3128526090668209
}

/api/v1/emissions accepts HTTP POST requests, whose body should contain an array of API Request objects (also in JSON format). It returns a list of API Response objects.

API Request Object

Field	Description	Required	Values
`id`	An identifier for this request. This is used when using the 'emissions' api in order to identify the results.	yes
`area`	The size of the field in hectares.	yes
`country`	The country the field is located in.	yes
`city`	The city or province the field is located in.	yes
`length`	The cultivation period in days. Must be between 90 and 180	yes
`yield`	The weight of paddy yield in tons per hectare. Must be between: 0 and 10	yes
`efch4`	The amount of methane (kg CH4) emitted per hectare per day.	yes
`sfpre`	Scaling factor for water regime before the crop season. Shorter flooding periods (for plowing) are not considered. Must be between 0.1 and 3.	yes
`sfw`	Scaling factor for water management during the crop season. Must be between 0 and 1	yes
`nfert`	Amount of pure nitrogen (N) per hectare per season. For example, low fertilizer rate is 80 and a high fertilizer rate is 140. Must be between 0 and 200	yes
`efburn`	Straw management (kgCO2/ kg straw).	yes
`strawburn`	Percentage of total straw used. Must be between 0 and 100	yes
`cfoa1`	Timing of straw incorporation. Conversion factor for duration of straw incorporation before cultivation. Must be between 0.1 and 2.	yes
`roa1`	Amount of straw incorporation (ton/ha). Amount of straw from the previous harvest that will be incorporated into the soil before planting - average amount from combine harvester is equal to 60% of grain yield. Stubble incorporation (10cm) is already included in the calculations. If you manually harvested and the stubble left behind is longer than 10cm, increase the amount of straw. Must be between: 0 and 10	yes
`cfoa2`	Conversion factor for type of organic amendment (ton/ha). Must be between 0 and 2	no	0
`roa2`	Amount of organic matter (t/ha) (not including rice straw unless it’s in the form on compost)	no	0
`gwpch4`	The 100-year time horizon global warming potentials (GWP) of methane (CH4) relative to CO2.	no	28
`gwpn2o`	The 100-year time horizon global warming potentials (GWP) of nitrous oxide (N2O) relative to CO2	no	265
`efn2odir`	Direct emissions factor of N2O	no	0.003

API Request Presets

For some fields above we provide presets that can be used instead of specifying an actual numeric value. To use a preset set the value of the field to the preset instead. Note presets are passing in as stings.

For example

{
 "id": "Test Field",
 "area": 1000,
 "country": "USA",
 "city": "San Diego",
 "length": 112,
 "yield": 5,
 "efch4": "AFRICA",
 "sfpre": "NON_FLODDED_MORE_180",
 "sfw": "IRRIGATED_MULTIPLE",
 "nfert": "HIGH",
 "efburn": "BURNING",
 "cfoa1": "MORE_30_DAYS",
 "strawburn": 5,
 "roa1": 0.8,
 "cfoa2": "FARM_MANURE",
 "roa2": 2
}

Below is a list of available presets for each field.

efch4

Preset	Value
SOUTH_EAST_ASIA	1.22
SOUTH_ASIA	0.85
EAST_ASIA	1.32
AFRICA	1.19
EUROPE	1.56
NORTH_AMERICA	0.65
SOUTH_AMERICA	1.27
GLOBAL	1.19

sfpre

Preset	Value
NON_FLOODED_LESS_180	1
NON_FLODDED_MORE_180	0.89
FLOODED_MORE_30	2.41
NON_FLOODED_MORE_365	0.59

cfoa1

Preset	Value
LESS_30_DAYS	1
MORE_30_DAYS	0.19

cfoa2

Preset	Value
COMPOST	0.17
FARM_MANURE	0.21
GREEN_MANURE	0.45

sfw

Preset	Value
IRRIGATED_FLOODED	1
IRRIGATED_SINGLE	0.71
IRRIGATED_MULTIPLE	0.55
RAIN_REGULAR	0.54
RAIN_DROUGHT	0.16
DEEP_WATER	0.06

nfert

Preset	Value
LOW	80
HIGH	140

efburn

Preset	Value
NOT_CONSIDERED	0
BURNING	0.175

API Response Object

Field	Description
id	The request identifier
emissions	Emissions in tCO2e
ghgIntensity	GHG Intensity in kg CO2/k paddy