Retrieve TrueFruit size measurements and size and mass forecasts by orchard and date, including size distributions, sample positions, and forecast ranges.
Use these endpoints to retrieve fruit size data collected in the field and forecasted size and mass distributions generated for future dates. The data supports three record types:
Measurements — Returns observed fruit size distributions for a specific orchard and measurement date. Detailed responses can also include length distributions, mass distributions, and sample position averages with GPS coordinates.
Size forecasts — Returns forecasted fruit size distributions for a specific orchard and forecast date, including per-range percentages of total count and total mass.
Mass forecasts — Returns forecasted fruit mass distributions for a specific orchard and forecast date, including per-range percentages of total count. These are only available for select Kiwifruit cultivars.
The measurements endpoints return observed size data, while the forecast endpoints return predicted distributions. Within each set, the list endpoint returns data aggregated by orchard and date, and the detail endpoint returns the full distribution data for a single orchard and date.
Recommended patterns for fetching TrueFruit size data
How to fetch fruit size distributions per orchard
First pull per orchard size measurement dates for a given time period using the farming/truefruit/size/measurements/ endpoint. The response will return a list of objects containing an orchard_id and measurement_date. Filter the response using the processed_date query parameter. Using the processed_date is the most robust approach because it avoids losing records where there is a large delay between the data collection date and when it became available to consume. If you are fetching data on a cron, for example once a day, use the date you last fetched data on.
To fetch the detailed orchard size distributions and aggregated metrics, pass the orchard_id and measurement_date received in the farming/truefruit/size/measurements/ response into the farming/truefruit/size/measurements/{orchard_id}/{measurement_date} endpoint. Use the size_distribution_format query parameter to select 1mm, 2mm, 2.5mm, 5mm, harvest_ranges_by_weight, or harvest_ranges_by_pieces bins. The default is harvest_ranges_by_pieces. For select Kiwifruit cultivars, use mass_distribution_format to select 1g, 5g, 10g, or harvest_ranges mass bins. The default is 1g.
How to fetch forecasted size distributions per orchard
First pull per orchard size forecast dates for a given time period using the farming/truefruit/size/forecasts/ endpoint. The response will return a list of objects containing an orchard_id and forecast_date. Filter the response using the processed_date query parameter. Using the processed_date is the most robust approach because it avoids losing records where there is a large delay between the forecast generation date and when it became available to consume. If you are fetching data on a cron, for example once a day, use the date you last fetched data on.
To fetch the detailed orchard size forecast and aggregated metrics, pass the orchard_id and forecast_date received in the farming/truefruit/size/forecasts/ response into the farming/truefruit/size/forecasts/{orchard_id}/{forecast_date} endpoint. This returns a size_ranges array with the bin ranges and each range's percentage of total count and percentage of total mass.
How to fetch forecasted mass distributions per orchard
First pull per orchard mass forecast dates for a given time period using the farming/truefruit/mass/forecasts/ endpoint. The response will return a list of objects containing an orchard_id and forecast_date. Filter the response using the processed_date__gte query parameter. Using processed_date__gte is the most robust approach because it avoids losing records where there is a large delay between the forecast generation date and when it became available to consume. If you are fetching data on a cron, for example once a day, use the date you last fetched data on.
To fetch the detailed orchard mass forecast and aggregated metrics, pass the orchard_id and forecast_date received in the farming/truefruit/mass/forecasts/ response into the farming/truefruit/mass/forecasts/{orchard_id}/{forecast_date} endpoint. This returns a mass_ranges array with the bin ranges and each range's percentage of total count.
Size Measurement Compact
Key
Type
Description
farm_id
Integer
The unique identifier for the farm which is provided by Aerobotics.