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.

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.

Biomass

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

POST /farm/models/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",
  "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": [
                        "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"
        },
        "scale": {
            "$ref": "#/definitions/scale"
        },
        "touch": {
            "$ref": "#/definitions/touch"
        }
    },
    "required": ["crop_type", "geometry", "date", "sowing_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

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

  • 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

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",
  "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": [
                        "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"
        },
        "scale": {
            "$ref": "#/definitions/scale"
        },
        "touch": {
            "$ref": "#/definitions/touch"
        }
    },
    "required": ["crop_type", "geometry", "date", "sowing_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

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

  • 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

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",
  "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": [
                        "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"
        },
        "scale": {
            "$ref": "#/definitions/scale"
        },
        "touch": {
            "$ref": "#/definitions/touch"
        }
    },
    "required": ["crop_type", "geometry", "date", "sowing_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

Weather

Resources to weather forecast and observations.

Resolutions

Resolutions
GET/weather/meteo/resolutions

Get the available resolutions of the weather datasets.

Example URI

GET /weather/meteo/resolutions
Response  200
HideShow
Headers
Content-Type: application/json
Body
[
  "6km",
  "6kmobserved",
  "2km",
  "18km",
  "18kmobserved",
  "2kmobserved"
]

Variables

Variables
GET/weather/meteo/variables

Get the available variables for a given resolution.

Example URI

GET /weather/meteo/variables
URI Parameters
HideShow
resolution
string (optional) 

A resolution as retrieved from the /resolutions endpoint. If the resolution is not provided then the API will return the union of all available variables from all available resolutions.

Response  200
HideShow
Headers
Content-Type: application/json
Body
[
  "precipitation",
  "rh2m",
  "surfacepressure",
  "surfacesolarradiation",
  "temperature2m",
  "windspeed10m",
  "totalcloudines",
  "reference_et",
  "temperature2m_min",
  "temperature2m_max"
]

Hourly Data

Hourly Data
GET/weather/meteo/hourly

Get hourly data at a given location and a specified period.

Example URI

GET /weather/meteo/hourly
URI Parameters
HideShow
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 or yyyy-mm-ddThh (e.g. 2019-01-25T05).

to_date
string (required) 

The period end. Format yyyy-mm-dd or yyyy-mm-ddThh (e.g. 2019-01-25T05).

at_date
string (optional) 

Alternative to the from-to date parameters. The at_date parameter is a convenient way of retrieving the weather for a single day or a signle hour. The format is the same as above.

resolution
string (optional) 

A resolution as retrieved from the /resolutions endpoint. If not provided then the default resolution will be used.

variables
string (optional) 

The required variables as retrieved from the /variables endpoint in comma separated form (e.g. temperature2m,rh2m).

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.

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "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 Events
GET/weather/meteo/hourly/events

Get the severe weather events identified in the datasets for a given period.

Example URI

GET /weather/meteo/hourly/events
URI Parameters
HideShow
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 or yyyy-mm-ddThh (e.g. 2019-01-25T05).

to_date
string (required) 

The period end. Format yyyy-mm-dd or yyyy-mm-ddThh (e.g. 2019-01-25T05).

at_date
string (optional) 

Alternative to the from-to date parameters. The at_date parameter is a convenient way of retrieving the weather for a single day or a signle hour. The format is the same as above.

resolution
string (optional) 

A resolution as retrieved from the /resolutions endpoint. If not provided then the default resolution will be used.

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.

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "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 Class
GET/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

GET /weather/meteo/hourly/icon_class
URI Parameters
HideShow
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 or yyyy-mm-ddThh (e.g. 2019-01-25T05).

to_date
string (required) 

The period end. Format yyyy-mm-dd or yyyy-mm-ddThh (e.g. 2019-01-25T05).

at_date
string (optional) 

Alternative to the from-to date parameters. The at_date parameter is a convenient way of retrieving the weather for a single day or a signle hour. The format is the same as above.

extended
boolean (optional) 

If true then the API returns details about the icon class.

resolution
string (optional) 

A resolution as retrieved from the /resolutions endpoint. If not provided then the default resolution will be used.

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.

Response  200
HideShow
Headers
Content-Type: application/json
Body
-- 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 Data
GET/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

GET /weather/meteo/daily
URI Parameters
HideShow
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).

at_date
string (optional) 

Alternative to the from-to date parameters. The at_date parameter is a convenient way of retrieving the weather for a single day or a signle hour. The format is the same as above.

variables
string (required) 

The required variables as retrieved from the /variables endpoint in comma separated form (e.g. temperature2m,rh2m).

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.

resolution
string (optional) 

A resolution as retrieved from the /resolutions endpoint. If not provided then the default resolution will be used.

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.

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "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 Events
GET/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

GET /weather/meteo/hourly/events
URI Parameters
HideShow
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 or yyyy-mm-ddThh (e.g. 2019-01-25T05).

to_date
string (required) 

The period end. Format yyyy-mm-dd or yyyy-mm-ddThh (e.g. 2019-01-25T05).

at_date
string (optional) 

Alternative to the from-to date parameters. The at_date parameter is a convenient way of retrieving the weather for a single day or a signle hour. The format is the same as above.

resolution
string (optional) 

A resolution as retrieved from the /resolutions endpoint. If not provided then the default resolution will be used.

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.

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "events": {
    "data": {
      "2019-11-08T00:00:00+0300": [
        {
          "frost": 2
        }
      ]
    },
    "description": "Severe weather events"
  }
}

Daily Icon Class

Daily Icon Class
GET/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

GET /weather/meteo/daily/icon_class
URI Parameters
HideShow
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 or yyyy-mm-ddThh (e.g. 2019-01-25T05).

to_date
string (required) 

The period end. Format yyyy-mm-dd or yyyy-mm-ddThh (e.g. 2019-01-25T05).

at_date
string (optional) 

Alternative to the from-to date parameters. The at_date parameter is a convenient way of retrieving the weather for a single day or a signle hour. The format is the same as above.

extended
boolean (optional) 

If true then the API returns details about the icon class.

resolution
string (optional) 

A resolution as retrieved from the /resolutions endpoint. If not provided then the default resolution will be used.

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.

Response  200
HideShow
Headers
Content-Type: application/json
Body
-- 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 Types
GET/weather/gdd/crop-types

Get a list of the available crop types that can ben used in the GDD calculation.

Example URI

GET /weather/gdd/crop-types
Response  200
HideShow
Headers
Content-Type: application/json
Body
[
  "sunflower",
  "wheat",
  "cotton",
  "maize",
  "corn",
  "soybean"
]

GDD

GDD
GET/weather/gdd/calculate

Calculate the Growing Degree Days (GDD) for a crop type at a given location and a given period.

Example URI

GET /weather/gdd/calculate
URI Parameters
HideShow
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).

at_date
string (optional) 

Alternative to the from-to date parameters. The at_date parameter is a convenient way of retrieving the weather for a single day or a signle hour. The format is the same as above.

crop_type
string (optional) 

A crop type as retrieved from the /crop-types endpoint. If not provided then the default Tbase will be used in the calculation.

resolution
string (optional) 

A resolution as retrieved from the /resolutions endpoint. If not provided then the default resolution will be used.

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.

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "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
  }
}

Generated by aglio on 17 Oct 2019