Statistics API
This service provides the ability to get aggregated statistics by some region.
Notes
Note
It have to note that in response we may get widely date-range then was requested, it happens because each field bound to particular season. It's better to understand with an image below.
POST /v1/statistics/vector
Getting statistics
| Name | Type | Description |
|---|---|---|
| bbox | List | Bounding box in format [min_lon, min_lat, max_lon, max_lat] |
| multipolygon | GeoJSON | Area of interest in Geojson format |
| point | GeoJSON | Point of interest in Geojson format |
| countryCode | String | Country code in ISO_3166-1 |
| regionCode | String | Region code in ISO_3166-1 |
| subregionCode | String | Custom value for particular country |
| regionCodeNUTS3 | String | Region code in NUTS level3 |
| growingDate | String | Datetime interval in ISO 8601 |
Examples
Example of getting statistics
By bbox
Request:
curl -X POST https://api-b2b.prod-be.onesoil.ai/v1/statistics/vector \
--header "Content-Type: application/json" \
--header "Authorization: Bearer ${TOKEN}" \
-d '{"bbox": [4.906768798828125, 50.58628844644363, 5.0186920166015625, 50.66230233898018]}'
Response:
[
{
"eppoCode": "BEAVA",
"coverage": 44433488,
"fieldsAmount": 876,
"growingDate": "2016-03-01/2021-10-01"
},
{
"eppoCode": "BRSNN",
"coverage": 1798720,
"fieldsAmount": 55,
"growingDate": "2016-03-01/2021-10-01"
},
{
"eppoCode": "GLXMA",
"coverage": 16878,
"fieldsAmount": 2,
"growingDate": "2016-03-01/2016-10-01"
},
{
"eppoCode": "GRASS",
"coverage": 18241134,
"fieldsAmount": 1107,
"growingDate": "2016-03-01/2021-10-01"
},
{
"eppoCode": "HELAN",
"coverage": 798722,
"fieldsAmount": 16,
"growingDate": "2016-03-01/2021-10-01"
},
{
"eppoCode": "HORVX",
"coverage": 10132142,
"fieldsAmount": 274,
"growingDate": "2016-03-01/2021-10-01"
},
{
"eppoCode": "NF",
"coverage": 3924864,
"fieldsAmount": 385,
"growingDate": "2016-03-01/2021-10-01"
},
{
"eppoCode": "OTHER",
"coverage": 96469458,
"fieldsAmount": 1765,
"growingDate": "2016-03-01/2021-10-01"
},
{
"eppoCode": "TRZAX",
"coverage": 113258734,
"fieldsAmount": 2035,
"growingDate": "2016-03-01/2021-10-01"
},
{
"eppoCode": "ZEAMX",
"coverage": 11754200,
"fieldsAmount": 533,
"growingDate": "2016-03-01/2021-10-01"
}
]
By Point and growingDate
Request:
curl -s -X POST https://api-b2b.prod-be.onesoil.ai/v1/statistics/vector \
--header "Content-Type: application/json" \
--header "Authorization: Bearer ${TOKEN}" \
-d '{"point": {"type": "Point", "coordinates": [-55.16, -23.522]}, "growingDate": "2020-01-01T00:00:00/2021-01-01T00:00:00"}'|jq
Response:
[
{
"eppoCode": "ZEAMX",
"coverage": 5533924,
"accuracy": null,
"fieldsAmount": 3,
"growingDate": "2019-11-01/2021-06-01"
}
]
POST /v1/statistics/raster
| Name | Type | Description |
|---|---|---|
| bbox | List |
Bounding box in format [min_lon, min_lat, max_lon, max_lat] |
| multipolygon | GeoJSON |
Area of interest in Geojson format |
| point | GeoJSON |
Point of interest in Geojson format |
| countryCode | String |
Country code in ISO_3166-1 |
| regionCode | String |
Region code in ISO_3166-1 |
| subregionCode | String |
Custom value for particular country |
| regionCodeNUTS3 | String |
Region code in NUTS level3 |
| regionCodeGADM | String |
Region code in GADM level2 |
| modelVersion | String |
Model version value (optional) |
| modelId | String |
Model Id value (optional) |
| growingDate | String |
Datetime interval in ISO 8601 (optional) |
Examples
Example of getting raster statistics
By Multipolygon, growingDate and modelVersion
Request:
curl -X POST https://api-b2b.prod-be.onesoil.ai/v1/statistics/raster \
--header "Content-Type: application/json" \
--header "Authorization: Bearer ${TOKEN}" \
-d '{"multipolygon": {"type": "MultiPolygon", "coordinates": [[[[30.731805073585441, 49.129722404001392], [30.836163462696017, 49.10181260226252], [30.845871219822584, 48.87974765799234], [30.616525457707478, 48.922219095421063], [30.637154441601432, 49.12486852543811], [30.729378134303801, 49.128508934360575], [30.731805073585441, 49.129722404001392]]]]},
"growingDate": "2022-01-28T00:00:00/2022-10-27T00:00:00"}'
Response:
[
{
"cropName": "wheat",
"eppoCode": "TRZAX",
"areaHa": 5285.76,
"coverage": 52857600.0,
"growingDate": "2022-03-01/2022-09-16"
},
{
"cropName": "maize",
"eppoCode": "ZEAMX",
"areaHa": 11702.4,
"coverage": 117024000.0,
"growingDate": "2022-03-01/2022-09-16"
},
{
"cropName": "rice",
"eppoCode": "ORYSA",
"areaHa": 0.32,
"coverage": 3200.0,
"growingDate": "2022-03-01/2022-09-16"
},
{
"cropName": "sorghum",
"eppoCode": "SORVU",
"areaHa": 0.96,
"coverage": 9600.0,
"growingDate": "2022-03-01/2022-09-16"
},
{
"cropName": "barley",
"eppoCode": "HORVX",
"areaHa": 788.64,
"coverage": 7886400.0,
"growingDate": "2022-03-01/2022-09-16"
},
{
"cropName": "soybeans",
"eppoCode": "GLXMA",
"areaHa": 1845.28,
"coverage": 18452800.0,
"growingDate": "2022-03-01/2022-09-16"
},
{
"cropName": "rapeseed",
"eppoCode": "BRSNN",
"areaHa": 668.48,
"coverage": 6684800.0,
"growingDate": "2022-03-01/2022-09-16"
},
{
"cropName": "sunflower",
"eppoCode": "HELAN",
"areaHa": 5957.92,
"coverage": 59579200.0,
"growingDate": "2022-03-01/2022-09-16"
},
{
"cropName": "sugarbeet",
"eppoCode": "BEAVA",
"areaHa": 2211.84,
"coverage": 22118400.0,
"growingDate": "2022-03-01/2022-09-16"
},
{
"cropName": "sugarcane",
"eppoCode": "SACOF",
"areaHa": 0.0,
"coverage": 0.0,
"growingDate": "2022-03-01/2022-09-16"
},
{
"cropName": "grass",
"eppoCode": "GRASS",
"areaHa": 1170.56,
"coverage": 11705600.0,
"growingDate": "2022-03-01/2022-09-16"
},
{
"cropName": "cotton",
"eppoCode": "CMJSP",
"areaHa": 0.0,
"coverage": 0.0,
"growingDate": "2022-03-01/2022-09-16"
},
{
"cropName": "other",
"eppoCode": "OTHER",
"areaHa": 1439.2,
"coverage": 14392000.0,
"growingDate": "2022-03-01/2022-09-16"
},
{
"cropName": "not_field",
"eppoCode": "NF",
"areaHa": 7496.48,
"coverage": 74964800.0,
"growingDate": "2022-03-01/2022-09-16"
},
{
"cropName": "to_delete",
"eppoCode": "DEL",
"areaHa": 0.0,
"coverage": 0.0,
"growingDate": "2022-03-01/2022-09-16"
}
]
By Subregion (custom geometry), growingDate and modelVersion
Request:
curl -X POST https://api-b2b.prod-be.onesoil.ai/v1/statistics/raster \
--header "Content-Type: application/json" \
--header "Authorization: Bearer ${TOKEN}" \
-d '{"subregionCode": "UA51233",
"growingDate": "2022-01-28T00:00:00/2022-10-27T00:00:00",
"modelVersion": "1.0.14"}'
Response:
[
{
"cropName": "wheat",
"eppoCode": "TRZAX",
"areaHa": 22649.92,
"coverage": 226499200.0,
"growingDate": "2022-03-01/2022-09-16"
},
{
"cropName": "maize",
"eppoCode": "ZEAMX",
"areaHa": 14254.24,
"coverage": 142542400.0,
"growingDate": "2022-03-01/2022-09-16"
},
{
"cropName": "rice",
"eppoCode": "ORYSA",
"areaHa": 4.48,
"coverage": 44800.0,
"growingDate": "2022-03-01/2022-09-16"
},
{
"cropName": "sorghum",
"eppoCode": "SORVU",
"areaHa": 0.96,
"coverage": 9600.0,
"growingDate": "2022-03-01/2022-09-16"
},
{
"cropName": "barley",
"eppoCode": "HORVX",
"areaHa": 6342.08,
"coverage": 63420800.0,
"growingDate": "2022-03-01/2022-09-16"
},
{
"cropName": "soybeans",
"eppoCode": "GLXMA",
"areaHa": 169.76,
"coverage": 1697600.0,
"growingDate": "2022-03-01/2022-09-16"
},
{
"cropName": "rapeseed",
"eppoCode": "BRSNN",
"areaHa": 2842.56,
"coverage": 28425600.0,
"growingDate": "2022-03-01/2022-09-16"
},
{
"cropName": "sunflower",
"eppoCode": "HELAN",
"areaHa": 26388.8,
"coverage": 263888000.0,
"growingDate": "2022-03-01/2022-09-16"
},
{
"cropName": "sugarbeet",
"eppoCode": "BEAVA",
"areaHa": 2768.64,
"coverage": 27686400.0,
"growingDate": "2022-03-01/2022-09-16"
},
{
"cropName": "sugarcane",
"eppoCode": "SACOF",
"areaHa": 0.0,
"coverage": 0.0,
"growingDate": "2022-03-01/2022-09-16"
},
{
"cropName": "grass",
"eppoCode": "GRASS",
"areaHa": 13919.36,
"coverage": 139193600.0,
"growingDate": "2022-03-01/2022-09-16"
},
{
"cropName": "cotton",
"eppoCode": "CMJSP",
"areaHa": 0.0,
"coverage": 0.0,
"growingDate": "2022-03-01/2022-09-16"
},
{
"cropName": "other",
"eppoCode": "OTHER",
"areaHa": 1796.48,
"coverage": 17964800.0,
"growingDate": "2022-03-01/2022-09-16"
},
{
"cropName": "not_field",
"eppoCode": "NF",
"areaHa": 19843.52,
"coverage": 198435200.0,
"growingDate": "2022-03-01/2022-09-16"
},
{
"cropName": "to_delete",
"eppoCode": "DEL",
"areaHa": 0.0,
"coverage": 0.0,
"growingDate": "2022-03-01/2022-09-16"
}
]
By Point (for all available seasons)
Request:
curl -X POST https://api-b2b.prod-be.onesoil.ai/v1/statistics/raster \
--header "Content-Type: application/json" \
--header "Authorization: Bearer ${TOKEN}" \
-d '{"point": {"type":"Point", "coordinates": [-72.55882632, 46.25836631]}}'
Response:
[
{
"cropName": "soybeans",
"eppoCode": "GLXMA",
"areaHa": 0.16,
"coverage": 1600.0,
"growingDate": "2019-03-01/2019-10-01"
},
{
"cropName": "maize",
"eppoCode": "ZEAMX",
"areaHa": 0.16,
"coverage": 1600.0,
"growingDate": "2020-03-01/2020-10-01"
},
{
"cropName": "maize",
"eppoCode": "ZEAMX",
"areaHa": 0.16,
"coverage": 1600.0,
"growingDate": "2021-03-01/2021-10-01"
},
{
"cropName": "soybeans",
"eppoCode": "GLXMA",
"areaHa": 0.16,
"coverage": 1600.0,
"growingDate": "2022-03-01/2022-09-16"
}
]
By a GADM region, growingDate, modelVersion and modelId
Request:
curl -X POST https://api-b2b.prod-be.onesoil.ai/v1/statistics/raster \
--header "Content-Type: application/json" \
--header "Authorization: Bearer ${TOKEN}" \
-d '{"regionCodeGADM": "UKR.27.20_1", "growingDate": "2018-01-01T00:00:00/2018-12-31T00:00:00", "modelVersion": "1.0.14", "modelId": "eu_uk_ru_unet_on_embeddings"}'
Response:
[
{
"cropName": "wheat",
"eppoCode": "TRZAX",
"areaHa": 5094.72,
"coverage": 50947200.0,
"growingDate": "2018-03-01/2018-10-01"
},
{
"cropName": "maize",
"eppoCode": "ZEAMX",
"areaHa": 7059.04,
"coverage": 70590400.0,
"growingDate": "2018-03-01/2018-10-01"
},
{
"cropName": "rice",
"eppoCode": "ORYSA",
"areaHa": 0.0,
"coverage": 0.0,
"growingDate": "2018-03-01/2018-10-01"
},
{
"cropName": "sorghum",
"eppoCode": "SORVU",
"areaHa": 0.0,
"coverage": 0.0,
"growingDate": "2018-03-01/2018-10-01"
},
{
"cropName": "barley",
"eppoCode": "HORVX",
"areaHa": 540.64,
"coverage": 5406400.0,
"growingDate": "2018-03-01/2018-10-01"
},
{
"cropName": "soybeans",
"eppoCode": "GLXMA",
"areaHa": 76.48,
"coverage": 764800.0,
"growingDate": "2018-03-01/2018-10-01"
},
{
"cropName": "rapeseed",
"eppoCode": "BRSNN",
"areaHa": 1139.52,
"coverage": 11395200.0,
"growingDate": "2018-03-01/2018-10-01"
},
{
"cropName": "sunflower",
"eppoCode": "HELAN",
"areaHa": 6002.56,
"coverage": 60025600.0,
"growingDate": "2018-03-01/2018-10-01"
},
{
"cropName": "sugarbeet",
"eppoCode": "BEAVA",
"areaHa": 76.0,
"coverage": 760000.0,
"growingDate": "2018-03-01/2018-10-01"
},
{
"cropName": "sugarcane",
"eppoCode": "SACOF",
"areaHa": 0.0,
"coverage": 0.0,
"growingDate": "2018-03-01/2018-10-01"
},
{
"cropName": "grass",
"eppoCode": "GRASS",
"areaHa": 7315.2,
"coverage": 73152000.0,
"growingDate": "2018-03-01/2018-10-01"
},
{
"cropName": "cotton",
"eppoCode": "CMJSP",
"areaHa": 0.0,
"coverage": 0.0,
"growingDate": "2018-03-01/2018-10-01"
},
{
"cropName": "other",
"eppoCode": "OTHER",
"areaHa": 7307.2,
"coverage": 73072000.0,
"growingDate": "2018-03-01/2018-10-01"
},
{
"cropName": "not_field",
"eppoCode": "NF",
"areaHa": 277203.2,
"coverage": 2772032000.0,
"growingDate": "2018-03-01/2018-10-01"
},
{
"cropName": "to_delete",
"eppoCode": "DEL",
"areaHa": 0.0,
"coverage": 0.0,
"growingDate": "2018-03-01/2018-10-01"
}
]