Hidromod API

Input Parameters

# Parameter Type Explanation
1 API Key String Unique API Key
2 Id String Id of the request given by you.
3 Product String Product is “soilmoisture” for Soil Moisture.
4 Start String Date that the satellite data start from. (YYYY-MM-DD)
5 End String Date that the satellite data to finish. (YYYY-MM-DD)
6 Polygon-Geometry Object Geojson object of the area for search. This geometry can be extracted via TKGM by the user.

Example Query

        
          curl --location --request GET 'https://hidromodapi.ew.r.appspot.com/tmp/v1.0/risks/soilmoisture?id=12a63884-16ae-4355-9c00-e1227a17b30e&start=2019-06-01&end=2019-06-10&polygon-geometry=POLYGON((26.800%2040.888,26.836%2040.888,26.836%2040.968,26.800%2040.968,26.800%2040.888))' --header 'apikey: <~API-KEY~>'
        
        

Response Outputs

# Parameter Type Explanation
1 Id String Id of the request.
2 Product List Product that is returned.
3 Date String Date (YYYY-MM-DD) of the satellite output that is returned.
4 Value Float Returns soil moisture of subject date for 1km.

Example Response

          
            {
              "id": "12a63884-16ae-4355-9c00-e1227a17b30e",
              "soil_moisture": {
                "2019-06-01": 0.19,
                "2019-06-02": 0.19,
                "2019-06-03": 0.19,
                "2019-06-04": 0.19,
                "2019-06-05": 0.20,
                "2019-06-06": 0.19,
                "2019-06-07": 0.19,
                "2019-06-08": 0.19,
                "2019-06-09": 0.19,
                "2019-06-10": 0.19
              }
            }
          
        

Input Parameters

# Parameter Type Explanation
1 API Key String Unique API Key
2 Id String Id of the request given by you.
3 Product String Product is “risk” for Risk Score.
4 Start String Date that the satellite data start from. (YYYY-MM-DD)
5 End String Date that the satellite data to finish. (YYYY-MM-DD)
6 Polygon-Geometry Object Geojson object of the area for search. This geometry can be extracted via TKGM by the user.

Example Query

        
          curl --location --request GET 'https://hidromodapi.ew.r.appspot.com/tmp/v1.0/risks/risk?id=12a63884-16ae-4355-9c00-e1227a17b30e&start=2019-06-01&end=2019-06-10&polygon-geometry=POLYGON((26.800%2040.888,26.836%2040.888,26.836%2040.968,26.800%2040.968,26.800%2040.888))' --header 'apikey: <~API-KEY~>'
        
        

Response Outputs

# Parameter Type Explanation
1 Id String Id of the request.
2 Product List Product that is returned.
3 Date String Date (YYYY-MM-DD) of the satellite output that is returned.
4 Value Float Returned risk score data for that date.

Example Response

          
            {
              "id": "12a63884-16ae-4355-9c00-e1227a17b30e",
              "risk": {
                "2019-06-01": 0.28,
                "2019-06-02": 0.28,
                "2019-06-03": 0.27,
                "2019-06-04": 0.25,
                "2019-06-05": 0.26,
                "2019-06-06": 0.27,
                "2019-06-07": 0.29,
                "2019-06-08": 0.29,
                "2019-06-09": 0.32,
                "2019-06-10": 0.34
              }
            }
          
        

Input Parameters

# Parameter Type Explanation
1 API Key String Unique API Key
2 Id String Id of the request given by you.
3 Product String Product is “forecast” for Weather Forecast.
4 Date String Date that the satellite data start from. (YYYY-MM-DD)
5 City-Region String Query area specified with city and region seperated with dash.
6 Coordinate Lat-Lon Query point specified with Latitude-Longitude

Example Query for City-Region

        
          curl --location --request GET 'https://hidromodapi.ew.r.appspot.com/tmp/v1.0/risks/forecast?id=12a63884-16ae-4355-9c00-e1227a17b30e&city-region=balikesir-burhaniye&date=2022-08-10' --header 'apikey: <~API-KEY~>'
        
        

Example Query for Coordinate

          
            curl --location --request GET 'https://hidromodapi.ew.r.appspot.com/tmp/v1.0/risks/forecast?id=12a63884-16ae-4355-9c00-e1227a17b30e&coordinate=41.2-37.7&date=2022-08-10' --header 'apikey: <~API-KEY~>'
          
          

Response Outputs

# Parameter Type Explanation
1 Id String Id of the request.
2 Product List Product that is returned.
3 Humidity List List of humidity date&value pairs for forecast interval.
4 Precipitation List List of precipitation date&value pairs for forecast interval.
5 Temperature List List of temperature date&value pairs for forecast interval.
6 Wind List List of wind date&value pairs for forecast interval.
7 Date String Date (YYYY-MM-DD) of the satellite output that is returned.
8 Value Float Returned forecast data for that date.

Example Response

          
            {
              "forecast": {
                "humidity": [
                  {
                    "date": "2022-01-03 00:00:00",
                    "value": 89.17306511
                  },
                  {
                    "date": "2022-01-03 01:00:00",
                    "value": 89.43289883
                  }
                ],
                "precipitation": [
                  {
                    "date": "2022-01-03 00:00:00",
                    "value": 0
                  },
                  {
                    "date": "2022-01-03 01:00:00",
                    "value": 0
                  }
                ],
                "temperature": [
                  {
                    "date": "2022-01-03 00:00:00",
                    "value": 5.3928838
                  },
                  {
                    "date": "2022-01-03 01:00:00",
                    "value": 5.12584281
                  }
                ],
                "wind": [
                  {
                    "date": "2022-01-03 00:00:00",
                    "value": 0.81729663
                  },
                  {
                    "date": "2022-01-03 01:00:00",
                    "value": 1.22133541
                  }
                ]
              },
              "id": "12a63884-16ae-4355-9c00-e1227a17b30e"
            }
          
        

Input Parameters

# Parameter Type Explanation
1 API Key String Unique API Key
2 Id String Id of the request given by you.
3 Product String Product is “wheat” for Wheat Yield.
4 Start String Date that the satellite data start from. (YYYY)
5 End String Date that the satellite data to finish. (YYYY)
6 Polygon-Geometry Object Geojson object of the area for search. This geometry can be extracted via TKGM by the user.
7 City-Region String Query area specified with city and region seperated with dash.

Example Query for City-Region

        
          curl --location --request GET 'https://hidromodapi.ew.r.appspot.com/tmp/v1.0/risks/wheat?id=12a63884-16ae-4355-9c00-e1227a17b30e&start=2007&end=2018&city-region=tekirdag-malkara' --header 'apikey: <~API-KEY~>'
        
        

Example Query for Coordinate

          
            curl --location --request GET 'https://hidromodapi.ew.r.appspot.com/tmp/v1.0/risks/wheat?id=12a63884-16ae-4355-9c00-e1227a17b30e&start=2007&end=2018&polygon-geometry=POLYGON((26.800%2040.888,26.836%2040.888,26.836%2040.968,26.800%2040.968,26.800%2040.888))' --header 'apikey: <~API-KEY~>'
          
          

Response Outputs

# Parameter Type Explanation
1 Id String Id of the request.
2 Product List Product that is returned.
3 Date String Date (YYYY) of the satellite output that is returned.
4 Value Float Returned yield data for that date.

Example Response

          
            {
              "id": "12a63884-16ae-4355-9c00-e1227a17b30e",
              "wheat": [
                {
                  "date": "2007",
                  "value": 369.1
                },
                {
                  "date": "2008",
                  "value": 369.2
                },
                {
                  "date": "2009",
                  "value": 347.4
                },
                {
                  "date": "2010",
                  "value": 365.6
                }
              ]
            }
          
        

Input Parameters

# Parameter Type Explanation
1 API Key String Unique API Key
2 Id String Id of the request given by you.
3 Product String Product is “cropclassification” for Crop Classification.
4 Polygon-Geometry Object Geojson object of the area for search. This geometry can be extracted via TKGM by the user.

Example Query

          
            curl --location --request GET 'https://hidromodapi.ew.r.appspot.com/tmp/v1.0/risks/cropclassification?id=12a63884-16ae-4355-9c00-e1227a17b30e&polygon-geometry=POLYGON((26.800%2040.888,26.836%2040.888,26.836%2040.968,26.800%2040.968,26.800%2040.888))' --header 'apikey: <~API-KEY~>'
          
          

Response Outputs

# Parameter Type Explanation
1 Id String Id of the request.
2 Product List Product that is returned.
3 Area Float Total area of geometry in km^2.
4 Class String Names of the crops.
5 Percentage Float Percentage of crops in %

Example Response

          
            {
              "crop_classification": {
                "arpa": 28.2,
                "aycicegi": 19.9,
                "biber": 7.0,
                "bugday": 8.8,
                "toprak": 8.2,
                "other": 27.9
              },
              "area": 82.0741260240363,
              "id": "12a63884-16ae-4355-9c00-e1227a17b30e"
            }
          
        

Input Parameters

# Parameter Type Explanation
1 API Key String Unique API Key
2 Id String Id of the request given by you.
3 Product String Product is “lightning” for Lightning Risk.
4 Polygon-Geometry Object Geojson object of the area for search. This geometry can be extracted via TKGM by the user.

Example Query

          
            curl --location --request GET 'https://hidromodapi.ew.r.appspot.com/tmp/v1.0/risks/lightning?id=12a63884-16ae-4355-9c00-e1227a17b30e&polygon-geometry=POLYGON((28.0%2040.5,28.0%2041.5,29.0%2041.5,29.0%2040.5,28.0%2040.5))' --header 'apikey: <~API-KEY~>'
          
          

Response Outputs

# Parameter Type Explanation
1 Id String Id of the request.
2 Product List Product that is returned.
3 Date String Date (YYYY-MM) of the output that is returned.
4 Value Float Risk values between 0 and 1.

Example Response

          
            {
              "id": "12a63884-16ae-4355-9c00-e1227a17b30e",
              "lightning_risk": {
                "2019-01": 0.0,
                "2019-02": 0.0,
                "2019-03": 0.28,
                "2019-04": 1.0,
                "2019-05": 0.5,
                "2019-06": 0.0,
                "2019-07": 1.0,
                "2019-08": 0.0,
                "2019-09": 0.0,
                "2019-10": 0.0,
                "2019-11": 0.0,
                "2019-12": 0.0,
              }
            }
            
        

Input Parameters

# Parameter Type Explanation
1 API Key String Unique API Key
2 Id String Id of the request given by you.
3 Product String Product is “wind” for Wind Energy Production Prediction.
4 Polygon-Geometry Object Geojson object of the area for search.

Example Query

          
            curl --location --request GET 'https://hidromodapi.ew.r.appspot.com/tmp/v1.0/prediction/wind?id=12a63884-16ae-4355-9c00-e1227a17b30e&polygon-geometry=POLYGON((28.0%2040.5,28.0%2041.5,29.0%2041.5,29.0%2040.5,28.0%2040.5))' --header 'apikey: <~API-KEY~>'
          
          

Response Outputs

# Parameter Type Explanation
1 Id String Id of the request.
2 Product List Product that is returned.
3 Date String Date (YYYY-MM-DD-HH) of the output that is returned.
4 Value Float Wind energy production prediction value.

Example Response

          
            {
              "id": "12a63884-16ae-4355-9c00-e1227a17b30e",
              "wind_energy": {
                "2023-12-11-00": 6.112,
                ...
                "2023-12-11-09": 7.062,
                "2023-12-11-10": 4.454,
                "2023-12-11-11": 5.349,
                "2023-12-11-12": 10.895,
                "2023-12-11-13": 12.052,
                "2023-12-11-14": 11.432,
                "2023-12-11-15": 13.189,
                ...
              }
            }