Back to top

Draxis API

Draxis API is a collection of RESTful endpoints that provide farm related data and tools.

The endpoint is located at http://api.draxis.gr

Vegetation Indices

Resources to provide vegetation indices.

CLre

CLre
POST/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)

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

POST /farm/vegetation_indices/clre
Request
HideShow
Headers
Content-Type: application/json
Body
{
  "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": [
                        "Polygon"
                    ]
                },
                "coordinates": {
                    "type": "array",
                    "items": {
                        "type": "array",
                        "minItems": 4,
                        "items": {
                            "type": "array",
                            "minItems": 2,
                            "items": {
                                "type": "number"
                            }
                        }
                    }
                },
                "bbox": {
                    "type": "array",
                    "minItems": 4,
                    "items": {
                        "type": "number"
                    }
                }
            },
            "required": ["type", "coordinates"]
        },
        "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"
        }
    },
    "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"]
}
Response  200
HideShow
Headers
Content-Type: image/tiff
Response  400
HideShow
Headers
Content-Type: application/json
Response  500
HideShow
Headers
Content-Type: application/json
Response  501
HideShow
Headers
Content-Type: application/json

GNDVI

GNDVI
POST/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)

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

POST /farm/vegetation_indices/gndvi
Request
HideShow
Headers
Content-Type: application/json
Body
{
  "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": [
                        "Polygon"
                    ]
                },
                "coordinates": {
                    "type": "array",
                    "items": {
                        "type": "array",
                        "minItems": 4,
                        "items": {
                            "type": "array",
                            "minItems": 2,
                            "items": {
                                "type": "number"
                            }
                        }
                    }
                },
                "bbox": {
                    "type": "array",
                    "minItems": 4,
                    "items": {
                        "type": "number"
                    }
                }
            },
            "required": ["type", "coordinates"]
        },
        "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"
        }
    },
    "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"]
}
Response  200
HideShow
Headers
Content-Type: image/tiff
Response  400
HideShow
Headers
Content-Type: application/json
Response  500
HideShow
Headers
Content-Type: application/json
Response  501
HideShow
Headers
Content-Type: application/json

GWDRVI

GWDRVI
POST/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)

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

POST /farm/vegetation_indices/gwdrvi
Request
HideShow
Headers
Content-Type: application/json
Body
{
  "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": [
                        "Polygon"
                    ]
                },
                "coordinates": {
                    "type": "array",
                    "items": {
                        "type": "array",
                        "minItems": 4,
                        "items": {
                            "type": "array",
                            "minItems": 2,
                            "items": {
                                "type": "number"
                            }
                        }
                    }
                },
                "bbox": {
                    "type": "array",
                    "minItems": 4,
                    "items": {
                        "type": "number"
                    }
                }
            },
            "required": ["type", "coordinates"]
        },
        "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"
        }
    },
    "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"]
}
Response  200
HideShow
Headers
Content-Type: image/tiff
Response  400
HideShow
Headers
Content-Type: application/json
Response  500
HideShow
Headers
Content-Type: application/json
Response  501
HideShow
Headers
Content-Type: application/json

mNDWI

mNDWI
POST/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)

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

POST /farm/vegetation_indices/mndwi
Request
HideShow
Headers
Content-Type: application/json
Body
{
  "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": [
                        "Polygon"
                    ]
                },
                "coordinates": {
                    "type": "array",
                    "items": {
                        "type": "array",
                        "minItems": 4,
                        "items": {
                            "type": "array",
                            "minItems": 2,
                            "items": {
                                "type": "number"
                            }
                        }
                    }
                },
                "bbox": {
                    "type": "array",
                    "minItems": 4,
                    "items": {
                        "type": "number"
                    }
                }
            },
            "required": ["type", "coordinates"]
        },
        "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"
        }
    },
    "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"]
}
Response  200
HideShow
Headers
Content-Type: image/tiff
Response  400
HideShow
Headers
Content-Type: application/json
Response  500
HideShow
Headers
Content-Type: application/json
Response  501
HideShow
Headers
Content-Type: application/json

Flood

Flood
POST/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)

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

POST /farm/vegetation_indices/flood
Request
HideShow
Headers
Content-Type: application/json
Body
{
  "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": [
                        "Polygon"
                    ]
                },
                "coordinates": {
                    "type": "array",
                    "items": {
                        "type": "array",
                        "minItems": 4,
                        "items": {
                            "type": "array",
                            "minItems": 2,
                            "items": {
                                "type": "number"
                            }
                        }
                    }
                },
                "bbox": {
                    "type": "array",
                    "minItems": 4,
                    "items": {
                        "type": "number"
                    }
                }
            },
            "required": ["type", "coordinates"]
        },
        "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"
        }
    },
    "type": "object",
    "properties": {
        "geometry": {
            "$ref": "#/definitions/geometry"
        },
        "date": {
            "$ref": "#/definitions/date"
        },
        "identifier": {
            "$ref": "#/definitions/identifier"
        }
    },
    "required": ["geometry", "date"]
}
Response  200
HideShow
Headers
Content-Type: image/tiff
Response  400
HideShow
Headers
Content-Type: application/json
Response  500
HideShow
Headers
Content-Type: application/json
Response  501
HideShow
Headers
Content-Type: application/json

NAOC

NAOC
POST/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)

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

POST /farm/vegetation_indices/naoc
Request
HideShow
Headers
Content-Type: application/json
Body
{
  "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": [
                        "Polygon"
                    ]
                },
                "coordinates": {
                    "type": "array",
                    "items": {
                        "type": "array",
                        "minItems": 4,
                        "items": {
                            "type": "array",
                            "minItems": 2,
                            "items": {
                                "type": "number"
                            }
                        }
                    }
                },
                "bbox": {
                    "type": "array",
                    "minItems": 4,
                    "items": {
                        "type": "number"
                    }
                }
            },
            "required": ["type", "coordinates"]
        },
        "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"
        }
    },
    "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"]
}
Response  200
HideShow
Headers
Content-Type: image/tiff
Response  400
HideShow
Headers
Content-Type: application/json
Response  500
HideShow
Headers
Content-Type: application/json
Response  501
HideShow
Headers
Content-Type: application/json

NBR

NBR
POST/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)

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

POST /farm/vegetation_indices/nbr
Request
HideShow
Headers
Content-Type: application/json
Body
{
  "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": [
                        "Polygon"
                    ]
                },
                "coordinates": {
                    "type": "array",
                    "items": {
                        "type": "array",
                        "minItems": 4,
                        "items": {
                            "type": "array",
                            "minItems": 2,
                            "items": {
                                "type": "number"
                            }
                        }
                    }
                },
                "bbox": {
                    "type": "array",
                    "minItems": 4,
                    "items": {
                        "type": "number"
                    }
                }
            },
            "required": ["type", "coordinates"]
        },
        "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"
        }
    },
    "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"]
}
Response  200
HideShow
Headers
Content-Type: image/tiff
Response  400
HideShow
Headers
Content-Type: application/json
Response  500
HideShow
Headers
Content-Type: application/json
Response  501
HideShow
Headers
Content-Type: application/json

NDVI

NDVI
POST/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)

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

POST /farm/vegetation_indices/ndvi
Request
HideShow
Headers
Content-Type: application/json
Body
{
  "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": [
                        "Polygon"
                    ]
                },
                "coordinates": {
                    "type": "array",
                    "items": {
                        "type": "array",
                        "minItems": 4,
                        "items": {
                            "type": "array",
                            "minItems": 2,
                            "items": {
                                "type": "number"
                            }
                        }
                    }
                },
                "bbox": {
                    "type": "array",
                    "minItems": 4,
                    "items": {
                        "type": "number"
                    }
                }
            },
            "required": ["type", "coordinates"]
        },
        "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"
        }
    },
    "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"]
}
Response  200
HideShow
Headers
Content-Type: image/tiff
Response  400
HideShow
Headers
Content-Type: application/json
Response  500
HideShow
Headers
Content-Type: application/json
Response  501
HideShow
Headers
Content-Type: application/json

OSAVI

OSAVI
POST/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)

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

POST /farm/vegetation_indices/osavi
Request
HideShow
Headers
Content-Type: application/json
Body
{
  "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": [
                        "Polygon"
                    ]
                },
                "coordinates": {
                    "type": "array",
                    "items": {
                        "type": "array",
                        "minItems": 4,
                        "items": {
                            "type": "array",
                            "minItems": 2,
                            "items": {
                                "type": "number"
                            }
                        }
                    }
                },
                "bbox": {
                    "type": "array",
                    "minItems": 4,
                    "items": {
                        "type": "number"
                    }
                }
            },
            "required": ["type", "coordinates"]
        },
        "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"
        }
    },
    "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"]
}
Response  200
HideShow
Headers
Content-Type: image/tiff
Response  400
HideShow
Headers
Content-Type: application/json
Response  500
HideShow
Headers
Content-Type: application/json
Response  501
HideShow
Headers
Content-Type: application/json

RVI

RVI
POST/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)

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

POST /farm/vegetation_indices/rvi
Request
HideShow
Headers
Content-Type: application/json
Body
{
  "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": [
                        "Polygon"
                    ]
                },
                "coordinates": {
                    "type": "array",
                    "items": {
                        "type": "array",
                        "minItems": 4,
                        "items": {
                            "type": "array",
                            "minItems": 2,
                            "items": {
                                "type": "number"
                            }
                        }
                    }
                },
                "bbox": {
                    "type": "array",
                    "minItems": 4,
                    "items": {
                        "type": "number"
                    }
                }
            },
            "required": ["type", "coordinates"]
        },
        "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"
        }
    },
    "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"]
}
Response  200
HideShow
Headers
Content-Type: image/tiff
Response  400
HideShow
Headers
Content-Type: application/json
Response  500
HideShow
Headers
Content-Type: application/json
Response  501
HideShow
Headers
Content-Type: application/json

Biophysical Parameters

Resources to provide biophysical parameters.

Biomass

Biomass
POST/farm/biophysical_parameters/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

  • 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

POST /farm/biophysical_parameters/biomass
Request
HideShow
Headers
Content-Type: application/json
Body
{
  "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"
}
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": [
                        "Polygon"
                    ]
                },
                "coordinates": {
                    "type": "array",
                    "items": {
                        "type": "array",
                        "minItems": 4,
                        "items": {
                            "type": "array",
                            "minItems": 2,
                            "items": {
                                "type": "number"
                            }
                        }
                    }
                },
                "bbox": {
                    "type": "array",
                    "minItems": 4,
                    "items": {
                        "type": "number"
                    }
                }
            },
            "required": ["type", "coordinates"]
        },
        "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"
        }
    },
    "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"]
}
Response  200
HideShow
Headers
Content-Type: image/tiff
Response  400
HideShow
Headers
Content-Type: application/json
Response  500
HideShow
Headers
Content-Type: application/json
Response  501
HideShow
Headers
Content-Type: application/json

Chl LAI

Chl LAI
POST/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 “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)

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

POST /farm/biophysical_parameters/chl_lai
Request
HideShow
Headers
Content-Type: application/json
Body
{
  "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": [
                        "Polygon"
                    ]
                },
                "coordinates": {
                    "type": "array",
                    "items": {
                        "type": "array",
                        "minItems": 4,
                        "items": {
                            "type": "array",
                            "minItems": 2,
                            "items": {
                                "type": "number"
                            }
                        }
                    }
                },
                "bbox": {
                    "type": "array",
                    "minItems": 4,
                    "items": {
                        "type": "number"
                    }
                }
            },
            "required": ["type", "coordinates"]
        },
        "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"
        }
    },
    "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"]
}
Response  200
HideShow
Headers
Content-Type: image/tiff
Response  400
HideShow
Headers
Content-Type: application/json
Response  500
HideShow
Headers
Content-Type: application/json
Response  501
HideShow
Headers
Content-Type: application/json

LAI

LAI
POST/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 “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)

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

POST /farm/biophysical_parameters/lai
Request
HideShow
Headers
Content-Type: application/json
Body
{
  "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": [
                        "Polygon"
                    ]
                },
                "coordinates": {
                    "type": "array",
                    "items": {
                        "type": "array",
                        "minItems": 4,
                        "items": {
                            "type": "array",
                            "minItems": 2,
                            "items": {
                                "type": "number"
                            }
                        }
                    }
                },
                "bbox": {
                    "type": "array",
                    "minItems": 4,
                    "items": {
                        "type": "number"
                    }
                }
            },
            "required": ["type", "coordinates"]
        },
        "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"
        }
    },
    "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"]
}
Response  200
HideShow
Headers
Content-Type: image/tiff
Response  400
HideShow
Headers
Content-Type: application/json
Response  500
HideShow
Headers
Content-Type: application/json
Response  501
HideShow
Headers
Content-Type: application/json

Damage Assessment

Resources to provide damage assessment tools.

dNBR

dNBR
POST/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)

Example URI

POST /farm/damage_assessment/dnbr
Request
HideShow
Headers
Content-Type: application/json
Body
{
  "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": [
                        "Polygon"
                    ]
                },
                "coordinates": {
                    "type": "array",
                    "items": {
                        "type": "array",
                        "minItems": 4,
                        "items": {
                            "type": "array",
                            "minItems": 2,
                            "items": {
                                "type": "number"
                            }
                        }
                    }
                },
                "bbox": {
                    "type": "array",
                    "minItems": 4,
                    "items": {
                        "type": "number"
                    }
                }
            },
            "required": ["type", "coordinates"]
        },
        "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"
        }
    },
    "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", "damage_start_date", damage_end_date]
}
Response  200
HideShow
Headers
Content-Type: image/tiff
Response  400
HideShow
Headers
Content-Type: application/json
Response  500
HideShow
Headers
Content-Type: application/json
Response  501
HideShow
Headers
Content-Type: application/json

PDI

PDI
POST/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)

Example URI

POST /farm/damage_assessment/pdi
Request
HideShow
Headers
Content-Type: application/json
Body
{
  "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": [
                        "Polygon"
                    ]
                },
                "coordinates": {
                    "type": "array",
                    "items": {
                        "type": "array",
                        "minItems": 4,
                        "items": {
                            "type": "array",
                            "minItems": 2,
                            "items": {
                                "type": "number"
                            }
                        }
                    }
                },
                "bbox": {
                    "type": "array",
                    "minItems": 4,
                    "items": {
                        "type": "number"
                    }
                }
            },
            "required": ["type", "coordinates"]
        },
        "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"
        }
    },
    "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", "damage_start_date", damage_end_date]
}
Response  200
HideShow
Headers
Content-Type: image/tiff
Response  400
HideShow
Headers
Content-Type: application/json
Response  500
HideShow
Headers
Content-Type: application/json
Response  501
HideShow
Headers
Content-Type: application/json

Models

Resources to provide models.

Crop Residues

Crop Residues
POST/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

  • 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

POST /farm/models/crop_residues
Request
HideShow
Headers
Content-Type: application/json
Body
{
  "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"
}
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": [
                        "Polygon"
                    ]
                },
                "coordinates": {
                    "type": "array",
                    "items": {
                        "type": "array",
                        "minItems": 4,
                        "items": {
                            "type": "array",
                            "minItems": 2,
                            "items": {
                                "type": "number"
                            }
                        }
                    }
                },
                "bbox": {
                    "type": "array",
                    "minItems": 4,
                    "items": {
                        "type": "number"
                    }
                }
            },
            "required": ["type", "coordinates"]
        },
        "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"
        }
    },
    "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"]
}
Response  200
HideShow
Headers
Content-Type: image/tiff
Response  400
HideShow
Headers
Content-Type: application/json
Response  500
HideShow
Headers
Content-Type: application/json
Response  501
HideShow
Headers
Content-Type: application/json

Irrigation

Irrigation
POST/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”, “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 two sets of images, one for “decision” and one for the “amount”. 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

POST /farm/models/irrigation
Request
HideShow
Headers
Content-Type: application/json
Body
{
  "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": [
                        "Polygon"
                    ]
                },
                "coordinates": {
                    "type": "array",
                    "items": {
                        "type": "array",
                        "minItems": 4,
                        "items": {
                            "type": "array",
                            "minItems": 2,
                            "items": {
                                "type": "number"
                            }
                        }
                    }
                },
                "bbox": {
                    "type": "array",
                    "minItems": 4,
                    "items": {
                        "type": "number"
                    }
                }
            },
            "required": ["type", "coordinates"]
        },
        "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"
        }
    },
    "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"]
}
Response  200
HideShow
Headers
Content-Type: application/zip
Response  400
HideShow
Headers
Content-Type: application/json
Response  500
HideShow
Headers
Content-Type: application/json
Response  501
HideShow
Headers
Content-Type: application/json

Nitrogen Fertilization

Nitrogen Fertilization
POST/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 “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

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

POST /farm/models/nitrogen_fertilization
Request
HideShow
Headers
Content-Type: application/json
Body
{
  "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": [
                        "Polygon"
                    ]
                },
                "coordinates": {
                    "type": "array",
                    "items": {
                        "type": "array",
                        "minItems": 4,
                        "items": {
                            "type": "array",
                            "minItems": 2,
                            "items": {
                                "type": "number"
                            }
                        }
                    }
                },
                "bbox": {
                    "type": "array",
                    "minItems": 4,
                    "items": {
                        "type": "number"
                    }
                }
            },
            "required": ["type", "coordinates"]
        },
        "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"
        }
    },
    "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"]
}
Response  200
HideShow
Headers
Content-Type: image/tiff
Response  400
HideShow
Headers
Content-Type: application/json
Response  500
HideShow
Headers
Content-Type: application/json
Response  501
HideShow
Headers
Content-Type: application/json

Yield Estimation

Yield Estimation
POST/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

  • 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

POST /farm/models/yield_estimation
Request
HideShow
Headers
Content-Type: application/json
Body
{
  "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"
}
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": [
                        "Polygon"
                    ]
                },
                "coordinates": {
                    "type": "array",
                    "items": {
                        "type": "array",
                        "minItems": 4,
                        "items": {
                            "type": "array",
                            "minItems": 2,
                            "items": {
                                "type": "number"
                            }
                        }
                    }
                },
                "bbox": {
                    "type": "array",
                    "minItems": 4,
                    "items": {
                        "type": "number"
                    }
                }
            },
            "required": ["type", "coordinates"]
        },
        "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"
        }
    },
    "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"]
}
Response  200
HideShow
Headers
Content-Type: image/tiff
Response  400
HideShow
Headers
Content-Type: application/json
Response  500
HideShow
Headers
Content-Type: application/json
Response  501
HideShow
Headers
Content-Type: application/json

Generated by aglio on 07 May 2019