API
A collection of RESTful endpoints that provide farm related data and tools.
Vegetation Indices ¶
Resources to provide vegetation indices.
CLre ¶
CLrePOST/farm/vegetation_indices/clre
Generate the red edge chlorophyll index for a farm field.
The resource accepts a JSON object containing the following properties:
-
geometry (geojson) - The boundaries of the field expressed in geojson format
-
date (string) - The date to use for the retrieval of the indicator
-
identifier (string) - The identifier of the satellite image (optional, overrides the “date” property)
-
scale (number) - The scale factor for resampling the resulting image (optional, defaults to 1.0)
-
touch (bool) - Whether to ensure that all pixels overlapping the boundaries will be selected (optional, defaults to true)
-
strict (bool) - Whether to request satellite data only for the requested date (optional, defaults to false)
The output image will contain the following metadata:
-
SENSING_DATE: The sensing date eg. “2018-01-01”
-
SENSING_TIME: The sensing time eg. “13:00:00”
Example URI
Headers
Content-Type: application/jsonBody
{
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
22.403781,
40.703388
],
[
22.403864,
40.70309
],
[
22.403968,
40.702733
],
[
22.404088,
40.702258
],
[
22.403781,
40.703388
]
]
]
},
"date": "2018-05-29",
"identifier": "S2B_MSIL2A_20180923T090659_N0208_R050_T34TFK_20180923T141055"
}Schema
{
"$schema": "http://json-schema.org/draft-06/schema#",
"definitions": {
"crop_type": {
"type": "string",
"enum": [
"cotton",
"soya",
"maize",
"wheat"
]
},
"geometry": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"Point",
"Polygon"
]
}
},
"allOf": [
{
"if": {
"properties": {
"type": {
"const": "Point"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"minItems": 2,
"maxItems": 2,
"items": {
"type": "number"
}
}
}
}
},
{
"if": {
"properties": {
"type": {
"const": "Polygon"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"items": {
"type": "array",
"minItems": 4,
"items": {
"type": "array",
"minItems": 2,
"items": {
"type": "number"
}
}
}
}
}
}
}
],
"required": ["type", "coordinates"]
},
"bbox": {
"type": "array",
"minItems": 4,
"items": {
"type": "number"
}
},
"date": {
"type": "string",
"pattern": "^\d{4}\-(0?[1-9]|1[012])\-(0?[1-9]|[12][0-9]|3[01])$"
},
"identifier": {
"type": "string"
},
"scale": {
"type": "number",
"minimum": 0
},
"touch": {
"type": "boolean"
},
"stats": {
"type": "array",
"items": {
"type": "string",
"enum": [
"min",
"max",
"mean",
"count",
"sum",
"std",
"median",
"majority",
"minority",
"unique",
"range",
"nodata"
]
}
},
"integer": {
"type": "integer"
},
"number": {
"type": "number"
},
"boolean": {
"type": "boolean"
},
},
"type": "object",
"properties": {
"geometry": {
"$ref": "#/definitions/geometry"
},
"date": {
"$ref": "#/definitions/date"
},
"identifier": {
"$ref": "#/definitions/identifier"
},
"scale": {
"$ref": "#/definitions/scale"
},
"touch": {
"$ref": "#/definitions/touch"
}
},
"required": ["geometry", "date"]
}200Headers
Content-Type: image/tiff400Headers
Content-Type: application/json500Headers
Content-Type: application/json501Headers
Content-Type: application/jsonGNDVI ¶
GNDVIPOST/farm/vegetation_indices/gndvi
Generate the green normalized difference vegetation index for a farm field.
The resource accepts a JSON object containing the following properties:
-
geometry (geojson) - The boundaries of the field expressed in geojson format
-
date (string) - The date to use for the retrieval of the indicator
-
identifier (string) - The identifier of the satellite image (optional, overrides the “date” property)
-
scale (number) - The scale factor for resampling the resulting image (optional, defaults to 1.0)
-
touch (bool) - Whether to ensure that all pixels overlapping the boundaries will be selected (optional, defaults to true)
-
strict (bool) - Whether to request satellite data only for the requested date (optional, defaults to false)
The output image will contain the following metadata:
-
SENSING_DATE: The sensing date eg. “2018-01-01”
-
SENSING_TIME: The sensing time eg. “13:00:00”
Example URI
Headers
Content-Type: application/jsonBody
{
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
22.403781,
40.703388
],
[
22.403864,
40.70309
],
[
22.403968,
40.702733
],
[
22.404088,
40.702258
],
[
22.403781,
40.703388
]
]
]
},
"date": "2018-05-29",
"identifier": "S2B_MSIL2A_20180923T090659_N0208_R050_T34TFK_20180923T141055"
}Schema
{
"$schema": "http://json-schema.org/draft-06/schema#",
"definitions": {
"crop_type": {
"type": "string",
"enum": [
"cotton",
"soya",
"maize",
"wheat"
]
},
"geometry": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"Point",
"Polygon"
]
}
},
"allOf": [
{
"if": {
"properties": {
"type": {
"const": "Point"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"minItems": 2,
"maxItems": 2,
"items": {
"type": "number"
}
}
}
}
},
{
"if": {
"properties": {
"type": {
"const": "Polygon"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"items": {
"type": "array",
"minItems": 4,
"items": {
"type": "array",
"minItems": 2,
"items": {
"type": "number"
}
}
}
}
}
}
}
],
"required": ["type", "coordinates"]
},
"bbox": {
"type": "array",
"minItems": 4,
"items": {
"type": "number"
}
},
"date": {
"type": "string",
"pattern": "^\d{4}\-(0?[1-9]|1[012])\-(0?[1-9]|[12][0-9]|3[01])$"
},
"identifier": {
"type": "string"
},
"scale": {
"type": "number",
"minimum": 0
},
"touch": {
"type": "boolean"
},
"stats": {
"type": "array",
"items": {
"type": "string",
"enum": [
"min",
"max",
"mean",
"count",
"sum",
"std",
"median",
"majority",
"minority",
"unique",
"range",
"nodata"
]
}
},
"integer": {
"type": "integer"
},
"number": {
"type": "number"
},
"boolean": {
"type": "boolean"
},
},
"type": "object",
"properties": {
"geometry": {
"$ref": "#/definitions/geometry"
},
"date": {
"$ref": "#/definitions/date"
},
"identifier": {
"$ref": "#/definitions/identifier"
},
"scale": {
"$ref": "#/definitions/scale"
},
"touch": {
"$ref": "#/definitions/touch"
}
},
"required": ["geometry", "date"]
}200Headers
Content-Type: image/tiff400Headers
Content-Type: application/json500Headers
Content-Type: application/json501Headers
Content-Type: application/jsonGWDRVI ¶
GWDRVIPOST/farm/vegetation_indices/gwdrvi
Generate the green wide dynamic range vegetation index for a farm field.
The resource accepts a JSON object containing the following properties:
-
geometry (geojson) - The boundaries of the field expressed in geojson format
-
date (string) - The date to use for the retrieval of the indicator
-
identifier (string) - The identifier of the satellite image (optional, overrides the “date” property)
-
scale (number) - The scale factor for resampling the resulting image (optional, defaults to 1.0)
-
touch (bool) - Whether to ensure that all pixels overlapping the boundaries will be selected (optional, defaults to true)
-
strict (bool) - Whether to request satellite data only for the requested date (optional, defaults to false)
The output image will contain the following metadata:
-
SENSING_DATE: The sensing date eg. “2018-01-01”
-
SENSING_TIME: The sensing time eg. “13:00:00”
Example URI
Headers
Content-Type: application/jsonBody
{
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
22.403781,
40.703388
],
[
22.403864,
40.70309
],
[
22.403968,
40.702733
],
[
22.404088,
40.702258
],
[
22.403781,
40.703388
]
]
]
},
"date": "2018-05-29",
"identifier": "S2B_MSIL2A_20180923T090659_N0208_R050_T34TFK_20180923T141055"
}Schema
{
"$schema": "http://json-schema.org/draft-06/schema#",
"definitions": {
"crop_type": {
"type": "string",
"enum": [
"cotton",
"soya",
"maize",
"wheat"
]
},
"geometry": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"Point",
"Polygon"
]
}
},
"allOf": [
{
"if": {
"properties": {
"type": {
"const": "Point"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"minItems": 2,
"maxItems": 2,
"items": {
"type": "number"
}
}
}
}
},
{
"if": {
"properties": {
"type": {
"const": "Polygon"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"items": {
"type": "array",
"minItems": 4,
"items": {
"type": "array",
"minItems": 2,
"items": {
"type": "number"
}
}
}
}
}
}
}
],
"required": ["type", "coordinates"]
},
"bbox": {
"type": "array",
"minItems": 4,
"items": {
"type": "number"
}
},
"date": {
"type": "string",
"pattern": "^\d{4}\-(0?[1-9]|1[012])\-(0?[1-9]|[12][0-9]|3[01])$"
},
"identifier": {
"type": "string"
},
"scale": {
"type": "number",
"minimum": 0
},
"touch": {
"type": "boolean"
},
"stats": {
"type": "array",
"items": {
"type": "string",
"enum": [
"min",
"max",
"mean",
"count",
"sum",
"std",
"median",
"majority",
"minority",
"unique",
"range",
"nodata"
]
}
},
"integer": {
"type": "integer"
},
"number": {
"type": "number"
},
"boolean": {
"type": "boolean"
},
},
"type": "object",
"properties": {
"geometry": {
"$ref": "#/definitions/geometry"
},
"date": {
"$ref": "#/definitions/date"
},
"identifier": {
"$ref": "#/definitions/identifier"
},
"scale": {
"$ref": "#/definitions/scale"
},
"touch": {
"$ref": "#/definitions/touch"
}
},
"required": ["geometry", "date"]
}200Headers
Content-Type: image/tiff400Headers
Content-Type: application/json500Headers
Content-Type: application/json501Headers
Content-Type: application/jsonmNDWI ¶
mNDWIPOST/farm/vegetation_indices/mndwi
Generate the modified normalized difference water index for a farm field.
The resource accepts a JSON object containing the following properties:
-
geometry (geojson) - The boundaries of the field expressed in geojson format
-
date (string) - The date to use for the retrieval of the indicator
-
identifier (string) - The identifier of the satellite image (optional, overrides the “date” property)
-
scale (number) - The scale factor for resampling the resulting image (optional, defaults to 1.0)
-
touch (bool) - Whether to ensure that all pixels overlapping the boundaries will be selected (optional, defaults to true)
-
strict (bool) - Whether to request satellite data only for the requested date (optional, defaults to false)
The output image will contain the following metadata:
-
SENSING_DATE: The sensing date eg. “2018-01-01”
-
SENSING_TIME: The sensing time eg. “13:00:00”
Example URI
Headers
Content-Type: application/jsonBody
{
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
22.403781,
40.703388
],
[
22.403864,
40.70309
],
[
22.403968,
40.702733
],
[
22.404088,
40.702258
],
[
22.403781,
40.703388
]
]
]
},
"date": "2018-05-29",
"identifier": "S2B_MSIL2A_20180923T090659_N0208_R050_T34TFK_20180923T141055"
}Schema
{
"$schema": "http://json-schema.org/draft-06/schema#",
"definitions": {
"crop_type": {
"type": "string",
"enum": [
"cotton",
"soya",
"maize",
"wheat"
]
},
"geometry": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"Point",
"Polygon"
]
}
},
"allOf": [
{
"if": {
"properties": {
"type": {
"const": "Point"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"minItems": 2,
"maxItems": 2,
"items": {
"type": "number"
}
}
}
}
},
{
"if": {
"properties": {
"type": {
"const": "Polygon"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"items": {
"type": "array",
"minItems": 4,
"items": {
"type": "array",
"minItems": 2,
"items": {
"type": "number"
}
}
}
}
}
}
}
],
"required": ["type", "coordinates"]
},
"bbox": {
"type": "array",
"minItems": 4,
"items": {
"type": "number"
}
},
"date": {
"type": "string",
"pattern": "^\d{4}\-(0?[1-9]|1[012])\-(0?[1-9]|[12][0-9]|3[01])$"
},
"identifier": {
"type": "string"
},
"scale": {
"type": "number",
"minimum": 0
},
"touch": {
"type": "boolean"
},
"stats": {
"type": "array",
"items": {
"type": "string",
"enum": [
"min",
"max",
"mean",
"count",
"sum",
"std",
"median",
"majority",
"minority",
"unique",
"range",
"nodata"
]
}
},
"integer": {
"type": "integer"
},
"number": {
"type": "number"
},
"boolean": {
"type": "boolean"
},
},
"type": "object",
"properties": {
"geometry": {
"$ref": "#/definitions/geometry"
},
"date": {
"$ref": "#/definitions/date"
},
"identifier": {
"$ref": "#/definitions/identifier"
},
"scale": {
"$ref": "#/definitions/scale"
},
"touch": {
"$ref": "#/definitions/touch"
}
},
"required": ["geometry", "date"]
}200Headers
Content-Type: image/tiff400Headers
Content-Type: application/json500Headers
Content-Type: application/json501Headers
Content-Type: application/jsonFlood ¶
FloodPOST/farm/vegetation_indices/flood
Generate the flooded areas of a field (0=not flooded, 1=flooded).
The resource accepts a JSON object containing the following properties:
-
geometry (geojson) - The boundaries of the field expressed in geojson format
-
date (string) - The date to use for the retrieval of the indicator
-
identifier (string) - The identifier of the satellite image (optional, overrides the “date” property)
-
strict (bool) - Whether to request satellite data only for the requested date (optional, defaults to false)
The output image will contain the following metadata:
-
SENSING_DATE: The sensing date eg. “2018-01-01”
-
SENSING_TIME: The sensing time eg. “13:00:00”
-
FLOODED_AREA: The flooded area of the field (percentage)
Example URI
Headers
Content-Type: application/jsonBody
{
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
22.403781,
40.703388
],
[
22.403864,
40.70309
],
[
22.403968,
40.702733
],
[
22.404088,
40.702258
],
[
22.403781,
40.703388
]
]
]
},
"date": "2018-05-29",
"identifier": "S2B_MSIL2A_20180923T090659_N0208_R050_T34TFK_20180923T141055"
}Schema
{
"$schema": "http://json-schema.org/draft-06/schema#",
"definitions": {
"crop_type": {
"type": "string",
"enum": [
"cotton",
"soya",
"maize",
"wheat"
]
},
"geometry": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"Point",
"Polygon"
]
}
},
"allOf": [
{
"if": {
"properties": {
"type": {
"const": "Point"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"minItems": 2,
"maxItems": 2,
"items": {
"type": "number"
}
}
}
}
},
{
"if": {
"properties": {
"type": {
"const": "Polygon"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"items": {
"type": "array",
"minItems": 4,
"items": {
"type": "array",
"minItems": 2,
"items": {
"type": "number"
}
}
}
}
}
}
}
],
"required": ["type", "coordinates"]
},
"bbox": {
"type": "array",
"minItems": 4,
"items": {
"type": "number"
}
},
"date": {
"type": "string",
"pattern": "^\d{4}\-(0?[1-9]|1[012])\-(0?[1-9]|[12][0-9]|3[01])$"
},
"identifier": {
"type": "string"
},
"scale": {
"type": "number",
"minimum": 0
},
"touch": {
"type": "boolean"
},
"stats": {
"type": "array",
"items": {
"type": "string",
"enum": [
"min",
"max",
"mean",
"count",
"sum",
"std",
"median",
"majority",
"minority",
"unique",
"range",
"nodata"
]
}
},
"integer": {
"type": "integer"
},
"number": {
"type": "number"
},
"boolean": {
"type": "boolean"
},
},
"type": "object",
"properties": {
"geometry": {
"$ref": "#/definitions/geometry"
},
"date": {
"$ref": "#/definitions/date"
},
"identifier": {
"$ref": "#/definitions/identifier"
}
},
"required": ["geometry", "date"]
}200Headers
Content-Type: image/tiff400Headers
Content-Type: application/json500Headers
Content-Type: application/json501Headers
Content-Type: application/jsonNAOC ¶
NAOCPOST/farm/vegetation_indices/naoc
Generate the normalized area over reflectance curve index for a farm field.
The resource accepts a JSON object containing the following properties:
-
geometry (geojson) - The boundaries of the field expressed in geojson format
-
date (string) - The date to use for the retrieval of the indicator
-
identifier (string) - The identifier of the satellite image (optional, overrides the “date” property)
-
scale (number) - The scale factor for resampling the resulting image (optional, defaults to 1.0)
-
touch (bool) - Whether to ensure that all pixels overlapping the boundaries will be selected (optional, defaults to true)
-
strict (bool) - Whether to request satellite data only for the requested date (optional, defaults to false)
The output image will contain the following metadata:
-
SENSING_DATE: The sensing date eg. “2018-01-01”
-
SENSING_TIME: The sensing time eg. “13:00:00”
Example URI
Headers
Content-Type: application/jsonBody
{
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
22.403781,
40.703388
],
[
22.403864,
40.70309
],
[
22.403968,
40.702733
],
[
22.404088,
40.702258
],
[
22.403781,
40.703388
]
]
]
},
"date": "2018-05-29",
"identifier": "S2B_MSIL2A_20180923T090659_N0208_R050_T34TFK_20180923T141055"
}Schema
{
"$schema": "http://json-schema.org/draft-06/schema#",
"definitions": {
"crop_type": {
"type": "string",
"enum": [
"cotton",
"soya",
"maize",
"wheat"
]
},
"geometry": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"Point",
"Polygon"
]
}
},
"allOf": [
{
"if": {
"properties": {
"type": {
"const": "Point"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"minItems": 2,
"maxItems": 2,
"items": {
"type": "number"
}
}
}
}
},
{
"if": {
"properties": {
"type": {
"const": "Polygon"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"items": {
"type": "array",
"minItems": 4,
"items": {
"type": "array",
"minItems": 2,
"items": {
"type": "number"
}
}
}
}
}
}
}
],
"required": ["type", "coordinates"]
},
"bbox": {
"type": "array",
"minItems": 4,
"items": {
"type": "number"
}
},
"date": {
"type": "string",
"pattern": "^\d{4}\-(0?[1-9]|1[012])\-(0?[1-9]|[12][0-9]|3[01])$"
},
"identifier": {
"type": "string"
},
"scale": {
"type": "number",
"minimum": 0
},
"touch": {
"type": "boolean"
},
"stats": {
"type": "array",
"items": {
"type": "string",
"enum": [
"min",
"max",
"mean",
"count",
"sum",
"std",
"median",
"majority",
"minority",
"unique",
"range",
"nodata"
]
}
},
"integer": {
"type": "integer"
},
"number": {
"type": "number"
},
"boolean": {
"type": "boolean"
},
},
"type": "object",
"properties": {
"geometry": {
"$ref": "#/definitions/geometry"
},
"date": {
"$ref": "#/definitions/date"
},
"identifier": {
"$ref": "#/definitions/identifier"
},
"scale": {
"$ref": "#/definitions/scale"
},
"touch": {
"$ref": "#/definitions/touch"
}
},
"required": ["geometry", "date"]
}200Headers
Content-Type: image/tiff400Headers
Content-Type: application/json500Headers
Content-Type: application/json501Headers
Content-Type: application/jsonNBR ¶
NBRPOST/farm/vegetation_indices/nbr
Generate the normalised burn ratio index for a farm field.
The resource accepts a JSON object containing the following properties:
-
geometry (geojson) - The boundaries of the field expressed in geojson format
-
date (string) - The date to use for the retrieval of the indicator
-
identifier (string) - The identifier of the satellite image (optional, overrides the “date” property)
-
scale (number) - The scale factor for resampling the resulting image (optional, defaults to 1.0)
-
touch (bool) - Whether to ensure that all pixels overlapping the boundaries will be selected (optional, defaults to true)
-
strict (bool) - Whether to request satellite data only for the requested date (optional, defaults to false)
The output image will contain the following metadata:
-
SENSING_DATE: The sensing date eg. “2018-01-01”
-
SENSING_TIME: The sensing time eg. “13:00:00”
Example URI
Headers
Content-Type: application/jsonBody
{
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
22.403781,
40.703388
],
[
22.403864,
40.70309
],
[
22.403968,
40.702733
],
[
22.404088,
40.702258
],
[
22.403781,
40.703388
]
]
]
},
"date": "2018-05-29",
"identifier": "S2B_MSIL2A_20180923T090659_N0208_R050_T34TFK_20180923T141055"
}Schema
{
"$schema": "http://json-schema.org/draft-06/schema#",
"definitions": {
"crop_type": {
"type": "string",
"enum": [
"cotton",
"soya",
"maize",
"wheat"
]
},
"geometry": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"Point",
"Polygon"
]
}
},
"allOf": [
{
"if": {
"properties": {
"type": {
"const": "Point"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"minItems": 2,
"maxItems": 2,
"items": {
"type": "number"
}
}
}
}
},
{
"if": {
"properties": {
"type": {
"const": "Polygon"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"items": {
"type": "array",
"minItems": 4,
"items": {
"type": "array",
"minItems": 2,
"items": {
"type": "number"
}
}
}
}
}
}
}
],
"required": ["type", "coordinates"]
},
"bbox": {
"type": "array",
"minItems": 4,
"items": {
"type": "number"
}
},
"date": {
"type": "string",
"pattern": "^\d{4}\-(0?[1-9]|1[012])\-(0?[1-9]|[12][0-9]|3[01])$"
},
"identifier": {
"type": "string"
},
"scale": {
"type": "number",
"minimum": 0
},
"touch": {
"type": "boolean"
},
"stats": {
"type": "array",
"items": {
"type": "string",
"enum": [
"min",
"max",
"mean",
"count",
"sum",
"std",
"median",
"majority",
"minority",
"unique",
"range",
"nodata"
]
}
},
"integer": {
"type": "integer"
},
"number": {
"type": "number"
},
"boolean": {
"type": "boolean"
},
},
"type": "object",
"properties": {
"geometry": {
"$ref": "#/definitions/geometry"
},
"date": {
"$ref": "#/definitions/date"
},
"identifier": {
"$ref": "#/definitions/identifier"
},
"scale": {
"$ref": "#/definitions/scale"
},
"touch": {
"$ref": "#/definitions/touch"
}
},
"required": ["geometry", "date"]
}200Headers
Content-Type: image/tiff400Headers
Content-Type: application/json500Headers
Content-Type: application/json501Headers
Content-Type: application/jsonNDVI ¶
NDVIPOST/farm/vegetation_indices/ndvi
Generate the normalized difference vegetation index for a farm field.
The resource accepts a JSON object containing the following properties:
-
geometry (geojson) - The boundaries of the field expressed in geojson format
-
date (string) - The date to use for the retrieval of the indicator
-
identifier (string) - The identifier of the satellite image (optional, overrides the “date” property)
-
scale (number) - The scale factor for resampling the resulting image (optional, defaults to 1.0)
-
touch (bool) - Whether to ensure that all pixels overlapping the boundaries will be selected (optional, defaults to true)
-
strict (bool) - Whether to request satellite data only for the requested date (optional, defaults to false)
-
validation_threshold (int) - Images with percentage of valid pixels below that threshold will be discarded (optional, defaults to none)
The output image will contain the following metadata:
-
SENSING_DATE: The sensing date eg. “2018-01-01”
-
SENSING_TIME: The sensing time eg. “13:00:00”
-
VALID_PIXELS: The percentage of image valid pixels eg. “90”
Example URI
Headers
Content-Type: application/jsonBody
{
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
22.403781,
40.703388
],
[
22.403864,
40.70309
],
[
22.403968,
40.702733
],
[
22.404088,
40.702258
],
[
22.403781,
40.703388
]
]
]
},
"date": "2018-05-29",
"identifier": "S2B_MSIL2A_20180923T090659_N0208_R050_T34TFK_20180923T141055"
}Schema
{
"$schema": "http://json-schema.org/draft-06/schema#",
"definitions": {
"crop_type": {
"type": "string",
"enum": [
"cotton",
"soya",
"maize",
"wheat"
]
},
"geometry": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"Point",
"Polygon"
]
}
},
"allOf": [
{
"if": {
"properties": {
"type": {
"const": "Point"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"minItems": 2,
"maxItems": 2,
"items": {
"type": "number"
}
}
}
}
},
{
"if": {
"properties": {
"type": {
"const": "Polygon"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"items": {
"type": "array",
"minItems": 4,
"items": {
"type": "array",
"minItems": 2,
"items": {
"type": "number"
}
}
}
}
}
}
}
],
"required": ["type", "coordinates"]
},
"bbox": {
"type": "array",
"minItems": 4,
"items": {
"type": "number"
}
},
"date": {
"type": "string",
"pattern": "^\d{4}\-(0?[1-9]|1[012])\-(0?[1-9]|[12][0-9]|3[01])$"
},
"identifier": {
"type": "string"
},
"scale": {
"type": "number",
"minimum": 0
},
"touch": {
"type": "boolean"
},
"stats": {
"type": "array",
"items": {
"type": "string",
"enum": [
"min",
"max",
"mean",
"count",
"sum",
"std",
"median",
"majority",
"minority",
"unique",
"range",
"nodata"
]
}
},
"integer": {
"type": "integer"
},
"number": {
"type": "number"
},
"boolean": {
"type": "boolean"
},
},
"type": "object",
"properties": {
"geometry": {
"$ref": "#/definitions/geometry"
},
"date": {
"$ref": "#/definitions/date"
},
"identifier": {
"$ref": "#/definitions/identifier"
},
"scale": {
"$ref": "#/definitions/scale"
},
"touch": {
"$ref": "#/definitions/touch"
}
},
"required": ["geometry", "date"]
}200Headers
Content-Type: image/tiff400Headers
Content-Type: application/json500Headers
Content-Type: application/json501Headers
Content-Type: application/jsonOSAVI ¶
OSAVIPOST/farm/vegetation_indices/osavi
Generate the optimized soil-adjusted vegetation index for a farm field.
The resource accepts a JSON object containing the following properties:
-
geometry (geojson) - The boundaries of the field expressed in geojson format
-
date (string) - The date to use for the retrieval of the indicator
-
identifier (string) - The identifier of the satellite image (optional, overrides the “date” property)
-
scale (number) - The scale factor for resampling the resulting image (optional, defaults to 1.0)
-
touch (bool) - Whether to ensure that all pixels overlapping the boundaries will be selected (optional, defaults to true)
-
strict (bool) - Whether to request satellite data only for the requested date (optional, defaults to false)
-
validation_threshold (int) - Images with percentage of valid pixels below that threshold will be discarded (optional, defaults to none)
The output image will contain the following metadata:
-
SENSING_DATE: The sensing date eg. “2018-01-01”
-
SENSING_TIME: The sensing time eg. “13:00:00”
-
VALID_PIXELS: The percentage of image valid pixels eg. “90”
Example URI
Headers
Content-Type: application/jsonBody
{
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
22.403781,
40.703388
],
[
22.403864,
40.70309
],
[
22.403968,
40.702733
],
[
22.404088,
40.702258
],
[
22.403781,
40.703388
]
]
]
},
"date": "2018-05-29",
"identifier": "S2B_MSIL2A_20180923T090659_N0208_R050_T34TFK_20180923T141055"
}Schema
{
"$schema": "http://json-schema.org/draft-06/schema#",
"definitions": {
"crop_type": {
"type": "string",
"enum": [
"cotton",
"soya",
"maize",
"wheat"
]
},
"geometry": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"Point",
"Polygon"
]
}
},
"allOf": [
{
"if": {
"properties": {
"type": {
"const": "Point"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"minItems": 2,
"maxItems": 2,
"items": {
"type": "number"
}
}
}
}
},
{
"if": {
"properties": {
"type": {
"const": "Polygon"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"items": {
"type": "array",
"minItems": 4,
"items": {
"type": "array",
"minItems": 2,
"items": {
"type": "number"
}
}
}
}
}
}
}
],
"required": ["type", "coordinates"]
},
"bbox": {
"type": "array",
"minItems": 4,
"items": {
"type": "number"
}
},
"date": {
"type": "string",
"pattern": "^\d{4}\-(0?[1-9]|1[012])\-(0?[1-9]|[12][0-9]|3[01])$"
},
"identifier": {
"type": "string"
},
"scale": {
"type": "number",
"minimum": 0
},
"touch": {
"type": "boolean"
},
"stats": {
"type": "array",
"items": {
"type": "string",
"enum": [
"min",
"max",
"mean",
"count",
"sum",
"std",
"median",
"majority",
"minority",
"unique",
"range",
"nodata"
]
}
},
"integer": {
"type": "integer"
},
"number": {
"type": "number"
},
"boolean": {
"type": "boolean"
},
},
"type": "object",
"properties": {
"geometry": {
"$ref": "#/definitions/geometry"
},
"date": {
"$ref": "#/definitions/date"
},
"identifier": {
"$ref": "#/definitions/identifier"
},
"scale": {
"$ref": "#/definitions/scale"
},
"touch": {
"$ref": "#/definitions/touch"
}
},
"required": ["geometry", "date"]
}200Headers
Content-Type: image/tiff400Headers
Content-Type: application/json500Headers
Content-Type: application/json501Headers
Content-Type: application/jsonRVI ¶
RVIPOST/farm/vegetation_indices/rvi
Generate the relative vigor index for a farm field.
The resource accepts a JSON object containing the following properties:
-
geometry (geojson) - The boundaries of the field expressed in geojson format
-
date (string) - The date to use for the retrieval of the indicator
-
identifier (string) - The identifier of the satellite image (optional, overrides the “date” property)
-
scale (number) - The scale factor for resampling the resulting image (optional, defaults to 1.0)
-
touch (bool) - Whether to ensure that all pixels overlapping the boundaries will be selected (optional, defaults to true)
-
strict (bool) - Whether to request satellite data only for the requested date (optional, defaults to false)
The output image will contain the following metadata:
-
SENSING_DATE: The sensing date eg. “2018-01-01”
-
SENSING_TIME: The sensing time eg. “13:00:00”
Example URI
Headers
Content-Type: application/jsonBody
{
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
22.403781,
40.703388
],
[
22.403864,
40.70309
],
[
22.403968,
40.702733
],
[
22.404088,
40.702258
],
[
22.403781,
40.703388
]
]
]
},
"date": "2018-05-29",
"identifier": "S2B_MSIL2A_20180923T090659_N0208_R050_T34TFK_20180923T141055"
}Schema
{
"$schema": "http://json-schema.org/draft-06/schema#",
"definitions": {
"crop_type": {
"type": "string",
"enum": [
"cotton",
"soya",
"maize",
"wheat"
]
},
"geometry": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"Point",
"Polygon"
]
}
},
"allOf": [
{
"if": {
"properties": {
"type": {
"const": "Point"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"minItems": 2,
"maxItems": 2,
"items": {
"type": "number"
}
}
}
}
},
{
"if": {
"properties": {
"type": {
"const": "Polygon"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"items": {
"type": "array",
"minItems": 4,
"items": {
"type": "array",
"minItems": 2,
"items": {
"type": "number"
}
}
}
}
}
}
}
],
"required": ["type", "coordinates"]
},
"bbox": {
"type": "array",
"minItems": 4,
"items": {
"type": "number"
}
},
"date": {
"type": "string",
"pattern": "^\d{4}\-(0?[1-9]|1[012])\-(0?[1-9]|[12][0-9]|3[01])$"
},
"identifier": {
"type": "string"
},
"scale": {
"type": "number",
"minimum": 0
},
"touch": {
"type": "boolean"
},
"stats": {
"type": "array",
"items": {
"type": "string",
"enum": [
"min",
"max",
"mean",
"count",
"sum",
"std",
"median",
"majority",
"minority",
"unique",
"range",
"nodata"
]
}
},
"integer": {
"type": "integer"
},
"number": {
"type": "number"
},
"boolean": {
"type": "boolean"
},
},
"type": "object",
"properties": {
"geometry": {
"$ref": "#/definitions/geometry"
},
"date": {
"$ref": "#/definitions/date"
},
"identifier": {
"$ref": "#/definitions/identifier"
},
"scale": {
"$ref": "#/definitions/scale"
},
"touch": {
"$ref": "#/definitions/touch"
}
},
"required": ["geometry", "date"]
}200Headers
Content-Type: image/tiff400Headers
Content-Type: application/json500Headers
Content-Type: application/json501Headers
Content-Type: application/jsonNDWI ¶
NDWIPOST/farm/vegetation_indices/ndwi
Generate the relative vigor index for a farm field.
The resource accepts a JSON object containing the following properties:
-
geometry (geojson) - The boundaries of the field expressed in geojson format
-
date (string) - The date to use for the retrieval of the indicator
-
identifier (string) - The identifier of the satellite image (optional, overrides the “date” property)
-
scale (number) - The scale factor for resampling the resulting image (optional, defaults to 1.0)
-
touch (bool) - Whether to ensure that all pixels overlapping the boundaries will be selected (optional, defaults to true)
-
strict (bool) - Whether to request satellite data only for the requested date (optional, defaults to false)
The output image will contain the following metadata:
-
SENSING_DATE: The sensing date eg. “2018-01-01”
-
SENSING_TIME: The sensing time eg. “13:00:00”
Example URI
Headers
Content-Type: application/jsonBody
{
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
22.403781,
40.703388
],
[
22.403864,
40.70309
],
[
22.403968,
40.702733
],
[
22.404088,
40.702258
],
[
22.403781,
40.703388
]
]
]
},
"date": "2018-05-29",
"identifier": "S2B_MSIL2A_20180923T090659_N0208_R050_T34TFK_20180923T141055"
}Schema
{
"$schema": "http://json-schema.org/draft-06/schema#",
"definitions": {
"crop_type": {
"type": "string",
"enum": [
"cotton",
"soya",
"maize",
"wheat"
]
},
"geometry": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"Point",
"Polygon"
]
}
},
"allOf": [
{
"if": {
"properties": {
"type": {
"const": "Point"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"minItems": 2,
"maxItems": 2,
"items": {
"type": "number"
}
}
}
}
},
{
"if": {
"properties": {
"type": {
"const": "Polygon"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"items": {
"type": "array",
"minItems": 4,
"items": {
"type": "array",
"minItems": 2,
"items": {
"type": "number"
}
}
}
}
}
}
}
],
"required": ["type", "coordinates"]
},
"bbox": {
"type": "array",
"minItems": 4,
"items": {
"type": "number"
}
},
"date": {
"type": "string",
"pattern": "^\d{4}\-(0?[1-9]|1[012])\-(0?[1-9]|[12][0-9]|3[01])$"
},
"identifier": {
"type": "string"
},
"scale": {
"type": "number",
"minimum": 0
},
"touch": {
"type": "boolean"
},
"stats": {
"type": "array",
"items": {
"type": "string",
"enum": [
"min",
"max",
"mean",
"count",
"sum",
"std",
"median",
"majority",
"minority",
"unique",
"range",
"nodata"
]
}
},
"integer": {
"type": "integer"
},
"number": {
"type": "number"
},
"boolean": {
"type": "boolean"
},
},
"type": "object",
"properties": {
"geometry": {
"$ref": "#/definitions/geometry"
},
"date": {
"$ref": "#/definitions/date"
},
"identifier": {
"$ref": "#/definitions/identifier"
},
"scale": {
"$ref": "#/definitions/scale"
},
"touch": {
"$ref": "#/definitions/touch"
}
},
"required": ["geometry", "date"]
}200Headers
Content-Type: image/tiff400Headers
Content-Type: application/json500Headers
Content-Type: application/json501Headers
Content-Type: application/jsonCRI1 ¶
CRI1POST/farm/vegetation_indices/cri1
Generate the carotenoid reflectance index 1 for a farm field.
The resource accepts a JSON object containing the following properties:
-
geometry (geojson) - The boundaries of the field expressed in geojson format
-
date (string) - The date to use for the retrieval of the indicator
-
identifier (string) - The identifier of the satellite image (optional, overrides the “date” property)
-
scale (number) - The scale factor for resampling the resulting image (optional, defaults to 1.0)
-
touch (bool) - Whether to ensure that all pixels overlapping the boundaries will be selected (optional, defaults to true)
-
strict (bool) - Whether to request satellite data only for the requested date (optional, defaults to false)
The output image will contain the following metadata:
-
SENSING_DATE: The sensing date eg. “2018-01-01”
-
SENSING_TIME: The sensing time eg. “13:00:00”
Example URI
Headers
Content-Type: application/jsonBody
{
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
22.403781,
40.703388
],
[
22.403864,
40.70309
],
[
22.403968,
40.702733
],
[
22.404088,
40.702258
],
[
22.403781,
40.703388
]
]
]
},
"date": "2018-05-29",
"identifier": "S2B_MSIL2A_20180923T090659_N0208_R050_T34TFK_20180923T141055"
}Schema
{
"$schema": "http://json-schema.org/draft-06/schema#",
"definitions": {
"crop_type": {
"type": "string",
"enum": [
"cotton",
"soya",
"maize",
"wheat"
]
},
"geometry": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"Point",
"Polygon"
]
}
},
"allOf": [
{
"if": {
"properties": {
"type": {
"const": "Point"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"minItems": 2,
"maxItems": 2,
"items": {
"type": "number"
}
}
}
}
},
{
"if": {
"properties": {
"type": {
"const": "Polygon"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"items": {
"type": "array",
"minItems": 4,
"items": {
"type": "array",
"minItems": 2,
"items": {
"type": "number"
}
}
}
}
}
}
}
],
"required": ["type", "coordinates"]
},
"bbox": {
"type": "array",
"minItems": 4,
"items": {
"type": "number"
}
},
"date": {
"type": "string",
"pattern": "^\d{4}\-(0?[1-9]|1[012])\-(0?[1-9]|[12][0-9]|3[01])$"
},
"identifier": {
"type": "string"
},
"scale": {
"type": "number",
"minimum": 0
},
"touch": {
"type": "boolean"
},
"stats": {
"type": "array",
"items": {
"type": "string",
"enum": [
"min",
"max",
"mean",
"count",
"sum",
"std",
"median",
"majority",
"minority",
"unique",
"range",
"nodata"
]
}
},
"integer": {
"type": "integer"
},
"number": {
"type": "number"
},
"boolean": {
"type": "boolean"
},
},
"type": "object",
"properties": {
"geometry": {
"$ref": "#/definitions/geometry"
},
"date": {
"$ref": "#/definitions/date"
},
"identifier": {
"$ref": "#/definitions/identifier"
},
"scale": {
"$ref": "#/definitions/scale"
},
"touch": {
"$ref": "#/definitions/touch"
}
},
"required": ["geometry", "date"]
}200Headers
Content-Type: image/tiff400Headers
Content-Type: application/json500Headers
Content-Type: application/json501Headers
Content-Type: application/jsonARI ¶
ARIPOST/farm/vegetation_indices/ari
Generate the anthocyanin reflectance index for a farm field.
The resource accepts a JSON object containing the following properties:
-
geometry (geojson) - The boundaries of the field expressed in geojson format
-
date (string) - The date to use for the retrieval of the indicator
-
identifier (string) - The identifier of the satellite image (optional, overrides the “date” property)
-
scale (number) - The scale factor for resampling the resulting image (optional, defaults to 1.0)
-
touch (bool) - Whether to ensure that all pixels overlapping the boundaries will be selected (optional, defaults to true)
-
strict (bool) - Whether to request satellite data only for the requested date (optional, defaults to false)
The output image will contain the following metadata:
-
SENSING_DATE: The sensing date eg. “2018-01-01”
-
SENSING_TIME: The sensing time eg. “13:00:00”
Example URI
Headers
Content-Type: application/jsonBody
{
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
22.403781,
40.703388
],
[
22.403864,
40.70309
],
[
22.403968,
40.702733
],
[
22.404088,
40.702258
],
[
22.403781,
40.703388
]
]
]
},
"date": "2018-05-29",
"identifier": "S2B_MSIL2A_20180923T090659_N0208_R050_T34TFK_20180923T141055"
}Schema
{
"$schema": "http://json-schema.org/draft-06/schema#",
"definitions": {
"crop_type": {
"type": "string",
"enum": [
"cotton",
"soya",
"maize",
"wheat"
]
},
"geometry": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"Point",
"Polygon"
]
}
},
"allOf": [
{
"if": {
"properties": {
"type": {
"const": "Point"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"minItems": 2,
"maxItems": 2,
"items": {
"type": "number"
}
}
}
}
},
{
"if": {
"properties": {
"type": {
"const": "Polygon"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"items": {
"type": "array",
"minItems": 4,
"items": {
"type": "array",
"minItems": 2,
"items": {
"type": "number"
}
}
}
}
}
}
}
],
"required": ["type", "coordinates"]
},
"bbox": {
"type": "array",
"minItems": 4,
"items": {
"type": "number"
}
},
"date": {
"type": "string",
"pattern": "^\d{4}\-(0?[1-9]|1[012])\-(0?[1-9]|[12][0-9]|3[01])$"
},
"identifier": {
"type": "string"
},
"scale": {
"type": "number",
"minimum": 0
},
"touch": {
"type": "boolean"
},
"stats": {
"type": "array",
"items": {
"type": "string",
"enum": [
"min",
"max",
"mean",
"count",
"sum",
"std",
"median",
"majority",
"minority",
"unique",
"range",
"nodata"
]
}
},
"integer": {
"type": "integer"
},
"number": {
"type": "number"
},
"boolean": {
"type": "boolean"
},
},
"type": "object",
"properties": {
"geometry": {
"$ref": "#/definitions/geometry"
},
"date": {
"$ref": "#/definitions/date"
},
"identifier": {
"$ref": "#/definitions/identifier"
},
"scale": {
"$ref": "#/definitions/scale"
},
"touch": {
"$ref": "#/definitions/touch"
}
},
"required": [geometry", "date"]
}200Headers
Content-Type: image/tiff400Headers
Content-Type: application/json500Headers
Content-Type: application/json501Headers
Content-Type: application/jsonBiophysical Parameters ¶
Resources to provide biophysical parameters.
Chl LAI ¶
Chl LAIPOST/farm/biophysical_parameters/chl_lai
Generate the chlorophyll leaf area index for a farm field.
The resource accepts a JSON object containing the following properties:
-
crop_type (string) - The crop type for the field (one of “barley”, “cotton”, “maize”, “soya”, “sunflower”, “wheat”)
-
geometry (geojson) - The boundaries of the field expressed in geojson format
-
date (string) - The date to use for the retrieval of the parameter
-
identifier (string) - The identifier of the satellite image (optional, overrides the “date” property)
-
scale (number) - The scale factor for resampling the resulting image (optional, defaults to 1.0)
-
touch (bool) - Whether to ensure that all pixels overlapping the boundaries will be selected (optional, defaults to true)
-
strict (bool) - Whether to request satellite data only for the requested date (optional, defaults to false)
-
validation_threshold (int) - Images with percentage of valid pixels below that threshold will be discarded (optional, defaults to none)
The output image will contain the following metadata:
-
SENSING_DATE: The sensing date eg. “2018-01-01”
-
SENSING_TIME: The sensing time eg. “13:00:00”
-
VALID_PIXELS: The percentage of image valid pixels eg. “90”
Example URI
Headers
Content-Type: application/jsonBody
{
"crop_type": "cotton",
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
22.403781,
40.703388
],
[
22.403864,
40.70309
],
[
22.403968,
40.702733
],
[
22.404088,
40.702258
],
[
22.403781,
40.703388
]
]
]
},
"date": "2018-05-29",
"identifier": "S2B_MSIL2A_20180923T090659_N0208_R050_T34TFK_20180923T141055"
}Schema
{
"$schema": "http://json-schema.org/draft-06/schema#",
"definitions": {
"crop_type": {
"type": "string",
"enum": [
"cotton",
"soya",
"maize",
"wheat"
]
},
"geometry": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"Point",
"Polygon"
]
}
},
"allOf": [
{
"if": {
"properties": {
"type": {
"const": "Point"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"minItems": 2,
"maxItems": 2,
"items": {
"type": "number"
}
}
}
}
},
{
"if": {
"properties": {
"type": {
"const": "Polygon"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"items": {
"type": "array",
"minItems": 4,
"items": {
"type": "array",
"minItems": 2,
"items": {
"type": "number"
}
}
}
}
}
}
}
],
"required": ["type", "coordinates"]
},
"bbox": {
"type": "array",
"minItems": 4,
"items": {
"type": "number"
}
},
"date": {
"type": "string",
"pattern": "^\d{4}\-(0?[1-9]|1[012])\-(0?[1-9]|[12][0-9]|3[01])$"
},
"identifier": {
"type": "string"
},
"scale": {
"type": "number",
"minimum": 0
},
"touch": {
"type": "boolean"
},
"stats": {
"type": "array",
"items": {
"type": "string",
"enum": [
"min",
"max",
"mean",
"count",
"sum",
"std",
"median",
"majority",
"minority",
"unique",
"range",
"nodata"
]
}
},
"integer": {
"type": "integer"
},
"number": {
"type": "number"
},
"boolean": {
"type": "boolean"
},
},
"type": "object",
"properties": {
"crop_type": {
"$ref": "#/definitions/crop_type"
},
"geometry": {
"$ref": "#/definitions/geometry"
},
"date": {
"$ref": "#/definitions/date"
},
"identifier": {
"$ref": "#/definitions/identifier"
},
"scale": {
"$ref": "#/definitions/scale"
},
"touch": {
"$ref": "#/definitions/touch"
}
},
"required": ["crop_type", "geometry", "date"]
}200Headers
Content-Type: image/tiff400Headers
Content-Type: application/json500Headers
Content-Type: application/json501Headers
Content-Type: application/jsonLAI ¶
LAIPOST/farm/biophysical_parameters/lai
Generate the leaf area index for a farm field.
The resource accepts a JSON object containing the following properties:
-
crop_type (string) - The crop type for the field (one of “barley”, “cotton”, “grapevine”, “maize”, “soya”, “sunflower”, “wheat”)
-
geometry (geojson) - The boundaries of the field expressed in geojson format
-
date (string) - The date to use for the retrieval of the parameter
-
identifier (string) - The identifier of the satellite image (optional, overrides the “date” property)
-
scale (number) - The scale factor for resampling the resulting image (optional, defaults to 1.0)
-
touch (bool) - Whether to ensure that all pixels overlapping the boundaries will be selected (optional, defaults to true)
-
strict (bool) - Whether to request satellite data only for the requested date (optional, defaults to false)
-
validation_threshold (int) - Images with percentage of valid pixels below that threshold will be discarded (optional, defaults to none)
The output image will contain the following metadata:
-
SENSING_DATE: The sensing date eg. “2018-01-01”
-
SENSING_TIME: The sensing time eg. “13:00:00”
-
VALID_PIXELS: The percentage of image valid pixels eg. “90”
Example URI
Headers
Content-Type: application/jsonBody
{
"crop_type": "cotton",
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
22.403781,
40.703388
],
[
22.403864,
40.70309
],
[
22.403968,
40.702733
],
[
22.404088,
40.702258
],
[
22.403781,
40.703388
]
]
]
},
"date": "2018-05-29",
"identifier": "S2B_MSIL2A_20180923T090659_N0208_R050_T34TFK_20180923T141055"
}Schema
{
"$schema": "http://json-schema.org/draft-06/schema#",
"definitions": {
"crop_type": {
"type": "string",
"enum": [
"cotton",
"soya",
"maize",
"wheat"
]
},
"geometry": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"Point",
"Polygon"
]
}
},
"allOf": [
{
"if": {
"properties": {
"type": {
"const": "Point"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"minItems": 2,
"maxItems": 2,
"items": {
"type": "number"
}
}
}
}
},
{
"if": {
"properties": {
"type": {
"const": "Polygon"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"items": {
"type": "array",
"minItems": 4,
"items": {
"type": "array",
"minItems": 2,
"items": {
"type": "number"
}
}
}
}
}
}
}
],
"required": ["type", "coordinates"]
},
"bbox": {
"type": "array",
"minItems": 4,
"items": {
"type": "number"
}
},
"date": {
"type": "string",
"pattern": "^\d{4}\-(0?[1-9]|1[012])\-(0?[1-9]|[12][0-9]|3[01])$"
},
"identifier": {
"type": "string"
},
"scale": {
"type": "number",
"minimum": 0
},
"touch": {
"type": "boolean"
},
"stats": {
"type": "array",
"items": {
"type": "string",
"enum": [
"min",
"max",
"mean",
"count",
"sum",
"std",
"median",
"majority",
"minority",
"unique",
"range",
"nodata"
]
}
},
"integer": {
"type": "integer"
},
"number": {
"type": "number"
},
"boolean": {
"type": "boolean"
},
},
"type": "object",
"properties": {
"crop_type": {
"$ref": "#/definitions/crop_type"
},
"geometry": {
"$ref": "#/definitions/geometry"
},
"date": {
"$ref": "#/definitions/date"
},
"identifier": {
"$ref": "#/definitions/identifier"
},
"scale": {
"$ref": "#/definitions/scale"
},
"touch": {
"$ref": "#/definitions/touch"
}
},
"required": ["crop_type", "geometry", "date"]
}200Headers
Content-Type: image/tiff400Headers
Content-Type: application/json500Headers
Content-Type: application/json501Headers
Content-Type: application/jsonProtein Content ¶
Protein ContentPOST/farm/biophysical_parameters/protein_content
Generate the protein content for a farm field.
The resource accepts a JSON object containing the following properties:
-
crop_type (string) - The crop type for the field (one of “wheat”, “barley”)
-
geometry (geojson) - The boundaries of the field expressed in geojson format
-
date (string) - The date to use for the retrieval of the parameter
-
sowing_date (string) - The date that the sowing took place
-
scale (number) - The scale factor for resampling the resulting image (optional, defaults to 1.0)
-
touch (bool) - Whether to ensure that all pixels overlapping the boundaries will be selected (optional, defaults to true)
The output image will contain the following metadata:
-
SENSING_DATE: The sensing date eg. “2018-05-01”
-
SENSING_TIME: The sensing time eg. “13:00:00”
Example URI
Headers
Content-Type: application/jsonBody
{
"crop_type": "wheat",
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
22.403781,
40.703388
],
[
22.403864,
40.70309
],
[
22.403968,
40.702733
],
[
22.404088,
40.702258
],
[
22.403781,
40.703388
]
]
]
},
"date": "2018-05-29",
"sowing_date": "2018-01-22"
}Schema
{
"$schema": "http://json-schema.org/draft-06/schema#",
"definitions": {
"crop_type": {
"type": "string",
"enum": [
"cotton",
"soya",
"maize",
"wheat"
]
},
"geometry": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"Point",
"Polygon"
]
}
},
"allOf": [
{
"if": {
"properties": {
"type": {
"const": "Point"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"minItems": 2,
"maxItems": 2,
"items": {
"type": "number"
}
}
}
}
},
{
"if": {
"properties": {
"type": {
"const": "Polygon"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"items": {
"type": "array",
"minItems": 4,
"items": {
"type": "array",
"minItems": 2,
"items": {
"type": "number"
}
}
}
}
}
}
}
],
"required": ["type", "coordinates"]
},
"bbox": {
"type": "array",
"minItems": 4,
"items": {
"type": "number"
}
},
"date": {
"type": "string",
"pattern": "^\d{4}\-(0?[1-9]|1[012])\-(0?[1-9]|[12][0-9]|3[01])$"
},
"identifier": {
"type": "string"
},
"scale": {
"type": "number",
"minimum": 0
},
"touch": {
"type": "boolean"
},
"stats": {
"type": "array",
"items": {
"type": "string",
"enum": [
"min",
"max",
"mean",
"count",
"sum",
"std",
"median",
"majority",
"minority",
"unique",
"range",
"nodata"
]
}
},
"integer": {
"type": "integer"
},
"number": {
"type": "number"
},
"boolean": {
"type": "boolean"
},
},
"type": "object",
"properties": {
"crop_type": {
"$ref": "#/definitions/crop_type"
},
"geometry": {
"$ref": "#/definitions/geometry"
},
"date": {
"$ref": "#/definitions/date"
},
"sowing_date": {
"$ref": "#/definitions/date"
},
"scale": {
"$ref": "#/definitions/scale"
},
"touch": {
"$ref": "#/definitions/touch"
}
},
"required": ["crop_type", "geometry", "date"]
}200Headers
Content-Type: image/tiff400Headers
Content-Type: application/json404Headers
Content-Type: application/json500Headers
Content-Type: application/json501Headers
Content-Type: application/jsonDamage Assessment ¶
Resources to provide damage assessment tools.
PDI ¶
PDIPOST/farm/damage_assessment/pdi
Generate the Percentage Difference Index for a farm field.
The resource accepts a JSON object containing the following properties:
-
geometry (geojson) - The boundaries of the field expressed in geojson format
-
start_date (string) - The date the damage started
-
end_date (string) - The date the damage ended
-
identifier_before (string) - The identifier of the satellite image (optional, overrides the “start_date” property)
-
identifier_after (string) - The identifier of the satellite image (optional, overrides the “end_date” property)
The output image will contain the following metadata:
-
SENSING_DATE_1: The sensing date eg. “2018-01-01”
-
SENSING_TIME_1: The sensing time eg. “13:00:00”
-
SENSING_DATE_2: The sensing date eg. “2018-01-31”
-
SENSING_TIME_2: The sensing time eg. “13:00:00”
Example URI
Headers
Content-Type: application/jsonBody
{
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
22.403781,
40.703388
],
[
22.403864,
40.70309
],
[
22.403968,
40.702733
],
[
22.404088,
40.702258
],
[
22.403781,
40.703388
]
]
]
},
"start_date": "2018-05-28",
"end_date": "2018-05-30"
}Schema
{
"$schema": "http://json-schema.org/draft-06/schema#",
"definitions": {
"crop_type": {
"type": "string",
"enum": [
"cotton",
"soya",
"maize",
"wheat"
]
},
"geometry": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"Point",
"Polygon"
]
}
},
"allOf": [
{
"if": {
"properties": {
"type": {
"const": "Point"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"minItems": 2,
"maxItems": 2,
"items": {
"type": "number"
}
}
}
}
},
{
"if": {
"properties": {
"type": {
"const": "Polygon"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"items": {
"type": "array",
"minItems": 4,
"items": {
"type": "array",
"minItems": 2,
"items": {
"type": "number"
}
}
}
}
}
}
}
],
"required": ["type", "coordinates"]
},
"bbox": {
"type": "array",
"minItems": 4,
"items": {
"type": "number"
}
},
"date": {
"type": "string",
"pattern": "^\d{4}\-(0?[1-9]|1[012])\-(0?[1-9]|[12][0-9]|3[01])$"
},
"identifier": {
"type": "string"
},
"scale": {
"type": "number",
"minimum": 0
},
"touch": {
"type": "boolean"
},
"stats": {
"type": "array",
"items": {
"type": "string",
"enum": [
"min",
"max",
"mean",
"count",
"sum",
"std",
"median",
"majority",
"minority",
"unique",
"range",
"nodata"
]
}
},
"integer": {
"type": "integer"
},
"number": {
"type": "number"
},
"boolean": {
"type": "boolean"
},
},
"type": "object",
"properties": {
"geometry": {
"$ref": "#/definitions/geometry"
},
"start_date": {
"$ref": "#/definitions/date"
},
"end_date": {
"$ref": "#/definitions/date"
},
"identifier_before": {
"$ref": "#/definitions/identifier"
},
"identifier_after": {
"$ref": "#/definitions/identifier"
}
},
"required": ["geometry", "end_date"]
}200Headers
Content-Type: image/tiff400Headers
Content-Type: application/json500Headers
Content-Type: application/json501Headers
Content-Type: application/jsondNBR ¶
dNBRPOST/farm/damage_assessment/dnbr
Generate the difference in Normalised Burn Ratio for a farm field.
The resource accepts a JSON object containing the following properties:
-
geometry (geojson) - The boundaries of the field expressed in geojson format
-
start_date (string) - The date the damage started
-
end_date (string) - The date the damage ended
-
identifier_before (string) - The identifier of the satellite image (optional, overrides the “damage_start_date” property)
-
identifier_after (string) - The identifier of the satellite image (optional, overrides the “damage_end_date” property)
The output image will contain the following metadata:
-
SENSING_DATE_1: The sensing date eg. “2018-01-01”
-
SENSING_TIME_1: The sensing time eg. “13:00:00”
-
SENSING_DATE_2: The sensing date eg. “2018-01-31”
-
SENSING_TIME_2: The sensing time eg. “13:00:00”
Example URI
Headers
Content-Type: application/jsonBody
{
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
22.403781,
40.703388
],
[
22.403864,
40.70309
],
[
22.403968,
40.702733
],
[
22.404088,
40.702258
],
[
22.403781,
40.703388
]
]
]
},
"start_date": "2018-05-28",
"end_date": "2018-05-30"
}Schema
{
"$schema": "http://json-schema.org/draft-06/schema#",
"definitions": {
"crop_type": {
"type": "string",
"enum": [
"cotton",
"soya",
"maize",
"wheat"
]
},
"geometry": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"Point",
"Polygon"
]
}
},
"allOf": [
{
"if": {
"properties": {
"type": {
"const": "Point"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"minItems": 2,
"maxItems": 2,
"items": {
"type": "number"
}
}
}
}
},
{
"if": {
"properties": {
"type": {
"const": "Polygon"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"items": {
"type": "array",
"minItems": 4,
"items": {
"type": "array",
"minItems": 2,
"items": {
"type": "number"
}
}
}
}
}
}
}
],
"required": ["type", "coordinates"]
},
"bbox": {
"type": "array",
"minItems": 4,
"items": {
"type": "number"
}
},
"date": {
"type": "string",
"pattern": "^\d{4}\-(0?[1-9]|1[012])\-(0?[1-9]|[12][0-9]|3[01])$"
},
"identifier": {
"type": "string"
},
"scale": {
"type": "number",
"minimum": 0
},
"touch": {
"type": "boolean"
},
"stats": {
"type": "array",
"items": {
"type": "string",
"enum": [
"min",
"max",
"mean",
"count",
"sum",
"std",
"median",
"majority",
"minority",
"unique",
"range",
"nodata"
]
}
},
"integer": {
"type": "integer"
},
"number": {
"type": "number"
},
"boolean": {
"type": "boolean"
},
},
"type": "object",
"properties": {
"geometry": {
"$ref": "#/definitions/geometry"
},
"start_date": {
"$ref": "#/definitions/date"
},
"end_date": {
"$ref": "#/definitions/date"
},
"identifier_before": {
"$ref": "#/definitions/identifier"
},
"identifier_after": {
"$ref": "#/definitions/identifier"
}
},
"required": ["geometry", "end_date"]
}200Headers
Content-Type: image/tiff400Headers
Content-Type: application/json404Headers
Content-Type: application/json500Headers
Content-Type: application/json501Headers
Content-Type: application/jsonRBR ¶
RBRPOST/farm/damage_assessment/rbr
Generate the Relativized Burn Ratio for a farm field.
The resource accepts a JSON object containing the following properties:
-
geometry (geojson) - The boundaries of the field expressed in geojson format
-
start_date (string) - The date the damage started
-
end_date (string) - The date the damage ended
-
identifier_before (string) - The identifier of the satellite image (optional, overrides the “damage_start_date” property)
-
identifier_after (string) - The identifier of the satellite image (optional, overrides the “damage_end_date” property)
The output image will contain the following metadata:
-
SENSING_DATE_1: The sensing date eg. “2018-01-01”
-
SENSING_TIME_1: The sensing time eg. “13:00:00”
-
SENSING_DATE_2: The sensing date eg. “2018-01-31”
-
SENSING_TIME_2: The sensing time eg. “13:00:00”
-
NAN_PERCENTAGE: The percentage of NaN values in the RBR image
Example URI
Headers
Content-Type: application/jsonBody
{
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
22.403781,
40.703388
],
[
22.403864,
40.70309
],
[
22.403968,
40.702733
],
[
22.404088,
40.702258
],
[
22.403781,
40.703388
]
]
]
},
"start_date": "2018-05-28",
"end_date": "2018-05-30"
}Schema
{
"$schema": "http://json-schema.org/draft-06/schema#",
"definitions": {
"crop_type": {
"type": "string",
"enum": [
"cotton",
"soya",
"maize",
"wheat"
]
},
"geometry": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"Point",
"Polygon"
]
}
},
"allOf": [
{
"if": {
"properties": {
"type": {
"const": "Point"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"minItems": 2,
"maxItems": 2,
"items": {
"type": "number"
}
}
}
}
},
{
"if": {
"properties": {
"type": {
"const": "Polygon"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"items": {
"type": "array",
"minItems": 4,
"items": {
"type": "array",
"minItems": 2,
"items": {
"type": "number"
}
}
}
}
}
}
}
],
"required": ["type", "coordinates"]
},
"bbox": {
"type": "array",
"minItems": 4,
"items": {
"type": "number"
}
},
"date": {
"type": "string",
"pattern": "^\d{4}\-(0?[1-9]|1[012])\-(0?[1-9]|[12][0-9]|3[01])$"
},
"identifier": {
"type": "string"
},
"scale": {
"type": "number",
"minimum": 0
},
"touch": {
"type": "boolean"
},
"stats": {
"type": "array",
"items": {
"type": "string",
"enum": [
"min",
"max",
"mean",
"count",
"sum",
"std",
"median",
"majority",
"minority",
"unique",
"range",
"nodata"
]
}
},
"integer": {
"type": "integer"
},
"number": {
"type": "number"
},
"boolean": {
"type": "boolean"
},
},
"type": "object",
"properties": {
"geometry": {
"$ref": "#/definitions/geometry"
},
"start_date": {
"$ref": "#/definitions/date"
},
"end_date": {
"$ref": "#/definitions/date"
},
"identifier_before": {
"$ref": "#/definitions/identifier"
},
"identifier_after": {
"$ref": "#/definitions/identifier"
}
},
"required": ["geometry", "end_date"]
}200Headers
Content-Type: image/tiff400Headers
Content-Type: application/json404Headers
Content-Type: application/json500Headers
Content-Type: application/json501Headers
Content-Type: application/jsonFloodMap Optical ¶
FloodMap (Optical)POST/farm/damage_assessment/flood_map_optical
Generate the flooded areas of a field (0=not flooded, 1=flooded).
The resource accepts a JSON object containing the following properties:
-
geometry (geojson) - The boundaries of the field expressed in geojson format
-
date (string) - The date to use for the retrieval of the indicator
The output image will contain the following metadata:
-
SENSING_DATE: The sensing date eg. “2018-01-01”
-
SENSING_TIME: The sensing time eg. “13:00:00”
-
FLOODED_AREA: The flooded area of the field (percentage)
Example URI
Headers
Content-Type: application/jsonBody
{
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
22.403781,
40.703388
],
[
22.403864,
40.70309
],
[
22.403968,
40.702733
],
[
22.404088,
40.702258
],
[
22.403781,
40.703388
]
]
]
},
"date": "2020-06-29"
}Schema
{
"$schema": "http://json-schema.org/draft-06/schema#",
"definitions": {
"crop_type": {
"type": "string",
"enum": [
"cotton",
"soya",
"maize",
"wheat"
]
},
"geometry": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"Point",
"Polygon"
]
}
},
"allOf": [
{
"if": {
"properties": {
"type": {
"const": "Point"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"minItems": 2,
"maxItems": 2,
"items": {
"type": "number"
}
}
}
}
},
{
"if": {
"properties": {
"type": {
"const": "Polygon"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"items": {
"type": "array",
"minItems": 4,
"items": {
"type": "array",
"minItems": 2,
"items": {
"type": "number"
}
}
}
}
}
}
}
],
"required": ["type", "coordinates"]
},
"bbox": {
"type": "array",
"minItems": 4,
"items": {
"type": "number"
}
},
"date": {
"type": "string",
"pattern": "^\d{4}\-(0?[1-9]|1[012])\-(0?[1-9]|[12][0-9]|3[01])$"
},
"identifier": {
"type": "string"
},
"scale": {
"type": "number",
"minimum": 0
},
"touch": {
"type": "boolean"
},
"stats": {
"type": "array",
"items": {
"type": "string",
"enum": [
"min",
"max",
"mean",
"count",
"sum",
"std",
"median",
"majority",
"minority",
"unique",
"range",
"nodata"
]
}
},
"integer": {
"type": "integer"
},
"number": {
"type": "number"
},
"boolean": {
"type": "boolean"
},
},
"type": "object",
"properties": {
"geometry": {
"$ref": "#/definitions/geometry"
},
"date": {
"$ref": "#/definitions/date"
}
},
"required": ["geometry", "date"]
}200Headers
Content-Type: image/tiff400Headers
Content-Type: application/json404Headers
Content-Type: application/json500Headers
Content-Type: application/jsonFloodMap SAR - NDFI ¶
FloodMap (SAR / NDFI)POST/farm/damage_assessment/flood_map_sar_ndfi
Generate the flooded areas of a field (0=not flooded, 1=flooded).
The resource accepts a JSON object containing the following properties:
-
geometry (geojson) - The boundaries of the field expressed in geojson format
-
date (string) - The date to use for the retrieval of the indicator
The output image will contain the following metadata:
-
SENSING_DATE: The sensing date eg. “2018-01-01”
-
SENSING_TIME: The sensing time eg. “13:00:00”
-
FLOODED_AREA: The flooded area of the field (percentage)
Example URI
Headers
Content-Type: application/jsonBody
{
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
22.403781,
40.703388
],
[
22.403864,
40.70309
],
[
22.403968,
40.702733
],
[
22.404088,
40.702258
],
[
22.403781,
40.703388
]
]
]
},
"date": "2020-06-29"
}Schema
{
"$schema": "http://json-schema.org/draft-06/schema#",
"definitions": {
"crop_type": {
"type": "string",
"enum": [
"cotton",
"soya",
"maize",
"wheat"
]
},
"geometry": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"Point",
"Polygon"
]
}
},
"allOf": [
{
"if": {
"properties": {
"type": {
"const": "Point"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"minItems": 2,
"maxItems": 2,
"items": {
"type": "number"
}
}
}
}
},
{
"if": {
"properties": {
"type": {
"const": "Polygon"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"items": {
"type": "array",
"minItems": 4,
"items": {
"type": "array",
"minItems": 2,
"items": {
"type": "number"
}
}
}
}
}
}
}
],
"required": ["type", "coordinates"]
},
"bbox": {
"type": "array",
"minItems": 4,
"items": {
"type": "number"
}
},
"date": {
"type": "string",
"pattern": "^\d{4}\-(0?[1-9]|1[012])\-(0?[1-9]|[12][0-9]|3[01])$"
},
"identifier": {
"type": "string"
},
"scale": {
"type": "number",
"minimum": 0
},
"touch": {
"type": "boolean"
},
"stats": {
"type": "array",
"items": {
"type": "string",
"enum": [
"min",
"max",
"mean",
"count",
"sum",
"std",
"median",
"majority",
"minority",
"unique",
"range",
"nodata"
]
}
},
"integer": {
"type": "integer"
},
"number": {
"type": "number"
},
"boolean": {
"type": "boolean"
},
},
"type": "object",
"properties": {
"geometry": {
"$ref": "#/definitions/geometry"
},
"date": {
"$ref": "#/definitions/date"
}
},
"required": ["geometry", "date"]
}200Headers
Content-Type: image/tiff400Headers
Content-Type: application/json404Headers
Content-Type: application/json500Headers
Content-Type: application/jsonFloodMap SAR - NDFVI ¶
FloodMap (SAR / NDFVI)POST/farm/damage_assessment/flood_map_sar_ndfvi
Generate the flooded areas of a field (0=not flooded, 1=flooded).
The resource accepts a JSON object containing the following properties:
-
geometry (geojson) - The boundaries of the field expressed in geojson format
-
date (string) - The date to use for the retrieval of the indicator
The output image will contain the following metadata:
-
SENSING_DATE: The sensing date eg. “2018-01-01”
-
SENSING_TIME: The sensing time eg. “13:00:00”
-
FLOODED_AREA: The flooded area of the field (percentage)
Example URI
Headers
Content-Type: application/jsonBody
{
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
22.403781,
40.703388
],
[
22.403864,
40.70309
],
[
22.403968,
40.702733
],
[
22.404088,
40.702258
],
[
22.403781,
40.703388
]
]
]
},
"date": "2020-06-29"
}Schema
{
"$schema": "http://json-schema.org/draft-06/schema#",
"definitions": {
"crop_type": {
"type": "string",
"enum": [
"cotton",
"soya",
"maize",
"wheat"
]
},
"geometry": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"Point",
"Polygon"
]
}
},
"allOf": [
{
"if": {
"properties": {
"type": {
"const": "Point"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"minItems": 2,
"maxItems": 2,
"items": {
"type": "number"
}
}
}
}
},
{
"if": {
"properties": {
"type": {
"const": "Polygon"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"items": {
"type": "array",
"minItems": 4,
"items": {
"type": "array",
"minItems": 2,
"items": {
"type": "number"
}
}
}
}
}
}
}
],
"required": ["type", "coordinates"]
},
"bbox": {
"type": "array",
"minItems": 4,
"items": {
"type": "number"
}
},
"date": {
"type": "string",
"pattern": "^\d{4}\-(0?[1-9]|1[012])\-(0?[1-9]|[12][0-9]|3[01])$"
},
"identifier": {
"type": "string"
},
"scale": {
"type": "number",
"minimum": 0
},
"touch": {
"type": "boolean"
},
"stats": {
"type": "array",
"items": {
"type": "string",
"enum": [
"min",
"max",
"mean",
"count",
"sum",
"std",
"median",
"majority",
"minority",
"unique",
"range",
"nodata"
]
}
},
"integer": {
"type": "integer"
},
"number": {
"type": "number"
},
"boolean": {
"type": "boolean"
},
},
"type": "object",
"properties": {
"geometry": {
"$ref": "#/definitions/geometry"
},
"date": {
"$ref": "#/definitions/date"
}
},
"required": ["geometry", "date"]
}200Headers
Content-Type: image/tiff400Headers
Content-Type: application/json404Headers
Content-Type: application/json500Headers
Content-Type: application/jsonFloodMap SAR - Duration ¶
FloodMap (SAR / Duration)POST/farm/damage_assessment/flood_map_sar_duration
Generate the duration of the flooded areas of a field in number of days.
The resource accepts a JSON object containing the following properties:
-
geometry (geojson) - The boundaries of the field expressed in geojson format
-
date (string) - The date to use for the retrieval of the indicator
The output image will contain the following metadata:
-
SENSING_DATE: The sensing date eg. “2018-01-01”
-
SENSING_TIME: The sensing time eg. “13:00:00”
-
FLOODED_AREA: The flooded area of the field (percentage)
Example URI
Headers
Content-Type: application/jsonBody
{
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
21.77505900638673,
39.47720985491206
],
[
21.77740969833957,
39.47778848677738
],
[
21.78102614749779,
39.474678340501306
],
[
21.778964771477607,
39.47323176083802
],
[
21.776288599100525,
39.47456984702656
],
[
21.77621627011736,
39.47475066948447
],
[
21.77621627011736,
39.47475066948447
],
[
21.77505900638673,
39.47720985491206
]
]
]
},
"date": "2020-10-16"
}Schema
{
"$schema": "http://json-schema.org/draft-06/schema#",
"definitions": {
"crop_type": {
"type": "string",
"enum": [
"cotton",
"soya",
"maize",
"wheat"
]
},
"geometry": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"Point",
"Polygon"
]
}
},
"allOf": [
{
"if": {
"properties": {
"type": {
"const": "Point"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"minItems": 2,
"maxItems": 2,
"items": {
"type": "number"
}
}
}
}
},
{
"if": {
"properties": {
"type": {
"const": "Polygon"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"items": {
"type": "array",
"minItems": 4,
"items": {
"type": "array",
"minItems": 2,
"items": {
"type": "number"
}
}
}
}
}
}
}
],
"required": ["type", "coordinates"]
},
"bbox": {
"type": "array",
"minItems": 4,
"items": {
"type": "number"
}
},
"date": {
"type": "string",
"pattern": "^\d{4}\-(0?[1-9]|1[012])\-(0?[1-9]|[12][0-9]|3[01])$"
},
"identifier": {
"type": "string"
},
"scale": {
"type": "number",
"minimum": 0
},
"touch": {
"type": "boolean"
},
"stats": {
"type": "array",
"items": {
"type": "string",
"enum": [
"min",
"max",
"mean",
"count",
"sum",
"std",
"median",
"majority",
"minority",
"unique",
"range",
"nodata"
]
}
},
"integer": {
"type": "integer"
},
"number": {
"type": "number"
},
"boolean": {
"type": "boolean"
},
},
"type": "object",
"properties": {
"geometry": {
"$ref": "#/definitions/geometry"
},
"date": {
"$ref": "#/definitions/date"
}
},
"required": ["geometry", "date"]
}200Headers
Content-Type: image/tiff400Headers
Content-Type: application/json404Headers
Content-Type: application/json500Headers
Content-Type: application/jsonChange Detection ¶
Resources to provide change detection tools.
NDVI Anomaly ¶
NDVI AnomalyPOST/farm/change_detection/ndvi_anomaly
Generate the normalized difference vegetation index anomaly for a farm field.
The resource accepts a JSON object containing the following properties:
-
geometry (geojson) - The boundaries of the field expressed in geojson format
-
date (string) - The date to use for the retrieval of the indicator
-
index (string) - The index (one of “relative”, “absolute” or “z-score”)
The output image will contain the following metadata:
- TIFFTAG_IMAGEDESCRIPTION: The index, year, decad and date of the retrieved image eg. “ndvi_anomaly_relative_2019_313_20191109”
Example URI
Headers
Content-Type: application/jsonBody
{
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
-5.6137,
42.0221
],
[
-5.6095,
42.0221
],
[
-5.6095,
42.0241
],
[
-5.6137,
42.0241
],
[
-5.6137,
42.0221
]
]
]
},
"date": "2019-11-10",
"index": "relative"
}Schema
{
"$schema": "http://json-schema.org/draft-06/schema#",
"definitions": {
"crop_type": {
"type": "string",
"enum": [
"cotton",
"soya",
"maize",
"wheat"
]
},
"geometry": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"Point",
"Polygon"
]
}
},
"allOf": [
{
"if": {
"properties": {
"type": {
"const": "Point"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"minItems": 2,
"maxItems": 2,
"items": {
"type": "number"
}
}
}
}
},
{
"if": {
"properties": {
"type": {
"const": "Polygon"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"items": {
"type": "array",
"minItems": 4,
"items": {
"type": "array",
"minItems": 2,
"items": {
"type": "number"
}
}
}
}
}
}
}
],
"required": ["type", "coordinates"]
},
"bbox": {
"type": "array",
"minItems": 4,
"items": {
"type": "number"
}
},
"date": {
"type": "string",
"pattern": "^\d{4}\-(0?[1-9]|1[012])\-(0?[1-9]|[12][0-9]|3[01])$"
},
"identifier": {
"type": "string"
},
"scale": {
"type": "number",
"minimum": 0
},
"touch": {
"type": "boolean"
},
"stats": {
"type": "array",
"items": {
"type": "string",
"enum": [
"min",
"max",
"mean",
"count",
"sum",
"std",
"median",
"majority",
"minority",
"unique",
"range",
"nodata"
]
}
},
"integer": {
"type": "integer"
},
"number": {
"type": "number"
},
"boolean": {
"type": "boolean"
},
},
"type": "object",
"properties": {
"geometry": {
"$ref": "#/definitions/geometry"
},
"date": {
"$ref": "#/definitions/date"
},
"index": {
"type": "string",
"enum": ["relative", "absolute", "z-score"]
}
},
"required": ["geometry", "date", "index"]
}200Headers
Content-Type: image/tiff400Headers
Content-Type: application/json404Headers
Content-Type: application/json500Headers
Content-Type: application/jsonDMP Anomaly ¶
DMP AnomalyPOST/farm/change_detection/dmp_anomaly
Generate the dry matter productivity index anomaly for a farm field.
The resource accepts a JSON object containing the following properties:
-
geometry (geojson) - The boundaries of the field expressed in geojson format
-
date (string) - The date to use for the retrieval of the indicator
-
index (string) - The index (one of “relative”, “absolute” or “z-score”)
The output image will contain the following metadata:
- TIFFTAG_IMAGEDESCRIPTION: The index, year, decad and date of the retrieved image eg. “dmp300-rt5_absolute_2017_01_20170110”
Example URI
Headers
Content-Type: application/jsonBody
{
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
-5.6137,
42.0221
],
[
-5.6095,
42.0221
],
[
-5.6095,
42.0241
],
[
-5.6137,
42.0241
],
[
-5.6137,
42.0221
]
]
]
},
"date": "2017-01-10",
"index": "relative"
}Schema
{
"$schema": "http://json-schema.org/draft-06/schema#",
"definitions": {
"crop_type": {
"type": "string",
"enum": [
"cotton",
"soya",
"maize",
"wheat"
]
},
"geometry": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"Point",
"Polygon"
]
}
},
"allOf": [
{
"if": {
"properties": {
"type": {
"const": "Point"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"minItems": 2,
"maxItems": 2,
"items": {
"type": "number"
}
}
}
}
},
{
"if": {
"properties": {
"type": {
"const": "Polygon"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"items": {
"type": "array",
"minItems": 4,
"items": {
"type": "array",
"minItems": 2,
"items": {
"type": "number"
}
}
}
}
}
}
}
],
"required": ["type", "coordinates"]
},
"bbox": {
"type": "array",
"minItems": 4,
"items": {
"type": "number"
}
},
"date": {
"type": "string",
"pattern": "^\d{4}\-(0?[1-9]|1[012])\-(0?[1-9]|[12][0-9]|3[01])$"
},
"identifier": {
"type": "string"
},
"scale": {
"type": "number",
"minimum": 0
},
"touch": {
"type": "boolean"
},
"stats": {
"type": "array",
"items": {
"type": "string",
"enum": [
"min",
"max",
"mean",
"count",
"sum",
"std",
"median",
"majority",
"minority",
"unique",
"range",
"nodata"
]
}
},
"integer": {
"type": "integer"
},
"number": {
"type": "number"
},
"boolean": {
"type": "boolean"
},
},
"type": "object",
"properties": {
"geometry": {
"$ref": "#/definitions/geometry"
},
"date": {
"$ref": "#/definitions/date"
},
"index": {
"type": "string",
"enum": ["relative", "absolute", "z-score"]
}
},
"required": ["geometry", "date", "index"]
}200Headers
Content-Type: image/tiff400Headers
Content-Type: application/json404Headers
Content-Type: application/json500Headers
Content-Type: application/jsonFAPAR Anomaly ¶
FAPAR AnomalyPOST/farm/change_detection/fapar_anomaly
Generate the fraction of absorbed photosynthetically active radiation index anomaly for a farm field.
The resource accepts a JSON object containing the following properties:
-
geometry (geojson) - The boundaries of the field expressed in geojson format
-
date (string) - The date to use for the retrieval of the indicator
-
index (string) - The index (one of “relative”, “absolute” or “z-score”)
The output image will contain the following metadata:
- TIFFTAG_IMAGEDESCRIPTION: The index, year, decad and date of the retrieved image eg. “fapar300_absolute_2017_01_20170110”
Example URI
Headers
Content-Type: application/jsonBody
{
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
-5.6137,
42.0221
],
[
-5.6095,
42.0221
],
[
-5.6095,
42.0241
],
[
-5.6137,
42.0241
],
[
-5.6137,
42.0221
]
]
]
},
"date": "2017-01-10",
"index": "relative"
}Schema
{
"$schema": "http://json-schema.org/draft-06/schema#",
"definitions": {
"crop_type": {
"type": "string",
"enum": [
"cotton",
"soya",
"maize",
"wheat"
]
},
"geometry": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"Point",
"Polygon"
]
}
},
"allOf": [
{
"if": {
"properties": {
"type": {
"const": "Point"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"minItems": 2,
"maxItems": 2,
"items": {
"type": "number"
}
}
}
}
},
{
"if": {
"properties": {
"type": {
"const": "Polygon"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"items": {
"type": "array",
"minItems": 4,
"items": {
"type": "array",
"minItems": 2,
"items": {
"type": "number"
}
}
}
}
}
}
}
],
"required": ["type", "coordinates"]
},
"bbox": {
"type": "array",
"minItems": 4,
"items": {
"type": "number"
}
},
"date": {
"type": "string",
"pattern": "^\d{4}\-(0?[1-9]|1[012])\-(0?[1-9]|[12][0-9]|3[01])$"
},
"identifier": {
"type": "string"
},
"scale": {
"type": "number",
"minimum": 0
},
"touch": {
"type": "boolean"
},
"stats": {
"type": "array",
"items": {
"type": "string",
"enum": [
"min",
"max",
"mean",
"count",
"sum",
"std",
"median",
"majority",
"minority",
"unique",
"range",
"nodata"
]
}
},
"integer": {
"type": "integer"
},
"number": {
"type": "number"
},
"boolean": {
"type": "boolean"
},
},
"type": "object",
"properties": {
"geometry": {
"$ref": "#/definitions/geometry"
},
"date": {
"$ref": "#/definitions/date"
},
"index": {
"type": "string",
"enum": ["relative", "absolute", "z-score"]
}
},
"required": ["geometry", "date", "index"]
}200Headers
Content-Type: image/tiff400Headers
Content-Type: application/json404Headers
Content-Type: application/json500Headers
Content-Type: application/jsonDPI FAPAR ¶
DPI FAPARPOST/farm/change_detection/dpi_fapar
Generate the DPI FAPAR index for a farm field.
The resource accepts a JSON object containing the following properties:
-
geometry (geojson) - The boundaries of the field expressed in geojson format
-
date_pre (string) - The date (PRE) to use for calculating the PDI
-
date_post (string) - The date (POST) to use for calculating the PDI
-
inverse (boolean) - Whether to inverse the PDI
-
classify (boolean) - Whether to classify the PDI
The output image will contain the following metadata:
-
INDEX: The index eg. “FAPAR”
-
DATE_PRE: The date (PRE) of the retrieved image eg. “2019-08-14”
-
DATE_POST: The date (POST) of the retrieved image eg. “2019-09-10”
-
STATISTICS_DATE: The date before the event eg. “2019-08-17”
-
STATISTICS_COUNT: Count of pixels for the quality image before the event eg. 220
-
STATISTICS_SUM: Sum of pixels for the quality image before the event eg. 220
-
STATISTICS_MAX: Maximum pixel value for the quality image before the event eg. 1.0
-
STATISTICS_MIN: Minimum pixel value for the quality image before the event eg. 0.0
Example URI
Headers
Content-Type: application/jsonBody
{
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
-4.2609,
41.062
],
[
-4.2598,
41.062
],
[
-4.2598,
41.0613
],
[
-4.2609,
41.0613
],
[
-4.2609,
41.062
]
]
]
},
"date_pre": "2020-01-25",
"date_post": "2020-02-21",
"inverse": false,
"classify": false
}Schema
{
"$schema": "http://json-schema.org/draft-06/schema#",
"definitions": {
"crop_type": {
"type": "string",
"enum": [
"cotton",
"soya",
"maize",
"wheat"
]
},
"geometry": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"Point",
"Polygon"
]
}
},
"allOf": [
{
"if": {
"properties": {
"type": {
"const": "Point"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"minItems": 2,
"maxItems": 2,
"items": {
"type": "number"
}
}
}
}
},
{
"if": {
"properties": {
"type": {
"const": "Polygon"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"items": {
"type": "array",
"minItems": 4,
"items": {
"type": "array",
"minItems": 2,
"items": {
"type": "number"
}
}
}
}
}
}
}
],
"required": ["type", "coordinates"]
},
"bbox": {
"type": "array",
"minItems": 4,
"items": {
"type": "number"
}
},
"date": {
"type": "string",
"pattern": "^\d{4}\-(0?[1-9]|1[012])\-(0?[1-9]|[12][0-9]|3[01])$"
},
"identifier": {
"type": "string"
},
"scale": {
"type": "number",
"minimum": 0
},
"touch": {
"type": "boolean"
},
"stats": {
"type": "array",
"items": {
"type": "string",
"enum": [
"min",
"max",
"mean",
"count",
"sum",
"std",
"median",
"majority",
"minority",
"unique",
"range",
"nodata"
]
}
},
"integer": {
"type": "integer"
},
"number": {
"type": "number"
},
"boolean": {
"type": "boolean"
},
},
"type": "object",
"properties": {
"geometry": {
"$ref": "#/definitions/geometry"
},
"date_pre": {
"$ref": "#/definitions/date"
},
"date_post": {
"$ref": "#/definitions/date"
},
"inverse": {
"$ref": "#/definitions/boolean"
},
"classify": {
"$ref": "#/definitions/boolean"
}
},
"required": ["geometry", "date_pre", "date_post"]
}200Headers
Content-Type: image/tiff400Headers
Content-Type: application/json404Headers
Content-Type: application/json500Headers
Content-Type: application/jsonDPI FCOVER ¶
DPI FCOVERPOST/farm/change_detection/dpi_fcover
Generate the DPI FCOVER index for a farm field.
The resource accepts a JSON object containing the following properties:
-
geometry (geojson) - The boundaries of the field expressed in geojson format
-
date_pre (string) - The date (PRE) to use for calculating the PDI
-
date_post (string) - The date (POST) to use for calculating the PDI
-
inverse (boolean) - Whether to inverse the PDI
-
classify (boolean) - Whether to classify the PDI
The output image will contain the following metadata:
-
INDEX: The index eg. “FCOVER”
-
DATE_PRE: The date (PRE) of the retrieved image eg. “2019-08-14”
-
DATE_POST: The date (POST) of the retrieved image eg. “2019-09-10”
-
STATISTICS_DATE: The date before the event eg. “2019-08-17”
-
STATISTICS_COUNT: Count of pixels for the quality image before the event eg. 220
-
STATISTICS_SUM: Sum of pixels for the quality image before the event eg. 220
-
STATISTICS_MAX: Maximum pixel value for the quality image before the event eg. 1.0
-
STATISTICS_MIN: Minimum pixel value for the quality image before the event eg. 0.0
Example URI
Headers
Content-Type: application/jsonBody
{
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
-4.2609,
41.062
],
[
-4.2598,
41.062
],
[
-4.2598,
41.0613
],
[
-4.2609,
41.0613
],
[
-4.2609,
41.062
]
]
]
},
"date_pre": "2020-01-25",
"date_post": "2020-02-21",
"inverse": false,
"classify": false
}Schema
{
"$schema": "http://json-schema.org/draft-06/schema#",
"definitions": {
"crop_type": {
"type": "string",
"enum": [
"cotton",
"soya",
"maize",
"wheat"
]
},
"geometry": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"Point",
"Polygon"
]
}
},
"allOf": [
{
"if": {
"properties": {
"type": {
"const": "Point"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"minItems": 2,
"maxItems": 2,
"items": {
"type": "number"
}
}
}
}
},
{
"if": {
"properties": {
"type": {
"const": "Polygon"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"items": {
"type": "array",
"minItems": 4,
"items": {
"type": "array",
"minItems": 2,
"items": {
"type": "number"
}
}
}
}
}
}
}
],
"required": ["type", "coordinates"]
},
"bbox": {
"type": "array",
"minItems": 4,
"items": {
"type": "number"
}
},
"date": {
"type": "string",
"pattern": "^\d{4}\-(0?[1-9]|1[012])\-(0?[1-9]|[12][0-9]|3[01])$"
},
"identifier": {
"type": "string"
},
"scale": {
"type": "number",
"minimum": 0
},
"touch": {
"type": "boolean"
},
"stats": {
"type": "array",
"items": {
"type": "string",
"enum": [
"min",
"max",
"mean",
"count",
"sum",
"std",
"median",
"majority",
"minority",
"unique",
"range",
"nodata"
]
}
},
"integer": {
"type": "integer"
},
"number": {
"type": "number"
},
"boolean": {
"type": "boolean"
},
},
"type": "object",
"properties": {
"geometry": {
"$ref": "#/definitions/geometry"
},
"date_pre": {
"$ref": "#/definitions/date"
},
"date_post": {
"$ref": "#/definitions/date"
},
"inverse": {
"$ref": "#/definitions/boolean"
},
"classify": {
"$ref": "#/definitions/boolean"
}
},
"required": ["geometry", "date_pre", "date_post"]
}200Headers
Content-Type: image/tiff400Headers
Content-Type: application/json404Headers
Content-Type: application/json500Headers
Content-Type: application/jsonDPI GNDVI ¶
DPI GNDVIPOST/farm/change_detection/dpi_gndvi
Generate the DPI GNDVI index for a farm field.
The resource accepts a JSON object containing the following properties:
-
geometry (geojson) - The boundaries of the field expressed in geojson format
-
date_pre (string) - The date (PRE) to use for calculating the PDI
-
date_post (string) - The date (POST) to use for calculating the PDI
-
inverse (boolean) - Whether to inverse the PDI
-
classify (boolean) - Whether to classify the PDI
The output image will contain the following metadata:
-
INDEX: The index eg. “GNDVI”
-
DATE_PRE: The date (PRE) of the retrieved image eg. “2019-08-14”
-
DATE_POST: The date (POST) of the retrieved image eg. “2019-09-10”
-
STATISTICS_DATE: The date before the event eg. “2019-08-17”
-
STATISTICS_COUNT: Count of pixels for the quality image before the event eg. 220
-
STATISTICS_SUM: Sum of pixels for the quality image before the event eg. 220
-
STATISTICS_MAX: Maximum pixel value for the quality image before the event eg. 1.0
-
STATISTICS_MIN: Minimum pixel value for the quality image before the event eg. 0.0
Example URI
Headers
Content-Type: application/jsonBody
{
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
-4.2609,
41.062
],
[
-4.2598,
41.062
],
[
-4.2598,
41.0613
],
[
-4.2609,
41.0613
],
[
-4.2609,
41.062
]
]
]
},
"date_pre": "2020-01-25",
"date_post": "2020-02-21",
"inverse": false,
"classify": false
}Schema
{
"$schema": "http://json-schema.org/draft-06/schema#",
"definitions": {
"crop_type": {
"type": "string",
"enum": [
"cotton",
"soya",
"maize",
"wheat"
]
},
"geometry": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"Point",
"Polygon"
]
}
},
"allOf": [
{
"if": {
"properties": {
"type": {
"const": "Point"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"minItems": 2,
"maxItems": 2,
"items": {
"type": "number"
}
}
}
}
},
{
"if": {
"properties": {
"type": {
"const": "Polygon"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"items": {
"type": "array",
"minItems": 4,
"items": {
"type": "array",
"minItems": 2,
"items": {
"type": "number"
}
}
}
}
}
}
}
],
"required": ["type", "coordinates"]
},
"bbox": {
"type": "array",
"minItems": 4,
"items": {
"type": "number"
}
},
"date": {
"type": "string",
"pattern": "^\d{4}\-(0?[1-9]|1[012])\-(0?[1-9]|[12][0-9]|3[01])$"
},
"identifier": {
"type": "string"
},
"scale": {
"type": "number",
"minimum": 0
},
"touch": {
"type": "boolean"
},
"stats": {
"type": "array",
"items": {
"type": "string",
"enum": [
"min",
"max",
"mean",
"count",
"sum",
"std",
"median",
"majority",
"minority",
"unique",
"range",
"nodata"
]
}
},
"integer": {
"type": "integer"
},
"number": {
"type": "number"
},
"boolean": {
"type": "boolean"
},
},
"type": "object",
"properties": {
"geometry": {
"$ref": "#/definitions/geometry"
},
"date_pre": {
"$ref": "#/definitions/date"
},
"date_post": {
"$ref": "#/definitions/date"
},
"inverse": {
"$ref": "#/definitions/boolean"
},
"classify": {
"$ref": "#/definitions/boolean"
}
},
"required": ["geometry", "date_pre", "date_post"]
}200Headers
Content-Type: image/tiff400Headers
Content-Type: application/json404Headers
Content-Type: application/json500Headers
Content-Type: application/jsonDPI LAI ¶
DPI LAIPOST/farm/change_detection/dpi_lai
Generate the DPI LAI index for a farm field.
The resource accepts a JSON object containing the following properties:
-
geometry (geojson) - The boundaries of the field expressed in geojson format
-
date_pre (string) - The date (PRE) to use for calculating the PDI
-
date_post (string) - The date (POST) to use for calculating the PDI
-
inverse (boolean) - Whether to inverse the PDI
-
classify (boolean) - Whether to classify the PDI
The output image will contain the following metadata:
-
INDEX: The index eg. “LAI”
-
DATE_PRE: The date (PRE) of the retrieved image eg. “2019-08-14”
-
DATE_POST: The date (POST) of the retrieved image eg. “2019-09-10”
-
STATISTICS_DATE: The date before the event eg. “2019-08-17”
-
STATISTICS_COUNT: Count of pixels for the quality image before the event eg. 220
-
STATISTICS_SUM: Sum of pixels for the quality image before the event eg. 220
-
STATISTICS_MAX: Maximum pixel value for the quality image before the event eg. 1.0
-
STATISTICS_MIN: Minimum pixel value for the quality image before the event eg. 0.0
Example URI
Headers
Content-Type: application/jsonBody
{
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
-4.2609,
41.062
],
[
-4.2598,
41.062
],
[
-4.2598,
41.0613
],
[
-4.2609,
41.0613
],
[
-4.2609,
41.062
]
]
]
},
"date_pre": "2020-01-25",
"date_post": "2020-02-21",
"inverse": false,
"classify": false
}Schema
{
"$schema": "http://json-schema.org/draft-06/schema#",
"definitions": {
"crop_type": {
"type": "string",
"enum": [
"cotton",
"soya",
"maize",
"wheat"
]
},
"geometry": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"Point",
"Polygon"
]
}
},
"allOf": [
{
"if": {
"properties": {
"type": {
"const": "Point"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"minItems": 2,
"maxItems": 2,
"items": {
"type": "number"
}
}
}
}
},
{
"if": {
"properties": {
"type": {
"const": "Polygon"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"items": {
"type": "array",
"minItems": 4,
"items": {
"type": "array",
"minItems": 2,
"items": {
"type": "number"
}
}
}
}
}
}
}
],
"required": ["type", "coordinates"]
},
"bbox": {
"type": "array",
"minItems": 4,
"items": {
"type": "number"
}
},
"date": {
"type": "string",
"pattern": "^\d{4}\-(0?[1-9]|1[012])\-(0?[1-9]|[12][0-9]|3[01])$"
},
"identifier": {
"type": "string"
},
"scale": {
"type": "number",
"minimum": 0
},
"touch": {
"type": "boolean"
},
"stats": {
"type": "array",
"items": {
"type": "string",
"enum": [
"min",
"max",
"mean",
"count",
"sum",
"std",
"median",
"majority",
"minority",
"unique",
"range",
"nodata"
]
}
},
"integer": {
"type": "integer"
},
"number": {
"type": "number"
},
"boolean": {
"type": "boolean"
},
},
"type": "object",
"properties": {
"geometry": {
"$ref": "#/definitions/geometry"
},
"date_pre": {
"$ref": "#/definitions/date"
},
"date_post": {
"$ref": "#/definitions/date"
},
"inverse": {
"$ref": "#/definitions/boolean"
},
"classify": {
"$ref": "#/definitions/boolean"
}
},
"required": ["geometry", "date_pre", "date_post"]
}200Headers
Content-Type: image/tiff400Headers
Content-Type: application/json404Headers
Content-Type: application/json500Headers
Content-Type: application/jsonDPI MCARI ¶
DPI MCARIPOST/farm/change_detection/dpi_mcari
Generate the DPI MCARI index for a farm field.
The resource accepts a JSON object containing the following properties:
-
geometry (geojson) - The boundaries of the field expressed in geojson format
-
date_pre (string) - The date (PRE) to use for calculating the PDI
-
date_post (string) - The date (POST) to use for calculating the PDI
-
inverse (boolean) - Whether to inverse the PDI
-
classify (boolean) - Whether to classify the PDI
The output image will contain the following metadata:
-
INDEX: The index eg. “MCARI”
-
DATE_PRE: The date (PRE) of the retrieved image eg. “2019-08-14”
-
DATE_POST: The date (POST) of the retrieved image eg. “2019-09-10”
-
STATISTICS_DATE: The date before the event eg. “2019-08-17”
-
STATISTICS_COUNT: Count of pixels for the quality image before the event eg. 220
-
STATISTICS_SUM: Sum of pixels for the quality image before the event eg. 220
-
STATISTICS_MAX: Maximum pixel value for the quality image before the event eg. 1.0
-
STATISTICS_MIN: Minimum pixel value for the quality image before the event eg. 0.0
Example URI
Headers
Content-Type: application/jsonBody
{
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
-4.2609,
41.062
],
[
-4.2598,
41.062
],
[
-4.2598,
41.0613
],
[
-4.2609,
41.0613
],
[
-4.2609,
41.062
]
]
]
},
"date_pre": "2020-01-25",
"date_post": "2020-02-21",
"inverse": false,
"classify": false
}Schema
{
"$schema": "http://json-schema.org/draft-06/schema#",
"definitions": {
"crop_type": {
"type": "string",
"enum": [
"cotton",
"soya",
"maize",
"wheat"
]
},
"geometry": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"Point",
"Polygon"
]
}
},
"allOf": [
{
"if": {
"properties": {
"type": {
"const": "Point"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"minItems": 2,
"maxItems": 2,
"items": {
"type": "number"
}
}
}
}
},
{
"if": {
"properties": {
"type": {
"const": "Polygon"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"items": {
"type": "array",
"minItems": 4,
"items": {
"type": "array",
"minItems": 2,
"items": {
"type": "number"
}
}
}
}
}
}
}
],
"required": ["type", "coordinates"]
},
"bbox": {
"type": "array",
"minItems": 4,
"items": {
"type": "number"
}
},
"date": {
"type": "string",
"pattern": "^\d{4}\-(0?[1-9]|1[012])\-(0?[1-9]|[12][0-9]|3[01])$"
},
"identifier": {
"type": "string"
},
"scale": {
"type": "number",
"minimum": 0
},
"touch": {
"type": "boolean"
},
"stats": {
"type": "array",
"items": {
"type": "string",
"enum": [
"min",
"max",
"mean",
"count",
"sum",
"std",
"median",
"majority",
"minority",
"unique",
"range",
"nodata"
]
}
},
"integer": {
"type": "integer"
},
"number": {
"type": "number"
},
"boolean": {
"type": "boolean"
},
},
"type": "object",
"properties": {
"geometry": {
"$ref": "#/definitions/geometry"
},
"date_pre": {
"$ref": "#/definitions/date"
},
"date_post": {
"$ref": "#/definitions/date"
},
"inverse": {
"$ref": "#/definitions/boolean"
},
"classify": {
"$ref": "#/definitions/boolean"
}
},
"required": ["geometry", "date_pre", "date_post"]
}200Headers
Content-Type: image/tiff400Headers
Content-Type: application/json404Headers
Content-Type: application/json500Headers
Content-Type: application/jsonDPI MPDI ¶
DPI MPDIPOST/farm/change_detection/dpi_mpdi
Generate the DPI MPDI index for a farm field.
The resource accepts a JSON object containing the following properties:
-
geometry (geojson) - The boundaries of the field expressed in geojson format
-
date_pre (string) - The date (PRE) to use for calculating the PDI
-
date_post (string) - The date (POST) to use for calculating the PDI
-
inverse (boolean) - Whether to inverse the PDI
-
classify (boolean) - Whether to classify the PDI
The output image will contain the following metadata:
-
INDEX: The index eg. “MPDI”
-
DATE_PRE: The date (PRE) of the retrieved image eg. “2019-08-14”
-
DATE_POST: The date (POST) of the retrieved image eg. “2019-09-10”
-
STATISTICS_DATE: The date before the event eg. “2019-08-17”
-
STATISTICS_COUNT: Count of pixels for the quality image before the event eg. 220
-
STATISTICS_SUM: Sum of pixels for the quality image before the event eg. 220
-
STATISTICS_MAX: Maximum pixel value for the quality image before the event eg. 1.0
-
STATISTICS_MIN: Minimum pixel value for the quality image before the event eg. 0.0
Example URI
Headers
Content-Type: application/jsonBody
{
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
-4.2609,
41.062
],
[
-4.2598,
41.062
],
[
-4.2598,
41.0613
],
[
-4.2609,
41.0613
],
[
-4.2609,
41.062
]
]
]
},
"date_pre": "2020-03-03",
"date_post": "2020-03-30",
"inverse": false,
"classify": false
}Schema
{
"$schema": "http://json-schema.org/draft-06/schema#",
"definitions": {
"crop_type": {
"type": "string",
"enum": [
"cotton",
"soya",
"maize",
"wheat"
]
},
"geometry": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"Point",
"Polygon"
]
}
},
"allOf": [
{
"if": {
"properties": {
"type": {
"const": "Point"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"minItems": 2,
"maxItems": 2,
"items": {
"type": "number"
}
}
}
}
},
{
"if": {
"properties": {
"type": {
"const": "Polygon"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"items": {
"type": "array",
"minItems": 4,
"items": {
"type": "array",
"minItems": 2,
"items": {
"type": "number"
}
}
}
}
}
}
}
],
"required": ["type", "coordinates"]
},
"bbox": {
"type": "array",
"minItems": 4,
"items": {
"type": "number"
}
},
"date": {
"type": "string",
"pattern": "^\d{4}\-(0?[1-9]|1[012])\-(0?[1-9]|[12][0-9]|3[01])$"
},
"identifier": {
"type": "string"
},
"scale": {
"type": "number",
"minimum": 0
},
"touch": {
"type": "boolean"
},
"stats": {
"type": "array",
"items": {
"type": "string",
"enum": [
"min",
"max",
"mean",
"count",
"sum",
"std",
"median",
"majority",
"minority",
"unique",
"range",
"nodata"
]
}
},
"integer": {
"type": "integer"
},
"number": {
"type": "number"
},
"boolean": {
"type": "boolean"
},
},
"type": "object",
"properties": {
"geometry": {
"$ref": "#/definitions/geometry"
},
"date_pre": {
"$ref": "#/definitions/date"
},
"date_post": {
"$ref": "#/definitions/date"
},
"inverse": {
"$ref": "#/definitions/boolean"
},
"classify": {
"$ref": "#/definitions/boolean"
}
},
"required": ["geometry", "date_pre", "date_post"]
}200Headers
Content-Type: image/tiff400Headers
Content-Type: application/json404Headers
Content-Type: application/json500Headers
Content-Type: application/jsonDPI NDVI ¶
DPI NDVIPOST/farm/change_detection/dpi_ndvi
Generate the DPI NDVI index for a farm field.
The resource accepts a JSON object containing the following properties:
-
geometry (geojson) - The boundaries of the field expressed in geojson format
-
date_pre (string) - The date (PRE) to use for calculating the PDI
-
date_post (string) - The date (POST) to use for calculating the PDI
-
inverse (boolean) - Whether to inverse the PDI
-
classify (boolean) - Whether to classify the PDI
The output image will contain the following metadata:
-
INDEX: The index eg. “NDVI”
-
DATE_PRE: The date (PRE) of the retrieved image eg. “2019-08-14”
-
DATE_POST: The date (POST) of the retrieved image eg. “2019-09-10”
-
STATISTICS_DATE: The date before the event eg. “2019-08-17”
-
STATISTICS_COUNT: Count of pixels for the quality image before the event eg. 220
-
STATISTICS_SUM: Sum of pixels for the quality image before the event eg. 220
-
STATISTICS_MAX: Maximum pixel value for the quality image before the event eg. 1.0
-
STATISTICS_MIN: Minimum pixel value for the quality image before the event eg. 0.0
Example URI
Headers
Content-Type: application/jsonBody
{
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
-4.2609,
41.062
],
[
-4.2598,
41.062
],
[
-4.2598,
41.0613
],
[
-4.2609,
41.0613
],
[
-4.2609,
41.062
]
]
]
},
"date_pre": "2020-01-25",
"date_post": "2020-02-21",
"inverse": false,
"classify": false
}Schema
{
"$schema": "http://json-schema.org/draft-06/schema#",
"definitions": {
"crop_type": {
"type": "string",
"enum": [
"cotton",
"soya",
"maize",
"wheat"
]
},
"geometry": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"Point",
"Polygon"
]
}
},
"allOf": [
{
"if": {
"properties": {
"type": {
"const": "Point"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"minItems": 2,
"maxItems": 2,
"items": {
"type": "number"
}
}
}
}
},
{
"if": {
"properties": {
"type": {
"const": "Polygon"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"items": {
"type": "array",
"minItems": 4,
"items": {
"type": "array",
"minItems": 2,
"items": {
"type": "number"
}
}
}
}
}
}
}
],
"required": ["type", "coordinates"]
},
"bbox": {
"type": "array",
"minItems": 4,
"items": {
"type": "number"
}
},
"date": {
"type": "string",
"pattern": "^\d{4}\-(0?[1-9]|1[012])\-(0?[1-9]|[12][0-9]|3[01])$"
},
"identifier": {
"type": "string"
},
"scale": {
"type": "number",
"minimum": 0
},
"touch": {
"type": "boolean"
},
"stats": {
"type": "array",
"items": {
"type": "string",
"enum": [
"min",
"max",
"mean",
"count",
"sum",
"std",
"median",
"majority",
"minority",
"unique",
"range",
"nodata"
]
}
},
"integer": {
"type": "integer"
},
"number": {
"type": "number"
},
"boolean": {
"type": "boolean"
},
},
"type": "object",
"properties": {
"geometry": {
"$ref": "#/definitions/geometry"
},
"date_pre": {
"$ref": "#/definitions/date"
},
"date_post": {
"$ref": "#/definitions/date"
},
"inverse": {
"$ref": "#/definitions/boolean"
},
"classify": {
"$ref": "#/definitions/boolean"
}
},
"required": ["geometry", "date_pre", "date_post"]
}200Headers
Content-Type: image/tiff400Headers
Content-Type: application/json404Headers
Content-Type: application/json500Headers
Content-Type: application/jsonDPI REIP ¶
DPI REIPPOST/farm/change_detection/dpi_reip
Generate the DPI REIP index for a farm field.
The resource accepts a JSON object containing the following properties:
-
geometry (geojson) - The boundaries of the field expressed in geojson format
-
date_pre (string) - The date (PRE) to use for calculating the PDI
-
date_post (string) - The date (POST) to use for calculating the PDI
-
inverse (boolean) - Whether to inverse the PDI
-
classify (boolean) - Whether to classify the PDI
The output image will contain the following metadata:
-
INDEX: The index eg. “REIP”
-
DATE_PRE: The date (PRE) of the retrieved image eg. “2019-08-14”
-
DATE_POST: The date (POST) of the retrieved image eg. “2019-09-10”
-
STATISTICS_DATE: The date before the event eg. “2019-08-17”
-
STATISTICS_COUNT: Count of pixels for the quality image before the event eg. 220
-
STATISTICS_SUM: Sum of pixels for the quality image before the event eg. 220
-
STATISTICS_MAX: Maximum pixel value for the quality image before the event eg. 1.0
-
STATISTICS_MIN: Minimum pixel value for the quality image before the event eg. 0.0
Example URI
Headers
Content-Type: application/jsonBody
{
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
-4.2609,
41.062
],
[
-4.2598,
41.062
],
[
-4.2598,
41.0613
],
[
-4.2609,
41.0613
],
[
-4.2609,
41.062
]
]
]
},
"date_pre": "2020-01-25",
"date_post": "2020-02-21",
"inverse": false,
"classify": false
}Schema
{
"$schema": "http://json-schema.org/draft-06/schema#",
"definitions": {
"crop_type": {
"type": "string",
"enum": [
"cotton",
"soya",
"maize",
"wheat"
]
},
"geometry": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"Point",
"Polygon"
]
}
},
"allOf": [
{
"if": {
"properties": {
"type": {
"const": "Point"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"minItems": 2,
"maxItems": 2,
"items": {
"type": "number"
}
}
}
}
},
{
"if": {
"properties": {
"type": {
"const": "Polygon"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"items": {
"type": "array",
"minItems": 4,
"items": {
"type": "array",
"minItems": 2,
"items": {
"type": "number"
}
}
}
}
}
}
}
],
"required": ["type", "coordinates"]
},
"bbox": {
"type": "array",
"minItems": 4,
"items": {
"type": "number"
}
},
"date": {
"type": "string",
"pattern": "^\d{4}\-(0?[1-9]|1[012])\-(0?[1-9]|[12][0-9]|3[01])$"
},
"identifier": {
"type": "string"
},
"scale": {
"type": "number",
"minimum": 0
},
"touch": {
"type": "boolean"
},
"stats": {
"type": "array",
"items": {
"type": "string",
"enum": [
"min",
"max",
"mean",
"count",
"sum",
"std",
"median",
"majority",
"minority",
"unique",
"range",
"nodata"
]
}
},
"integer": {
"type": "integer"
},
"number": {
"type": "number"
},
"boolean": {
"type": "boolean"
},
},
"type": "object",
"properties": {
"geometry": {
"$ref": "#/definitions/geometry"
},
"date_pre": {
"$ref": "#/definitions/date"
},
"date_post": {
"$ref": "#/definitions/date"
},
"inverse": {
"$ref": "#/definitions/boolean"
},
"classify": {
"$ref": "#/definitions/boolean"
}
},
"required": ["geometry", "date_pre", "date_post"]
}200Headers
Content-Type: image/tiff400Headers
Content-Type: application/json404Headers
Content-Type: application/json500Headers
Content-Type: application/jsonDPI SigmaVH ¶
DPI SigmaVHPOST/farm/change_detection/dpi_sigma_vh
Generate the DPI SigmaVH index for a farm field.
The resource accepts a JSON object containing the following properties:
-
geometry (geojson) - The boundaries of the field expressed in geojson format
-
date_pre (string) - The date (PRE) to use for calculating the PDI
-
date_post (string) - The date (POST) to use for calculating the PDI
-
inverse (boolean) - Whether to inverse the PDI
-
classify (boolean) - Whether to classify the PDI
The output image will contain the following metadata:
-
INDEX: The index eg. “SigmaVH”
-
DATE_PRE: The date (PRE) of the retrieved image eg. “2019-08-14”
-
DATE_POST: The date (POST) of the retrieved image eg. “2019-09-10”
-
STATISTICS_DATE: The date before the event eg. “2019-08-17”
-
STATISTICS_COUNT: Count of pixels for the quality image before the event eg. 220
-
STATISTICS_SUM: Sum of pixels for the quality image before the event eg. 220
-
STATISTICS_MAX: Maximum pixel value for the quality image before the event eg. 1.0
-
STATISTICS_MIN: Minimum pixel value for the quality image before the event eg. 0.0
Example URI
Headers
Content-Type: application/jsonBody
{
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
-4.2609,
41.062
],
[
-4.2598,
41.062
],
[
-4.2598,
41.0613
],
[
-4.2609,
41.0613
],
[
-4.2609,
41.062
]
]
]
},
"date_pre": "2020-03-03",
"date_post": "2020-03-30",
"inverse": false,
"classify": false
}Schema
{
"$schema": "http://json-schema.org/draft-06/schema#",
"definitions": {
"crop_type": {
"type": "string",
"enum": [
"cotton",
"soya",
"maize",
"wheat"
]
},
"geometry": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"Point",
"Polygon"
]
}
},
"allOf": [
{
"if": {
"properties": {
"type": {
"const": "Point"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"minItems": 2,
"maxItems": 2,
"items": {
"type": "number"
}
}
}
}
},
{
"if": {
"properties": {
"type": {
"const": "Polygon"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"items": {
"type": "array",
"minItems": 4,
"items": {
"type": "array",
"minItems": 2,
"items": {
"type": "number"
}
}
}
}
}
}
}
],
"required": ["type", "coordinates"]
},
"bbox": {
"type": "array",
"minItems": 4,
"items": {
"type": "number"
}
},
"date": {
"type": "string",
"pattern": "^\d{4}\-(0?[1-9]|1[012])\-(0?[1-9]|[12][0-9]|3[01])$"
},
"identifier": {
"type": "string"
},
"scale": {
"type": "number",
"minimum": 0
},
"touch": {
"type": "boolean"
},
"stats": {
"type": "array",
"items": {
"type": "string",
"enum": [
"min",
"max",
"mean",
"count",
"sum",
"std",
"median",
"majority",
"minority",
"unique",
"range",
"nodata"
]
}
},
"integer": {
"type": "integer"
},
"number": {
"type": "number"
},
"boolean": {
"type": "boolean"
},
},
"type": "object",
"properties": {
"geometry": {
"$ref": "#/definitions/geometry"
},
"date_pre": {
"$ref": "#/definitions/date"
},
"date_post": {
"$ref": "#/definitions/date"
},
"inverse": {
"$ref": "#/definitions/boolean"
},
"classify": {
"$ref": "#/definitions/boolean"
}
},
"required": ["geometry", "date_pre", "date_post"]
}200Headers
Content-Type: image/tiff400Headers
Content-Type: application/json404Headers
Content-Type: application/json500Headers
Content-Type: application/jsonDPI SigmaVV ¶
DPI SigmaVVPOST/farm/change_detection/dpi_sigma_vv
Generate the DPI SigmaVV index for a farm field.
The resource accepts a JSON object containing the following properties:
-
geometry (geojson) - The boundaries of the field expressed in geojson format
-
date_pre (string) - The date (PRE) to use for calculating the PDI
-
date_post (string) - The date (POST) to use for calculating the PDI
-
inverse (boolean) - Whether to inverse the PDI
-
classify (boolean) - Whether to classify the PDI
The output image will contain the following metadata:
-
INDEX: The index eg. “SigmaVV”
-
DATE_PRE: The date (PRE) of the retrieved image eg. “2019-08-14”
-
DATE_POST: The date (POST) of the retrieved image eg. “2019-09-10”
-
STATISTICS_DATE: The date before the event eg. “2019-08-17”
-
STATISTICS_COUNT: Count of pixels for the quality image before the event eg. 220
-
STATISTICS_SUM: Sum of pixels for the quality image before the event eg. 220
-
STATISTICS_MAX: Maximum pixel value for the quality image before the event eg. 1.0
-
STATISTICS_MIN: Minimum pixel value for the quality image before the event eg. 0.0
Example URI
Headers
Content-Type: application/jsonBody
{
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
-4.2609,
41.062
],
[
-4.2598,
41.062
],
[
-4.2598,
41.0613
],
[
-4.2609,
41.0613
],
[
-4.2609,
41.062
]
]
]
},
"date_pre": "2020-03-03",
"date_post": "2020-03-30",
"inverse": false,
"classify": false
}Schema
{
"$schema": "http://json-schema.org/draft-06/schema#",
"definitions": {
"crop_type": {
"type": "string",
"enum": [
"cotton",
"soya",
"maize",
"wheat"
]
},
"geometry": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"Point",
"Polygon"
]
}
},
"allOf": [
{
"if": {
"properties": {
"type": {
"const": "Point"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"minItems": 2,
"maxItems": 2,
"items": {
"type": "number"
}
}
}
}
},
{
"if": {
"properties": {
"type": {
"const": "Polygon"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"items": {
"type": "array",
"minItems": 4,
"items": {
"type": "array",
"minItems": 2,
"items": {
"type": "number"
}
}
}
}
}
}
}
],
"required": ["type", "coordinates"]
},
"bbox": {
"type": "array",
"minItems": 4,
"items": {
"type": "number"
}
},
"date": {
"type": "string",
"pattern": "^\d{4}\-(0?[1-9]|1[012])\-(0?[1-9]|[12][0-9]|3[01])$"
},
"identifier": {
"type": "string"
},
"scale": {
"type": "number",
"minimum": 0
},
"touch": {
"type": "boolean"
},
"stats": {
"type": "array",
"items": {
"type": "string",
"enum": [
"min",
"max",
"mean",
"count",
"sum",
"std",
"median",
"majority",
"minority",
"unique",
"range",
"nodata"
]
}
},
"integer": {
"type": "integer"
},
"number": {
"type": "number"
},
"boolean": {
"type": "boolean"
},
},
"type": "object",
"properties": {
"geometry": {
"$ref": "#/definitions/geometry"
},
"date_pre": {
"$ref": "#/definitions/date"
},
"date_post": {
"$ref": "#/definitions/date"
},
"inverse": {
"$ref": "#/definitions/boolean"
},
"classify": {
"$ref": "#/definitions/boolean"
}
},
"required": ["geometry", "date_pre", "date_post"]
}200Headers
Content-Type: image/tiff400Headers
Content-Type: application/json404Headers
Content-Type: application/json500Headers
Content-Type: application/jsonZonal Statistics ¶
Resources to provide zonal statistics.
Zonal Statistics for NDVI Anomaly ¶
NDVI AnomalyPOST/farm/zonal_analysis/zonal_statistics/ndvi_anomaly
Generate zonal statistics based on the normalized difference vegetation index anomaly for a farm field.
The resource accepts a JSON object containing the following properties:
-
geometry (geojson) - The boundaries of the field expressed in geojson format
-
date (string) - The date to use for the retrieval of the indicator
-
index (string) - The index (one of “relative”, “absolute” or “z-score”)
-
stats (list) - A list of the requested statistics. Supported statistics are: [“min”, “max”, “mean”, “count”, “sum”, “std”, “median”, “majority”, “minority”, “unique”, “range”, “nodata”]
In case the supplied geometry is a POINT and you provide a radius (in meters), a geodesic buffer will be created and used for the calculations of the zonal statistics.
The output json will contain the requested statistics with their corresponding values and the sensing date of the image.
Example URI
Headers
Content-Type: application/jsonBody
{
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
-5.6137,
42.0221
],
[
-5.6095,
42.0221
],
[
-5.6095,
42.0241
],
[
-5.6137,
42.0241
],
[
-5.6137,
42.0221
]
]
]
},
"date": "2015-01-10",
"index": "relative",
"stats": [
"min",
"max"
]
}Schema
{
"$schema": "http://json-schema.org/draft-06/schema#",
"definitions": {
"crop_type": {
"type": "string",
"enum": [
"cotton",
"soya",
"maize",
"wheat"
]
},
"geometry": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"Point",
"Polygon"
]
}
},
"allOf": [
{
"if": {
"properties": {
"type": {
"const": "Point"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"minItems": 2,
"maxItems": 2,
"items": {
"type": "number"
}
}
}
}
},
{
"if": {
"properties": {
"type": {
"const": "Polygon"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"items": {
"type": "array",
"minItems": 4,
"items": {
"type": "array",
"minItems": 2,
"items": {
"type": "number"
}
}
}
}
}
}
}
],
"required": ["type", "coordinates"]
},
"bbox": {
"type": "array",
"minItems": 4,
"items": {
"type": "number"
}
},
"date": {
"type": "string",
"pattern": "^\d{4}\-(0?[1-9]|1[012])\-(0?[1-9]|[12][0-9]|3[01])$"
},
"identifier": {
"type": "string"
},
"scale": {
"type": "number",
"minimum": 0
},
"touch": {
"type": "boolean"
},
"stats": {
"type": "array",
"items": {
"type": "string",
"enum": [
"min",
"max",
"mean",
"count",
"sum",
"std",
"median",
"majority",
"minority",
"unique",
"range",
"nodata"
]
}
},
"integer": {
"type": "integer"
},
"number": {
"type": "number"
},
"boolean": {
"type": "boolean"
},
},
"type": "object",
"properties": {
"geometry": {
"$ref": "#/definitions/geometry"
},
"date": {
"$ref": "#/definitions/date"
},
"index": {
"type": "string",
"enum": ["relative", "absolute", "z-score"]
},
"stats": {
"type": "array",
"items": {
"type": "string",
"enum": ["min", "max", "mean", "count", "sum", "std",
"median", "majority", "minority", "unique", "range", "nodata"]
}
}
},
"required": ["geometry", "date", "index", "stats"]
}Headers
Content-Type: application/jsonBody
{
"geometry": {
"type": "Point",
"coordinates": [
-3.7038,
40.4168
]
},
"properties": {
"radius": 100
},
"date": "2015-01-10",
"index": "relative",
"stats": [
"min",
"max"
]
}Schema
{
"$schema": "http://json-schema.org/draft-06/schema#",
"definitions": {
"crop_type": {
"type": "string",
"enum": [
"cotton",
"soya",
"maize",
"wheat"
]
},
"geometry": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"Point",
"Polygon"
]
}
},
"allOf": [
{
"if": {
"properties": {
"type": {
"const": "Point"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"minItems": 2,
"maxItems": 2,
"items": {
"type": "number"
}
}
}
}
},
{
"if": {
"properties": {
"type": {
"const": "Polygon"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"items": {
"type": "array",
"minItems": 4,
"items": {
"type": "array",
"minItems": 2,
"items": {
"type": "number"
}
}
}
}
}
}
}
],
"required": ["type", "coordinates"]
},
"bbox": {
"type": "array",
"minItems": 4,
"items": {
"type": "number"
}
},
"date": {
"type": "string",
"pattern": "^\d{4}\-(0?[1-9]|1[012])\-(0?[1-9]|[12][0-9]|3[01])$"
},
"identifier": {
"type": "string"
},
"scale": {
"type": "number",
"minimum": 0
},
"touch": {
"type": "boolean"
},
"stats": {
"type": "array",
"items": {
"type": "string",
"enum": [
"min",
"max",
"mean",
"count",
"sum",
"std",
"median",
"majority",
"minority",
"unique",
"range",
"nodata"
]
}
},
"integer": {
"type": "integer"
},
"number": {
"type": "number"
},
"boolean": {
"type": "boolean"
},
},
"type": "object",
"properties": {
"geometry": {
"$ref": "#/definitions/geometry"
},
"properties": {
"type": "object",
"properties": {
"radius": {
"type": "integer",
}
}
},
"date": {
"$ref": "#/definitions/date"
},
"index": {
"type": "string",
"enum": ["relative", "absolute", "z-score"]
},
"stats": {
"type": "array",
"items": {
"type": "string",
"enum": ["min", "max", "mean", "count", "sum", "std",
"median", "majority", "minority", "unique", "range", "nodata"]
}
}
},
"required": ["geometry", "date", "index", "stats"]
}200Headers
Content-Type: application/jsonBody
{
"max": 21.583648681640625,
"min": 0.884957492351532,
"date": "2015-05-09"
}400Headers
Content-Type: application/json404Headers
Content-Type: application/json500Headers
Content-Type: application/jsonZonal Statistics for DMP Anomaly ¶
DMP AnomalyPOST/farm/zonal_analysis/zonal_statistics/dmp_anomaly
Generate zonal statistics based on the dry matter productivity index anomaly for a farm field.
The resource accepts a JSON object containing the following properties:
-
geometry (geojson) - The boundaries of the field expressed in geojson format
-
date (string) - The date to use for the retrieval of the indicator
-
index (string) - The index (one of “relative”, “absolute” or “z-score”)
-
stats (list) - A list of the requested statistics. Supported statistics are: [“min”, “max”, “mean”, “count”, “sum”, “std”, “median”, “majority”, “minority”, “unique”, “range”, “nodata”]
In case the supplied geometry is a POINT and you provide a radius (in meters), a geodesic buffer will be created and used for the calculations of the zonal statistics.
The output json will contain the requested statistics with their corresponding values and the sensing date of the image.
Example URI
Headers
Content-Type: application/jsonBody
{
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
-5.6137,
42.0221
],
[
-5.6095,
42.0221
],
[
-5.6095,
42.0241
],
[
-5.6137,
42.0241
],
[
-5.6137,
42.0221
]
]
]
},
"date": "2015-01-10",
"index": "relative",
"stats": [
"min",
"max"
]
}Schema
{
"$schema": "http://json-schema.org/draft-06/schema#",
"definitions": {
"crop_type": {
"type": "string",
"enum": [
"cotton",
"soya",
"maize",
"wheat"
]
},
"geometry": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"Point",
"Polygon"
]
}
},
"allOf": [
{
"if": {
"properties": {
"type": {
"const": "Point"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"minItems": 2,
"maxItems": 2,
"items": {
"type": "number"
}
}
}
}
},
{
"if": {
"properties": {
"type": {
"const": "Polygon"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"items": {
"type": "array",
"minItems": 4,
"items": {
"type": "array",
"minItems": 2,
"items": {
"type": "number"
}
}
}
}
}
}
}
],
"required": ["type", "coordinates"]
},
"bbox": {
"type": "array",
"minItems": 4,
"items": {
"type": "number"
}
},
"date": {
"type": "string",
"pattern": "^\d{4}\-(0?[1-9]|1[012])\-(0?[1-9]|[12][0-9]|3[01])$"
},
"identifier": {
"type": "string"
},
"scale": {
"type": "number",
"minimum": 0
},
"touch": {
"type": "boolean"
},
"stats": {
"type": "array",
"items": {
"type": "string",
"enum": [
"min",
"max",
"mean",
"count",
"sum",
"std",
"median",
"majority",
"minority",
"unique",
"range",
"nodata"
]
}
},
"integer": {
"type": "integer"
},
"number": {
"type": "number"
},
"boolean": {
"type": "boolean"
},
},
"type": "object",
"properties": {
"geometry": {
"$ref": "#/definitions/geometry"
},
"date": {
"$ref": "#/definitions/date"
},
"index": {
"type": "string",
"enum": ["relative", "absolute", "z-score"]
},
"stats": {
"type": "array",
"items": {
"type": "string",
"enum": ["min", "max", "mean", "count", "sum", "std",
"median", "majority", "minority", "unique", "range", "nodata"]
}
}
},
"required": ["geometry", "date", "index", "stats"]
}Headers
Content-Type: application/jsonBody
{
"geometry": {
"type": "Point",
"coordinates": [
-3.7038,
40.4168
]
},
"properties": {
"radius": 100
},
"date": "2015-01-10",
"index": "relative",
"stats": [
"min",
"max"
]
}Schema
{
"$schema": "http://json-schema.org/draft-06/schema#",
"definitions": {
"crop_type": {
"type": "string",
"enum": [
"cotton",
"soya",
"maize",
"wheat"
]
},
"geometry": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"Point",
"Polygon"
]
}
},
"allOf": [
{
"if": {
"properties": {
"type": {
"const": "Point"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"minItems": 2,
"maxItems": 2,
"items": {
"type": "number"
}
}
}
}
},
{
"if": {
"properties": {
"type": {
"const": "Polygon"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"items": {
"type": "array",
"minItems": 4,
"items": {
"type": "array",
"minItems": 2,
"items": {
"type": "number"
}
}
}
}
}
}
}
],
"required": ["type", "coordinates"]
},
"bbox": {
"type": "array",
"minItems": 4,
"items": {
"type": "number"
}
},
"date": {
"type": "string",
"pattern": "^\d{4}\-(0?[1-9]|1[012])\-(0?[1-9]|[12][0-9]|3[01])$"
},
"identifier": {
"type": "string"
},
"scale": {
"type": "number",
"minimum": 0
},
"touch": {
"type": "boolean"
},
"stats": {
"type": "array",
"items": {
"type": "string",
"enum": [
"min",
"max",
"mean",
"count",
"sum",
"std",
"median",
"majority",
"minority",
"unique",
"range",
"nodata"
]
}
},
"integer": {
"type": "integer"
},
"number": {
"type": "number"
},
"boolean": {
"type": "boolean"
},
},
"type": "object",
"properties": {
"geometry": {
"$ref": "#/definitions/geometry"
},
"properties": {
"type": "object",
"properties": {
"radius": {
"type": "integer",
}
}
},
"date": {
"$ref": "#/definitions/date"
},
"index": {
"type": "string",
"enum": ["relative", "absolute", "z-score"]
},
"stats": {
"type": "array",
"items": {
"type": "string",
"enum": ["min", "max", "mean", "count", "sum", "std",
"median", "majority", "minority", "unique", "range", "nodata"]
}
}
},
"required": ["geometry", "date", "index", "stats"]
}200Headers
Content-Type: application/jsonBody
{
"max": 27.525251388549805,
"min": 9.409186363220215,
"date": "2015-05-09"
}400Headers
Content-Type: application/json404Headers
Content-Type: application/json500Headers
Content-Type: application/jsonZonal Statistics for FAPAR Anomaly ¶
FAPAR AnomalyPOST/farm/zonal_analysis/zonal_statistics/fapar_anomaly
Generate zonal statistics based on the fraction of absorbed photosynthetically active radiation index anomaly for a farm field.
The resource accepts a JSON object containing the following properties:
-
geometry (geojson) - The boundaries of the field expressed in geojson format
-
date (string) - The date to use for the retrieval of the indicator
-
index (string) - The index (one of “relative”, “absolute” or “z-score”)
-
stats (list) - A list of the requested statistics. Supported statistics are: [“min”, “max”, “mean”, “count”, “sum”, “std”, “median”, “majority”, “minority”, “unique”, “range”, “nodata”]
In case the supplied geometry is a POINT and you provide a radius (in meters), a geodesic buffer will be created and used for the calculations of the zonal statistics.
The output json will contain the requested statistics with their corresponding values and the sensing date of the image.
Example URI
Headers
Content-Type: application/jsonBody
{
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
-5.6137,
42.0221
],
[
-5.6095,
42.0221
],
[
-5.6095,
42.0241
],
[
-5.6137,
42.0241
],
[
-5.6137,
42.0221
]
]
]
},
"date": "2015-01-10",
"index": "relative",
"stats": [
"min",
"max"
]
}Schema
{
"$schema": "http://json-schema.org/draft-06/schema#",
"definitions": {
"crop_type": {
"type": "string",
"enum": [
"cotton",
"soya",
"maize",
"wheat"
]
},
"geometry": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"Point",
"Polygon"
]
}
},
"allOf": [
{
"if": {
"properties": {
"type": {
"const": "Point"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"minItems": 2,
"maxItems": 2,
"items": {
"type": "number"
}
}
}
}
},
{
"if": {
"properties": {
"type": {
"const": "Polygon"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"items": {
"type": "array",
"minItems": 4,
"items": {
"type": "array",
"minItems": 2,
"items": {
"type": "number"
}
}
}
}
}
}
}
],
"required": ["type", "coordinates"]
},
"bbox": {
"type": "array",
"minItems": 4,
"items": {
"type": "number"
}
},
"date": {
"type": "string",
"pattern": "^\d{4}\-(0?[1-9]|1[012])\-(0?[1-9]|[12][0-9]|3[01])$"
},
"identifier": {
"type": "string"
},
"scale": {
"type": "number",
"minimum": 0
},
"touch": {
"type": "boolean"
},
"stats": {
"type": "array",
"items": {
"type": "string",
"enum": [
"min",
"max",
"mean",
"count",
"sum",
"std",
"median",
"majority",
"minority",
"unique",
"range",
"nodata"
]
}
},
"integer": {
"type": "integer"
},
"number": {
"type": "number"
},
"boolean": {
"type": "boolean"
},
},
"type": "object",
"properties": {
"geometry": {
"$ref": "#/definitions/geometry"
},
"date": {
"$ref": "#/definitions/date"
},
"index": {
"type": "string",
"enum": ["relative", "absolute", "z-score"]
},
"stats": {
"type": "array",
"items": {
"type": "string",
"enum": ["min", "max", "mean", "count", "sum", "std",
"median", "majority", "minority", "unique", "range", "nodata"]
}
}
},
"required": ["geometry", "date", "index", "stats"]
}Headers
Content-Type: application/jsonBody
{
"geometry": {
"type": "Point",
"coordinates": [
-3.7038,
40.4168
]
},
"properties": {
"radius": 100
},
"date": "2015-01-10",
"index": "relative",
"stats": [
"min",
"max"
]
}Schema
{
"$schema": "http://json-schema.org/draft-06/schema#",
"definitions": {
"crop_type": {
"type": "string",
"enum": [
"cotton",
"soya",
"maize",
"wheat"
]
},
"geometry": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"Point",
"Polygon"
]
}
},
"allOf": [
{
"if": {
"properties": {
"type": {
"const": "Point"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"minItems": 2,
"maxItems": 2,
"items": {
"type": "number"
}
}
}
}
},
{
"if": {
"properties": {
"type": {
"const": "Polygon"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"items": {
"type": "array",
"minItems": 4,
"items": {
"type": "array",
"minItems": 2,
"items": {
"type": "number"
}
}
}
}
}
}
}
],
"required": ["type", "coordinates"]
},
"bbox": {
"type": "array",
"minItems": 4,
"items": {
"type": "number"
}
},
"date": {
"type": "string",
"pattern": "^\d{4}\-(0?[1-9]|1[012])\-(0?[1-9]|[12][0-9]|3[01])$"
},
"identifier": {
"type": "string"
},
"scale": {
"type": "number",
"minimum": 0
},
"touch": {
"type": "boolean"
},
"stats": {
"type": "array",
"items": {
"type": "string",
"enum": [
"min",
"max",
"mean",
"count",
"sum",
"std",
"median",
"majority",
"minority",
"unique",
"range",
"nodata"
]
}
},
"integer": {
"type": "integer"
},
"number": {
"type": "number"
},
"boolean": {
"type": "boolean"
},
},
"type": "object",
"properties": {
"geometry": {
"$ref": "#/definitions/geometry"
},
"properties": {
"type": "object",
"properties": {
"radius": {
"type": "integer",
}
}
},
"date": {
"$ref": "#/definitions/date"
},
"index": {
"type": "string",
"enum": ["relative", "absolute", "z-score"]
},
"stats": {
"type": "array",
"items": {
"type": "string",
"enum": ["min", "max", "mean", "count", "sum", "std",
"median", "majority", "minority", "unique", "range", "nodata"]
}
}
},
"required": ["geometry", "date", "index", "stats"]
}200Headers
Content-Type: application/jsonBody
{
"max": 21.428571701049805,
"min": 3.7037034034729004,
"date": "2015-05-09"
}400Headers
Content-Type: application/json404Headers
Content-Type: application/json500Headers
Content-Type: application/jsonZonal Statistics for DPI FAPAR ¶
DPI FAPARPOST/farm/zonal_analysis/zonal_statistics/dpi_fapar
Generate the zonal statistics for a farm field, based on the DPI FAPAR index.
The resource accepts a JSON object containing the following properties:
-
geometry (geojson) - The boundaries of the field expressed in geojson format
-
date_pre (string) - The date (PRE) to use for the PDI
-
date_post (string) - The date (POST) to use for the PDI
-
inverse (boolean) - Whether to inverse the PDI
-
classify (boolean) - Whether to classify the PDI
-
stats (list) - A list of the requested statistics. Supported statistics are: [“min”, “max”, “mean”, “count”, “sum”, “std”, “median”, “majority”, “minority”, “unique”, “range”, “nodata”]
In case the supplied geometry is a POINT and you provide a radius (in meters), a geodesic buffer will be created and used for the calculations of the zonal statistics.
The output json will contain the requested statistics with their corresponding values.
Example URI
Headers
Content-Type: application/jsonBody
{
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
-4.2609,
41.062
],
[
-4.2598,
41.062
],
[
-4.2598,
41.0613
],
[
-4.2609,
41.0613
],
[
-4.2609,
41.062
]
]
]
},
"date_pre": "2020-01-25",
"date_post": "2020-02-21",
"inverse": false,
"classify": false,
"stats": [
"min",
"max"
]
}Schema
{
"$schema": "http://json-schema.org/draft-06/schema#",
"definitions": {
"crop_type": {
"type": "string",
"enum": [
"cotton",
"soya",
"maize",
"wheat"
]
},
"geometry": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"Point",
"Polygon"
]
}
},
"allOf": [
{
"if": {
"properties": {
"type": {
"const": "Point"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"minItems": 2,
"maxItems": 2,
"items": {
"type": "number"
}
}
}
}
},
{
"if": {
"properties": {
"type": {
"const": "Polygon"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"items": {
"type": "array",
"minItems": 4,
"items": {
"type": "array",
"minItems": 2,
"items": {
"type": "number"
}
}
}
}
}
}
}
],
"required": ["type", "coordinates"]
},
"bbox": {
"type": "array",
"minItems": 4,
"items": {
"type": "number"
}
},
"date": {
"type": "string",
"pattern": "^\d{4}\-(0?[1-9]|1[012])\-(0?[1-9]|[12][0-9]|3[01])$"
},
"identifier": {
"type": "string"
},
"scale": {
"type": "number",
"minimum": 0
},
"touch": {
"type": "boolean"
},
"stats": {
"type": "array",
"items": {
"type": "string",
"enum": [
"min",
"max",
"mean",
"count",
"sum",
"std",
"median",
"majority",
"minority",
"unique",
"range",
"nodata"
]
}
},
"integer": {
"type": "integer"
},
"number": {
"type": "number"
},
"boolean": {
"type": "boolean"
},
},
"type": "object",
"properties": {
"geometry": {
"$ref": "#/definitions/geometry"
},
"date_pre": {
"$ref": "#/definitions/date"
},
"date_post": {
"$ref": "#/definitions/date"
},
"inverse": {
"$ref": "#/definitions/boolean"
},
"classify": {
"$ref": "#/definitions/boolean"
},
"stats": {
"type": "array",
"items": {
"type": "string",
"enum": ["min", "max", "mean", "count", "sum", "std",
"median", "majority", "minority", "unique", "range", "nodata"]
}
}
},
"required": ["geometry", "date_pre", "date_post", "stats"]
}Headers
Content-Type: application/jsonBody
{
"geometry": {
"type": "Point",
"coordinates": [
-4.260339,
41.061665
]
},
"properties": {
"radius": 50
},
"date_pre": "2020-01-25",
"date_post": "2020-02-21",
"inverse": false,
"classify": false,
"stats": [
"min",
"max"
]
}Schema
{
"$schema": "http://json-schema.org/draft-06/schema#",
"definitions": {
"crop_type": {
"type": "string",
"enum": [
"cotton",
"soya",
"maize",
"wheat"
]
},
"geometry": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"Point",
"Polygon"
]
}
},
"allOf": [
{
"if": {
"properties": {
"type": {
"const": "Point"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"minItems": 2,
"maxItems": 2,
"items": {
"type": "number"
}
}
}
}
},
{
"if": {
"properties": {
"type": {
"const": "Polygon"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"items": {
"type": "array",
"minItems": 4,
"items": {
"type": "array",
"minItems": 2,
"items": {
"type": "number"
}
}
}
}
}
}
}
],
"required": ["type", "coordinates"]
},
"bbox": {
"type": "array",
"minItems": 4,
"items": {
"type": "number"
}
},
"date": {
"type": "string",
"pattern": "^\d{4}\-(0?[1-9]|1[012])\-(0?[1-9]|[12][0-9]|3[01])$"
},
"identifier": {
"type": "string"
},
"scale": {
"type": "number",
"minimum": 0
},
"touch": {
"type": "boolean"
},
"stats": {
"type": "array",
"items": {
"type": "string",
"enum": [
"min",
"max",
"mean",
"count",
"sum",
"std",
"median",
"majority",
"minority",
"unique",
"range",
"nodata"
]
}
},
"integer": {
"type": "integer"
},
"number": {
"type": "number"
},
"boolean": {
"type": "boolean"
},
},
"type": "object",
"properties": {
"geometry": {
"$ref": "#/definitions/geometry"
},
"properties": {
"type": "object",
"properties": {
"radius": {
"type": "integer",
}
}
},
"date_pre": {
"$ref": "#/definitions/date"
},
"date_post": {
"$ref": "#/definitions/date"
},
"inverse": {
"$ref": "#/definitions/boolean"
},
"classify": {
"$ref": "#/definitions/boolean"
},
"stats": {
"type": "array",
"items": {
"type": "string",
"enum": ["min", "max", "mean", "count", "sum", "std",
"median", "majority", "minority", "unique", "range", "nodata"]
}
}
},
"required": ["geometry", "date_pre", "date_post", "stats"]
}200Headers
Content-Type: application/jsonBody
{
"max": 21.428571701049805,
"min": 3.7037034034729004,
}400Headers
Content-Type: application/json404Headers
Content-Type: application/json500Headers
Content-Type: application/jsonZonal Statistics for DPI FCOVER ¶
DPI FCOVERPOST/farm/zonal_analysis/zonal_statistics/dpi_fcover
Generate the zonal statistics for a farm field, based on the DPI FCOVER index.
The resource accepts a JSON object containing the following properties:
-
geometry (geojson) - The boundaries of the field expressed in geojson format
-
date_pre (string) - The date (PRE) to use for the PDI
-
date_post (string) - The date (POST) to use for the PDI
-
inverse (boolean) - Whether to inverse the PDI
-
classify (boolean) - Whether to classify the PDI
-
stats (list) - A list of the requested statistics. Supported statistics are: [“min”, “max”, “mean”, “count”, “sum”, “std”, “median”, “majority”, “minority”, “unique”, “range”, “nodata”]
In case the supplied geometry is a POINT and you provide a radius (in meters), a geodesic buffer will be created and used for the calculations of the zonal statistics.
The output json will contain the requested statistics with their corresponding values.
Example URI
Headers
Content-Type: application/jsonBody
{
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
-4.2609,
41.062
],
[
-4.2598,
41.062
],
[
-4.2598,
41.0613
],
[
-4.2609,
41.0613
],
[
-4.2609,
41.062
]
]
]
},
"date_pre": "2020-01-25",
"date_post": "2020-02-21",
"inverse": false,
"classify": false,
"stats": [
"min",
"max"
]
}Schema
{
"$schema": "http://json-schema.org/draft-06/schema#",
"definitions": {
"crop_type": {
"type": "string",
"enum": [
"cotton",
"soya",
"maize",
"wheat"
]
},
"geometry": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"Point",
"Polygon"
]
}
},
"allOf": [
{
"if": {
"properties": {
"type": {
"const": "Point"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"minItems": 2,
"maxItems": 2,
"items": {
"type": "number"
}
}
}
}
},
{
"if": {
"properties": {
"type": {
"const": "Polygon"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"items": {
"type": "array",
"minItems": 4,
"items": {
"type": "array",
"minItems": 2,
"items": {
"type": "number"
}
}
}
}
}
}
}
],
"required": ["type", "coordinates"]
},
"bbox": {
"type": "array",
"minItems": 4,
"items": {
"type": "number"
}
},
"date": {
"type": "string",
"pattern": "^\d{4}\-(0?[1-9]|1[012])\-(0?[1-9]|[12][0-9]|3[01])$"
},
"identifier": {
"type": "string"
},
"scale": {
"type": "number",
"minimum": 0
},
"touch": {
"type": "boolean"
},
"stats": {
"type": "array",
"items": {
"type": "string",
"enum": [
"min",
"max",
"mean",
"count",
"sum",
"std",
"median",
"majority",
"minority",
"unique",
"range",
"nodata"
]
}
},
"integer": {
"type": "integer"
},
"number": {
"type": "number"
},
"boolean": {
"type": "boolean"
},
},
"type": "object",
"properties": {
"geometry": {
"$ref": "#/definitions/geometry"
},
"date_pre": {
"$ref": "#/definitions/date"
},
"date_post": {
"$ref": "#/definitions/date"
},
"inverse": {
"$ref": "#/definitions/boolean"
},
"classify": {
"$ref": "#/definitions/boolean"
},
"stats": {
"type": "array",
"items": {
"type": "string",
"enum": ["min", "max", "mean", "count", "sum", "std",
"median", "majority", "minority", "unique", "range", "nodata"]
}
}
},
"required": ["geometry", "date_pre", "date_post", "stats"]
}Headers
Content-Type: application/jsonBody
{
"geometry": {
"type": "Point",
"coordinates": [
-4.260339,
41.061665
]
},
"properties": {
"radius": 50
},
"date_pre": "2020-01-25",
"date_post": "2020-02-21",
"inverse": false,
"classify": false,
"stats": [
"min",
"max"
]
}Schema
{
"$schema": "http://json-schema.org/draft-06/schema#",
"definitions": {
"crop_type": {
"type": "string",
"enum": [
"cotton",
"soya",
"maize",
"wheat"
]
},
"geometry": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"Point",
"Polygon"
]
}
},
"allOf": [
{
"if": {
"properties": {
"type": {
"const": "Point"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"minItems": 2,
"maxItems": 2,
"items": {
"type": "number"
}
}
}
}
},
{
"if": {
"properties": {
"type": {
"const": "Polygon"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"items": {
"type": "array",
"minItems": 4,
"items": {
"type": "array",
"minItems": 2,
"items": {
"type": "number"
}
}
}
}
}
}
}
],
"required": ["type", "coordinates"]
},
"bbox": {
"type": "array",
"minItems": 4,
"items": {
"type": "number"
}
},
"date": {
"type": "string",
"pattern": "^\d{4}\-(0?[1-9]|1[012])\-(0?[1-9]|[12][0-9]|3[01])$"
},
"identifier": {
"type": "string"
},
"scale": {
"type": "number",
"minimum": 0
},
"touch": {
"type": "boolean"
},
"stats": {
"type": "array",
"items": {
"type": "string",
"enum": [
"min",
"max",
"mean",
"count",
"sum",
"std",
"median",
"majority",
"minority",
"unique",
"range",
"nodata"
]
}
},
"integer": {
"type": "integer"
},
"number": {
"type": "number"
},
"boolean": {
"type": "boolean"
},
},
"type": "object",
"properties": {
"geometry": {
"$ref": "#/definitions/geometry"
},
"properties": {
"type": "object",
"properties": {
"radius": {
"type": "integer",
}
}
},
"date_pre": {
"$ref": "#/definitions/date"
},
"date_post": {
"$ref": "#/definitions/date"
},
"inverse": {
"$ref": "#/definitions/boolean"
},
"classify": {
"$ref": "#/definitions/boolean"
},
"stats": {
"type": "array",
"items": {
"type": "string",
"enum": ["min", "max", "mean", "count", "sum", "std",
"median", "majority", "minority", "unique", "range", "nodata"]
}
}
},
"required": ["geometry", "date_pre", "date_post", "stats"]
}200Headers
Content-Type: application/jsonBody
{
"max": 21.428571701049805,
"min": 3.7037034034729004,
}400Headers
Content-Type: application/json404Headers
Content-Type: application/json500Headers
Content-Type: application/jsonZonal Statistics for DPI GNDVI ¶
DPI GNDVIPOST/farm/zonal_analysis/zonal_statistics/dpi_gndvi
Generate the zonal statistics for a farm field, based on the DPI GNDVI index.
The resource accepts a JSON object containing the following properties:
-
geometry (geojson) - The boundaries of the field expressed in geojson format
-
date_pre (string) - The date (PRE) to use for the PDI
-
date_post (string) - The date (POST) to use for the PDI
-
inverse (boolean) - Whether to inverse the PDI
-
classify (boolean) - Whether to classify the PDI
-
stats (list) - A list of the requested statistics. Supported statistics are: [“min”, “max”, “mean”, “count”, “sum”, “std”, “median”, “majority”, “minority”, “unique”, “range”, “nodata”]
In case the supplied geometry is a POINT and you provide a radius (in meters), a geodesic buffer will be created and used for the calculations of the zonal statistics.
The output json will contain the requested statistics with their corresponding values.
Example URI
Headers
Content-Type: application/jsonBody
{
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
-4.2609,
41.062
],
[
-4.2598,
41.062
],
[
-4.2598,
41.0613
],
[
-4.2609,
41.0613
],
[
-4.2609,
41.062
]
]
]
},
"date_pre": "2020-01-25",
"date_post": "2020-02-21",
"inverse": false,
"classify": false,
"stats": [
"min",
"max"
]
}Schema
{
"$schema": "http://json-schema.org/draft-06/schema#",
"definitions": {
"crop_type": {
"type": "string",
"enum": [
"cotton",
"soya",
"maize",
"wheat"
]
},
"geometry": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"Point",
"Polygon"
]
}
},
"allOf": [
{
"if": {
"properties": {
"type": {
"const": "Point"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"minItems": 2,
"maxItems": 2,
"items": {
"type": "number"
}
}
}
}
},
{
"if": {
"properties": {
"type": {
"const": "Polygon"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"items": {
"type": "array",
"minItems": 4,
"items": {
"type": "array",
"minItems": 2,
"items": {
"type": "number"
}
}
}
}
}
}
}
],
"required": ["type", "coordinates"]
},
"bbox": {
"type": "array",
"minItems": 4,
"items": {
"type": "number"
}
},
"date": {
"type": "string",
"pattern": "^\d{4}\-(0?[1-9]|1[012])\-(0?[1-9]|[12][0-9]|3[01])$"
},
"identifier": {
"type": "string"
},
"scale": {
"type": "number",
"minimum": 0
},
"touch": {
"type": "boolean"
},
"stats": {
"type": "array",
"items": {
"type": "string",
"enum": [
"min",
"max",
"mean",
"count",
"sum",
"std",
"median",
"majority",
"minority",
"unique",
"range",
"nodata"
]
}
},
"integer": {
"type": "integer"
},
"number": {
"type": "number"
},
"boolean": {
"type": "boolean"
},
},
"type": "object",
"properties": {
"geometry": {
"$ref": "#/definitions/geometry"
},
"date_pre": {
"$ref": "#/definitions/date"
},
"date_post": {
"$ref": "#/definitions/date"
},
"inverse": {
"$ref": "#/definitions/boolean"
},
"classify": {
"$ref": "#/definitions/boolean"
},
"stats": {
"type": "array",
"items": {
"type": "string",
"enum": ["min", "max", "mean", "count", "sum", "std",
"median", "majority", "minority", "unique", "range", "nodata"]
}
}
},
"required": ["geometry", "date_pre", "date_post", "stats"]
}Headers
Content-Type: application/jsonBody
{
"geometry": {
"type": "Point",
"coordinates": [
-4.260339,
41.061665
]
},
"properties": {
"radius": 50
},
"date_pre": "2020-01-25",
"date_post": "2020-02-21",
"inverse": false,
"classify": false,
"stats": [
"min",
"max"
]
}Schema
{
"$schema": "http://json-schema.org/draft-06/schema#",
"definitions": {
"crop_type": {
"type": "string",
"enum": [
"cotton",
"soya",
"maize",
"wheat"
]
},
"geometry": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"Point",
"Polygon"
]
}
},
"allOf": [
{
"if": {
"properties": {
"type": {
"const": "Point"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"minItems": 2,
"maxItems": 2,
"items": {
"type": "number"
}
}
}
}
},
{
"if": {
"properties": {
"type": {
"const": "Polygon"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"items": {
"type": "array",
"minItems": 4,
"items": {
"type": "array",
"minItems": 2,
"items": {
"type": "number"
}
}
}
}
}
}
}
],
"required": ["type", "coordinates"]
},
"bbox": {
"type": "array",
"minItems": 4,
"items": {
"type": "number"
}
},
"date": {
"type": "string",
"pattern": "^\d{4}\-(0?[1-9]|1[012])\-(0?[1-9]|[12][0-9]|3[01])$"
},
"identifier": {
"type": "string"
},
"scale": {
"type": "number",
"minimum": 0
},
"touch": {
"type": "boolean"
},
"stats": {
"type": "array",
"items": {
"type": "string",
"enum": [
"min",
"max",
"mean",
"count",
"sum",
"std",
"median",
"majority",
"minority",
"unique",
"range",
"nodata"
]
}
},
"integer": {
"type": "integer"
},
"number": {
"type": "number"
},
"boolean": {
"type": "boolean"
},
},
"type": "object",
"properties": {
"geometry": {
"$ref": "#/definitions/geometry"
},
"properties": {
"type": "object",
"properties": {
"radius": {
"type": "integer",
}
}
},
"date_pre": {
"$ref": "#/definitions/date"
},
"date_post": {
"$ref": "#/definitions/date"
},
"inverse": {
"$ref": "#/definitions/boolean"
},
"classify": {
"$ref": "#/definitions/boolean"
},
"stats": {
"type": "array",
"items": {
"type": "string",
"enum": ["min", "max", "mean", "count", "sum", "std",
"median", "majority", "minority", "unique", "range", "nodata"]
}
}
},
"required": ["geometry", "date_pre", "date_post", "stats"]
}200Headers
Content-Type: application/jsonBody
{
"max": 21.428571701049805,
"min": 3.7037034034729004,
}400Headers
Content-Type: application/json404Headers
Content-Type: application/json500Headers
Content-Type: application/jsonZonal Statistics for DPI LAI ¶
DPI LAIPOST/farm/zonal_analysis/zonal_statistics/dpi_lai
Generate the zonal statistics for a farm field, based on the DPI LAI index.
The resource accepts a JSON object containing the following properties:
-
geometry (geojson) - The boundaries of the field expressed in geojson format
-
date_pre (string) - The date (PRE) to use for the PDI
-
date_post (string) - The date (POST) to use for the PDI
-
inverse (boolean) - Whether to inverse the PDI
-
classify (boolean) - Whether to classify the PDI
-
stats (list) - A list of the requested statistics. Supported statistics are: [“min”, “max”, “mean”, “count”, “sum”, “std”, “median”, “majority”, “minority”, “unique”, “range”, “nodata”]
In case the supplied geometry is a POINT and you provide a radius (in meters), a geodesic buffer will be created and used for the calculations of the zonal statistics.
The output json will contain the requested statistics with their corresponding values.
Example URI
Headers
Content-Type: application/jsonBody
{
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
-4.2609,
41.062
],
[
-4.2598,
41.062
],
[
-4.2598,
41.0613
],
[
-4.2609,
41.0613
],
[
-4.2609,
41.062
]
]
]
},
"date_pre": "2020-01-25",
"date_post": "2020-02-21",
"inverse": false,
"classify": false,
"stats": [
"min",
"max"
]
}Schema
{
"$schema": "http://json-schema.org/draft-06/schema#",
"definitions": {
"crop_type": {
"type": "string",
"enum": [
"cotton",
"soya",
"maize",
"wheat"
]
},
"geometry": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"Point",
"Polygon"
]
}
},
"allOf": [
{
"if": {
"properties": {
"type": {
"const": "Point"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"minItems": 2,
"maxItems": 2,
"items": {
"type": "number"
}
}
}
}
},
{
"if": {
"properties": {
"type": {
"const": "Polygon"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"items": {
"type": "array",
"minItems": 4,
"items": {
"type": "array",
"minItems": 2,
"items": {
"type": "number"
}
}
}
}
}
}
}
],
"required": ["type", "coordinates"]
},
"bbox": {
"type": "array",
"minItems": 4,
"items": {
"type": "number"
}
},
"date": {
"type": "string",
"pattern": "^\d{4}\-(0?[1-9]|1[012])\-(0?[1-9]|[12][0-9]|3[01])$"
},
"identifier": {
"type": "string"
},
"scale": {
"type": "number",
"minimum": 0
},
"touch": {
"type": "boolean"
},
"stats": {
"type": "array",
"items": {
"type": "string",
"enum": [
"min",
"max",
"mean",
"count",
"sum",
"std",
"median",
"majority",
"minority",
"unique",
"range",
"nodata"
]
}
},
"integer": {
"type": "integer"
},
"number": {
"type": "number"
},
"boolean": {
"type": "boolean"
},
},
"type": "object",
"properties": {
"geometry": {
"$ref": "#/definitions/geometry"
},
"date_pre": {
"$ref": "#/definitions/date"
},
"date_post": {
"$ref": "#/definitions/date"
},
"inverse": {
"$ref": "#/definitions/boolean"
},
"classify": {
"$ref": "#/definitions/boolean"
},
"stats": {
"type": "array",
"items": {
"type": "string",
"enum": ["min", "max", "mean", "count", "sum", "std",
"median", "majority", "minority", "unique", "range", "nodata"]
}
}
},
"required": ["geometry", "date_pre", "date_post", "stats"]
}Headers
Content-Type: application/jsonBody
{
"geometry": {
"type": "Point",
"coordinates": [
-4.260339,
41.061665
]
},
"properties": {
"radius": 50
},
"date_pre": "2020-01-25",
"date_post": "2020-02-21",
"inverse": false,
"classify": false,
"stats": [
"min",
"max"
]
}Schema
{
"$schema": "http://json-schema.org/draft-06/schema#",
"definitions": {
"crop_type": {
"type": "string",
"enum": [
"cotton",
"soya",
"maize",
"wheat"
]
},
"geometry": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"Point",
"Polygon"
]
}
},
"allOf": [
{
"if": {
"properties": {
"type": {
"const": "Point"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"minItems": 2,
"maxItems": 2,
"items": {
"type": "number"
}
}
}
}
},
{
"if": {
"properties": {
"type": {
"const": "Polygon"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"items": {
"type": "array",
"minItems": 4,
"items": {
"type": "array",
"minItems": 2,
"items": {
"type": "number"
}
}
}
}
}
}
}
],
"required": ["type", "coordinates"]
},
"bbox": {
"type": "array",
"minItems": 4,
"items": {
"type": "number"
}
},
"date": {
"type": "string",
"pattern": "^\d{4}\-(0?[1-9]|1[012])\-(0?[1-9]|[12][0-9]|3[01])$"
},
"identifier": {
"type": "string"
},
"scale": {
"type": "number",
"minimum": 0
},
"touch": {
"type": "boolean"
},
"stats": {
"type": "array",
"items": {
"type": "string",
"enum": [
"min",
"max",
"mean",
"count",
"sum",
"std",
"median",
"majority",
"minority",
"unique",
"range",
"nodata"
]
}
},
"integer": {
"type": "integer"
},
"number": {
"type": "number"
},
"boolean": {
"type": "boolean"
},
},
"type": "object",
"properties": {
"geometry": {
"$ref": "#/definitions/geometry"
},
"properties": {
"type": "object",
"properties": {
"radius": {
"type": "integer",
}
}
},
"date_pre": {
"$ref": "#/definitions/date"
},
"date_post": {
"$ref": "#/definitions/date"
},
"inverse": {
"$ref": "#/definitions/boolean"
},
"classify": {
"$ref": "#/definitions/boolean"
},
"stats": {
"type": "array",
"items": {
"type": "string",
"enum": ["min", "max", "mean", "count", "sum", "std",
"median", "majority", "minority", "unique", "range", "nodata"]
}
}
},
"required": ["geometry", "date_pre", "date_post", "stats"]
}200Headers
Content-Type: application/jsonBody
{
"max": 21.428571701049805,
"min": 3.7037034034729004,
}400Headers
Content-Type: application/json404Headers
Content-Type: application/json500Headers
Content-Type: application/jsonZonal Statistics for DPI MCARI ¶
DPI MCARIPOST/farm/zonal_analysis/zonal_statistics/dpi_mcari
Generate the zonal statistics for a farm field, based on the DPI MCARI index.
The resource accepts a JSON object containing the following properties:
-
geometry (geojson) - The boundaries of the field expressed in geojson format
-
date_pre (string) - The date (PRE) to use for the PDI
-
date_post (string) - The date (POST) to use for the PDI
-
inverse (boolean) - Whether to inverse the PDI
-
classify (boolean) - Whether to classify the PDI
-
stats (list) - A list of the requested statistics. Supported statistics are: [“min”, “max”, “mean”, “count”, “sum”, “std”, “median”, “majority”, “minority”, “unique”, “range”, “nodata”]
In case the supplied geometry is a POINT and you provide a radius (in meters), a geodesic buffer will be created and used for the calculations of the zonal statistics.
The output json will contain the requested statistics with their corresponding values.
Example URI
Headers
Content-Type: application/jsonBody
{
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
-4.2609,
41.062
],
[
-4.2598,
41.062
],
[
-4.2598,
41.0613
],
[
-4.2609,
41.0613
],
[
-4.2609,
41.062
]
]
]
},
"date_pre": "2020-01-25",
"date_post": "2020-02-21",
"inverse": false,
"classify": false,
"stats": [
"min",
"max"
]
}Schema
{
"$schema": "http://json-schema.org/draft-06/schema#",
"definitions": {
"crop_type": {
"type": "string",
"enum": [
"cotton",
"soya",
"maize",
"wheat"
]
},
"geometry": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"Point",
"Polygon"
]
}
},
"allOf": [
{
"if": {
"properties": {
"type": {
"const": "Point"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"minItems": 2,
"maxItems": 2,
"items": {
"type": "number"
}
}
}
}
},
{
"if": {
"properties": {
"type": {
"const": "Polygon"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"items": {
"type": "array",
"minItems": 4,
"items": {
"type": "array",
"minItems": 2,
"items": {
"type": "number"
}
}
}
}
}
}
}
],
"required": ["type", "coordinates"]
},
"bbox": {
"type": "array",
"minItems": 4,
"items": {
"type": "number"
}
},
"date": {
"type": "string",
"pattern": "^\d{4}\-(0?[1-9]|1[012])\-(0?[1-9]|[12][0-9]|3[01])$"
},
"identifier": {
"type": "string"
},
"scale": {
"type": "number",
"minimum": 0
},
"touch": {
"type": "boolean"
},
"stats": {
"type": "array",
"items": {
"type": "string",
"enum": [
"min",
"max",
"mean",
"count",
"sum",
"std",
"median",
"majority",
"minority",
"unique",
"range",
"nodata"
]
}
},
"integer": {
"type": "integer"
},
"number": {
"type": "number"
},
"boolean": {
"type": "boolean"
},
},
"type": "object",
"properties": {
"geometry": {
"$ref": "#/definitions/geometry"
},
"date_pre": {
"$ref": "#/definitions/date"
},
"date_post": {
"$ref": "#/definitions/date"
},
"inverse": {
"$ref": "#/definitions/boolean"
},
"classify": {
"$ref": "#/definitions/boolean"
},
"stats": {
"type": "array",
"items": {
"type": "string",
"enum": ["min", "max", "mean", "count", "sum", "std",
"median", "majority", "minority", "unique", "range", "nodata"]
}
}
},
"required": ["geometry", "date_pre", "date_post", "stats"]
}Headers
Content-Type: application/jsonBody
{
"geometry": {
"type": "Point",
"coordinates": [
-4.260339,
41.061665
]
},
"properties": {
"radius": 50
},
"date_pre": "2020-01-25",
"date_post": "2020-02-21",
"inverse": false,
"classify": false,
"stats": [
"min",
"max"
]
}Schema
{
"$schema": "http://json-schema.org/draft-06/schema#",
"definitions": {
"crop_type": {
"type": "string",
"enum": [
"cotton",
"soya",
"maize",
"wheat"
]
},
"geometry": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"Point",
"Polygon"
]
}
},
"allOf": [
{
"if": {
"properties": {
"type": {
"const": "Point"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"minItems": 2,
"maxItems": 2,
"items": {
"type": "number"
}
}
}
}
},
{
"if": {
"properties": {
"type": {
"const": "Polygon"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"items": {
"type": "array",
"minItems": 4,
"items": {
"type": "array",
"minItems": 2,
"items": {
"type": "number"
}
}
}
}
}
}
}
],
"required": ["type", "coordinates"]
},
"bbox": {
"type": "array",
"minItems": 4,
"items": {
"type": "number"
}
},
"date": {
"type": "string",
"pattern": "^\d{4}\-(0?[1-9]|1[012])\-(0?[1-9]|[12][0-9]|3[01])$"
},
"identifier": {
"type": "string"
},
"scale": {
"type": "number",
"minimum": 0
},
"touch": {
"type": "boolean"
},
"stats": {
"type": "array",
"items": {
"type": "string",
"enum": [
"min",
"max",
"mean",
"count",
"sum",
"std",
"median",
"majority",
"minority",
"unique",
"range",
"nodata"
]
}
},
"integer": {
"type": "integer"
},
"number": {
"type": "number"
},
"boolean": {
"type": "boolean"
},
},
"type": "object",
"properties": {
"geometry": {
"$ref": "#/definitions/geometry"
},
"properties": {
"type": "object",
"properties": {
"radius": {
"type": "integer",
}
}
},
"date_pre": {
"$ref": "#/definitions/date"
},
"date_post": {
"$ref": "#/definitions/date"
},
"inverse": {
"$ref": "#/definitions/boolean"
},
"classify": {
"$ref": "#/definitions/boolean"
},
"stats": {
"type": "array",
"items": {
"type": "string",
"enum": ["min", "max", "mean", "count", "sum", "std",
"median", "majority", "minority", "unique", "range", "nodata"]
}
}
},
"required": ["geometry", "date_pre", "date_post", "stats"]
}200Headers
Content-Type: application/jsonBody
{
"max": 21.428571701049805,
"min": 3.7037034034729004,
}400Headers
Content-Type: application/json404Headers
Content-Type: application/json500Headers
Content-Type: application/jsonZonal Statistics for DPI MPDI ¶
DPI MPDIPOST/farm/zonal_analysis/zonal_statistics/dpi_mpdi
Generate the zonal statistics for a farm field, based on the DPI MPDI index.
The resource accepts a JSON object containing the following properties:
-
geometry (geojson) - The boundaries of the field expressed in geojson format
-
date_pre (string) - The date (PRE) to use for the PDI
-
date_post (string) - The date (POST) to use for the PDI
-
inverse (boolean) - Whether to inverse the PDI
-
classify (boolean) - Whether to classify the PDI
-
stats (list) - A list of the requested statistics. Supported statistics are: [“min”, “max”, “mean”, “count”, “sum”, “std”, “median”, “majority”, “minority”, “unique”, “range”, “nodata”]
In case the supplied geometry is a POINT and you provide a radius (in meters), a geodesic buffer will be created and used for the calculations of the zonal statistics.
The output json will contain the requested statistics with their corresponding values.
Example URI
Headers
Content-Type: application/jsonBody
{
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
-4.2609,
41.062
],
[
-4.2598,
41.062
],
[
-4.2598,
41.0613
],
[
-4.2609,
41.0613
],
[
-4.2609,
41.062
]
]
]
},
"date_pre": "2020-03-03",
"date_post": "2020-03-30",
"inverse": false,
"classify": false,
"stats": [
"min",
"max"
]
}Schema
{
"$schema": "http://json-schema.org/draft-06/schema#",
"definitions": {
"crop_type": {
"type": "string",
"enum": [
"cotton",
"soya",
"maize",
"wheat"
]
},
"geometry": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"Point",
"Polygon"
]
}
},
"allOf": [
{
"if": {
"properties": {
"type": {
"const": "Point"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"minItems": 2,
"maxItems": 2,
"items": {
"type": "number"
}
}
}
}
},
{
"if": {
"properties": {
"type": {
"const": "Polygon"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"items": {
"type": "array",
"minItems": 4,
"items": {
"type": "array",
"minItems": 2,
"items": {
"type": "number"
}
}
}
}
}
}
}
],
"required": ["type", "coordinates"]
},
"bbox": {
"type": "array",
"minItems": 4,
"items": {
"type": "number"
}
},
"date": {
"type": "string",
"pattern": "^\d{4}\-(0?[1-9]|1[012])\-(0?[1-9]|[12][0-9]|3[01])$"
},
"identifier": {
"type": "string"
},
"scale": {
"type": "number",
"minimum": 0
},
"touch": {
"type": "boolean"
},
"stats": {
"type": "array",
"items": {
"type": "string",
"enum": [
"min",
"max",
"mean",
"count",
"sum",
"std",
"median",
"majority",
"minority",
"unique",
"range",
"nodata"
]
}
},
"integer": {
"type": "integer"
},
"number": {
"type": "number"
},
"boolean": {
"type": "boolean"
},
},
"type": "object",
"properties": {
"geometry": {
"$ref": "#/definitions/geometry"
},
"date_pre": {
"$ref": "#/definitions/date"
},
"date_post": {
"$ref": "#/definitions/date"
},
"inverse": {
"$ref": "#/definitions/boolean"
},
"classify": {
"$ref": "#/definitions/boolean"
},
"stats": {
"type": "array",
"items": {
"type": "string",
"enum": ["min", "max", "mean", "count", "sum", "std",
"median", "majority", "minority", "unique", "range", "nodata"]
}
}
},
"required": ["geometry", "date_pre", "date_post", "stats"]
}Headers
Content-Type: application/jsonBody
{
"geometry": {
"type": "Point",
"coordinates": [
-4.260339,
41.061665
]
},
"properties": {
"radius": 50
},
"date_pre": "2020-03-03",
"date_post": "2020-03-30",
"inverse": false,
"classify": false,
"stats": [
"min",
"max"
]
}Schema
{
"$schema": "http://json-schema.org/draft-06/schema#",
"definitions": {
"crop_type": {
"type": "string",
"enum": [
"cotton",
"soya",
"maize",
"wheat"
]
},
"geometry": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"Point",
"Polygon"
]
}
},
"allOf": [
{
"if": {
"properties": {
"type": {
"const": "Point"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"minItems": 2,
"maxItems": 2,
"items": {
"type": "number"
}
}
}
}
},
{
"if": {
"properties": {
"type": {
"const": "Polygon"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"items": {
"type": "array",
"minItems": 4,
"items": {
"type": "array",
"minItems": 2,
"items": {
"type": "number"
}
}
}
}
}
}
}
],
"required": ["type", "coordinates"]
},
"bbox": {
"type": "array",
"minItems": 4,
"items": {
"type": "number"
}
},
"date": {
"type": "string",
"pattern": "^\d{4}\-(0?[1-9]|1[012])\-(0?[1-9]|[12][0-9]|3[01])$"
},
"identifier": {
"type": "string"
},
"scale": {
"type": "number",
"minimum": 0
},
"touch": {
"type": "boolean"
},
"stats": {
"type": "array",
"items": {
"type": "string",
"enum": [
"min",
"max",
"mean",
"count",
"sum",
"std",
"median",
"majority",
"minority",
"unique",
"range",
"nodata"
]
}
},
"integer": {
"type": "integer"
},
"number": {
"type": "number"
},
"boolean": {
"type": "boolean"
},
},
"type": "object",
"properties": {
"geometry": {
"$ref": "#/definitions/geometry"
},
"properties": {
"type": "object",
"properties": {
"radius": {
"type": "integer",
}
}
},
"date_pre": {
"$ref": "#/definitions/date"
},
"date_post": {
"$ref": "#/definitions/date"
},
"inverse": {
"$ref": "#/definitions/boolean"
},
"classify": {
"$ref": "#/definitions/boolean"
},
"stats": {
"type": "array",
"items": {
"type": "string",
"enum": ["min", "max", "mean", "count", "sum", "std",
"median", "majority", "minority", "unique", "range", "nodata"]
}
}
},
"required": ["geometry", "date_pre", "date_post", "stats"]
}200Headers
Content-Type: application/jsonBody
{
"max": 21.428571701049805,
"min": 3.7037034034729004,
}400Headers
Content-Type: application/json404Headers
Content-Type: application/json500Headers
Content-Type: application/jsonZonal Statistics for DPI NDVI ¶
DPI NDVIPOST/farm/zonal_analysis/zonal_statistics/dpi_ndvi
Generate the zonal statistics for a farm field, based on the DPI NDVI index.
The resource accepts a JSON object containing the following properties:
-
geometry (geojson) - The boundaries of the field expressed in geojson format
-
date_pre (string) - The date (PRE) to use for the PDI
-
date_post (string) - The date (POST) to use for the PDI
-
inverse (boolean) - Whether to inverse the PDI
-
classify (boolean) - Whether to classify the PDI
-
stats (list) - A list of the requested statistics. Supported statistics are: [“min”, “max”, “mean”, “count”, “sum”, “std”, “median”, “majority”, “minority”, “unique”, “range”, “nodata”]
In case the supplied geometry is a POINT and you provide a radius (in meters), a geodesic buffer will be created and used for the calculations of the zonal statistics.
The output json will contain the requested statistics with their corresponding values.
Example URI
Headers
Content-Type: application/jsonBody
{
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
-4.2609,
41.062
],
[
-4.2598,
41.062
],
[
-4.2598,
41.0613
],
[
-4.2609,
41.0613
],
[
-4.2609,
41.062
]
]
]
},
"date_pre": "2020-01-25",
"date_post": "2020-02-21",
"inverse": false,
"classify": false,
"stats": [
"min",
"max"
]
}Schema
{
"$schema": "http://json-schema.org/draft-06/schema#",
"definitions": {
"crop_type": {
"type": "string",
"enum": [
"cotton",
"soya",
"maize",
"wheat"
]
},
"geometry": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"Point",
"Polygon"
]
}
},
"allOf": [
{
"if": {
"properties": {
"type": {
"const": "Point"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"minItems": 2,
"maxItems": 2,
"items": {
"type": "number"
}
}
}
}
},
{
"if": {
"properties": {
"type": {
"const": "Polygon"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"items": {
"type": "array",
"minItems": 4,
"items": {
"type": "array",
"minItems": 2,
"items": {
"type": "number"
}
}
}
}
}
}
}
],
"required": ["type", "coordinates"]
},
"bbox": {
"type": "array",
"minItems": 4,
"items": {
"type": "number"
}
},
"date": {
"type": "string",
"pattern": "^\d{4}\-(0?[1-9]|1[012])\-(0?[1-9]|[12][0-9]|3[01])$"
},
"identifier": {
"type": "string"
},
"scale": {
"type": "number",
"minimum": 0
},
"touch": {
"type": "boolean"
},
"stats": {
"type": "array",
"items": {
"type": "string",
"enum": [
"min",
"max",
"mean",
"count",
"sum",
"std",
"median",
"majority",
"minority",
"unique",
"range",
"nodata"
]
}
},
"integer": {
"type": "integer"
},
"number": {
"type": "number"
},
"boolean": {
"type": "boolean"
},
},
"type": "object",
"properties": {
"geometry": {
"$ref": "#/definitions/geometry"
},
"date_pre": {
"$ref": "#/definitions/date"
},
"date_post": {
"$ref": "#/definitions/date"
},
"inverse": {
"$ref": "#/definitions/boolean"
},
"classify": {
"$ref": "#/definitions/boolean"
},
"stats": {
"type": "array",
"items": {
"type": "string",
"enum": ["min", "max", "mean", "count", "sum", "std",
"median", "majority", "minority", "unique", "range", "nodata"]
}
}
},
"required": ["geometry", "date_pre", "date_post", "stats"]
}Headers
Content-Type: application/jsonBody
{
"geometry": {
"type": "Point",
"coordinates": [
-4.260339,
41.061665
]
},
"properties": {
"radius": 50
},
"date_pre": "2020-01-25",
"date_post": "2020-02-21",
"inverse": false,
"classify": false,
"stats": [
"min",
"max"
]
}Schema
{
"$schema": "http://json-schema.org/draft-06/schema#",
"definitions": {
"crop_type": {
"type": "string",
"enum": [
"cotton",
"soya",
"maize",
"wheat"
]
},
"geometry": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"Point",
"Polygon"
]
}
},
"allOf": [
{
"if": {
"properties": {
"type": {
"const": "Point"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"minItems": 2,
"maxItems": 2,
"items": {
"type": "number"
}
}
}
}
},
{
"if": {
"properties": {
"type": {
"const": "Polygon"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"items": {
"type": "array",
"minItems": 4,
"items": {
"type": "array",
"minItems": 2,
"items": {
"type": "number"
}
}
}
}
}
}
}
],
"required": ["type", "coordinates"]
},
"bbox": {
"type": "array",
"minItems": 4,
"items": {
"type": "number"
}
},
"date": {
"type": "string",
"pattern": "^\d{4}\-(0?[1-9]|1[012])\-(0?[1-9]|[12][0-9]|3[01])$"
},
"identifier": {
"type": "string"
},
"scale": {
"type": "number",
"minimum": 0
},
"touch": {
"type": "boolean"
},
"stats": {
"type": "array",
"items": {
"type": "string",
"enum": [
"min",
"max",
"mean",
"count",
"sum",
"std",
"median",
"majority",
"minority",
"unique",
"range",
"nodata"
]
}
},
"integer": {
"type": "integer"
},
"number": {
"type": "number"
},
"boolean": {
"type": "boolean"
},
},
"type": "object",
"properties": {
"geometry": {
"$ref": "#/definitions/geometry"
},
"properties": {
"type": "object",
"properties": {
"radius": {
"type": "integer",
}
}
},
"date_pre": {
"$ref": "#/definitions/date"
},
"date_post": {
"$ref": "#/definitions/date"
},
"inverse": {
"$ref": "#/definitions/boolean"
},
"classify": {
"$ref": "#/definitions/boolean"
},
"stats": {
"type": "array",
"items": {
"type": "string",
"enum": ["min", "max", "mean", "count", "sum", "std",
"median", "majority", "minority", "unique", "range", "nodata"]
}
}
},
"required": ["geometry", "date_pre", "date_post", "stats"]
}200Headers
Content-Type: application/jsonBody
{
"max": 21.428571701049805,
"min": 3.7037034034729004,
}400Headers
Content-Type: application/json404Headers
Content-Type: application/json500Headers
Content-Type: application/jsonZonal Statistics for DPI REIP ¶
DPI REIPPOST/farm/zonal_analysis/zonal_statistics/dpi_reip
Generate the zonal statistics for a farm field, based on the DPI REIP index.
The resource accepts a JSON object containing the following properties:
-
geometry (geojson) - The boundaries of the field expressed in geojson format
-
date_pre (string) - The date (PRE) to use for the PDI
-
date_post (string) - The date (POST) to use for the PDI
-
inverse (boolean) - Whether to inverse the PDI
-
classify (boolean) - Whether to classify the PDI
-
stats (list) - A list of the requested statistics. Supported statistics are: [“min”, “max”, “mean”, “count”, “sum”, “std”, “median”, “majority”, “minority”, “unique”, “range”, “nodata”]
In case the supplied geometry is a POINT and you provide a radius (in meters), a geodesic buffer will be created and used for the calculations of the zonal statistics.
The output json will contain the requested statistics with their corresponding values.
Example URI
Headers
Content-Type: application/jsonBody
{
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
-4.2609,
41.062
],
[
-4.2598,
41.062
],
[
-4.2598,
41.0613
],
[
-4.2609,
41.0613
],
[
-4.2609,
41.062
]
]
]
},
"date_pre": "2020-01-25",
"date_post": "2020-02-21",
"inverse": false,
"classify": false,
"stats": [
"min",
"max"
]
}Schema
{
"$schema": "http://json-schema.org/draft-06/schema#",
"definitions": {
"crop_type": {
"type": "string",
"enum": [
"cotton",
"soya",
"maize",
"wheat"
]
},
"geometry": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"Point",
"Polygon"
]
}
},
"allOf": [
{
"if": {
"properties": {
"type": {
"const": "Point"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"minItems": 2,
"maxItems": 2,
"items": {
"type": "number"
}
}
}
}
},
{
"if": {
"properties": {
"type": {
"const": "Polygon"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"items": {
"type": "array",
"minItems": 4,
"items": {
"type": "array",
"minItems": 2,
"items": {
"type": "number"
}
}
}
}
}
}
}
],
"required": ["type", "coordinates"]
},
"bbox": {
"type": "array",
"minItems": 4,
"items": {
"type": "number"
}
},
"date": {
"type": "string",
"pattern": "^\d{4}\-(0?[1-9]|1[012])\-(0?[1-9]|[12][0-9]|3[01])$"
},
"identifier": {
"type": "string"
},
"scale": {
"type": "number",
"minimum": 0
},
"touch": {
"type": "boolean"
},
"stats": {
"type": "array",
"items": {
"type": "string",
"enum": [
"min",
"max",
"mean",
"count",
"sum",
"std",
"median",
"majority",
"minority",
"unique",
"range",
"nodata"
]
}
},
"integer": {
"type": "integer"
},
"number": {
"type": "number"
},
"boolean": {
"type": "boolean"
},
},
"type": "object",
"properties": {
"geometry": {
"$ref": "#/definitions/geometry"
},
"date_pre": {
"$ref": "#/definitions/date"
},
"date_post": {
"$ref": "#/definitions/date"
},
"inverse": {
"$ref": "#/definitions/boolean"
},
"classify": {
"$ref": "#/definitions/boolean"
},
"stats": {
"type": "array",
"items": {
"type": "string",
"enum": ["min", "max", "mean", "count", "sum", "std",
"median", "majority", "minority", "unique", "range", "nodata"]
}
}
},
"required": ["geometry", "date_pre", "date_post", "stats"]
}Headers
Content-Type: application/jsonBody
{
"geometry": {
"type": "Point",
"coordinates": [
-4.260339,
41.061665
]
},
"properties": {
"radius": 50
},
"date_pre": "2020-01-25",
"date_post": "2020-02-21",
"inverse": false,
"classify": false,
"stats": [
"min",
"max"
]
}Schema
{
"$schema": "http://json-schema.org/draft-06/schema#",
"definitions": {
"crop_type": {
"type": "string",
"enum": [
"cotton",
"soya",
"maize",
"wheat"
]
},
"geometry": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"Point",
"Polygon"
]
}
},
"allOf": [
{
"if": {
"properties": {
"type": {
"const": "Point"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"minItems": 2,
"maxItems": 2,
"items": {
"type": "number"
}
}
}
}
},
{
"if": {
"properties": {
"type": {
"const": "Polygon"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"items": {
"type": "array",
"minItems": 4,
"items": {
"type": "array",
"minItems": 2,
"items": {
"type": "number"
}
}
}
}
}
}
}
],
"required": ["type", "coordinates"]
},
"bbox": {
"type": "array",
"minItems": 4,
"items": {
"type": "number"
}
},
"date": {
"type": "string",
"pattern": "^\d{4}\-(0?[1-9]|1[012])\-(0?[1-9]|[12][0-9]|3[01])$"
},
"identifier": {
"type": "string"
},
"scale": {
"type": "number",
"minimum": 0
},
"touch": {
"type": "boolean"
},
"stats": {
"type": "array",
"items": {
"type": "string",
"enum": [
"min",
"max",
"mean",
"count",
"sum",
"std",
"median",
"majority",
"minority",
"unique",
"range",
"nodata"
]
}
},
"integer": {
"type": "integer"
},
"number": {
"type": "number"
},
"boolean": {
"type": "boolean"
},
},
"type": "object",
"properties": {
"geometry": {
"$ref": "#/definitions/geometry"
},
"properties": {
"type": "object",
"properties": {
"radius": {
"type": "integer",
}
}
},
"date_pre": {
"$ref": "#/definitions/date"
},
"date_post": {
"$ref": "#/definitions/date"
},
"inverse": {
"$ref": "#/definitions/boolean"
},
"classify": {
"$ref": "#/definitions/boolean"
},
"stats": {
"type": "array",
"items": {
"type": "string",
"enum": ["min", "max", "mean", "count", "sum", "std",
"median", "majority", "minority", "unique", "range", "nodata"]
}
}
},
"required": ["geometry", "date_pre", "date_post", "stats"]
}200Headers
Content-Type: application/jsonBody
{
"max": 21.428571701049805,
"min": 3.7037034034729004,
}400Headers
Content-Type: application/json404Headers
Content-Type: application/json500Headers
Content-Type: application/jsonZonal Statistics for DPI SigmaVH ¶
DPI SigmaVHPOST/farm/zonal_analysis/zonal_statistics/dpi_sigma_vh
Generate the zonal statistics for a farm field, based on the DPI SigmaVH index.
The resource accepts a JSON object containing the following properties:
-
geometry (geojson) - The boundaries of the field expressed in geojson format
-
date_pre (string) - The date (PRE) to use for the PDI
-
date_post (string) - The date (POST) to use for the PDI
-
inverse (boolean) - Whether to inverse the PDI
-
classify (boolean) - Whether to classify the PDI
-
stats (list) - A list of the requested statistics. Supported statistics are: [“min”, “max”, “mean”, “count”, “sum”, “std”, “median”, “majority”, “minority”, “unique”, “range”, “nodata”]
In case the supplied geometry is a POINT and you provide a radius (in meters), a geodesic buffer will be created and used for the calculations of the zonal statistics.
The output json will contain the requested statistics with their corresponding values.
Example URI
Headers
Content-Type: application/jsonBody
{
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
-4.2609,
41.062
],
[
-4.2598,
41.062
],
[
-4.2598,
41.0613
],
[
-4.2609,
41.0613
],
[
-4.2609,
41.062
]
]
]
},
"date_pre": "2020-03-03",
"date_post": "2020-03-30",
"inverse": false,
"classify": false,
"stats": [
"min",
"max"
]
}Schema
{
"$schema": "http://json-schema.org/draft-06/schema#",
"definitions": {
"crop_type": {
"type": "string",
"enum": [
"cotton",
"soya",
"maize",
"wheat"
]
},
"geometry": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"Point",
"Polygon"
]
}
},
"allOf": [
{
"if": {
"properties": {
"type": {
"const": "Point"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"minItems": 2,
"maxItems": 2,
"items": {
"type": "number"
}
}
}
}
},
{
"if": {
"properties": {
"type": {
"const": "Polygon"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"items": {
"type": "array",
"minItems": 4,
"items": {
"type": "array",
"minItems": 2,
"items": {
"type": "number"
}
}
}
}
}
}
}
],
"required": ["type", "coordinates"]
},
"bbox": {
"type": "array",
"minItems": 4,
"items": {
"type": "number"
}
},
"date": {
"type": "string",
"pattern": "^\d{4}\-(0?[1-9]|1[012])\-(0?[1-9]|[12][0-9]|3[01])$"
},
"identifier": {
"type": "string"
},
"scale": {
"type": "number",
"minimum": 0
},
"touch": {
"type": "boolean"
},
"stats": {
"type": "array",
"items": {
"type": "string",
"enum": [
"min",
"max",
"mean",
"count",
"sum",
"std",
"median",
"majority",
"minority",
"unique",
"range",
"nodata"
]
}
},
"integer": {
"type": "integer"
},
"number": {
"type": "number"
},
"boolean": {
"type": "boolean"
},
},
"type": "object",
"properties": {
"geometry": {
"$ref": "#/definitions/geometry"
},
"date_pre": {
"$ref": "#/definitions/date"
},
"date_post": {
"$ref": "#/definitions/date"
},
"inverse": {
"$ref": "#/definitions/boolean"
},
"classify": {
"$ref": "#/definitions/boolean"
},
"stats": {
"type": "array",
"items": {
"type": "string",
"enum": ["min", "max", "mean", "count", "sum", "std",
"median", "majority", "minority", "unique", "range", "nodata"]
}
}
},
"required": ["geometry", "date_pre", "date_post", "stats"]
}Headers
Content-Type: application/jsonBody
{
"geometry": {
"type": "Point",
"coordinates": [
-4.260339,
41.061665
]
},
"properties": {
"radius": 50
},
"date_pre": "2020-03-03",
"date_post": "2020-03-30",
"inverse": false,
"classify": false,
"stats": [
"min",
"max"
]
}Schema
{
"$schema": "http://json-schema.org/draft-06/schema#",
"definitions": {
"crop_type": {
"type": "string",
"enum": [
"cotton",
"soya",
"maize",
"wheat"
]
},
"geometry": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"Point",
"Polygon"
]
}
},
"allOf": [
{
"if": {
"properties": {
"type": {
"const": "Point"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"minItems": 2,
"maxItems": 2,
"items": {
"type": "number"
}
}
}
}
},
{
"if": {
"properties": {
"type": {
"const": "Polygon"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"items": {
"type": "array",
"minItems": 4,
"items": {
"type": "array",
"minItems": 2,
"items": {
"type": "number"
}
}
}
}
}
}
}
],
"required": ["type", "coordinates"]
},
"bbox": {
"type": "array",
"minItems": 4,
"items": {
"type": "number"
}
},
"date": {
"type": "string",
"pattern": "^\d{4}\-(0?[1-9]|1[012])\-(0?[1-9]|[12][0-9]|3[01])$"
},
"identifier": {
"type": "string"
},
"scale": {
"type": "number",
"minimum": 0
},
"touch": {
"type": "boolean"
},
"stats": {
"type": "array",
"items": {
"type": "string",
"enum": [
"min",
"max",
"mean",
"count",
"sum",
"std",
"median",
"majority",
"minority",
"unique",
"range",
"nodata"
]
}
},
"integer": {
"type": "integer"
},
"number": {
"type": "number"
},
"boolean": {
"type": "boolean"
},
},
"type": "object",
"properties": {
"geometry": {
"$ref": "#/definitions/geometry"
},
"properties": {
"type": "object",
"properties": {
"radius": {
"type": "integer",
}
}
},
"date_pre": {
"$ref": "#/definitions/date"
},
"date_post": {
"$ref": "#/definitions/date"
},
"inverse": {
"$ref": "#/definitions/boolean"
},
"classify": {
"$ref": "#/definitions/boolean"
},
"stats": {
"type": "array",
"items": {
"type": "string",
"enum": ["min", "max", "mean", "count", "sum", "std",
"median", "majority", "minority", "unique", "range", "nodata"]
}
}
},
"required": ["geometry", "date_pre", "date_post", "stats"]
}200Headers
Content-Type: application/jsonBody
{
"max": 21.428571701049805,
"min": 3.7037034034729004,
}400Headers
Content-Type: application/json404Headers
Content-Type: application/json500Headers
Content-Type: application/jsonZonal Statistics for DPI SigmaVV ¶
DPI SigmaVVPOST/farm/zonal_analysis/zonal_statistics/dpi_sigma_vv
Generate the zonal statistics for a farm field, based on the DPI SigmaVV index.
The resource accepts a JSON object containing the following properties:
-
geometry (geojson) - The boundaries of the field expressed in geojson format
-
date_pre (string) - The date (PRE) to use for the PDI
-
date_post (string) - The date (POST) to use for the PDI
-
inverse (boolean) - Whether to inverse the PDI
-
classify (boolean) - Whether to classify the PDI
-
stats (list) - A list of the requested statistics. Supported statistics are: [“min”, “max”, “mean”, “count”, “sum”, “std”, “median”, “majority”, “minority”, “unique”, “range”, “nodata”]
In case the supplied geometry is a POINT and you provide a radius (in meters), a geodesic buffer will be created and used for the calculations of the zonal statistics.
The output json will contain the requested statistics with their corresponding values.
Example URI
Headers
Content-Type: application/jsonBody
{
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
-4.2609,
41.062
],
[
-4.2598,
41.062
],
[
-4.2598,
41.0613
],
[
-4.2609,
41.0613
],
[
-4.2609,
41.062
]
]
]
},
"date_pre": "2020-03-03",
"date_post": "2020-03-30",
"inverse": false,
"classify": false,
"stats": [
"min",
"max"
]
}Schema
{
"$schema": "http://json-schema.org/draft-06/schema#",
"definitions": {
"crop_type": {
"type": "string",
"enum": [
"cotton",
"soya",
"maize",
"wheat"
]
},
"geometry": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"Point",
"Polygon"
]
}
},
"allOf": [
{
"if": {
"properties": {
"type": {
"const": "Point"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"minItems": 2,
"maxItems": 2,
"items": {
"type": "number"
}
}
}
}
},
{
"if": {
"properties": {
"type": {
"const": "Polygon"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"items": {
"type": "array",
"minItems": 4,
"items": {
"type": "array",
"minItems": 2,
"items": {
"type": "number"
}
}
}
}
}
}
}
],
"required": ["type", "coordinates"]
},
"bbox": {
"type": "array",
"minItems": 4,
"items": {
"type": "number"
}
},
"date": {
"type": "string",
"pattern": "^\d{4}\-(0?[1-9]|1[012])\-(0?[1-9]|[12][0-9]|3[01])$"
},
"identifier": {
"type": "string"
},
"scale": {
"type": "number",
"minimum": 0
},
"touch": {
"type": "boolean"
},
"stats": {
"type": "array",
"items": {
"type": "string",
"enum": [
"min",
"max",
"mean",
"count",
"sum",
"std",
"median",
"majority",
"minority",
"unique",
"range",
"nodata"
]
}
},
"integer": {
"type": "integer"
},
"number": {
"type": "number"
},
"boolean": {
"type": "boolean"
},
},
"type": "object",
"properties": {
"geometry": {
"$ref": "#/definitions/geometry"
},
"date_pre": {
"$ref": "#/definitions/date"
},
"date_post": {
"$ref": "#/definitions/date"
},
"inverse": {
"$ref": "#/definitions/boolean"
},
"classify": {
"$ref": "#/definitions/boolean"
},
"stats": {
"type": "array",
"items": {
"type": "string",
"enum": ["min", "max", "mean", "count", "sum", "std",
"median", "majority", "minority", "unique", "range", "nodata"]
}
}
},
"required": ["geometry", "date_pre", "date_post", "stats"]
}Headers
Content-Type: application/jsonBody
{
"geometry": {
"type": "Point",
"coordinates": [
-4.260339,
41.061665
]
},
"properties": {
"radius": 50
},
"date_pre": "2020-03-03",
"date_post": "2020-03-30",
"inverse": false,
"classify": false,
"stats": [
"min",
"max"
]
}Schema
{
"$schema": "http://json-schema.org/draft-06/schema#",
"definitions": {
"crop_type": {
"type": "string",
"enum": [
"cotton",
"soya",
"maize",
"wheat"
]
},
"geometry": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"Point",
"Polygon"
]
}
},
"allOf": [
{
"if": {
"properties": {
"type": {
"const": "Point"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"minItems": 2,
"maxItems": 2,
"items": {
"type": "number"
}
}
}
}
},
{
"if": {
"properties": {
"type": {
"const": "Polygon"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"items": {
"type": "array",
"minItems": 4,
"items": {
"type": "array",
"minItems": 2,
"items": {
"type": "number"
}
}
}
}
}
}
}
],
"required": ["type", "coordinates"]
},
"bbox": {
"type": "array",
"minItems": 4,
"items": {
"type": "number"
}
},
"date": {
"type": "string",
"pattern": "^\d{4}\-(0?[1-9]|1[012])\-(0?[1-9]|[12][0-9]|3[01])$"
},
"identifier": {
"type": "string"
},
"scale": {
"type": "number",
"minimum": 0
},
"touch": {
"type": "boolean"
},
"stats": {
"type": "array",
"items": {
"type": "string",
"enum": [
"min",
"max",
"mean",
"count",
"sum",
"std",
"median",
"majority",
"minority",
"unique",
"range",
"nodata"
]
}
},
"integer": {
"type": "integer"
},
"number": {
"type": "number"
},
"boolean": {
"type": "boolean"
},
},
"type": "object",
"properties": {
"geometry": {
"$ref": "#/definitions/geometry"
},
"properties": {
"type": "object",
"properties": {
"radius": {
"type": "integer",
}
}
},
"date_pre": {
"$ref": "#/definitions/date"
},
"date_post": {
"$ref": "#/definitions/date"
},
"inverse": {
"$ref": "#/definitions/boolean"
},
"classify": {
"$ref": "#/definitions/boolean"
},
"stats": {
"type": "array",
"items": {
"type": "string",
"enum": ["min", "max", "mean", "count", "sum", "std",
"median", "majority", "minority", "unique", "range", "nodata"]
}
}
},
"required": ["geometry", "date_pre", "date_post", "stats"]
}200Headers
Content-Type: application/jsonBody
{
"max": 21.428571701049805,
"min": 3.7037034034729004,
}400Headers
Content-Type: application/json404Headers
Content-Type: application/json500Headers
Content-Type: application/jsonTabulate Area ¶
Resources to provide zonal statistics for classified rasters.
RBR ¶
RBRPOST/farm/tabulate_area/rbr
Generate the tabulate area for a farm field, based on the RBR index.
The resource accepts a JSON object containing the following properties:
-
geometry (geojson) - The boundaries of the field expressed in geojson format
-
start_date (string) - The date the damage started
-
end_date (string) - The date the damage ended
-
identifier_before (string) - The identifier of the satellite image (optional, overrides the “start_date” property)
-
identifier_after (string) - The identifier of the satellite image (optional, overrides the “end_date” property)
-
stats (list) - A list of the requested statistics. Supported statistics are: [“min”, “max”, “mean”, “count”, “sum”, “std”, “median”, “majority”, “minority”, “unique”, “range”, “nodata”]
The output json will contain:
-
The values for the cross-tabulated areas
-
The requested statistics
-
The following metadata:
- SENSING_DATE_1: The sensing date eg. “2018-01-01”
- SENSING_TIME_1: The sensing time eg. “13:00:00”
- SENSING_DATE_2: The sensing date eg. “2018-01-31”
- SENSING_TIME_2: The sensing time eg. “13:00:00”
- NAN_PERCENTAGE: The percentage of NaN values in the RBR image
Example URI
Headers
Content-Type: application/jsonBody
{
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
22.4037,
40.7035
],
[
22.4054,
40.7035
],
[
22.4063,
40.7009
],
[
22.4044,
40.7009
],
[
22.4037,
40.7035
]
]
]
},
"start_date": "2020-06-01",
"end_date": "2020-06-30",
"stats": [
"count"
]
}Schema
{
"$schema": "http://json-schema.org/draft-06/schema#",
"definitions": {
"crop_type": {
"type": "string",
"enum": [
"cotton",
"soya",
"maize",
"wheat"
]
},
"geometry": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"Point",
"Polygon"
]
}
},
"allOf": [
{
"if": {
"properties": {
"type": {
"const": "Point"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"minItems": 2,
"maxItems": 2,
"items": {
"type": "number"
}
}
}
}
},
{
"if": {
"properties": {
"type": {
"const": "Polygon"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"items": {
"type": "array",
"minItems": 4,
"items": {
"type": "array",
"minItems": 2,
"items": {
"type": "number"
}
}
}
}
}
}
}
],
"required": ["type", "coordinates"]
},
"bbox": {
"type": "array",
"minItems": 4,
"items": {
"type": "number"
}
},
"date": {
"type": "string",
"pattern": "^\d{4}\-(0?[1-9]|1[012])\-(0?[1-9]|[12][0-9]|3[01])$"
},
"identifier": {
"type": "string"
},
"scale": {
"type": "number",
"minimum": 0
},
"touch": {
"type": "boolean"
},
"stats": {
"type": "array",
"items": {
"type": "string",
"enum": [
"min",
"max",
"mean",
"count",
"sum",
"std",
"median",
"majority",
"minority",
"unique",
"range",
"nodata"
]
}
},
"integer": {
"type": "integer"
},
"number": {
"type": "number"
},
"boolean": {
"type": "boolean"
},
},
"type": "object",
"properties": {
"geometry": {
"$ref": "#/definitions/geometry"
},
"start_date": {
"$ref": "#/definitions/date"
},
"end_date": {
"$ref": "#/definitions/date"
},
"identifier_before": {
"$ref": "#/definitions/identifier"
},
"identifier_after": {
"$ref": "#/definitions/identifier"
},
"stats": {
"$ref": "#/definitions/stats"
}
},
"required": ["geometry"]
}200Headers
Content-Type: application/jsonBody
{
"geometry": {
"coordinates": [
[
[
618582.555247834,
4506790.998318417
],
[
618726.1731609292,
4506793.294756559
],
[
618806.8268660603,
4506505.888752573
],
[
618646.3064736492,
4506503.320718179
],
[
618582.555247834,
4506790.998318417
]
]
],
"type": "Polygon"
},
"properties": {
"0.0": 8,
"1.0": 118,
"2.0": 3,
"3.0": 4,
"count": 133
},
"tags": {
"NAN_PERCENTAGE": 30.56,
"SENSING_DATE_1": "2020-05-28",
"SENSING_DATE_2": "2020-06-27",
"SENSING_TIME_1": "09:20:29",
"SENSING_TIME_2": "09:20:29"
},
"type": "Feature"
}400Headers
Content-Type: application/json404Headers
Content-Type: application/json500Headers
Content-Type: application/json501Headers
Content-Type: application/jsonModels ¶
Resources to provide models.
Biomass ¶
BiomassPOST/farm/models/biomass
Generate the biomass for a farm field.
The resource accepts a JSON object containing the following properties:
-
crop_type (string) - The crop type for the field (one of “barley”, “cotton”, “maize”, “soya”, “sunflower”, “wheat”)
-
geometry (geojson) - The boundaries of the field expressed in geojson format
-
date (string) - The date to use for the retrieval of the parameter
-
sowing_date (string) - The date that the sowing took place
-
scale (number) - The scale factor for resampling the resulting image (optional, defaults to 1.0)
-
touch (bool) - Whether to ensure that all pixels overlapping the boundaries will be selected (optional, defaults to true)
The output image will contain the following metadata:
-
SENSING_DATE: The sensing date eg. “2018-01-01”
-
SENSING_TIME: The sensing time eg. “13:00:00”
Example URI
Headers
Content-Type: application/jsonBody
{
"crop_type": "cotton",
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
22.403781,
40.703388
],
[
22.403864,
40.70309
],
[
22.403968,
40.702733
],
[
22.404088,
40.702258
],
[
22.403781,
40.703388
]
]
]
},
"date": "2018-05-29",
"sowing_date": "2018-01-01"
}Schema
{
"$schema": "http://json-schema.org/draft-06/schema#",
"definitions": {
"crop_type": {
"type": "string",
"enum": [
"cotton",
"soya",
"maize",
"wheat"
]
},
"geometry": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"Point",
"Polygon"
]
}
},
"allOf": [
{
"if": {
"properties": {
"type": {
"const": "Point"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"minItems": 2,
"maxItems": 2,
"items": {
"type": "number"
}
}
}
}
},
{
"if": {
"properties": {
"type": {
"const": "Polygon"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"items": {
"type": "array",
"minItems": 4,
"items": {
"type": "array",
"minItems": 2,
"items": {
"type": "number"
}
}
}
}
}
}
}
],
"required": ["type", "coordinates"]
},
"bbox": {
"type": "array",
"minItems": 4,
"items": {
"type": "number"
}
},
"date": {
"type": "string",
"pattern": "^\d{4}\-(0?[1-9]|1[012])\-(0?[1-9]|[12][0-9]|3[01])$"
},
"identifier": {
"type": "string"
},
"scale": {
"type": "number",
"minimum": 0
},
"touch": {
"type": "boolean"
},
"stats": {
"type": "array",
"items": {
"type": "string",
"enum": [
"min",
"max",
"mean",
"count",
"sum",
"std",
"median",
"majority",
"minority",
"unique",
"range",
"nodata"
]
}
},
"integer": {
"type": "integer"
},
"number": {
"type": "number"
},
"boolean": {
"type": "boolean"
},
},
"type": "object",
"properties": {
"crop_type": {
"$ref": "#/definitions/crop_type"
},
"geometry": {
"$ref": "#/definitions/geometry"
},
"date": {
"$ref": "#/definitions/date"
},
"sowing_date": {
"$ref": "#/definitions/date"
},
"scale": {
"$ref": "#/definitions/scale"
},
"touch": {
"$ref": "#/definitions/touch"
}
},
"required": ["crop_type", "geometry", "date", "sowing_date"]
}200Headers
Content-Type: image/tiff400Headers
Content-Type: application/json500Headers
Content-Type: application/json501Headers
Content-Type: application/jsonYield Estimation ¶
Yield EstimationPOST/farm/models/yield_estimation
Estimate the yield for a farm field.
The resource accepts a JSON object containing the following properties:
-
crop_type (string) - The crop type for the field (one of “barley”, “cotton”, “maize”, “soya”, “sunflower”, “wheat”)
-
geometry (geojson) - The boundaries of the field expressed in geojson format
-
date (string) - The date to use for the estimation
-
sowing_date (string) - The date that the sowing took place
-
scale (number) - The scale factor for resampling the resulting image (optional, defaults to 1.0)
-
touch (bool) - Whether to ensure that all pixels overlapping the boundaries will be selected (optional, defaults to true)
The output image will contain the following metadata:
-
SENSING_DATE: The sensing date eg. “2018-01-01”
-
SENSING_TIME: The sensing time eg. “13:00:00”
Example URI
Headers
Content-Type: application/jsonBody
{
"crop_type": "cotton",
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
22.403781,
40.703388
],
[
22.403864,
40.70309
],
[
22.403968,
40.702733
],
[
22.404088,
40.702258
],
[
22.403781,
40.703388
]
]
]
},
"date": "2018-05-29",
"sowing_date": "2018-01-01"
}Schema
{
"$schema": "http://json-schema.org/draft-06/schema#",
"definitions": {
"crop_type": {
"type": "string",
"enum": [
"cotton",
"soya",
"maize",
"wheat"
]
},
"geometry": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"Point",
"Polygon"
]
}
},
"allOf": [
{
"if": {
"properties": {
"type": {
"const": "Point"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"minItems": 2,
"maxItems": 2,
"items": {
"type": "number"
}
}
}
}
},
{
"if": {
"properties": {
"type": {
"const": "Polygon"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"items": {
"type": "array",
"minItems": 4,
"items": {
"type": "array",
"minItems": 2,
"items": {
"type": "number"
}
}
}
}
}
}
}
],
"required": ["type", "coordinates"]
},
"bbox": {
"type": "array",
"minItems": 4,
"items": {
"type": "number"
}
},
"date": {
"type": "string",
"pattern": "^\d{4}\-(0?[1-9]|1[012])\-(0?[1-9]|[12][0-9]|3[01])$"
},
"identifier": {
"type": "string"
},
"scale": {
"type": "number",
"minimum": 0
},
"touch": {
"type": "boolean"
},
"stats": {
"type": "array",
"items": {
"type": "string",
"enum": [
"min",
"max",
"mean",
"count",
"sum",
"std",
"median",
"majority",
"minority",
"unique",
"range",
"nodata"
]
}
},
"integer": {
"type": "integer"
},
"number": {
"type": "number"
},
"boolean": {
"type": "boolean"
},
},
"type": "object",
"properties": {
"crop_type": {
"$ref": "#/definitions/crop_type"
},
"geometry": {
"$ref": "#/definitions/geometry"
},
"date": {
"$ref": "#/definitions/date"
},
"sowing_date": {
"$ref": "#/definitions/date"
},
"scale": {
"$ref": "#/definitions/scale"
},
"touch": {
"$ref": "#/definitions/touch"
}
},
"required": ["crop_type", "geometry", "date", "sowing_date"]
}200Headers
Content-Type: image/tiff400Headers
Content-Type: application/json500Headers
Content-Type: application/json501Headers
Content-Type: application/jsonCrop Residues ¶
Crop ResiduesPOST/farm/models/crop_residues
Estimate the crop residues for a farm field.
The resource accepts a JSON object containing the following properties:
-
crop_type (string) - The crop type for the field (one of “barley”, “cotton”, “maize”, “soya”, “sunflower”, “wheat”)
-
geometry (geojson) - The boundaries of the field expressed in geojson format
-
date (string) - The date to use for the estimation
-
sowing_date (string) - The date that the sowing took place
-
scale (number) - The scale factor for resampling the resulting image (optional, defaults to 1.0)
-
touch (bool) - Whether to ensure that all pixels overlapping the boundaries will be selected (optional, defaults to true)
The output image will contain the following metadata:
-
SENSING_DATE: The sensing date eg. “2018-01-01”
-
SENSING_TIME: The sensing time eg. “13:00:00”
Example URI
Headers
Content-Type: application/jsonBody
{
"crop_type": "cotton",
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
22.403781,
40.703388
],
[
22.403864,
40.70309
],
[
22.403968,
40.702733
],
[
22.404088,
40.702258
],
[
22.403781,
40.703388
]
]
]
},
"date": "2018-05-29",
"sowing_date": "2018-01-01"
}Schema
{
"$schema": "http://json-schema.org/draft-06/schema#",
"definitions": {
"crop_type": {
"type": "string",
"enum": [
"cotton",
"soya",
"maize",
"wheat"
]
},
"geometry": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"Point",
"Polygon"
]
}
},
"allOf": [
{
"if": {
"properties": {
"type": {
"const": "Point"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"minItems": 2,
"maxItems": 2,
"items": {
"type": "number"
}
}
}
}
},
{
"if": {
"properties": {
"type": {
"const": "Polygon"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"items": {
"type": "array",
"minItems": 4,
"items": {
"type": "array",
"minItems": 2,
"items": {
"type": "number"
}
}
}
}
}
}
}
],
"required": ["type", "coordinates"]
},
"bbox": {
"type": "array",
"minItems": 4,
"items": {
"type": "number"
}
},
"date": {
"type": "string",
"pattern": "^\d{4}\-(0?[1-9]|1[012])\-(0?[1-9]|[12][0-9]|3[01])$"
},
"identifier": {
"type": "string"
},
"scale": {
"type": "number",
"minimum": 0
},
"touch": {
"type": "boolean"
},
"stats": {
"type": "array",
"items": {
"type": "string",
"enum": [
"min",
"max",
"mean",
"count",
"sum",
"std",
"median",
"majority",
"minority",
"unique",
"range",
"nodata"
]
}
},
"integer": {
"type": "integer"
},
"number": {
"type": "number"
},
"boolean": {
"type": "boolean"
},
},
"type": "object",
"properties": {
"crop_type": {
"$ref": "#/definitions/crop_type"
},
"geometry": {
"$ref": "#/definitions/geometry"
},
"date": {
"$ref": "#/definitions/date"
},
"sowing_date": {
"$ref": "#/definitions/date"
},
"scale": {
"$ref": "#/definitions/scale"
},
"touch": {
"$ref": "#/definitions/touch"
}
},
"required": ["crop_type", "geometry", "date", "sowing_date"]
}200Headers
Content-Type: image/tiff400Headers
Content-Type: application/json500Headers
Content-Type: application/json501Headers
Content-Type: application/jsonIrrigation ¶
IrrigationPOST/farm/models/irrigation
Determine the irrigation decision and dose amount for a farm field.
The resource accepts a JSON object containing the following properties:
-
crop_type (string) - The crop type for the field (one of “cotton”, “grapevine”, “maize”, “wheat”)
-
geometry (geojson) - The boundaries of the field expressed in geojson format
-
date (string) - The date to use for the determination
-
sowing_date (string) - The date that the sowing took place
-
days (integer) - The number of days for which to determine the irrigation
-
sand (integer) - The “sand” value of the field
-
clay (integer) - The “clay” value of the field
-
silt (integer) - The “silt” value of the field
-
org_mat (float) - The “org_mat” value of the field
-
is_irrigated (boolean) - Whether the field is irrigated or not
The output zip file will contain three sets of images, one for “decision” one for the “amount” and one for “sw”. The images will contain the following metadata:
-
SENSING_DATE: The sensing date eg. “2018-01-01”
-
SENSING_TIME: The sensing time eg. “13:00:00”
SW images will contain additional metadata:
-
PERMANENT_WILTING_POINT: A float number eg. 1.2
-
FIELD_CAPACITY: A float number eg. 1.3
-
LOWEST_AVAILABLE_MOISTURE: A float number eg. 1.4
Example URI
Headers
Content-Type: application/jsonBody
{
"crop_type": "cotton",
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
22.403781,
40.703388
],
[
22.403864,
40.70309
],
[
22.403968,
40.702733
],
[
22.404088,
40.702258
],
[
22.403781,
40.703388
]
]
]
},
"date": "2018-05-29",
"sowing_date": "2018-04-24",
"days": 7,
"sand": 35,
"clay": 24,
"silt": 41,
"org_mat": 1.1,
"is_irrigated": false
}Schema
{
"$schema": "http://json-schema.org/draft-06/schema#",
"definitions": {
"crop_type": {
"type": "string",
"enum": [
"cotton",
"soya",
"maize",
"wheat"
]
},
"geometry": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"Point",
"Polygon"
]
}
},
"allOf": [
{
"if": {
"properties": {
"type": {
"const": "Point"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"minItems": 2,
"maxItems": 2,
"items": {
"type": "number"
}
}
}
}
},
{
"if": {
"properties": {
"type": {
"const": "Polygon"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"items": {
"type": "array",
"minItems": 4,
"items": {
"type": "array",
"minItems": 2,
"items": {
"type": "number"
}
}
}
}
}
}
}
],
"required": ["type", "coordinates"]
},
"bbox": {
"type": "array",
"minItems": 4,
"items": {
"type": "number"
}
},
"date": {
"type": "string",
"pattern": "^\d{4}\-(0?[1-9]|1[012])\-(0?[1-9]|[12][0-9]|3[01])$"
},
"identifier": {
"type": "string"
},
"scale": {
"type": "number",
"minimum": 0
},
"touch": {
"type": "boolean"
},
"stats": {
"type": "array",
"items": {
"type": "string",
"enum": [
"min",
"max",
"mean",
"count",
"sum",
"std",
"median",
"majority",
"minority",
"unique",
"range",
"nodata"
]
}
},
"integer": {
"type": "integer"
},
"number": {
"type": "number"
},
"boolean": {
"type": "boolean"
},
},
"type": "object",
"properties": {
"crop_type": {
"$ref": "#/definitions/crop_type"
},
"geometry": {
"$ref": "#/definitions/geometry"
},
"date": {
"$ref": "#/definitions/date"
}
"sowing_date": {
"$ref": "#/definitions/date"
},
"days": {
"type": "integer",
"minimum": 1,
"maximum": 7
},
"sand": {
"type": "integer",
"minimum": 0
},
"clay": {
"type": "integer",
"minimum": 0
},
"silt": {
"type": "integer",
"minimum": 0
},
"org_mat": {
"type": "number",
"minimum": 0
},
"is_irrigated": {
"type": "boolean"
}
},
"required": ["crop_type", "geometry", "date", "sowing_date", "days", "sand", "clay", "silt", "org_mat", "is_irrigated"]
}200Headers
Content-Type: application/zip400Headers
Content-Type: application/json409Headers
Content-Type: application/json500Headers
Content-Type: application/json501Headers
Content-Type: application/jsonCanopy Water Content ¶
Canopy Water ContentPOST/farm/models/canopy_water_content
Estimate the canopy water content for a farm field.
The resource accepts a JSON object containing the following properties:
-
crop_type (string) - The crop type for the field (one of “barley”, “wheat”)
-
geometry (geojson) - The boundaries of the field expressed in geojson format
-
date (string) - The date to use for the estimation
-
scale (number) - The scale factor for resampling the resulting image (optional, defaults to 1.0)
-
touch (bool) - Whether to ensure that all pixels overlapping the boundaries will be selected (optional, defaults to true)
The output image will contain the following metadata:
-
SENSING_DATE: The sensing date eg. “2018-01-01”
-
SENSING_TIME: The sensing time eg. “13:00:00”
Example URI
Headers
Content-Type: application/jsonBody
{
"crop_type":"barley",
"geometry": {"type":"Polygon","coordinates":[[[22.403781,40.703388],[22.403864,40.70309],[22.403968,40.702733],[22.404088,40.702258],[22.403781,40.703388]]]},
"date": "2018-05-29",
}Schema
{
"$schema": "http://json-schema.org/draft-06/schema#",
"definitions": {
"crop_type": {
"type": "string",
"enum": [
"cotton",
"soya",
"maize",
"wheat"
]
},
"geometry": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"Point",
"Polygon"
]
}
},
"allOf": [
{
"if": {
"properties": {
"type": {
"const": "Point"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"minItems": 2,
"maxItems": 2,
"items": {
"type": "number"
}
}
}
}
},
{
"if": {
"properties": {
"type": {
"const": "Polygon"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"items": {
"type": "array",
"minItems": 4,
"items": {
"type": "array",
"minItems": 2,
"items": {
"type": "number"
}
}
}
}
}
}
}
],
"required": ["type", "coordinates"]
},
"bbox": {
"type": "array",
"minItems": 4,
"items": {
"type": "number"
}
},
"date": {
"type": "string",
"pattern": "^\d{4}\-(0?[1-9]|1[012])\-(0?[1-9]|[12][0-9]|3[01])$"
},
"identifier": {
"type": "string"
},
"scale": {
"type": "number",
"minimum": 0
},
"touch": {
"type": "boolean"
},
"stats": {
"type": "array",
"items": {
"type": "string",
"enum": [
"min",
"max",
"mean",
"count",
"sum",
"std",
"median",
"majority",
"minority",
"unique",
"range",
"nodata"
]
}
},
"integer": {
"type": "integer"
},
"number": {
"type": "number"
},
"boolean": {
"type": "boolean"
},
},
"type": "object",
"properties": {
"crop_type": {
"$ref": "#/definitions/crop_type"
},
"geometry": {
"$ref": "#/definitions/geometry"
},
"date": {
"$ref": "#/definitions/date"
},
"scale": {
"$ref": "#/definitions/scale"
},
"touch": {
"$ref": "#/definitions/touch"
}
},
"required": ["crop_type", "geometry", "date"]
}200Headers
Content-Type: image/tiff400Headers
Content-Type: application/json500Headers
Content-Type: application/json501Headers
Content-Type: application/jsonTillage ¶
TillagePOST/farm/models/tillage
Determine the tillage decision for a farm field.
The resource accepts a JSON object containing the following properties:
-
crop_type (string) - The crop type for the field (one of “barley”, “cotton”, “maize”, “wheat”, “grapevine”)
-
geometry (geojson) - The boundaries of the field expressed in geojson format
-
date (string) - The date to use for the determination
-
sowing_date (string) - The date that the sowing took place
-
days (integer) - The number of days for which to determine the tillage
-
sand (integer) - The “sand” value of the field
-
clay (integer) - The “clay” value of the field
-
silt (integer) - The “silt” value of the field
-
org_mat (float) - The “org_mat” value of the field
-
is_irrigated (boolean) - Whether the field is irrigated or not
The output zip file will contain two set of images, one for “decision” and one for “gravimetric_soil_moisture”. The images will contain the following metadata:
-
SENSING_DATE: The sensing date eg. “2018-01-01”
-
SENSING_TIME: The sensing time eg. “13:00:00”
Example URI
Headers
Content-Type: application/jsonBody
{
"crop_type": "cotton",
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
22.403781,
40.703388
],
[
22.403864,
40.70309
],
[
22.403968,
40.702733
],
[
22.404088,
40.702258
],
[
22.403781,
40.703388
]
]
]
},
"date": "2018-05-29",
"sowing_date": "2018-04-24",
"days": 7,
"sand": 35,
"clay": 24,
"silt": 41,
"org_mat": 1.1,
"is_irrigated": false
}Schema
{
"$schema": "http://json-schema.org/draft-06/schema#",
"definitions": {
"crop_type": {
"type": "string",
"enum": [
"cotton",
"soya",
"maize",
"wheat"
]
},
"geometry": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"Point",
"Polygon"
]
}
},
"allOf": [
{
"if": {
"properties": {
"type": {
"const": "Point"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"minItems": 2,
"maxItems": 2,
"items": {
"type": "number"
}
}
}
}
},
{
"if": {
"properties": {
"type": {
"const": "Polygon"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"items": {
"type": "array",
"minItems": 4,
"items": {
"type": "array",
"minItems": 2,
"items": {
"type": "number"
}
}
}
}
}
}
}
],
"required": ["type", "coordinates"]
},
"bbox": {
"type": "array",
"minItems": 4,
"items": {
"type": "number"
}
},
"date": {
"type": "string",
"pattern": "^\d{4}\-(0?[1-9]|1[012])\-(0?[1-9]|[12][0-9]|3[01])$"
},
"identifier": {
"type": "string"
},
"scale": {
"type": "number",
"minimum": 0
},
"touch": {
"type": "boolean"
},
"stats": {
"type": "array",
"items": {
"type": "string",
"enum": [
"min",
"max",
"mean",
"count",
"sum",
"std",
"median",
"majority",
"minority",
"unique",
"range",
"nodata"
]
}
},
"integer": {
"type": "integer"
},
"number": {
"type": "number"
},
"boolean": {
"type": "boolean"
},
},
"type": "object",
"properties": {
"crop_type": {
"$ref": "#/definitions/crop_type"
},
"geometry": {
"$ref": "#/definitions/geometry"
},
"date": {
"$ref": "#/definitions/date"
}
"sowing_date": {
"$ref": "#/definitions/date"
},
"days": {
"type": "integer",
"minimum": 1,
"maximum": 7
},
"sand": {
"type": "integer",
"minimum": 0
},
"clay": {
"type": "integer",
"minimum": 0
},
"silt": {
"type": "integer",
"minimum": 0
},
"org_mat": {
"type": "number",
"minimum": 0
},
"is_irrigated": {
"type": "boolean"
}
},
"required": ["crop_type", "geometry", "date", "sowing_date", "days", "sand", "clay", "silt", "org_mat", "is_irrigated"]
}200Headers
Content-Type: application/zip400Headers
Content-Type: application/json409Headers
Content-Type: application/json500Headers
Content-Type: application/json501Headers
Content-Type: application/jsonNitrogen Fertilization ¶
Nitrogen FertilizationPOST/farm/models/nitrogen_fertilization
Determine the nitrogen fertilization rate for a farm field.
The resource accepts a JSON object containing the following properties:
-
crop_type (string) - The crop type for the field (one of “barley”, “cotton”, “maize”, “wheat”)
-
geometry (geojson) - The boundaries of the field expressed in geojson format
-
sowing_date (string) - The date that the sowing took place
-
days_after_sowing (integer) - The number of days after the sowing (mandatory if one_time property is missing or is false)
-
one_time (boolean) - If true model will calculate only one value
The output image will contain the following metadata:
-
SENSING_DATE: The sensing date eg. “2018-01-01”
-
SENSING_TIME: The sensing time eg. “13:00:00”
Additionally, it will contain the following metadata depending on the crop type:
-
CUMULATIVE_GDD: The cumulative GDD that was used in case the crop type is “cotton”. eg “12.93”
-
GDD: The GDD that was used in case the crop type is “wheat”. eg “6.02”
Example URI
Headers
Content-Type: application/jsonBody
{
"crop_type": "cotton",
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
22.403781,
40.703388
],
[
22.403864,
40.70309
],
[
22.403968,
40.702733
],
[
22.404088,
40.702258
],
[
22.403781,
40.703388
]
]
]
},
"sowing_date": "2018-04-24",
"days_after_sowing": 38
}Schema
{
"$schema": "http://json-schema.org/draft-06/schema#",
"definitions": {
"crop_type": {
"type": "string",
"enum": [
"cotton",
"soya",
"maize",
"wheat"
]
},
"geometry": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"Point",
"Polygon"
]
}
},
"allOf": [
{
"if": {
"properties": {
"type": {
"const": "Point"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"minItems": 2,
"maxItems": 2,
"items": {
"type": "number"
}
}
}
}
},
{
"if": {
"properties": {
"type": {
"const": "Polygon"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"items": {
"type": "array",
"minItems": 4,
"items": {
"type": "array",
"minItems": 2,
"items": {
"type": "number"
}
}
}
}
}
}
}
],
"required": ["type", "coordinates"]
},
"bbox": {
"type": "array",
"minItems": 4,
"items": {
"type": "number"
}
},
"date": {
"type": "string",
"pattern": "^\d{4}\-(0?[1-9]|1[012])\-(0?[1-9]|[12][0-9]|3[01])$"
},
"identifier": {
"type": "string"
},
"scale": {
"type": "number",
"minimum": 0
},
"touch": {
"type": "boolean"
},
"stats": {
"type": "array",
"items": {
"type": "string",
"enum": [
"min",
"max",
"mean",
"count",
"sum",
"std",
"median",
"majority",
"minority",
"unique",
"range",
"nodata"
]
}
},
"integer": {
"type": "integer"
},
"number": {
"type": "number"
},
"boolean": {
"type": "boolean"
},
},
"type": "object",
"properties": {
"crop_type": {
"$ref": "#/definitions/crop_type"
},
"geometry": {
"$ref": "#/definitions/geometry"
},
"sowing_date": {
"$ref": "#/definitions/date"
},
"days_after_sowing": {
"type": "integer",
"minimum": 38,
"maximum": 163,
}
},
"required": ["crop_type", "geometry", "sowing_date", "days_after_sowing"]
}200Headers
Content-Type: image/tiff400Headers
Content-Type: application/json500Headers
Content-Type: application/json501Headers
Content-Type: application/jsonWeather ¶
Resources to weather forecast and observations.
Hourly Data ¶
Hourly DataGET/weather/meteo/hourly
Get hourly data at a given location and a specified period.
Example URI
- lat
number(required)The location latitude (-90 to 90).
- lon
number(required)The location longitude (from -180 to 180).
- from_date
string(required)The period start. Format
yyyy-mm-ddoryyyy-mm-ddThh(e.g. 2019-01-25T05).- to_date
string(required)The period end. Format
yyyy-mm-ddoryyyy-mm-ddThh(e.g. 2019-01-25T05).- variables
string(optional)The required variables in comma-separated form(e.g.
temperature2m,rh2m). The available variables are:-
temperature2m- Temperature at 2 meters above ground in degrees Celsius(°C). -
precipitation- Precipitation accumulated over the past hour in millimeters(equivalent to liters per square meter). -
rh2m- Instantaneous value of the relative humidity at 2 meters above ground as a percentage. -
leafwetness- A binary value indicating the presence or absence of dew on surfaces (leaf_wetness:idx). -
soilmoisture- Volumetric soil water within the top 15 centimeters of the soil profile(-15cm:m3m3). -
reference_et- Evapotranspiration in millimeters accumulated for 1h(evapotranspiration_1h:mm). -
windspeed10m- Wind Speed in m/s at 10 meters above ground(wind_speed_10m:ms). -
winddir- Instantaneous wind direction at 10 meters above ground in degrees from North(wind_dir_10m:d). -
totalcloudines- Refers to the percentage of sky cover obscured by clouds. -
precipitation_prob- Precipitation probability forecast within a specific one hour interval (prob_precip_1h).
-
- timezone
string(optional)If a timezone string is provided (e.g. Europe/Athens) then the given dates will be considered as belonging to that timezone and the returned timestamps will also include the timezone offset. If the timezone is not provided then the default timezone will be used which is
Etc/Utc.
200Headers
Content-Type: application/jsonBody
{
"temperature2m": {
"data": {
"2019-10-02T10:00:00+0000": 27.7229375,
"2019-10-02T11:00:00+0000": 28.5099375,
"2019-10-02T12:00:00+0000": 28.4596875
},
"unit": "C",
"description": "Temperature [C]"
},
"rh2m": {
"data": {
"2019-10-02T10:00:00+0000": 40.4184521484375,
"2019-10-02T11:00:00+0000": 36.6426025390625,
"2019-10-02T12:00:00+0000": 38.4315234375
},
"unit": "%",
"description": "Relative humidity [%]"
}
}Hourly Events ¶
Hourly EventsGET/weather/meteo/hourly/events
Get the severe weather events identified in the datasets for a given period.
Example URI
- lat
number(required)The location latitude (-90 to 90).
- lon
number(required)The location longitude (from -180 to 180).
- from_date
string(required)The period start. Format
yyyy-mm-ddoryyyy-mm-ddThh(e.g. 2019-01-25T05).- to_date
string(required)The period end. Format
yyyy-mm-ddoryyyy-mm-ddThh(e.g. 2019-01-25T05).- timezone
string(optional)If a timezone string is provided (e.g. Europe/Athens) then the given dates will be considered as belonging to that timezone and the returned timestamps will also include the timezone offset. If the timezone is not provided then the default timezone will be used which is
Etc/Utc.
200Headers
Content-Type: application/jsonBody
{
"events": {
"data": {
"2019-10-05T00:00:00+0300": [
{
"frost": 1
}
],
"2019-10-05T01:00:00+0300": [
{
"frost": 1
}
],
"2019-10-05T02:00:00+0300": [
{
"frost": 1
}
]
},
"description": "Severe weather events"
}
}Hourly Icon Class ¶
Hourly Icon ClassGET/weather/meteo/hourly/icon_class
Get icon classes for a specified period and location. There are 15 classes available:
-
sun
-
sun_clouds
-
sun_clouds_rain_light
-
sun_clouds_rain_moderate
-
sun_clouds_rain_heavy
-
sun_clouds_snow_light
-
sun_clouds_snow_moderate
-
sun_clouds_snow_heavy
-
clouds_rain_light
-
clouds_rain_moderate
-
clouds_rain_heavy
-
clouds_snow_light
-
clouds_snow_moderate
-
clouds_snow_heavy
-
clouds
Example URI
- lat
number(required)The location latitude (-90 to 90).
- lon
number(required)The location longitude (from -180 to 180).
- from_date
string(required)The period start. Format
yyyy-mm-ddoryyyy-mm-ddThh(e.g. 2019-01-25T05).- to_date
string(required)The period end. Format
yyyy-mm-ddoryyyy-mm-ddThh(e.g. 2019-01-25T05).- extended
boolean(optional)If true then the API returns details about the icon class.
- timezone
string(optional)If a timezone string is provided (e.g. Europe/Athens) then the given dates will be considered as belonging to that timezone and the returned timestamps will also include the timezone offset. If the timezone is not provided then the default timezone will be used which is
Etc/Utc.
200Headers
Content-Type: application/jsonBody
-- COMPACT VERSION --
{
"icon_class": {
"data": {
"2019-10-02T13:00:00+0000": "sun",
"2019-10-02T14:00:00+0000": "sun_clouds",
"2019-10-02T15:00:00+0000": "sun_clouds",
"2019-10-02T16:00:00+0000": "sun_clouds_rain_light"
},
"description": "Weather icon class"
}
}
-- EXTENDED VERSION --
{
"icon_class": {
"data": {
"2019-10-02T14:00:00+0000": {
"class": "sun_clouds",
"analysis": {
"has_sun": true,
"has_clouds": true,
"precipitation_severity": 0,
"has_snow": false
}
},
"2019-10-02T15:00:00+0000": {
"class": "sun_clouds",
"analysis": {
"has_sun": true,
"has_clouds": true,
"precipitation_severity": 0,
"has_snow": false
}
},
"2019-10-02T16:00:00+0000": {
"class": "sun_clouds_rain_light",
"analysis": {
"has_sun": true,
"has_clouds": true,
"precipitation_severity": 1,
"has_snow": false
}
}
},
"description": "Weather icon class"
}
}Daily Data ¶
Daily DataGET/weather/meteo/daily
Get daily data at a given location and a specified period. Daily data derive from hourly data so in order to get calculated the request must include the appropriate aggregation functions.
Example URI
- lat
number(required)The location latitude (-90 to 90).
- lon
number(required)The location longitude (from -180 to 180).
- from_date
string(required)The period start. Format
yyyy-mm-dd(e.g. 2019-01-18).- to_date
string(required)The period end. Format
yyyy-mm-dd(e.g. 2019-01-18).- variables
string(required)The required variables in comma-separated form(e.g.
temperature2m,rh2m). The available variables are:-
temperature2m- Temperature at 2 meters above ground in degrees Celsius(°C). -
precipitation- Precipitation accumulated over the past hour in millimeters(equivalent to liters per square meter). -
rh2m- Instantaneous value of the relative humidity at 2 meters above ground as a percentage. -
leafwetness- A binary value indicating the presence or absence of dew on surfaces (leaf_wetness:idx). -
soilmoisture- Volumetric soil water within the top 15 centimeters of the soil profile(-15cm:m3m3). -
reference_et- Evapotranspiration in millimeters accumulated for 1h(evapotranspiration_1h:mm). -
windspeed10m- Wind Speed in m/s at 10 meters above ground(wind_speed_10m:ms). -
winddir- Instantaneous wind direction at 10 meters above ground in degrees from North(wind_dir_10m:d). -
totalcloudines- Refers to the percentage of sky cover obscured by clouds. -
precipitation_prob- Precipitation probability forecast within a specific one hour interval (prob_precip_1h).
-
- aggregations
string(required)Every variable must have a corresponding aggregation function. The available functions are:
mean,min,max,sum. The aggregation functions must be comma separated and must match the order and the number of the requested variables.- timezone
string(optional)If a timezone string is provided (e.g. Europe/Athens) then the given dates will be considered as belonging to that timezone. If the timezone is not provided then the default timezone will be used which is
Etc/Utc.
200Headers
Content-Type: application/jsonBody
{
"temperature2m": {
"data": {
"2019-10-02": 29.942,
"2019-10-03": 29.0924375
},
"unit": "C",
"description": "Temperature [C]"
},
"rh2m": {
"data": {
"2019-10-02": 68.57758371988932,
"2019-10-03": 67.90789296468101
},
"unit": "%",
"description": "Relative humidity [%]"
}
}Daily Events ¶
Daily EventsGET/weather/meteo/hourly/events
Get the severe weather events identified in the datasets for a given period in a daily manner. The API returns the maximum severity for each type of event through the day.
Example URI
- lat
number(required)The location latitude (-90 to 90).
- lon
number(required)The location longitude (from -180 to 180).
- from_date
string(required)The period start. Format
yyyy-mm-ddoryyyy-mm-ddThh(e.g. 2019-01-25T05).- to_date
string(required)The period end. Format
yyyy-mm-ddoryyyy-mm-ddThh(e.g. 2019-01-25T05).- timezone
string(optional)If a timezone string is provided (e.g. Europe/Athens) then the given dates will be considered as belonging to that timezone and the returned timestamps will also include the timezone offset. If the timezone is not provided then the default timezone will be used which is
Etc/Utc.
200Headers
Content-Type: application/jsonBody
{
"events": {
"data": {
"2019-11-08T00:00:00+0300": [
{
"frost": 2
}
]
},
"description": "Severe weather events"
}
}Daily Icon Class ¶
Daily Icon ClassGET/weather/meteo/daily/icon_class
Get icon classes for a specified period and location in a daily manner. There are 15 classes available:
-
sun
-
sun_clouds
-
sun_clouds_rain_light
-
sun_clouds_rain_moderate
-
sun_clouds_rain_heavy
-
sun_clouds_snow_light
-
sun_clouds_snow_moderate
-
sun_clouds_snow_heavy
-
clouds_rain_light
-
clouds_rain_moderate
-
clouds_rain_heavy
-
clouds_snow_light
-
clouds_snow_moderate
-
clouds_snow_heavy
-
clouds
Example URI
- lat
number(required)The location latitude (-90 to 90).
- lon
number(required)The location longitude (from -180 to 180).
- from_date
string(required)The period start. Format
yyyy-mm-ddoryyyy-mm-ddThh(e.g. 2019-01-25T05).- to_date
string(required)The period end. Format
yyyy-mm-ddoryyyy-mm-ddThh(e.g. 2019-01-25T05).- extended
boolean(optional)If true then the API returns details about the icon class.
- timezone
string(optional)If a timezone string is provided (e.g. Europe/Athens) then the given dates will be considered as belonging to that timezone and the returned timestamps will also include the timezone offset. If the timezone is not provided then the default timezone will be used which is
Etc/Utc.
200Headers
Content-Type: application/jsonBody
-- COMPACT VERSION --
{
"icon_class": {
"data": {
"2019-10-02T13:00:00+0000": "sun",
"2019-10-02T14:00:00+0000": "sun_clouds",
"2019-10-02T15:00:00+0000": "sun_clouds",
"2019-10-02T16:00:00+0000": "sun_clouds_rain_light"
},
"description": "Weather icon class"
}
}
-- EXTENDED VERSION --
{
"icon_class": {
"data": {
"2019-10-02T14:00:00+0000": {
"class": "sun_clouds",
"analysis": {
"has_sun": true,
"has_clouds": true,
"precipitation_severity": 0,
"has_snow": false
}
},
"2019-10-02T15:00:00+0000": {
"class": "sun_clouds",
"analysis": {
"has_sun": true,
"has_clouds": true,
"precipitation_severity": 0,
"has_snow": false
}
},
"2019-10-02T16:00:00+0000": {
"class": "sun_clouds_rain_light",
"analysis": {
"has_sun": true,
"has_clouds": true,
"precipitation_severity": 1,
"has_snow": false
}
}
},
"description": "Weather icon class"
}
}GDD Crop Types ¶
GDD Crop TypesGET/weather/gdd/crop-types
Get a list of the available crop types that can ben used in the GDD calculation.
Example URI
200Headers
Content-Type: application/jsonBody
[
"sunflower",
"wheat",
"cotton",
"maize",
"corn",
"soybean"
]GDD ¶
GDDGET/weather/gdd/calculate
Calculate the Growing Degree Days (GDD) for a crop type at a given location and a given period.
Example URI
- lat
number(required)The location latitude (-90 to 90).
- lon
number(required)The location longitude (from -180 to 180).
- from_date
string(required)The period start. Format
yyyy-mm-dd(e.g. 2019-01-18).- to_date
string(required)The period end. Format
yyyy-mm-dd(e.g. 2019-01-18).- crop_type
string(optional)A crop type as retrieved from the
/crop-typesendpoint. If not provided then the default Tbase will be used in the calculation.- cumulative
boolean(optional)If provided controls whether the response will contain the cumulative GDD values or just the plain daily values. The default value is
true.- timezone
string(optional)If a timezone string is provided (e.g. Europe/Athens) then the given dates will be considered as belonging to that timezone. If the timezone is not provided then the default timezone will be used which is
Etc/Utc.
200Headers
Content-Type: application/jsonBody
{
"gdd": {
"data": {
"2019-09-02": 15.81759357452395,
"2019-09-03": 31.40403175354005,
"2019-09-04": 47.59865665435795,
"2019-09-05": 62.84112548828131
},
"unit": "C",
"description": "Growing degree days",
"tbase": 10,
"result-quality": 0.8
}
}Climatology ¶
Resources to climatological data.
Request Data ¶
Request DataGET/climatology/indices/{source}/{index}
Request a climatological index.
If the requested dataset requires processing then the service will respond with
a processing response for this and every consecutive identical request while
the processing is in progress.
When the processing is finished then an identical call to the endpoint will
return a ready response including information about the prepared dataset. See
below the two different responses.
Example URI
- source
string(required)The source dataset:
-
era5
-
era5_land
-
seasonal_forecast
-
seasonal_forecast_anomaly
-
- index
string(required)The required climatological index:
NOTICE - Not all indices apply to all sources!
-
gdd (Growing Degree Days)
-
cdd (Cooling Degree-Days)
-
hdd (Heating Degree Days)
-
thi (Temperature Humidity Index)
-
lwi (Leaf Wetness Index)
-
fd (Frost Days)
-
id (Ice Days)
-
wet-days
-
dry-days
-
r20mm
-
tti (Total Totals Index)
-
ki (K-Index)
-
temp-avg
-
temp-min
-
temp-max
-
total-prec
-
dew-temp
-
wind
-
rh
-
pet
-
spei
-
spi
-
temp-avg-anomaly
-
temp-min-amonaly
-
temp-max-anomaly
-
temp-sea-anomaly
-
temp-soil-anomaly
-
wind-anomaly
-
sea-level-pressure-anomaly
-
runoff-rate-of-accumulation-anomaly
-
snow-density-anomaly
-
snow-depth-anomaly
-
solar-radiation-rate-of-accumulation-anomaly
-
total-prec-rate-of-accumulation-anomaly
-
gdd-anomaly
-
cdd-anomaly
-
hdd-anomaly
-
- bbox
string(required)The bounding box of the result. This parameter must contain the four sides of the bounding box separated with comma in the following order: S,W,N,E
For example: 34.6,19.0,41.9,28.7
- from_date
string(optional)This parameter is applicable to specific indices.
- to_date
string(optional)This parameter is applicable to specific indices.
- t_base
number(optional)This parameter is applicable to specific indices.
- wind_height
number(optional)This parameter is applicable to specific indices.
200Headers
Content-Type: application/jsonBody
{
"status": "processing"
}200Headers
Content-Type: application/jsonBody
{
"status": "ready",
"results": [
{
"path": "results/34600_19000_41900_28700/era5/temp-avg_e2b1acff52f850ae17529a9c414e1c80/result.nc",
"source": "era5",
"variable": "t2m",
"bbox": [
34.75,
19,
41.75,
28.5
],
"min_value": -19.682937622070312,
"max_value": 36.917083740234375,
"times": [
"2019-06-10T11:30:00",
"2019-06-11T11:30:00",
"2019-06-12T11:30:00",
"2019-06-13T11:30:00",
"2019-06-14T11:30:00",
"2019-06-15T11:30:00"
]
}
]
}WMS ¶
WMSGET/climatology/data/wms/{path}
WMS compatible endpoint for accessing the datasets.
Example URI
- path
string(required)The path to a dataset as returned by the
climatology/indicesendpoint.
Timeseries ¶
TimeseriesGET/climatology/data/timeseries/{path}
Returns the values of a dataset at a requested location and period.
Example URI
- path
string(required)The path to a dataset as returned by the
climatology/indicesendpoint.- lat
number(required)The location latitude (-90 to 90).
- lon
number(required)The location longitude (from -180 to 180).
- variable
string(required)The variable name in the dataset. (Can be retrieved from the ‘Request Data’ endpoint)
- from_date
string(optional)The period start. Format
yyyy-mm-dd(e.g. 2019-01-18).- to_date
string(optional)The period end. Format
yyyy-mm-dd(e.g. 2019-01-18).
200Headers
Content-Type: application/jsonBody
{
"2010-08-10T11:30:00": 26.902435302734375,
"2010-08-11T11:30:00": 27.021453857421875,
"2010-08-12T11:30:00": 27.11334228515625,
"2010-08-13T11:30:00": 27.454132080078125,
"2010-08-14T11:30:00": 27.65118408203125,
"2010-08-15T11:30:00": 27.839630126953125,
"2010-08-16T11:30:00": 27.866668701171875
}Management Zones ¶
Resources to provide management zones.
NDVI ¶
NDVIPOST/farm/management_zones/ndvi
Generate the management zones from a farm field NDVI timeseries.
The resource accepts a JSON object containing the following properties:
-
geometry (geojson) - The boundaries of the field expressed in geojson format
-
date_from (string) - The date to start getting NDVI
-
date_to (string) - The date to end getting NDVI
-
scale (number) - The scale factor for resampling the resulting image (optional, defaults to 1.0)
-
touch (bool) - Whether to ensure that all pixels overlapping the boundaries will be selected (optional, defaults to true)
The output image will contain the following metadata:
-
SENSING_DATE: The sensing date eg. “2018-01-01”
-
SENSING_TIME: The sensing time eg. “13:00:00”
Example URI
Headers
Content-Type: application/jsonBody
{
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
22.403781,
40.703388
],
[
22.403864,
40.70309
],
[
22.403968,
40.702733
],
[
22.404088,
40.702258
],
[
22.403781,
40.703388
]
]
]
},
"date_from": "2021-04-15",
"date_to": "2021-09-21"
}Schema
{
"$schema": "http://json-schema.org/draft-06/schema#",
"definitions": {
"crop_type": {
"type": "string",
"enum": [
"cotton",
"soya",
"maize",
"wheat"
]
},
"geometry": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"Point",
"Polygon"
]
}
},
"allOf": [
{
"if": {
"properties": {
"type": {
"const": "Point"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"minItems": 2,
"maxItems": 2,
"items": {
"type": "number"
}
}
}
}
},
{
"if": {
"properties": {
"type": {
"const": "Polygon"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"items": {
"type": "array",
"minItems": 4,
"items": {
"type": "array",
"minItems": 2,
"items": {
"type": "number"
}
}
}
}
}
}
}
],
"required": ["type", "coordinates"]
},
"bbox": {
"type": "array",
"minItems": 4,
"items": {
"type": "number"
}
},
"date": {
"type": "string",
"pattern": "^\d{4}\-(0?[1-9]|1[012])\-(0?[1-9]|[12][0-9]|3[01])$"
},
"identifier": {
"type": "string"
},
"scale": {
"type": "number",
"minimum": 0
},
"touch": {
"type": "boolean"
},
"stats": {
"type": "array",
"items": {
"type": "string",
"enum": [
"min",
"max",
"mean",
"count",
"sum",
"std",
"median",
"majority",
"minority",
"unique",
"range",
"nodata"
]
}
},
"integer": {
"type": "integer"
},
"number": {
"type": "number"
},
"boolean": {
"type": "boolean"
},
},
"type": "object",
"properties": {
"geometry": {
"$ref": "#/definitions/geometry"
},
"date_from": {
"$ref": "#/definitions/date"
},
"date_to": {
"$ref": "#/definitions/date"
},
"scale": {
"$ref": "#/definitions/scale"
},
"touch": {
"$ref": "#/definitions/touch"
}
},
"required": ["geometry", "date_from", "date_to"]
}200Headers
Content-Type: image/tiff400Headers
Content-Type: application/json500Headers
Content-Type: application/json501Headers
Content-Type: application/jsonEmissions ¶
Resources to provide emissions.
CO2 ¶
CO2POST/farm/emissions/co2
Calculate co2 emissions of a farm.
The resource accepts a JSON object containing the following properties:
-
crop_type (string) - The crop type for the field (one of “barley”, “cotton”, “grapevine”, “maize”, “soya”, “sunflower”, “wheat”, “olive”, “tomato”, “potato”, “alfalfa”, “canola”, “apple”, “pear”, “peach”, “cherry”, “kiwi”, “apricot”, “orange”, “mandarin”, “lemon”, “spinach”, “pea”, “bean”, “chicory”)
-
size (number) - The size of field in ha
-
soil_texture (string) - The soil texture of field (one of “fine”, “medium”, “coarse”)
-
ph (number) - The ph of field (value is divided by 10 in calculations)
-
clay_content (number) - The clay content of field
-
soc (number) - The soc of field
-
nf_inhibitor (number) - The nf inhibitor of field
-
crop_residues (array) - The crop residues of field (optional)
-
tillage (array) - The tillage data of field (optional)
-
sowing (array) - The sowing data of field (optional)
-
fertilization (array) - The fertilization data of field (optional)
-
spraying (array) - The spraying data of field (optional)
-
pruning (array) - The pruning data of field (optional)
-
thinning (array) - The thinning data of field (optional)
-
mineral_fertilization (array) - The mineral fertilization data of field (optional)
-
is_harvested (bool) - Whether field is harvested or not(optional)
-
irrigations_count (int) - The number of irrigation that have been applied to the field (optional)
-
crop_protection_applications (int) - The number of crop protection applications of the field (optional)
-
harvests_count (int) - The number of harvests of the field (optional)
The output json will contain CO2 emissions per category
Example URI
Headers
Content-Type: application/jsonBody
{
"crop_type": "wheat",
"soil_texture": "medium",
"clay_content": 24,
"ph": 70,
"nf_inhibitor": 0.63,
"size": 5.5,
"soc": 1.2,
"crop_residues": [
{
"amount": 100,
"residues_management": "burned",
}
],
"is_harvested": true,
"harvests_count": 2,
"irrigations_count": 1,
"crop_protection_applications": 1,
"mineral_fertilization": [
{
"n_fert": 250,
"n_rate": 21,
"e_fie": 0.86,
"f_n2o": 0.0055,
"f_no": 0.0050,
"f_nh3": 0.1508,
"nf_inhibitor":1,
"urea": false,
"type": "basal"
},
{
"n_fert": 200,
"n_rate": 46,
"e_fie": 0.91,
"f_n2o": 0.0051,
"f_no": 0.0061,
"f_nh3": 0.666,
"nf_inhibitor": 0.63,
"urea": true,
"type": "midseason"
},
{
"n_fert": 3.215,
"n_rate": 18,
"e_fie": 1,
"f_n2o": 0.0034,
"f_no": 0.0054,
"f_nh3": -1.585,
"nf_inhibitor": 1,
"urea": false,
"type": "foliar"
}
],
"tillage": [
{
"machine_type": "moldboard_ploughing"
},
{
"machine_type": "disc_harrowing"
}
],
"sowing": [
{
"machine_type": "seeder"
}
],
"fertilization": [
{
"machine_type": "dry_fertilizer"
},
{
"machine_type": "sprayer"
}
],
"spraying": [
{
"machine_type": "sprayer"
},
{
"machine_type": "sprayer"
}
]
"pruning": [
{
"machine_type": "mechanical_pruning"
}
]
"thinning": [
{
"machine_type": "mechanical_thinning"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-06/schema#",
"definitions": {
"crop_type": {
"type": "string",
"enum": [
"cotton",
"soya",
"maize",
"wheat"
]
},
"geometry": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"Point",
"Polygon"
]
}
},
"allOf": [
{
"if": {
"properties": {
"type": {
"const": "Point"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"minItems": 2,
"maxItems": 2,
"items": {
"type": "number"
}
}
}
}
},
{
"if": {
"properties": {
"type": {
"const": "Polygon"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"items": {
"type": "array",
"minItems": 4,
"items": {
"type": "array",
"minItems": 2,
"items": {
"type": "number"
}
}
}
}
}
}
}
],
"required": ["type", "coordinates"]
},
"bbox": {
"type": "array",
"minItems": 4,
"items": {
"type": "number"
}
},
"date": {
"type": "string",
"pattern": "^\d{4}\-(0?[1-9]|1[012])\-(0?[1-9]|[12][0-9]|3[01])$"
},
"identifier": {
"type": "string"
},
"scale": {
"type": "number",
"minimum": 0
},
"touch": {
"type": "boolean"
},
"stats": {
"type": "array",
"items": {
"type": "string",
"enum": [
"min",
"max",
"mean",
"count",
"sum",
"std",
"median",
"majority",
"minority",
"unique",
"range",
"nodata"
]
}
},
"integer": {
"type": "integer"
},
"number": {
"type": "number"
},
"boolean": {
"type": "boolean"
},
},
"type": "object",
"properties": {
"crop_type": {
"type": "string",
"enum": [
"wheat"
]
},
"size": {
"type": "number",
"minimum": 0
},
"soil_texture": {
"type": "string",
"enum": [
"fine",
"medium",
"coarse",
]
},
"ph": {
"type": "number"
},
"clay_content": {
"type": "number",
"minimum": 0,
"maximum": 100
},
"soc": {
"type": "number",
"minimum": 0
},
"nf_inhibitor": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"crop_residues": {
"type": "array",
"items": {
"type": "object",
"properties": {
"amount": {
"type": "number",
"minimum": 0,
},
"residues_management": {
"type": "string",
"enum": [
"burned",
"distributed",
"removed",
]
}
},
"required": ["amount", "residues_management"]
}
},
"tillage": {
"type": "array",
"items": {
"type": "object",
"properties": {
"machine_type": {
"type": "string",
"enum": [
"moldboard_ploughing",
"disc_harrowing",
"stubble_harrowing",
]
}
},
"required": ["machine_type"]
}
},
"sowing": {
"type": "array",
"items": {
"type": "object",
"properties": {
"machine_type": {
"type": "string",
"enum": [
"seeder",
]
}
},
"required": ["machine_type"]
}
},
"fertilization":{
"type": "array",
"items": {
"type": "object",
"properties": {
"machine_type": {
"type": "string",
"enum": [
"dry_fertilizer",
"sprayer",
]
}
},
"required": ["machine_type"]
}
},
"spraying": {
"type": "array",
"items": {
"type": "object",
"properties": {
"machine_type": {
"type": "string",
"enum": [
"sprayer",
]
}
},
"required": ["machine_type"]
}
},
"pruning": {
"type": "array",
"items": {
"type": "object",
"properties": {
"machine_type": {
"type": "string",
"enum": [
"mechanical_pruning",
]
}
},
"required": ["machine_type"]
}
},
"thinning": {
"type": "array",
"items": {
"type": "object",
"properties": {
"machine_type": {
"type": "string",
"enum": [
"mechanical_thinning"
]
}
},
"required": ["machine_type"]
}
},
"mineral_fertilization": {
"type": "array",
"items": {
"type": "object",
"properties": {
"n_fert": {
"type": "number",
"minimum": 0,
},
"n_rate": {
"type": "number",
"minimum": 0,
},
"e_fie": {
"type": "number",
"minimum": 0,
},
"f_n2o": {
"type": "number",
"minimum": 0,
},
"f_no": {
"type": "number",
"minimum": 0,
},
"f_nh3": {
"type": "number",
},
"nf_inhibitor": {
"type": "number",
"minimum": 0,
},
"urea": {
"type": "boolean"
},
"type": {
"type": "string",
"enum": [
"basal",
"midseason",
"foliar",
]
}
},
"required": ["n_fert", "n_rate", "e_fie", "f_n2o", "f_no", "f_nh3", "urea", "type"]
}
},
"is_harvested": {
"$ref": "#/definitions/boolean"
},
"harvests_count": {
"type": "integer",
"minimum": 1,
},
"irrigations_count": {
"type": "integer",
"minimum": 0,
},
"crop_protection_applications": {
"type": "integer",
"minimum": 0,
}
},
"required": ["crop_type", "size", "soil_texture", "ph", "clay_content", "soc", "nf_inhibitor"]
}200Headers
Content-Type: application/jsonBody
{
"crop_protection_emissions": 112.75,
"crop_residues_emissions": 943.13417742,
"fuel_emissions": 595.9381999999999,
"fuel_emissions_detailed": {
"fertilization_emissions": 35.376000000000005,
"harvest_emissions": 209.45540000000003,
"sowing_emissions": 14.74,
"spraying_emissions": 41.272,
"tillage_emissions": 295.09479999999996
"pruning": 21.272
"thinning": 21.272
},
"irrigation_emissions": 2102.1,
"mineral_fertilization_emissions": 4891.859634283272,
"mineral_fertilization_emissions_detailed": {
"basal_fertilizer_emissions": 1930.7688841665447,
"foliar_fertilizer_emissions": 928.6374318460579,
"midseason_fertilizer_emissions": 2032.4533182706696
},
"soil_emissions": 572.6321065748513,
"total_emissions": 9218.414118278122
}400Headers
Content-Type: application/json500Headers
Content-Type: application/json501Headers
Content-Type: application/jsonSpraying ¶
Resources to provide spraying advices.
Spraying ¶
SprayingPOST/farm/spraying
Calculate spraying risk of a farm.
The resource accepts a JSON object containing the following properties:
-
lat (number) - The latitude of the point
-
long (number) - The longitude of the point
-
date (string) - The first date to calculate the spraying risk
-
number_of_days (int) - The number of days from first date to calculate the spraying risk level
-
timezone (string) - The timezone of date (optional, defaults to “Europe/Athens”)
The output json will contain the spraying risk per hour for the chosen dates
-
Risk levels
{ 0: "NO_RISK", 1: "RISK_LEVEL_1", 2: "RISK_LEVEL_2" } -
Message codes
{ 100: "IDEAL_CONDITIONS", 201: "LOW_TEMPERATURE", 202: "MEDIUM_TEMPERATURE", 203: "HIGH_TEMPERATURE", 302: "MEDIUM_PRECIPITATION", 303: "HIGH_PRECIPITATION", 401: "LOW_EVAPORATION", 402: "MEDIUM_EVAPORATION", 403: "HIGH_EVAPORATION", 503: "HIGH_LEAF_WETNESS", 601: "LOW_WIND", 602: "MEDIUM_WIND", 603: "HIGH_WIND", }
Example URI
Headers
Content-Type: application/jsonBody
{
"lat": 40.989619",
"long": 23.650100",
"date": "2022-05-21",
"timezone": "Europe/Athens",
"number_of_days": 7,
}Schema
{
"$schema": "http://json-schema.org/draft-06/schema#",
"definitions": {
"crop_type": {
"type": "string",
"enum": [
"cotton",
"soya",
"maize",
"wheat"
]
},
"geometry": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"Point",
"Polygon"
]
}
},
"allOf": [
{
"if": {
"properties": {
"type": {
"const": "Point"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"minItems": 2,
"maxItems": 2,
"items": {
"type": "number"
}
}
}
}
},
{
"if": {
"properties": {
"type": {
"const": "Polygon"
}
}
},
"then": {
"properties": {
"coordinates": {
"type": "array",
"items": {
"type": "array",
"minItems": 4,
"items": {
"type": "array",
"minItems": 2,
"items": {
"type": "number"
}
}
}
}
}
}
}
],
"required": ["type", "coordinates"]
},
"bbox": {
"type": "array",
"minItems": 4,
"items": {
"type": "number"
}
},
"date": {
"type": "string",
"pattern": "^\d{4}\-(0?[1-9]|1[012])\-(0?[1-9]|[12][0-9]|3[01])$"
},
"identifier": {
"type": "string"
},
"scale": {
"type": "number",
"minimum": 0
},
"touch": {
"type": "boolean"
},
"stats": {
"type": "array",
"items": {
"type": "string",
"enum": [
"min",
"max",
"mean",
"count",
"sum",
"std",
"median",
"majority",
"minority",
"unique",
"range",
"nodata"
]
}
},
"integer": {
"type": "integer"
},
"number": {
"type": "number"
},
"boolean": {
"type": "boolean"
},
},
"type": "object",
"properties": {
"lat": {
"$ref": "#/definitions/lat"
},
"long": {
"$ref": "#/definitions/long"
},
"date": {
"$ref": "#/definitions/date"
},
"timezone": {
"$ref": "#/definitions/timezone"
},
"number_of_days": {
"$ref": "#/definitions/number_of_days"
}
},
"required": ["lat", "long", "date", "number_of_days"]
}200Headers
Content-Type: application/jsonBody
{
"2022-06-06 00:00:00": {
"max_risk": {
"risk_level": 0
},
"temperature_risk": {
"risk_level": 0,
"message_code": 100
},
"precipitation_risk": {
"risk_level": 0,
"message_code": 100
},
"evaporation_risk": {
"risk_level": 0,
"message_code": 100
},
"leaf_wetness_risk": {
"risk_level": 0,
"message_code": 100
},
"wind_risk": {
"risk_level": 0,
"message_code": 100
}
},
"2022-06-06 01:00:00": {
"max_risk": {
"risk_level": 2
},
"temperature_risk": {
"risk_level": 0,
"message_code": 100
},
"precipitation_risk": {
"risk_level": 0,
"message_code": 100
},
"evaporation_risk": {
"risk_level": 0,
"message_code": 402
},
"leaf_wetness_risk": {
"risk_level": 0,
"message_code": 100
},
"wind_risk": {
"risk_level": 0,
"message_code": 603
}
},
"2022-06-06 02:00:00": {
"max_risk": {
"risk_level": 2
},
"temperature_risk": {
"risk_level": 0,
"message_code": 100
},
"precipitation_risk": {
"risk_level": 0,
"message_code": 100
},
"evaporation_risk": {
"risk_level": 1,
"message_code": 402
},
"leaf_wetness_risk": {
"risk_level": 0,
"message_code": 100
},
"wind_risk": {
"risk_level": 2,
"message_code": 603
}
}
}400Headers
Content-Type: application/json500Headers
Content-Type: application/json501Headers
Content-Type: application/jsonSustainability Indicators ¶
Resources to provide sustainability indicators.
Farmers Workers Safety ¶
Farmers Workers SafetyPOST/farm/sustainability_indicators/farmers_workers_safety
Calculate farmers and workers safety indicator related to the spraying events of a farm.
The resource accepts a JSON object containing the following properties:
-
lat (number) - The latitude of the point
-
long (number) - The longitude of the point
-
timezone (string) - The timezone of date (ex. “Europe/Athens”)
-
spraying_actions(object) - Farmer’s spraying actions
The output json will contain the spraying sustainability indicator and score for the provided actions
Example URI
Headers
Content-Type: application/jsonBody
{
"lat": 38.063682,
"long": 23.883738,
"spraying_actions": [
{"spraying_type": "herbicide", "datetime": "2023-05-18 11:00:00"},
{"spraying_type": "fungicide", "datetime": "2023-05-18 12:00:00"},
{"spraying_type": "biostimulants", "datetime": "2023-05-18 20:00:00"},
],
"timezone": "Europe/Athens"
}Schema
{
"$schema": "http://json-schema.org/draft-06/schema#",
"type": "object",
"properties": {
"lat": {
"type": "number"
},
"long": {
"type": "number"
},
"timezone": {
"type": "string"
},
"spraying_actions":{
"type":"object",
"properties": {
"spraying_type":{
"type":"string",
"enum": [
"fungicide",
"insecticide",
"herbicide",
"plant_growth_regulators",
"plant_hormones",
"foliar_fertilizers",
"biostimulants"
]
},
"datetime":{
"type":"string"
}
}
}
},
"required": ["lat", "long", "spraying_actions", "timezone"]
}200Headers
Content-Type: application/jsonBody
{
"overall_indicator": "average",
"overall_score": 2.2354995055745444,
"spraying": [
{
"datetime": "2023-05-18 11:00:00",
"indicator": "optimal",
"score": 0,
"spraying_type": "herbicide",
},
{
"datetime": "2023-05-18 12:00:00",
"indicator": "optimal",
"score": 0,
"spraying_type": "fungicide",
},
{
"datetime": "2023-05-18 20:00:00",
"indicator": "average",
"score": 6.706498516723633,
"spraying_type": "biostimulants",
}
]
}400Headers
Content-Type: application/json500Headers
Content-Type: application/json501Headers
Content-Type: application/jsonSoil Structure Deterioration ¶
Soil Structure DeteriorationPOST/farm/sustainability_indicators/soil_structure_deterioration
Calculate soil structure deterioration indicator of a farm.
The resource accepts a JSON object containing the following properties:
-
lat (number) - The latitude of the point
-
long (number) - The longitude of the point
-
timezone (string) - The timezone of date (ex. “Europe/Athens”)
-
soil_type(string) - Farm’s soil type
-
tillage_actions(object) - Farmer’s tillage actions
-
bulk_density(number) - Farm’s bulk density. Organic matter parameter, needed for calculations
The output json will contain the soil structure deterioration sustainability indicator and score for the provided actions
Example URI
Headers
Content-Type: application/jsonBody
{
"soil_type": "silt",
"lat": 38.063682,
"lon": 23.883738,
"bulk_density": 1.45,
"tillage_actions": [
{
"machine_type": "moldboard_ploughing",
"datetime": "2023-04-13 12:45:00",
},
{"machine_type": "disc_harrowing", "datetime": "2023-04-12 12:45:00"},
{"machine_type": "power_tiller", "datetime": "2023-04-11 12:45:00"},
],
"timezone": "Europe/Athens",
}Schema
{
"$schema": "http://json-schema.org/draft-06/schema#",
"type": "object",
"properties": {
"lat": {
"type": "number"
},
"long": {
"type": "number"
},
"crop_type": {
"type": "string",
"enum": [
"cotton",
"soya",
"maize",
"wheat"
]
},
"timezone": {
"type": "string"
},
"bulk_density": {
"type": "number"
},
"tillage_actions": {
"type": "object",
"properties": {
"machine_type": {
"type": "string",
"enum": [
"moldboard_ploughing",
"disc_harrowing",
"stubble_harrowing",
"rototiller",
"power_tiller",
"weeder",
"stalks_shredder",
"subsoiler_ripper",
"disk_chisel_plow"
]
},
"datetime": {
"type": "string"
}
},
},
},
"required": ["lat", "long", "bulk_density", "tillage_actions", "soil_type", "timezone"]
}200Headers
Content-Type: application/jsonBody
{
"overall_indicator": "average",
"overall_score": 15.746322642874382,
"tillage": [
{
"datetime": "2023-04-13 12:45:00",
"indicator": "good",
"machine_type": "moldboard_ploughing",
"score": 10.923559199421286,
},
{
"datetime": "2023-04-12 12:45:00",
"indicator": "average",
"machine_type": "disc_harrowing",
"score": 20.569086086327484,
},
{
"datetime": "2023-04-11 12:45:00",
"indicator": "good",
"machine_type": "power_tiller",
"score": 15.746322642874375,
}
]
}400Headers
Content-Type: application/json500Headers
Content-Type: application/json501Headers
Content-Type: application/jsonChemicals Sustainable Application ¶
Chemicals Sustainable ApplicationPOST/farm/sustainability_indicators/chemicals_sustainable_application
Calculate chemicals sustainable application indicator related to the spraying events of a farm.
The resource accepts a JSON object containing the following properties:
-
lat (number) - The latitude of the point
-
long (number) - The longitude of the point
-
timezone (string) - The timezone of date (ex. “Europe/Athens”)
-
spraying_actions(object) - Farmer’s spraying actions
The output json will contain the spraying sustainability indicator and score for the provided actions
Example URI
Headers
Content-Type: application/jsonBody
{
"lat": 38.063682,
"long": 23.883738,
"spraying_actions": [
{
"spraying_type": "herbicide",
"datetime": "2023-06-11 11:00:00"
},
{
"spraying_type": "fungicide",
"datetime": "2023-06-15 12:00:00"
},
{
"spraying_type": "biostimulants",
"datetime": "2023-06-17 20:00:00"
}
],
"timezone": "Europe/Athens"
}Schema
{
"$schema": "http://json-schema.org/draft-06/schema#",
"type": "object",
"properties": {
"lat": {
"type": "number"
},
"long": {
"type": "number"
},
"timezone": {
"type": "string"
},
"spraying_actions": {
"type": "object",
"properties": {
"spraying_type": {
"type": "string",
"enum": [
"fungicide",
"insecticide",
"herbicide",
"plant_growth_regulators",
"plant_hormones",
"foliar_fertilizers",
"biostimulants"
]
},
"datetime": {
"type": "string"
}
}
}
},
"required": [
"lat",
"long",
"spraying_actions",
"timezone"
]
}200Headers
Content-Type: application/jsonBody
{
"overall_indicator": "bad",
"overall_score": 15.445227380564637,
"spraying": [
{
"datetime": "2023-06-11 11:00:00",
"indicator": "bad",
"score": 7.249539494514465,
"spraying_type": "herbicide"
},
{
"datetime": "2023-06-15 12:00:00",
"indicator": "bad",
"score": 27.5679834024049,
"spraying_type": "fungicide"
},
{
"datetime": "2023-06-17 20:00:00",
"indicator": "bad",
"score": 11.518159244774544,
"spraying_type": "biostimulants"
}
]
}400Headers
Content-Type: application/json500Headers
Content-Type: application/json501Headers
Content-Type: application/jsonNutrients Use Efficiency ¶
Nutrients Use EfficiencyPOST/farm/sustainability_indicators/nutrients_use_efficiency
Calculate nutrients use efficiency indicator of a farm.
The resource accepts a JSON object containing the following properties:
-
crop_type (string) - The crop type for the field (one of “barley”, “cotton”, “maize”, “wheat”)
-
fertilization_actions(object) - Farmer’s fertilization actions
The output json will contain the overall nutrients use efficiency sustainability indicator and the overall score for the provided actions
Example URI
Headers
Content-Type: application/jsonBody
{
"fertilization_actions": [
{
"fertilization_type": "manure",
"fertilizer_basic": "poultry_farmyard_manure",
"amount_kg_ha_basic": 200,
"date": "2023-06-15",
"n_percentage": 0.019
},
{
"fertilization_type": "basal",
"fertilizer_basic": "fertilizer_1_16-4-6",
"amount_kg_ha_basic": 200,
"date": "2023-06-15",
"n_p_k_percentage": [
0.16,
0.04,
0.06
]
},
{
"fertilization_type": "basal_manure",
"fertilizer_basic": "fertilizer_1_16-4-6",
"amount_kg_ha_basic": 40,
"fertilizer_secondary": "pig_farmyard_manure",
"amount_kg_ha_secondary": 40,
"n_percentage": 0.007,
"date": "2023-06-15",
"n_p_k_percentage": [
0.16,
0.04,
0.06
]
}
],
"crop_type": "peach"
}Schema
{
"$schema": "http://json-schema.org/draft-06/schema#",
"type": "object",
"properties": {
"crop_type": {
"type": "string",
"enum": [
"cotton",
"soya",
"maize",
"wheat"
]
},
"fertilization_actions": {
"type": "object",
"properties": {
"fertilization_type": {
"type": "string",
"enum": [
"basal",
"midseason",
"basal_manure",
"manure",
"compost"
],
},
"fertilizer_basic": {
"type": "string"
},
"amount_kg_ha_basic": {
"type": "number",
"minimum": 0
},
"fertilizer_secondary": {
"type": "string"
},
"amount_kg_ha_secondary": {
"type": "number",
"minimum": 0
},
"date": {
"type": "string",
"pattern": "^\d{4}\-(0?[1-9]|1[012])\-(0?[1-9]|[12][0-9]|3[01])$"
},
"n_percentage": {
"type": "number",
"minimum": 0
}
"n_p_k_percentage": {
"type": "array",
"minItems": 3,
"maxItems": 3,
"items": {
"type": "number",
"minimum": 0
}
}
}
},
},
"required": ["crop_type", "fertilization_actions"]
}200Headers
Content-Type: application/jsonBody
{
"overall_indicator": "optimal",
"overall_score": 0
}400Headers
Content-Type: application/json500Headers
Content-Type: application/json501Headers
Content-Type: application/jsonWater Use Efficiency ¶
Water Use EfficiencyPOST/farm/sustainability_indicators/water_use_efficiency
Calculate water use efficiency indicator related to the irrigation of a farm.
The resource accepts a JSON object containing the following properties:
-
lat (number) - The latitude of the point
-
long (number) - The longitude of the point
-
timezone (string) - The timezone of date (ex. “Europe/Athens”)
-
start_date (string) - Growing season start date
-
end_date (string) - Growing season end date
-
irrigation (string) - Irrigation system
-
irrigation_applied_mm (number) - Irrigation quantity applied during the growing season
The output json will contain the overall water use efficiency indicator and the overall score for the provided data as well as the amount of “blue” and “green” water
Example URI
Headers
Content-Type: application/jsonBody
{
"lat": 38.063682,
"long": 23.883738,
"timezone": "Europe/Athens",
"start_date": "2023-02-01",
"end_date": "2023-11-31",
"irrigation": "default",
"irrigation_applied_mm": 500
}Schema
{
"$schema": "http://json-schema.org/draft-06/schema#",
"type": "object",
"properties": {
"lat": {
"type": "number"
},
"long": {
"type": "number"
},
"start_date": {
"type": "string",
"pattern": "^\d{4}\-(0?[1-9]|1[012])\-(0?[1-9]|[12][0-9]|3[01])$"
},
"end_date": {
"type": "string",
"pattern": "^\d{4}\-(0?[1-9]|1[012])\-(0?[1-9]|[12][0-9]|3[01])$"
},
"timezone": {
"type": "string"
}
"irrigation": {
"type": "string",
"enum": [
"default",
"borehole_drip",
"borehole_sprinkler",
"closed_pressurized_network_drip",
"closed_pressurized_network_sprinkler",
"surface_abstraction_drip",
"surface_abstraction_sprinkler",
"open_network_drip",
"open_network_sprinkler"
]
},
"irrigation_applied_mm": {
"type": "number"
}
},
"required": [
"lat",
"long",
"start_date",
"end_date",
"timezone",
"irrigation",
"irrigation_applied_mm"
]
}200Headers
Content-Type: application/jsonBody
{
"blue_water": 446.0711391260055,
"green_water": 309.0852775574523,
"overall_indicator": "rational",
"overall_score": 0
}400Headers
Content-Type: application/json500Headers
Content-Type: application/json501Headers
Content-Type: application/jsonGreenhouse gas emissions ¶
Greenhouse gas emissionsPOST/farm/sustainability_indicators/greenhouse_gas_emissions
Calculate greenhouse gas emissions indicator related to agricultural practises applied on a farm.
The resource accepts a JSON object containing the following properties:
-
crop_kg_per_ha (number) - crop quantity in kg per hectare
-
crop_type (string) - crop type
-
size (number) - size of the farm
-
soil_texture (string) - soil texture (ex. medium, coarse)
-
ph (number) - soil ph
-
clay_content (number) - soil clay content
-
soc (number) - soc value
-
nf_inhibitor (number) - nf inhibitor value
-
irrigation (array, optional) - irrigation type
-
tillage (array, optional) - tillage type
-
fertilization (array, optional) - fertilization type
-
spraying (array, optional) - spraying type
The output json will contain the overall greenhouse gas emissions indicator and the overall score for the provided data as well as the fertilizer, fuel and irrigation emissions.
Example URI
Headers
Content-Type: application/jsonBody
{
"crop_kg_per_ha": 50000,
"crop_type": "olive",
"size": 60,
"soil_texture": "medium",
"ph": 6.5,
"clay_content": 15,
"soc": 3.5,
"nf_inhibitor": 0.1,
"irrigation": [
{
"type": "default"
}
],
"tillage": [
{
"machine_type": "power_tiller"
}
],
"fertilization": [
{
"machine_type": "dry_fertilizer"
}
],
"spraying": [
{
"machine_type": "sprayer"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-06/schema#",
"type": "object",
"properties": {
"crop_kg_per_ha": {
"type": "number"
},
"crop_type": {
"type": "string",
"enum": [
"cotton",
"soya",
"maize",
"wheat"
]
},
"size": {
"type": "number"
},
"soil_texture": {
"type": "string",
"enum": [
"fine",
"medium",
"coarse"
]
},
"ph": {
"type": "number"
}
"clay_content": {
"type": "number"
},
"soc": {
"type": "number"
}
"nf_inhibitor": {
"type": "number"
}
"irrigation": {
"type": "string",
"enum": [
"default",
"borehole_drip",
"borehole_sprinkler",
"closed_pressurized_network_drip",
"closed_pressurized_network_sprinkler",
"surface_abstraction_drip",
"surface_abstraction_sprinkler",
"open_network_drip",
"open_network_sprinkler"
]
},
"tillage": {
"type": "object",
"properties": {
"machine_type": {
"type": "string",
"enum": [
"moldboard_ploughing",
"disc_harrowing",
"stubble_harrowing",
"rototiller",
"power_tiller",
"weeder",
"stalks_shredder",
"subsoiler_ripper",
"disk_chisel_plow"
]
}
}
},
"fertilization": {
"type": "object",
"properties": {
"machine_type": {
"type": "string",
"enum": [
"dry_fertilizer",
"sprayer",
"fertilizer_spreading",
"manure_spreader"
]
}
}
},
"spraying": {
"type": "object",
"properties": {
"machine_type": {
"type": "string",
"enum": [
"sprayer"
]
}
}
},
},
"required": [
"crop_kg_per_ha",
"crop_type",
"size",
"soil_texture",
"ph",
"clay_content",
"soc",
"nf_inhibitor"
]
}200Headers
Content-Type: application/jsonBody
{
"fertilizer_emissions": 160.8,
"fuel_emissions": 575.664,
"irrigation_emissions": 22932,
"overall_indicator": "low",
"overall_score": 0
}400Headers
Content-Type: application/json500Headers
Content-Type: application/json501Headers
Content-Type: application/jsonOverall Farmer Score ¶
Overall Farmer ScorePOST/farm/sustainability_indicators/overall_farmer_score
Calculate overall farmer’s performance.
The resource accepts a JSON object containing the following properties:
-
score_chemicals_sustainable_application (number) - chemicals sustainable application score
-
score_farmers_workers_safety (number) - farmers workers safety score
-
score_greenhouse_gas_emissions (number) - greenhouse gas emissions score
-
score_nutrients_use_efficiency (number) - nutrients use efficiency score
-
score_soil_structure_deterioration (number) - soil structure deterioration score
-
score_water_use_efficiency (number) - water use efficiency score
The output json will contain the overall farmer overall score for the provided data.
Example URI
Headers
Content-Type: application/jsonBody
{
"score_chemicals_sustainable_application": 4.333646544,
"score_farmers_workers_safety": 20.347559389968715,
"score_greenhouse_gas_emissions": 0,
"score_nutrients_use_efficiency": 13.3665654,
"score_soil_structure_deterioration": 4.338821580200888,
"score_water_use_efficiency": 0
}Schema
{
"$schema": "http://json-schema.org/draft-06/schema#",
"type": "object",
"properties": {
"score_chemicals_sustainable_application": {
"type": "number"
},
"score_farmers_workers_safety": {
"type": "number"
},
"score_greenhouse_gas_emissions": {
"type": "number"
},
"score_nutrients_use_efficiency": {
"type": "number"
},
"score_soil_structure_deterioration": {
"type": "number"
}
"score_water_use_efficiency": {
"type": "number"
}
},
"required": [
"score_chemicals_sustainable_application",
"score_farmers_workers_safety",
"score_greenhouse_gas_emissions",
"score_nutrients_use_efficiency",
"score_soil_structure_deterioration",
"score_water_use_efficiency"
]
}200Headers
Content-Type: application/jsonBody
{
"overall_score": 5.226007380108481
}400Headers
Content-Type: application/json500Headers
Content-Type: application/json501Headers
Content-Type: application/json