Growth

Crop Growth & Health API

Iteris’ Crop Growth & Health API includes crop-specific growth models, including Crop Growth Model Feedback, Crop Harvest Modeling, and Crop Nutrient (Nitrogen) Decision Support.

Crop Growth

last updated 1/4/19

The growth models combine user-provided information with the ClearAg field weather and soil data to provide past, current, and projected plant growth stage information specific to a particular crop planted on a specific field.

The required parameters will vary depending on whether coordinates are provided or Accounts API integration is used. For clients not using the Accounts API, required and optional parameters are listed under the “location-based” column within the Request Parameters tables. For required and optional parameters when utilizing the Accounts API, please refer to the information contained in the “Accounts API Integration” column. When utilizing the Accounts API, field, growth, activity, and feedback information present in the system will be used where necessary. The Accounts API integration will automatically pre-populate client data where applicable.

Additional information is provided in the Accounts API.

For those not currently using the Accounts API, please contact your Iteris account representative for details.

Multiple data center regions are available to meet users’ legal and performance needs. Currently, data centers exist within the United States (ag.us.clearapis.com) and the European Union (ag.eu.clearapis.com). Account and related information such as fields and growths are not shared between these regions. Data resolution and availability also vary by region, and each region requires a unique set of credentials. Please contact your account representative for account creation, data segregation, and data coverage information.

Please note that API responses are currently only provided in English.

Iteris requires the use of https when working within the ClearAg APIs.

Additional API information is available in the Appendix.

Barley

Barley Growth Creation - v1.0

This endpoint allows users to create a barley growth on an existing field. The given user adding the barley growth must have write privileges for the field being updated.

URL Description

https://ag.clearapis.com/v1.0/crop_health/barley/growth/create/{field_id}?
app_id={string}&app_key={string}&account_id={string}&user_id={string}
&plant_date={timestamp}&maturity_group={string}&name={string}&zone_map_id={string}

Request Parameters

Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

Your Accounts API account ID.

field_id

string

yes

Specifies ID of field to be updated.

user_id

string

yes

User ID provided by and used with the Accounts API. The user must have privileges to view information for the field to which the target growth is assigned.

plant_date, emergence_date

timestamp

yes

Epoch timestamp valid near the time that the crop reached emergence. Please refer to the Epoch/Unix Timestamp section of the Appendix for Iteris' definition of Epoch/Unix timestamp.

maturity_group, relative_maturity

string

no

Classification indicating how early a variety matures. Valid values include "early," "medium-early," "medium," "medium-late," and "late." Crops that have an "early" relative maturity are expected to mature relatively fast, and crops having a "late" relative maturity are expected to mature relatively slowly. Default is "medium."

name

string

no

Unique name to assign to the growth. Default is "barley."

zone_map_id

string

no

The target zone map id must exist for the target field. This will be a UUID. If provided and growth creation is successful, the growth will be treated as "zone aware," enabling zone management features. This property cannot be mutated after a growth has been created.

Response Object

A string representing a growth ID.

Example Request

https://ag.clearapis.com/v1.0/crop_health/barley/growth/create/abc-123?
app_id=456&app_key=789&account_id=123&user_id=xyz-123&app_id=456&app_key=789
&plant_date=1393632000

Example Response

abc-def

Barley Get Growth - v1.0

This endpoint allows a user to receive a previously created growth based on growth ID.

URL Description

https://ag.clearapis.com/v1.0/crop_health/barley/growth/get/{growth_id}?
app_id={string}&app_key={string}&account_id={string}
&user_id={string}

Request Parameters

Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

A unique account ID provided by your Iteris account representative.

user_id

string

yes

User ID provided by the Create User endpoint as a result of adding a new user to the user information database.

growth_id

string

yes

Specifies ID of crop growth to be queried from the user information database, provided by the Create Growth endpoint.

Response Object (JSON)

Field Description

acres

Areal size of the field in acres.

created

Epoch timestamp in seconds. Please refer to the Epoch/Unix Timestamp section of the Appendix for Iteris' definition of Epoch/Unix timestamp.

field_id

Specifies ID of field to which crop growth data has been assigned.

field_name

Name of the field.

growth_id

Specifies ID of crop growth queried.

harvest_date

An epoch timestamp in seconds for which harvest has begun. Please refer to the Epoch/Unix Timestamp section of the Appendix for Iteris' definition of Epoch/Unix timestamp.

irrigation_type

Represents whether or not the cropland utilizes pivot irrigation. Valid values: 0 is "false" and 1 is "true."

latitude

Latitude coordinate near the center of the field in decimal degrees. Please verify that latitude/longitude coordinates are over soil representative of your field.

longitude

Longitude coordinate near the center of the field in decimal degrees. Please verify that latitude/longitude coordinates are over soil representative of your field.

name

Name of the growth.

plant_date

Approximate time at which the crop was planted.

plant_name

Name of the crop plant.

plant_type

Value representing the type of crop planted. (See the Plant Enumerations section of the Appendix for a listing of plant type IDs.)

plant_subtype

Enumeration value representing plant sub-type.

relative_maturity

Classification indicating how early a variety matures. Valid values include "early," "medium-early," "medium," "medium-late," and "late." Crops that have an "early" relative maturity are expected to mature relatively fast, and crops having a "late" relative maturity are expected to mature relatively slowly. Default is "medium."

seed_variety

Additional description or notes for the seed used.

subdrainage_type

Represents whether or not the cropland utilizes drainage tile. Valid values: 0 is "false" (default) and 1 is "true."

surface_drainage_quality

Represents field drainage effectiveness. Valid values: 0 is poor, 1 is average, and 2 is good.

previous_crop

Type ID of previously planted crop.

previous_harvest_date

Epoch time which previous crop was harvested. Please refer to the Epoch/Unix Timestamp section of the Appendix for Iteris' definition of Epoch/Unix timestamp.

previous_yield

Yield of previous crop.

previous_yield_unit

Unit of measure for previous yield.

yield_goal

Yield target of current growth.

yield_goal_unit

Unit of measure for yield goal.

zone_map_id

Zone map ID to be used with this growth when utilizing zone management products. Value will be a UUID or null.

Example Request

https://ag.clearapis.com/v1.0/crop_health/barley/growth/get/bcd-def?
app_id=456&app_key=789&account_id=123&user_id=xyz-123

Example Response

{
    "acres":1234.0,
    "created":1445972460,
    "emergence_date":null,
    "field_id":"abc-def",
    "field_name":"MyField",
    "growth_id":"bcd-def",
    "harvest_date":null,
    "irrigation_type":1,
    "latitude":47.92338180541992,
    "longitude":-97.0919189453125,
    "name":"MyGrowth",
    "plant_date":1398920400,
    "plant_name":"barley",
    "plant_subtype":0,
    "plant_type":50,
    "seed_variety":null,
    "subdrainage_type":1,
    "surface_drainage_quality":1,
    "version":"v1.1"
}

Barley Growth Modify - v1.0

This endpoint allows a user to modify an existing barley growth.

URL Description

https://ag.clearapis.com/v1.0/crop_health/barley/growth/modify/{growth_id}?
app_id={string}&app_key={string}&account_id={string}&user_id={string}
&plant_date={timestamp}&name={string}

Request Parameters

Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

Your Accounts API account ID.

user_id

string

yes

User ID provided by and used with the Accounts API. The user must have privileges to view information for the field to which the target growth is assigned.

plant_date, emergence_date

timestamp

yes

Epoch timestamp valid near the time that the crop reached emergence. Please refer to the Epoch/Unix Timestamp section of the Appendix for Iteris' definition of Epoch/Unix timestamp.

growth_id

string

yes

Growth ID provided by and used with the Accounts API. This ID is given when a growth is successfully modified on a field in the Accounts API.

name

string

no

Unique name to assign to the growth.

Response Object

Returns "true" on success.

Example Request

https://ag.clearapis.com/v1.0/crop_health/barley/growth/modify/abc-123?
app_id=456&app_key=789&account_id=123&user_id=xyz-123&
plant_date=1456890400

Example Response

true

Barley Growth Delete - v1.0

This endpoint allows a user to delete a barley growth. By deleting a growth, any applicable growth feedback and growth whitelist items will also be deleted.

URL Description

https://ag.clearapis.com/v1.0/crop_health/barley/growth/delete/{growth_id}?
app_id={string}&app_key={string}&account_id={string}&user_id={string}

Request Parameters

Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

growth_id

string

yes

The ID of the target growth to delete.

account_id

string

yes

A unique account ID provided by your Iteris account representative.

user_id

sring

yes

User ID provided by the Create User endpoint as a result of adding a new user to the user information database.

Response Object

Returns "true" on success.

Example Request

https://ag.clearapis.com/v1.0/crop_health/barley/growth/delete/abc-def?
app_id=456&app_key=789&account_id=123&user_id=xyz-123

Example Response

true

Barley Growth - v1.1

Leveraging Iteris' spring barley growth stage model, the Barley Growth endpoint allows users to model the maturation and development of spring barley crops. Users may also take advantage of Accounts API integration to provide crop growth feedback and optimize model results.

URL Description

https://ag.us.clearapis.com/v1.1/crop_health/barley/growth?app_id={string}
&app_key={string}&location={lat, lon coordinates}&plant_date={timestamp}
&days={integer}&account_id={string}&user_id={string}&growth_id={string}
&relative_maturity={string}

Request Parameters

Parameter Type Location-based Accounts API Integration Description

app_id

string

yes

yes

API ID provided by Iteris.

app_key

string

yes

yes

API key provided by Iteris.

location

lat, lon coordinates

yes

 — 

User-provided latitude and longitude coordinates in decimal degrees. Please verify that latitude/longitude coordinates are over soil representative of your field. Users are allowed a maximum of five coordinates1, formatted as "&location=[(<lat_1>,<lon_1>),(<lat_2>,<lon_2>)]."

plant_date, emergence_date

timestamp

yes

 — 

Epoch timestamp valid near the time that the crop was planted or the date of emergence. Please refer to the Epoch/Unix Timestamp section of the Appendix for Iteris' definition of Epoch/Unix timestamp.

days

integer

yes

yes

Number of days for which to calculate results. Possible values range from 1 to 366.

relative_maturity

string

no

 — 

Classification indicating how early a variety matures. Valid values include "early," "medium-early," "medium," "medium-late," and "late." Crops that have an "early" relative maturity are expected to mature relatively fast, and crops having a "late" relative maturity are expected to mature relatively slowly. Default is "medium."

account_id

string

no

yes

Your Accounts API account ID.

user_id

string

no

yes

User ID provided by and used with the Accounts API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

no

yes

Specifies the ID given when a growth is successfully added to a field using the create growth endpoint.

1 Additional coordinates are not counted against a client’s account, but will count as additional requests in the future.

Response Object (JSON)

Field Description

attribution

Various model attributions.

agdd

Aggregate growing degree days from plant or emergence date, including the current date.

air_temp_max

Maximum daily air temperature valid for the current date. Obtained from historical, forecast, or climatological data, depending on the timeframe.

air_temp_min

Minimum daily air temperature valid for the current date. Obtained from historical, forecast, or climatological data, depending on the timeframe.

feedback_id

If this field is present, it indicates a confirmed or observed growth stage on the current date.

gdd

Growing degree days accumulated on the current date.

last_stage

The last known growth stage.

new_stage

The crop may have entered a new growth stage between the current date and the previous date. If new_stage is n/a, the crop is somewhere between the previous growth stage and the next growth stage.

harvest_window/end

Expected end date for harvest operations.

harvest_window/start

Expected start date for harvest operations.

advisor

Suggested field properties to check.

description

Text description for a stage.

images/attribution

Credit for image.

images/caption

Image description.

images/url

Image URL.

name

Growth stage name.

order

Relative position of the stage within the growth scale.

Example Request

https://ag.us.clearapis.com/v1.1/crop_health/barley/growth?app_id=123
&app_key=321&location=47,-97&plant_date=1462060800&days=160

Example Response

{
    "attribution":[
        "Growth model based on...",...
    ],
    "data":{
        "47,-97":{
            "growth":{
                "2016-07-17":{
                    "agdd":2563.0,
                    "air_temp_max":82.0,
                    "air_temp_min":63.0,
                    "gdd":40.5,
                    "last_stage":"13.0",
                    "new_stage":"15.0"
                },...
            },
            "harvest_window":{
                "end":"2016-08-17",
                "start":"2016-07-27"
            }
        }
    },
    "stage_descriptions":{
        "15.0":{
            "advisor":"Harvest",
            "description":"Dry weight of the kernels stops increasing.",
            "images":[
                {
                    "attribution":"Courtesy of...",
                    "caption":"This stage is between Hard Dough (left) and Harvest Ripe (right)",
                    "url":".../Physiological_maturity.png"
                },...
            ],
            "name":"15.0 - Physiological Maturity",
            "order":"16"
        },...
    }
}

Barley Growth Add Feedback - v1.0

By providing feedback relating to the growth stage estimates, Iteris will be able to make updates and adjustments to offer its users better results in the future. The given user providing feedback must have write privileges for the field in which the field growth belongs.

Additional information related to feedback timestamp, growth feedback, and feedback stage is available in the Appendix.

URL Description

https://ag.us.clearapis.com/v1.0/crop_health/barley/growth/feedback/add/
{growth_id}/{timestamp}/{stage}?account_id={string}&user_id={string}
&app_id={string}&app_key={string}&start_override={boolean}

Request Parameters

Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

Your Accounts API account ID.

user_id

string

yes

User ID provided by and used with the Accounts API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

yes

Specifies the ID given when a growth is successfully added to a field using the create growth endpoint.

timestamp

integer

yes

An epoch timestamp in seconds representing the date for which the feedback applies. Please refer to the Epoch/Unix Timestamp section of the Appendix for Iteris' definition of Epoch/Unix timestamp.

stage

string

yes

Inform the system that on the given date, the plant has entered or is currently in the provided stage. Please refer to the Crop Growth Stages section of the Appendix for a listing of accepted growth stage IDs.

start_override

boolean

no

When this is included, the corrector system will treat this feedback as meaning "the crop entered this stage on this date." In the absence of this parameter, the corrector will treat this feedback as meaning "the crop was observed in this stage on this date."

Response Object

A string representing a feedback ID.

Example Request

https://ag.us.clearapis.com/v1.0/crop_health/barley/growth/feedback/add/
xyz/1472688000/15.0?account_id=abc&user_id=cba
&app_id=123&app_key=321

Example Response

def-345

Barley Growth Feedbacks by Growth - v1.0

Returns a list of growth feedback activities associated with the target growth_id.

URL Description

https://ag.us.clearapis.com/v1.0/crop_health/barley/growth/feedback/
get/by_growth/{growth_id}?app_id={string}&app_key={string}&account_id={string}
&user_id={string}

Request Parameters

Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

Your Accounts API account ID.

user_id

string

yes

User ID provided by and used with the Accounts API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

yes

Specifies the ID given when a growth is successfully added to a field using the create growth endpoint.

Response Object (JSON)

Field Description

user_id

User ID provided by and used with the Accounts API.

created

Timestamp denoting when the feedback was created.

data

Information pertaining to the activity.

subtype

Enumeration value representing the specific variety of the activity. Defaults to 0.

growth_feedback_id

ID of target growth feedback.

type

Enumeration value of plant.

feedback/date

Unix timestamp denoting when the feedback happened. Please refer to the Epoch/Unix Timestamp section of the Appendix for Iteris' definition of Epoch/Unix timestamp.

feedback/stage

Stage provided as feedback.

feedback/start_ override

True denotes this feedback as meaning "the crop entered this stage on this date." False denotes this feedback as meaning "the crop was observed in this stage on this date."

Example Request

https://ag.us.clearapis.com/v1.0/crop_health/barley/growth/feedback/
get/by_growth/xyz?app_id=123&app_key=321&account_id=abc
&user_id=cba

Example Response

[
    {
        "user_id":"1234",
        "feedback":{
            "date":1400371200,
            "type":50,
            "stage":"1.0"
        },
        "created":1446229281,
        "data":"{}",
        "subtype":"0",
        "growth_feedback_id":"1111",
        "type":50
    },...
]

Barley Growth Modify Feedback - v1.0

The Barley Growth Modify Feedback endpoint allows users to modify previously provided growth stage estimate feedback. The given user providing feedback must have write privileges for the field in which the field growth belongs. At least one modification must be provided.

URL Description

https://ag.us.clearapis.com/v1.0/crop_health/barley/growth/feedback/modify/
{feedback_id}?account_id={string}&user_id={string}&app_id={string}
&app_key={string}&timestamp={integer}&stage={string}

Request Parameters

Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

Your Accounts API account ID.

user_id

string

yes

User ID provided by and used with the Accounts API. The user must have privileges to view information for the field to which the target growth is assigned.

feedback_id

string

yes

A unique ID returned as a result from successfully adding feedback.

timestamp

integer

yes

An epoch timestamp in seconds representing the date for which the feedback applies. Please refer to the Epoch/Unix Timestamp section of the Appendix for Iteris’ definition of Epoch/Unix timestamp.

stage

string

yes

Inform the system that on the given date, the plant has entered or is currently in the provided stage. Please refer to the Crop Growth Stages section of the Appendix for a listing of accepted growth stage IDs.

Response Object

A string representing success ("true") or failure ("false").

Example Request

https://ag.us.clearapis.com/v1.0/crop_health/barley/growth/feedback/
modify/abc-123?account_id=abc&user_id=cba&app_id=123&app_key=321
&timestamp=1472688000&stage=15.0

Example Response

true

Barley Growth Delete Feedback - v1.0

This endpoint allows users to delete the previously provided growth stage estimate feedback. The given user deleting feedback must have write privileges for the field in which the field growth belongs.

URL Description

https://ag.us.clearapis.com/v1.0/crop_health/barley/growth/feedback/
delete/{feedback_id}?account_id={string}&user_id={string}&app_id={string}
&app_key={string}

Request Parameters

Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

Your Accounts API account ID.

user_id

string

yes

User ID provided by and used with the Accounts API. The user must have privileges to view information for the field to which the target growth is assigned.

feedback_id

string

yes

A unique ID returned as a result from successfully adding feedback.

Response Object

A string representing success ("true") or failure ("false").

Example Request

https://ag.us.clearapis.com/v1.0/crop_health/barley/growth/
feedback/delete/abc-123?account_id=abc&user_id=cba
&app_id=123&app_key=321

Example Response

true

Barley Growth with GDD Envelope - v1.1

The Barley Growth with GDD Envelope service provides spring barley growth information in addition to GDD envelope data. GDD envelope calculation begins from either the current day, or the planted/emergence date, whichever is further in the future. The envelope is constructed by compiling the previous 10 years of weather data, and simulating the maximum and minimum GDD that would have accumulated within those 10 years for each date. The calculated minimum and maximum values are then added to the current start of calculation date AGDD going onwards to show range of possibilities.

URL Description

https://ag.us.clearapis.com/v1.1/crop_health/barley/growth/
gdd_envelope?app_id={string}&app_key={string}&plant_date={timestamp}
&location={lat, lon coordinates}&days={integer}&account_id={string}
&user_id={string}&growth_id={string}
&relative_maturity={string}

Request Parameters

Parameter Type Location-based Accounts API Integration Description

app_id

string

yes

yes

API ID provided by Iteris.

app_key

string

yes

yes

API key provided by Iteris.

location

lat, lon coordinates

yes

 — 

User-provided latitude and longitude coordinates in decimal degrees. Please verify that latitude/longitude coordinates are over soil representative of your field. Users are allowed a maximum of five coordinates1, formatted as "&location=[(<lat_1>,<lon_1>),(<lat_2>,<lon_2>)]."

plant_date, emergence_date

timestamp

yes

 — 

Epoch timestamp valid near the time that the crop was planted or the date of emergence. Please refer to the Epoch/Unix Timestamp section of the Appendix for Iteris' definition of Epoch/Unix timestamp.

days

integer

yes

yes

Number of days for which to calculate results. Possible values range from 1 to 366.

relative_maturity

string

no

 — 

Classification indicating how early a variety matures. Valid values include "early," "medium-early," "medium," "medium-late," and "late." Crops that have an "early" relative maturity are expected to mature relatively fast, and crops having a "late" relative maturity are expected to mature relatively slowly. Default is "medium."

account_id

string

no

yes

Your Accounts API account ID.

user_id

string

no

yes

User ID provided by and used with the Accounts API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

no

yes

Specifies the ID given when a growth is successfully added to a field using the create growth endpoint.

1 Additional coordinates are not counted against a client’s account, but will count as additional requests in the future.

Response Object (JSON)

Field Description

attribution

Various model attributions.

agdd

Aggregate growing degree days from plant or emergence date, including the current date.

agdd_envelope_max

Maximum observed AGDD of the past 10 years.

agdd_envelope_max_year

Year that the maximum AGDD value was observed.

agdd_envelope_min

Minimum observed AGDD of the past 10 years.

agdd_envelope_min_year

Year that the maximum AGDD value was observed.

air_temp_max

Maximum daily air temperature valid for the current date. Obtained from historical, forecast, or climatological data, depending on the timeframe.

air_temp_min

Minimum daily air temperature valid for the current date. Obtained from historical, forecast, or climatological data, depending on the timeframe.

feedback_id

If this field is present, it indicates a confirmed or observed growth stage on the current date.

gdd

Growing degree days accumulated on the current date.

last_stage

The last known growth stage.

new_stage

The crop may have entered a new growth stage between the current date and the previous date. If new_stage is n/a, the crop is somewhere between the previous growth stage and the next growth stage.

harvest_window/end

Expected end date for harvest operations.

harvest_window/start

Expected start date for harvest operations.

advisor

Suggested field properties to check.

description

Text description for a stage.

images/attribution

Credit for image.

images/caption

Image description.

images/url

Image URL.

name

Growth stage name.

order

Relative position of the stage within the growth scale.

Example Request

https://ag.us.clearapis.com/v1.1/crop_health/barley/growth/gdd_envelope?
app_id=123&app_key=321&location=47,-97&plant_date=1462060800&days=160

Example Response

{
    "attribution":[
        "Growth model based on...",...
    ],
    "data":{
        "47,-97":{
            "growth":{
                "2016-07-17":{
                    "agdd":2563.0,
                    "agdd_envelope_max":2750.0,
                    "agdd_envelope_max_year":"2015",
                    "agdd_envelope_min":2450.0,
                    "agdd_envelope_min_year":"2013",
                    "air_temp_max":82.0,
                    "air_temp_min":63.0,
                    "gdd":40.5,
                    "last_stage":"13.0",
                    "new_stage":"15.0"
                },...
            },
            "harvest_window":{
                "end":"2016-08-17",
                "start":"2016-07-27"
            }
        }
    },
    "stage_descriptions":{
        "15.0":{
            "advisor":"Harvest",
            "description":"Dry weight of the kernels stops increasing.",
            "images":[
                {
                    "attribution":"Courtesy of...",
                    "caption":"This stage is between Hard Dough (left) and Harvest Ripe (right)",
                    "url":".../Physiological_maturity.png"
                },...
            ],
            "name":"15.0 - Physiological Maturity",
            "order":"16"
        },...
    }
}

Bermuda Turfgrass

Bermuda Turfgrass Growth Creation - v1.0

This endpoint allows users to create a bermuda turfgrass growth on an existing field. The user adding the bermuda turfgrass growth must have write privileges for the field being updated.

URL Description

https://ag.us.clearapis.com/v1.0/crop_health/turfgrass_bermuda/growth/create/
{field_id}?app_id={string}&app_key={string}&account_id={string}
&user_id={string}&start_date={string}&variety={string}&name={string}
&max_moisture_depletion={float}&max_moisture_refill={float}&zone_map_id={string}

Request Parameters

Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

Your Accounts API account ID.

user_id

string

yes

User ID provided by the Accounts API. The user must have privileges to view information for the field to which the target growth is assigned.

field_id

string

yes

ID of field on which to create the growth.

start_date

string

yes

Start time of the model, formatted either as a date string (YYYY-MM-DD) or an epoch timestamp. (Note that this is stored only as a timestamp in the database.) Please refer to the Epoch/Unix Timestamp section of the Appendix for Iteris' definition of Epoch/Unix timestamp.

variety

string

yes

Subclass of bermuda turfgrass. Currently, only "generic" is supported.

name

string

no

Unique name to assign to the growth. Default is "turfgrass bermuda."

max_moisture_ depletion

float

no

Desired driest state the soil is allowed to attain before an irrigation recommendation is triggered, expressed as percent depletion from field capacity to wilting point. Default values are optimized to the soil composition, crop type, and crop growth stage, with typical values of around 50%. Valid values range from 0% (indicating soil moisture should not be allowed to fall below field capacity) to 100% (soil moisture is allowed to reach the permanent wilting point, at which crop death will occur). Practical values typically range from 30 to 70%. Values are internally limited to be greater than the max_moisture_refill value.

max_moisture_refill

float

no

Desired maximum amount of refill to be provided by irrigation recommendations, expressed as percent depletion from field capacity to wilting point. The default value is 0%, indicating recommended irrigation activities will try to not exceed field capacity. Valid values range from –50% (an increase in the allowed maximum soil moisture) to 50% (a decrease in the allowed maximum soil moisture). Negative values represent refill amounts that exceed field capacity and are internally limited to the soil-specific saturation point.

zone_map_id

string

no

The target zone map id must exist for the target field. This will be a UUID. If provided and growth creation is successful, the growth will be treated as "zone aware," enabling zone management features. This property cannot be mutated after a growth has been created.

Response Object

A string representing a growth ID.

Example Request

https://ag.us.clearapis.com/v1.0/crop_health/turfgrass_bermuda/growth/create/e1b?
app_id=123&app_key=321&account_id=abc&user_id=cba&start_date=1462060800
variety=generic

Example Response

xyz

Bermuda Turfgrass Get Growth - v1.0

This endpoint allows users to retrieve a previously created growth based on growth ID.

URL Description

https://ag.us.clearapis.com/v1.0/crop_health/turfgrass_bermuda/growth/get/{growth_id}?
app_id={string}&app_key={string}&account_id={string}&user_id={string}

Request Parameters

Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

Your Accounts API account ID.

user_id

string

yes

User ID provided by the Create User endpoint as a result of adding a new user to the user information database.

growth_id

string

yes

Specifies ID of crop growth to be queried from the user information database, provided by the Create Growth endpoint.

Response Object (JSON)

Field Description

acres

Areal size of the field in acres.

created

Epoch timestamp when the growth was created. Please refer to the Epoch/Unix Timestamp section of the Appendix for Iteris' definition of Epoch/Unix timestamp.

field_id

ID of field to which crop growth data has been assigned.

field_name

Name of the field.

growth_id

ID of crop growth queried.

irrigation_type

Represents whether or not the cropland utilizes pivot irrigation. Valid values include 0 ("false") and 1 ("true").

latitude

Latitude coordinate near the center of the field in decimal degrees.

longitude

Longitude coordinate near the center of the field in decimal degrees.

max_moisture_depletion

Desired driest state the soil is allowed to attain before an irrigation recommendation is triggered, expressed as percent depletion from field capacity to wilting point.

max_moisture_refill

Desired maximum amount of refill to be provided by irrigation recommendations, expressed as percent depletion from field capacity to wilting point.

name

Name of the growth.

plant_name

Name of the crop plant.

plant_type

Value representing the type of crop planted. (See the Plant Enumerations section of the Appendix for a listing of plant type IDs.)

start_date

Start time of the model, formatted as an epoch timestamp. Please refer to the Epoch/Unix Timestamp section of the Appendix for Iteris' definition of Epoch/Unix timestamp.

subdrainage_type

Represents whether or not the cropland utilizes drainage tile. Valid values include 0 ("false") and 1 ("true").

surface_drainage_quality

Represents field drainage effectiveness. Valid values include 0 ("poor"), 1 ("average"), and 2 ("good").

variety

Subclass of bermuda turfgrass.

version

Growth model version to which feedbacks are applicable. [deprecated]

zone_map_id

Zone map ID to be used with this growth when utilizing zone management products. Value will be a UUID or null.

Example Request

https://ag.us.clearapis.com/v1.0/crop_health/turfgrass_bermuda/growth/get/bcd-def?
app_id=123&app_key=321&account_id=abc&user_id=cba

Example Response

{
    "acres":160.0,
    "created":1498069941,
    "field_id":"e1b",
    "field_name":"My Field",
    "growth_id":"xyz",
    "irrigation_type":0,
    "latitude":30.0,
    "longitude":-82.0,
    "max_moisture_depletion":75.0,
    "max_moisture_refill":15.0,
    "name":"MyGrowth",
    "plant_name":"turfgrass bermuda",
    "plant_type":78,
    "start_date":1398920400,
    "subdrainage_type":0,
    "surface_drainage_quality":1,
    "variety":"generic",
    "version":"v1.0"
}

Bermuda Turfgrass Growth Modify - v1.0

This endpoint allows users to modify an existing bermuda turfgrass growth.

URL Description

https://ag.us.clearapis.com/v1.0/crop_health/turfgrass_bermuda/growth/modify/
{growth_id}?app_id={string}&app_key={string}&account_id={string}
&user_id={string}&start_date={string}&variety={string}&name={string}
&max_moisture_depletion={float}&max_moisture_refill={float}

Request Parameters

Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

Your Accounts API account ID.

user_id

string

yes

User ID provided by the Accounts API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

yes

ID of target growth to modify.

start_date

string

no

Start time of the model, formatted either as a date string (YYYY-MM-DD) or an epoch timestamp. (Note that this is stored only as a timestamp in the database.) Please refer to the Epoch/Unix Timestamp section of the Appendix for Iteris' definition of Epoch/Unix timestamp.

variety

string

no

Subclass of bermuda turfgrass. Currently, only "generic" is supported.

name

string

no

Unique name to assign to the growth.

max_moisture_ depletion

float

no

Desired driest state the soil is allowed to attain before an irrigation recommendation is triggered, expressed as percent depletion from field capacity to wilting point. Valid values range from 0% (indicating soil moisture should not be allowed to fall below field capacity) to 100% (soil moisture is allowed to reach the permanent wilting point, at which crop death will occur). Practical values typically range from 30 to 70%. Values are internally limited to be greater than the max_moisture_refill value.

max_moisture_refill

float

no

Desired maximum amount of refill to be provided by irrigation recommendations, expressed as percent depletion from field capacity to wilting point. Valid values range from –50% (an increase in the allowed maximum soil moisture) to 50% (a decrease in the allowed maximum soil moisture). Negative values represent refill amounts that exceed field capacity and are internally limited to the soil-specific saturation point.

Response Object (JSON)

Returns "true" on success.

Example Request

https://ag.us.clearapis.com/v1.0/crop_health/turfgrass_bermuda/growth/modify/xyz?
app_id=123&app_key=321&account_id=abc&user_id=cba
&start_date=1462060800

Example Response

true

Bermuda Turfgrass Growth Delete - v1.0

This endpoint allows users to delete a bermuda turfgrass growth. By deleting a growth, any applicable growth feedback and growth whitelist items will also be deleted.

URL Description

https://ag.us.clearapis.com/v1.0/crop_health/turfgrass_bermuda/growth/delete/
{growth_id}?app_id={string}&app_key={string}&account_id={string}
&user_id={string}

Request Parameters

Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

Your Accounts API account ID.

user_id

string

yes

User ID provided by the Create User endpoint as a result of adding a new user to the user information database.

growth_id

string

yes

The ID of the target growth to delete.

Response Object

Returns "true" on success.

Example Request

https://ag.us.clearapis.com/v1.0/crop_health/turfgrass_bermuda/growth/delete/xyz?
app_id=123&app_key=321&account_id=abc&user_id=cba

Example Response

true

Bermuda Turfgrass Growth - v1.0

The Bermuda Turfgrass Growth endpoint allows users to simulate dormancy of bermuda turfgrass and determine when it is expected to be fully dormant, fully active, and in a transition phase between these two.

URL Description

https://ag.us.clearapis.com/v1.0/crop_health/turfgrass_bermuda/growth?app_id={string}
&app_key={string}&location={lat, lon coordinates}&start_date={start_date}
&days={integer}&variety={string}&account_id={string}&user_id={string}
&growth_id={string}

Request Parameters

Parameter Type Location-based Accounts API Integration Description

app_id

string

yes

yes

API ID provided by Iteris.

app_key

string

yes

yes

API key provided by Iteris.

location

lat, lon coordinates

yes

 — 

User-provided latitude and longitude coordinates in decimal degrees. Users are allowed a maximum of five coordinates,1 formatted as "&location=[(<lat_1>,<lon_1>),(<lat_2>,<lon_2>)]."

start_date

string

yes

 — 

Start time of the model, formatted either as a date string (YYYY-MM-DD) or an epoch timestamp. Please refer to the Epoch/Unix Timestamp section of the Appendix for Iteris' definition of Epoch/Unix timestamp.

days

integer

yes

yes

Number of days for which to calculate results. Possible values range from 1 to 366.

variety

string

yes

 — 

Subclass of bermuda turfgrass. Currently, only "generic" is supported.

account_id

string

no

yes

Your Accounts API account ID.

user_id

string

no

yes

User ID provided by the Accounts API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

no

yes

Growth ID provided by the Bermuda Turfgrass Growth Creation endpoint.

1 Additional coordinates are not counted against a client’s account.

Response Object (JSON)

Field Description

attribution

Various model attributions.

air_temp_max

Maximum daily air temperature in degrees Fahrenheit, which may be a historical, forecast, or climatological value, depending on the timeframe.

air_temp_min

Minimum daily air temperature in degrees Fahrenheit, which may be a historical, forecast, or climatological value, depending on the timeframe.

last_stage

The last known growth stage.

new_stage

The crop may have entered a new growth stage between the current date and the previous date. The output is "n/a" if the crop is somewhere between the previous growth stage and the next growth stage. Note that due to the perennial nature of turfgrass, the same stages can be reached multiple times in the simulation.

description

Text description for a stage.

images/attribution

Credit for image.

images/caption

Image description.

images/url

Image URL.

name

Growth stage name.

Example Request

https://ag.us.clearapis.com/v1.0/crop_health/turfgrass_bermuda/growth?app_id=123
&app_key=321&location=47,-97&start_date=1462060800&days=160
&variety=generic

Example Response

{
    "attribution":[
        "Growth model based on...",...
    ],
    "data":{
        "47,-97":{
            "growth":{
                "2016-05-01":{
                    "air_temp_max":66.0,
                    "air_temp_min":32.0,
                    "last_stage":"n/a",
                    "new_stage":"TA"
                },...
            }
        }
    },
    "stage_descriptions":{
        "TA":{
            "description":"Turfgrass starts a transition phase from dormant to active.",
            "images":[],
            "name":"Beginning Transition to Active"
        },...
    }
}

Canola

Canola Growth Creation - v1.0

This endpoint allows users to create a canola growth on an existing field. The given user adding the canola growth must have write privileges for the field being updated.

URL Description

https://ag.clearapis.com/v1.0/crop_health/canola/growth/create/{field_id}?
app_id={string}&app_key={string}&account_id={string}&user_id={string}
&plant_date={timestamp}&relative_maturity={string}
&max_moisture_depletion={float}&max_moisture_refill={float}&name={string}
&zone_map_id={string}

Request Parameters

Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

Your Accounts API account ID.

field_id

string

yes

Specifies ID of field to be updated.

user_id

string

yes

User ID provided by and used with the Accounts API. The user must have privileges to view information for the field to which the target growth is assigned.

plant_date, emergence_date

timestamp

yes

Epoch timestamp valid near the time that the crop was planted or the date of emergence. Please refer to the Epoch/Unix Timestamp section of the Appendix for Iteris' definition of Epoch/Unix timestamp.

relative_maturity

string

no

Classification indicating how early a variety matures. Valid values include "early," "medium-early," and "medium." Crops that have an "early" relative maturity are expected to mature relatively fast, and crops having a "medium" relative maturity are expected to mature relatively slowly. Default is "medium."

max_moisture_refill

float

no

Desired maximum amount of refill to be provided by irrigation recommendations, expressed as percent depletion from field capacity to wilting point. The default value is 0%, indicating recommended irrigation activities will try to not exceed field capacity. Valid values range from –50% (an increase in the allowed maximum soil moisture) to 50% (a decrease in the allowed maximum soil moisture). Negative values represent refill amounts that exceed field capacity and are internally limited to the soil-specific saturation point.

max_moisture_ depletion

float

no

Desired driest state the soil is allowed to attain before an irrigation recommendation is triggered, expressed as percent depletion from field capacity to wilting point. Default values are optimized to the soil composition, crop type, and crop growth stage, with typical values of around 50%. Valid values range from 0% (indicating soil moisture should not be allowed to fall below field capacity) to 100% (soil moisture is allowed to reach the permanent wilting point, at which crop death will occur). Practical values typically range from 30 to 70%. Values are internally limited to be greater than the max_moisture_refill value.

name

string

no

Unique name to assign to the growth. Default is "canola."

zone_map_id

string

no

The target zone map id must exist for the target field. This will be a UUID. If provided and growth creation is successful, the growth will be treated as "zone aware," enabling zone management features. This property cannot be mutated after a growth has been created.

Response Object

A string representing a growth ID.

Example Request

https://ag.clearapis.com/v1.0/crop_health/canola/growth/create/abc-123?
app_id=456&app_key=789&account_id=123&user_id=xyz-123&plant_date=1393632000

Example Response

abc-def

Canola Get Growth - v1.0

This endpoint allows a user to receive a previously created growth based on growth ID.

URL Description

https://ag.clearapis.com/v1.0/crop_health/canola/growth/get/{growth_id}?
app_id={string}&app_key={string}&account_id={string}
&user_id={string}

Request Parameters

Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

A unique account ID provided by your Iteris account representative.

user_id

string

yes

User ID provided by the Create User endpoint as a result of adding a new user to the user information database.

growth_id

string

yes

Specifies ID of crop growth to be queried from the user information database, provided by the Create Growth endpoint.

Response Object (JSON)

Field Description

acres

Areal size of the field in acres.

created

Epoch timestamp in seconds. Please refer to the Epoch/Unix Timestamp section of the Appendix for Iteris' definition of Epoch/Unix timestamp.

field_id

Specifies ID of field to which crop growth data has been assigned.

field_name

Name of the field.

growth_id

Specifies ID of crop growth queried.

harvest_date

An epoch timestamp in seconds for which harvest has begun. Please refer to the Epoch/Unix Timestamp section of the Appendix for Iteris' definition of Epoch/Unix timestamp.

irrigation_type

Represents whether or not the cropland utilizes pivot irrigation. Valid values: 0 is "false" and 1 is "true."

latitude

Latitude coordinate near the center of the field in decimal degrees. Please verify that latitude/longitude coordinates are over soil representative of your field.

longitude

Longitude coordinate near the center of the field in decimal degrees. Please verify that latitude/longitude coordinates are over soil representative of your field.

max_moisture_refill

Desired maximum amount of refill to be provided by irrigation recommendations, expressed as percent depletion from field capacity to wilting point. The default value is 0%, indicating recommended irrigation activities will try to not exceed field capacity. Valid values range from –50% (an increase in the allowed maximum soil moisture) to 50% (a decrease in the allowed maximum soil moisture). Negative values represent refill amounts that exceed field capacity and are internally limited to the soil-specific saturation point.

max_moisture_ depletion

Desired driest state the soil is allowed to attain before an irrigation recommendation is triggered, expressed as percent depletion from field capacity to wilting point. Default values are optimized to the soil composition, crop type, and crop growth stage, with typical values of around 50%. Valid values range from 0% (indicating soil moisture should not be allowed to fall below field capacity) to 100% (soil moisture is allowed to reach the permanent wilting point, at which crop death will occur). Practical values typically range from 30 to 70%. Values are internally limited to be greater than the max_moisture_refill value.

name

Name of the growth.

plant_date

Approximate time at which the crop was planted.

plant_name

Name of the crop plant.

plant_type

Value representing the type of crop planted. (See the Plant Enumerations section of the Appendix for a listing of plant type IDs.)

plant_subtype

Enumeration value representing plant sub-type.

relative_maturity

Classification indicating how early a variety matures. Valid values include "early," "medium-early," and "medium." Crops that have an "early" relative maturity are expected to mature relatively fast, and crops having a "medium" relative maturity are expected to mature relatively slowly. Default is "medium."

seed_variety

Additional description or notes for the seed used.

subdrainage_type

Represents whether or not the cropland utilizes drainage tile. Valid values: 0 is "false" (default) and 1 is "true."

surface_drainage_quality

Represents field drainage effectiveness. Valid values: 0 is poor, 1 is average, and 2 is good.

previous_crop

Type ID of previously planted crop.

previous_harvest_date

Epoch time which previous crop was harvested. Please refer to the Epoch/Unix Timestamp section of the Appendix for Iteris' definition of Epoch/Unix timestamp.

previous_yield

Yield of previous crop.

previous_yield_unit

Unit of measure for previous yield.

yield_goal

Yield target of current growth.

yield_goal_unit

Unit of measure for yield goal.

zone_map_id

Zone map ID to be used with this growth when utilizing zone management products. Value will be a UUID or null.

Example Request

https://ag.clearapis.com/v1.0/crop_health/canola/growth/get/bcd-def?
app_id=456&app_key=789&account_id=123&user_id=xyz-123

Example Response

{
    "acres":160.0,
    "created":1496777557,
    "field_id":"abc-def",
    "field_name":"MyField",
    "growth_id":"bcd-def",
    "harvest_date":null,
    "irrigation_type":0,
    "latitude":47.92338180541992,
    "longitude":-97.0919189453125,
    "max_moisture_depletion":50.0,
    "max_moisture_refill":-2.0,
    "name":"MyGrowth",
    "plant_date":1398920400,
    "plant_name":"canola",
    "plant_subtype":0,
    "plant_type":59,
    "seed_variety":null,
    "subdrainage_type":0,
    "surface_drainage_quality":1
}

Canola Growth Modify - v1.0

This endpoint allows a user to modify an existing canola growth.

URL Description

https://ag.clearapis.com/v1.0/crop_health/canola/growth/modify/{growth_id}?
app_id={string}&app_key={string}&account_id={string}&user_id={string}
&plant_date={timestamp}&max_moisture_depletion={float}
&max_moisture_refill={float}&name={string}

Request Parameters

Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

Your Accounts API account ID.

user_id

string

yes

User ID provided by and used with the Accounts API. The user must have privileges to view information for the field to which the target growth is assigned.

plant_date, emergence_date

timestamp

no

Epoch timestamp valid near the time that the crop was planted or the date of emergence. Please refer to the Epoch/Unix Timestamp section of the Appendix for Iteris' definition of Epoch/Unix timestamp.

relative_maturity

string

no

Classification indicating how early a variety matures. Valid values include "early," "medium-early," and "medium." Crops that have an "early" relative maturity are expected to mature relatively fast, and crops having a "medium" relative maturity are expected to mature relatively slowly. Default is "medium."

growth_id

string

yes

Growth ID provided by and used with the Accounts API. This ID is given when a growth is successfully modified on a field in the Accounts API.

max_moisture_refill

float

no

Desired maximum amount of refill to be provided by irrigation recommendations, expressed as percent depletion from field capacity to wilting point. The default value is 0%, indicating recommended irrigation activities will try to not exceed field capacity. Valid values range from –50% (an increase in the allowed maximum soil moisture) to 50% (a decrease in the allowed maximum soil moisture). Negative values represent refill amounts that exceed field capacity and are internally limited to the soil-specific saturation point.

max_moisture_ depletion

float

no

Desired driest state the soil is allowed to attain before an irrigation recommendation is triggered, expressed as percent depletion from field capacity to wilting point. Default values are optimized to the soil composition, crop type, and crop growth stage, with typical values of around 50%. Valid values range from 0% (indicating soil moisture should not be allowed to fall below field capacity) to 100% (soil moisture is allowed to reach the permanent wilting point, at which crop death will occur). Practical values typically range from 30 to 70%. Values are internally limited to be greater than the max_moisture_refill value.

name

string

no

Unique name to assign to the growth.

Response Object

Returns "true" on success.

Example Request

https://ag.clearapis.com/v1.0/crop_health/canola/growth/modify/abc-123?
app_id=456&app_key=789&account_id=123&user_id=xyz-123&plant_date=1456890400

Example Response

true

Canola Growth Delete - v1.0

This endpoint allows a user to delete a canola growth. By deleting a growth, any applicable growth feedback and growth whitelist items will also be deleted.

URL Description

https://ag.clearapis.com/v1.0/crop_health/canola/growth/delete/{growth_id}?
app_id={string}&app_key={string}&account_id={string}&user_id={string}

Request Parameters

Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

growth_id

string

yes

The ID of the target growth to delete.

account_id

string

yes

A unique account ID provided by your Iteris account representative.

user_id

sring

yes

User ID provided by the Create User endpoint as a result of adding a new user to the user information database.

Response Object

Returns "true" on success.

Example Request

https://ag.clearapis.com/v1.0/crop_health/canola/growth/delete/abc-def?
app_id=456&app_key=789&account_id=123&user_id=xyz-123

Example Response

true

Canola Growth - v1.1

Leveraging Iteris' canola growth stage model, the Canola Growth endpoint allows users to model the maturation and development of canola crops. Users may also take advantage of Accounts API integration to provide crop growth feedback and optimize model results.

URL Description

https://ag.us.clearapis.com/v1.1/crop_health/canola/growth?app_id={string}
&app_key={string}&location={lat, lon coordinates}&plant_date={timestamp}
&days={integer}&account_id={string}&user_id={string}&growth_id={string}
&relative_maturity={string}

Request Parameters

Parameter Type Location-based Accounts API Integration Description

app_id

string

yes

yes

API ID provided by Iteris.

app_key

string

yes

yes

API key provided by Iteris.

location

lat, lon coordinates

yes

 — 

User-provided latitude and longitude coordinates in decimal degrees. Please verify that latitude/longitude coordinates are over soil representative of your field. Users are allowed a maximum of five coordinates1, formatted as "&location=[(<lat_1>,<lon_1>),(<lat_2>,<lon_2>)]."

plant_date, emergence_date

timestamp

yes

 — 

Epoch timestamp valid near the time that the crop was planted or the date of emergence. Please refer to the Epoch/Unix Timestamp section of the Appendix for Iteris' definition of Epoch/Unix timestamp.

days

integer

yes

yes

Number of days for which to calculate results. Possible values range from 1 to 366.

relative_maturity

string

no

 — 

Classification indicating how early a variety matures. Valid values include "early," "medium-early," and "medium." Crops that have an "early" relative maturity are expected to mature relatively fast, and crops having a "medium" relative maturity are expected to mature relatively slowly. Default is "medium."

account_id

string

no

yes

Your Accounts API account ID.

user_id

string

no

yes

User ID provided by and used with the Accounts API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

no

yes

Specifies the ID given when a growth is successfully added to a field using the create growth endpoint.

1 Additional coordinates are not counted against a client’s account, but will count as additional requests in the future.

Response Object (JSON)

Field Description

attribution

Various model attributions.

agdd

Aggregate growing degree days from plant or emergence date, including the current date.

air_temp_max

Maximum daily air temperature valid for the current date. Obtained from historical, forecast, or climatological data, depending on the timeframe.

air_temp_min

Minimum daily air temperature valid for the current date. Obtained from historical, forecast, or climatological data, depending on the timeframe.

feedback_id

If this field is present, it indicates a confirmed or observed growth stage on the current date.

gdd

Growing degree days accumulated on the current date.

last_stage

The last known growth stage.

new_stage

The crop may have entered a new growth stage between the current date and the previous date. If new_stage is n/a, the crop is somewhere between the previous growth stage and the next growth stage.

harvest_window/end

Expected end date for harvest operations.

harvest_window/start

Expected start date for harvest operations.

advisor

Suggested field properties to check.

description

Text description for a stage.

images/attribution

Credit for image.

images/caption

Image description.

images/url

Image URL.

name

Growth stage name.

order

Relative position of the stage within the growth scale.

Example Request

https://ag.us.clearapis.com/v1.1/crop_health/canola/growth?app_id=123
&app_key=321&location=47,-97&plant_date=1462060800&days=160

Example Response

{
    "attribution":[
        "Growth model based on...",...
    ],
    "data":{
        "47,-97":{
            "growth":{
                "2016-07-23":{
                    "agdd":2128.5,
                    "air_temp_max":84.0,
                    "air_temp_min":72.0,
                    "gdd":37.0,
                    "last_stage":"ER",
                    "new_stage":"R"
                },...
            },
            "harvest_window":{
                "end":"2016-08-19",
                "start":"2016-07-30"
            }
        }
    },
    "stage_descriptions":{
        "R":{
            "advisor":"Harvest",
            "description":"About one third of the seeds on the main stem have changed color; the crop is ready to swath.",
            "images":[
                {
                    "attribution":"Courtesy of...",
                    "caption":"Mature",
                    "url":".../ripening4.png"
                },...
            ],
            "name":"Ripe",
            "order":"9"
        },...
    }
}

Canola Growth Add Feedback - v1.0

By providing feedback relating to the growth stage estimates, Iteris will be able to make updates and adjustments to offer its users better results in the future. The given user providing feedback must have write privileges for the field in which the field growth belongs.

Additional information related to feedback timestamp, growth feedback, and feedback stage is available in the Appendix.

URL Description

https://ag.us.clearapis.com/v1.0/crop_health/canola/growth/feedback/add/
{growth_id}/{timestamp}/{stage}?account_id={string}&user_id={string}
&app_id={string}&app_key={string}&start_override={boolean}

Request Parameters

Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

Your Accounts API account ID.

user_id

string

yes

User ID provided by and used with the Accounts API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

yes

Specifies the ID given when a growth is successfully added to a field using the create growth endpoint.

timestamp

integer

yes

An epoch timestamp in seconds representing the date for which the feedback applies. Please refer to the Epoch/Unix Timestamp section of the Appendix for Iteris' definition of Epoch/Unix timestamp.

stage

string

yes

Inform the system that on the given date, the plant has entered or is currently in the provided stage. Please refer to the Crop Growth Stages section of the Appendix for a listing of accepted growth stage IDs.

start_override

boolean

no

When this is included, the corrector system will treat this feedback as meaning "the crop entered this stage on this date." In the absence of this parameter, the corrector will treat this feedback as meaning "the crop was observed in this stage on this date."

Response Object

A string representing a feedback ID.

Example Request

https://ag.us.clearapis.com/v1.0/crop_health/canola/growth/feedback/add/
xyz/1472688000/R?account_id=abc&user_id=cba
&app_id=123&app_key=321

Example Response

def-345

Canola Growth Feedbacks by Growth - v1.1

Returns a list of growth feedback activities associated with the target growth_id.

URL Description

https://ag.us.clearapis.com/v1.1/crop_health/canola/growth/feedback/
get/by_growth/{growth_id}?app_id={string}&app_key={string}&account_id={string}
&user_id={string}

Request Parameters

Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

Your Accounts API account ID.

user_id

string

yes

User ID provided by and used with the Accounts API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

yes

Specifies the ID given when a growth is successfully added to a field using the create growth endpoint.

Response Object (JSON)

Field Description

user_id

User ID provided by and used with the Accounts API.

created

Timestamp denoting when the feedback was created.

data

Information pertaining to the activity.

subtype

Enumeration value representing the specific variety of the activity. Defaults to 0.

growth_feedback_id

ID of target growth feedback.

type

Enumeration value of plant.

feedback/date

Unix timestamp denoting when the feedback happened. Please refer to the Epoch/Unix Timestamp section of the Appendix for Iteris' definition of Epoch/Unix timestamp.

feedback/stage

Stage provided as feedback.

feedback/start_ override

True denotes this feedback as meaning "the crop entered this stage on this date." False denotes this feedback as meaning "the crop was observed in this stage on this date."

Example Request

https://ag.us.clearapis.com/v1.1/crop_health/canola/growth/feedback/
get/by_growth/xyz?app_id=123&app_key=321&account_id=abc
&user_id=cba

Example Response

[
    {
        "user_id":"1234",
        "feedback":{
            "date":1400371200,
            "type":59,
            "stage":"v1.0"
        },
        "created":1446229281,
        "data":"{}",
        "subtype":"0",
        "growth_feedback_id":"1111",
        "type":59
    },...
]

Canola Growth Modify Feedback - v1.0

The Canola Growth Modify Feedback endpoint allows users to modify previously provided growth stage estimate feedback. The given user providing feedback must have write privileges for the field in which the field growth belongs. At least one modification must be provided.

URL Description

https://ag.us.clearapis.com/v1.0/crop_health/canola/growth/feedback/modify/
{feedback_id}?account_id={string}&user_id={string}&app_id={string}
&app_key={string}&timestamp={integer}&stage={string}

Request Parameters

Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

Your Accounts API account ID.

user_id

string

yes

User ID provided by and used with the Accounts API. The user must have privileges to view information for the field to which the target growth is assigned.

feedback_id

string

yes

A unique ID returned as a result from successfully adding feedback.

timestamp

integer

yes

An epoch timestamp in seconds representing the date for which the feedback applies. Please refer to the Epoch/Unix Timestamp section of the Appendix for Iteris’ definition of Epoch/Unix timestamp.

stage

string

yes

Inform the system that on the given date, the plant has entered or is currently in the provided stage. Please refer to the Crop Growth Stages section of the Appendix for a listing of accepted growth stage IDs.

Response Object

A string representing success ("true") or failure ("false").

Example Request

https://ag.us.clearapis.com/v1.0/crop_health/canola/growth/feedback/
modify/abc-123?account_id=abc&user_id=cba&app_id=123&app_key=321
&timestamp=1472688000&stage=R

Example Response

true

Canola Growth Delete Feedback - v1.0

This endpoint allows users to delete the previously provided growth stage estimate feedback. The given user deleting feedback must have write privileges for the field in which the field growth belongs.

URL Description

https://ag.us.clearapis.com/v1.0/crop_health/canola/growth/feedback/
delete/{feedback_id}?account_id={string}&user_id={string}&app_id={string}
&app_key={string}

Request Parameters

Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

Your Accounts API account ID.

user_id

string

yes

User ID provided by and used with the Accounts API. The user must have privileges to view information for the field to which the target growth is assigned.

feedback_id

string

yes

A unique ID returned as a result from successfully adding feedback.

Response Object

A string representing success ("true") or failure ("false").

Example Request

https://ag.us.clearapis.com/v1.0/crop_health/canola/growth/
feedback/delete/abc-123?account_id=abc&user_id=cba
&app_id=123&app_key=321

Example Response

true

Canola Growth with GDD Envelope - v1.1

The Canola Growth with GDD Envelope service provides canola growth information in addition to GDD envelope data. GDD envelope calculation begins from either the current day, or the planted/emergence date, whichever is further in the future. The envelope is constructed by compiling the previous 10 years of weather data, and simulating the maximum and minimum GDD that would have accumulated within those 10 years for each date. The calculated minimum and maximum values are then added to the current start of calculation date AGDD going onwards to show range of possibilities.

URL Description

https://ag.us.clearapis.com/v1.1/crop_health/canola/growth/
gdd_envelope?app_id={string}&app_key={string}&plant_date={timestamp}
&location={lat, lon coordinates}&days={integer}&account_id={string}
&user_id={string}&growth_id={string}
&relative_maturity={string}

Request Parameters

Parameter Type Location-based Accounts API Integration Description

app_id

string

yes

yes

API ID provided by Iteris.

app_key

string

yes

yes

API key provided by Iteris.

location

lat, lon coordinates

yes

 — 

User-provided latitude and longitude coordinates in decimal degrees. Please verify that latitude/longitude coordinates are over soil representative of your field. Users are allowed a maximum of five coordinates1, formatted as "&location=[(<lat_1>,<lon_1>),(<lat_2>,<lon_2>)]."

plant_date, emergence_date

timestamp

yes

 — 

Epoch timestamp valid near the time that the crop was planted or the date of emergence. Please refer to the Epoch/Unix Timestamp section of the Appendix for Iteris' definition of Epoch/Unix timestamp.

days

integer

yes

yes

Number of days for which to calculate results. Possible values range from 1 to 366.

relative_maturity

string

no

 — 

Classification indicating how early a variety matures. Valid values include "early," "medium-early," and "medium." Crops that have an "early" relative maturity are expected to mature relatively fast, and crops having a "medium" relative maturity are expected to mature relatively slowly. Default is "medium."

account_id

string

no

yes

Your Accounts API account ID.

user_id

string

no

yes

User ID provided by and used with the Accounts API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

no

yes

Specifies the ID given when a growth is successfully added to a field using the create growth endpoint.

1 Additional coordinates are not counted against a client’s account, but will count as additional requests in the future.

Response Object (JSON)
Field Description

attribution

Various model attributions.

agdd

Aggregate growing degree days from plant or emergence date, including the current date.

agdd_envelope_max

Maximum observed AGDD of the past 10 years.

agdd_envelope_max_year

Year that the maximum AGDD value was observed.

agdd_envelope_min

Minimum observed AGDD of the past 10 years.

agdd_envelope_min_year

Year that the maximum AGDD value was observed.

air_temp_max

Maximum daily air temperature valid for the current date. Obtained from historical, forecast, or climatological data, depending on the timeframe.

air_temp_min

Minimum daily air temperature valid for the current date. Obtained from historical, forecast, or climatological data, depending on the timeframe.

feedback_id

If this field is present, it indicates a confirmed or observed growth stage on the current date.

gdd

Growing degree days accumulated on the current date.

last_stage

The last known growth stage.

new_stage

The crop may have entered a new growth stage between the current date and the previous date. If new_stage is n/a, the crop is somewhere between the previous growth stage and the next growth stage.

harvest_window/end

Expected end date for harvest operations.

harvest_window/start

Expected start date for harvest operations.

advisor

Suggested field properties to check.

description

Text description for a stage.

images/attribution

Credit for image.

images/caption

Image description.

images/url

Image URL.

name

Growth stage name.

order

Relative position of the stage within the growth scale.

Example Request

https://ag.us.clearapis.com/v1.1/crop_health/canola/growth/gdd_envelope?
app_id=123&app_key=321&location=47,-97&plant_date=1462060800&days=160

Example Response

{
    "attribution":[
        "Growth model based on...",...
    ],
    "data":{
        "47,-97":{
            "growth":{
                "2016-07-23":{
                    "agdd":2128.5,
                    "agdd_envelope_max":2300.0,
                    "agdd_envelope_max_year":"2015",
                    "agdd_envelope_min":2050.0,
                    "agdd_envelope_min_year":"2013",
                    "air_temp_max":84.0,
                    "air_temp_min":72.0,
                    "gdd":37.0,
                    "last_stage":"ER",
                    "new_stage":"R"
                },...
            },
            "harvest_window":{
                "end":"2016-08-19",
                "start":"2016-07-30"
            }
        }
    },
    "stage_descriptions":{
        "R":{
            "advisor":"Harvest",
            "description":"About one third of the seeds on the main stem have changed color; the crop is ready to swath.",
            "images":[
                {
                    "attribution":"Courtesy of...",
                    "caption":"Mature",
                    "url":".../ripening4.png"
                },...
            ],
            "name":"Ripe",
            "order":"9"
        },...
    }
}

Corn

Corn Growth Creation - v1.0

This endpoint allows users to create a corn growth on an existing field. The given user adding the corn growth must have write privileges for the field being updated.

URL Description

https://ag.clearapis.com/v1.0/crop_health/corn/growth/create/{field_id}?
app_id={string}&app_key={string}&account_id={string}&user_id={string}
&plant_date={timestamp}&relative_maturity={integer}
&max_moisture_depletion={float}&max_moisture_refill={float}
&name={string}&zone_map_id={string}

Request Parameters

Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

Your Accounts API account ID.

field_id

string

yes

Specifies ID of field to be updated.

user_id

string

yes

User ID provided by and used with the Accounts API. The user must have privileges to view information for the field to which the target growth is assigned.

plant_date, emergence_date

timestamp

yes

Epoch timestamp valid near the time that the crop reached emergence. Please refer to the Epoch/Unix Timestamp section of the Appendix for Iteris' definition of Epoch/Unix timestamp.

relative_maturity

integer

no

Classification indicating how early a variety matures. Valid values range from 70 to 130, with lower values indicating an "early" relative maturity and higher values indicating a "late" relative maturity. Default is 100.

max_moisture_refill

float

no

Desired maximum amount of refill to be provided by irrigation recommendations, expressed as percent depletion from field capacity to wilting point. The default value is 0%, indicating recommended irrigation activities will try to not exceed field capacity. Valid values range from –50% (an increase in the allowed maximum soil moisture) to 50% (a decrease in the allowed maximum soil moisture). Negative values represent refill amounts that exceed field capacity and are internally limited to the soil-specific saturation point.

max_moisture_ depletion

float

no

Desired driest state the soil is allowed to attain before an irrigation recommendation is triggered, expressed as percent depletion from field capacity to wilting point. Default values are optimized to the soil composition, crop type, and crop growth stage, with typical values of around 50%. Valid values range from 0% (indicating soil moisture should not be allowed to fall below field capacity) to 100% (soil moisture is allowed to reach the permanent wilting point, at which crop death will occur). Practical values typically range from 30 to 70%. Values are internally limited to be greater than the max_moisture_refill value.

name

string

no

Unique name to assign to the growth. Default is "corn."

zone_map_id

string

no

The target zone map id must exist for the target field. This will be a UUID. If provided and growth creation is successful, the growth will be treated as "zone aware," enabling zone management features. This property cannot be mutated after a growth has been created.

Response Object

A string representing a growth ID.

Example Request

https://ag.clearapis.com/v1.0/crop_health/corn/growth/create/abc-123?
app_id=456&app_key=789&account_id=123&user_id=xyz-123
&plant_date=1393632000&relative_maturity=88

Example Response

abc-def

Corn Get Growth - v1.0

This endpoint allows a user to receive a previously created growth based on growth ID.

URL Description

https://ag.clearapis.com/v1.0/crop_health/corn/growth/get/{growth_id}?
app_id={string}&app_key={string}&account_id={string}
&user_id={string}

Request Parameters

Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

A unique account ID provided by your Iteris account representative.

user_id

string

yes

User ID provided by the Create User endpoint as a result of adding a new user to the user information database.

growth_id

string

yes

Specifies ID of crop growth to be queried from the user information database, provided by the Create Growth endpoint.

Response Object (JSON)

Field Description

acres

Areal size of the field in acres.

created

Epoch timestamp in seconds. Please refer to the Epoch/Unix Timestamp section of the Appendix for Iteris' definition of Epoch/Unix timestamp.

field_id

Specifies ID of field to which crop growth data has been assigned.

field_name

Name of the field.

growth_id

Specifies ID of crop growth queried.

harvest_date

An epoch timestamp in seconds for which harvest has begun. Please refer to the Epoch/Unix Timestamp section of the Appendix for Iteris' definition of Epoch/Unix timestamp.

irrigation_type

Represents whether or not the cropland utilizes pivot irrigation. Valid values: 0 is "false" and 1 is "true."

latitude

Latitude coordinate near the center of the field in decimal degrees. Please verify that latitude/longitude coordinates are over soil representative of your field.

longitude

Longitude coordinate near the center of the field in decimal degrees. Please verify that latitude/longitude coordinates are over soil representative of your field.

max_moisture_refill

Desired maximum amount of refill to be provided by irrigation recommendations, expressed as percent depletion from field capacity to wilting point. The default value is 0%, indicating recommended irrigation activities will try to not exceed field capacity. Valid values range from –50% (an increase in the allowed maximum soil moisture) to 50% (a decrease in the allowed maximum soil moisture). Negative values represent refill amounts that exceed field capacity and are internally limited to the soil-specific saturation point.

max_moisture_ depletion

Desired driest state the soil is allowed to attain before an irrigation recommendation is triggered, expressed as percent depletion from field capacity to wilting point. Default values are optimized to the soil composition, crop type, and crop growth stage, with typical values of around 50%. Valid values range from 0% (indicating soil moisture should not be allowed to fall below field capacity) to 100% (soil moisture is allowed to reach the permanent wilting point, at which crop death will occur). Practical values typically range from 30 to 70%. Values are internally limited to be greater than the max_moisture_refill value.

name

Name of the growth.

plant_date

Approximate time at which the crop was planted.

plant_name

Name of the crop plant.

plant_type

Value representing the type of crop planted. (See the Plant Enumerations section of the Appendix for a listing of plant type IDs.)

plant_subtype

Coded value representing the specific variety of crop planted.

plant_type

Enumeration value representing plant sub-type.

relative_maturity

Classification indicating how early a variety matures. Valid values range from 70 to 130, with lower values indicating an "early" relative maturity and higher values indicating a "late" relative maturity. Default is 100.

seed_variety

Additional description or notes for the seed used.

subdrainage_type

Represents whether or not the cropland utilizes drainage tile. Valid values: 0 is "false" (default) and 1 is "true."

surface_drainage_quality

Represents field drainage effectiveness. Valid values: 0 is poor, 1 is average, and 2 is good.

previous_crop

Type ID of previously planted crop.

previous_harvest_date

Epoch time which previous crop was harvested. Please refer to the Epoch/Unix Timestamp section of the Appendix for Iteris' definition of Epoch/Unix timestamp.

previous_yield

Yield of previous crop.

previous_yield_unit

Unit of measure for previous yield.

yield_goal

Yield target of current growth.

yield_goal_unit

Unit of measure for yield goal.

zone_map_id

Zone map ID to be used with this growth when utilizing zone management products. Value will be a UUID or null.

Example Request

https://ag.clearapis.com/v1.0/crop_health/corn/growth/get/bcd-def?
app_id=456&app_key=789&account_id=123&user_id=xyz-123

Example Response

{
    "acres":160.0,
    "created":1498058928,
    "field_id":"abc-def",
    "field_name":"MyField",
    "growth_id":"bcd-def",
    "harvest_date":null,
    "irrigation_type":0,
    "latitude":47.92338180541992,
    "longitude":-97.0919189453125,
    "max_moisture_depletion":50.0,
    "max_moisture_refill":-2.0,
    "name":"MyGrowth",
    "plant_date":1398920400,
    "plant_name":"corn",
    "plant_subtype":0,
    "plant_type":51,
    "relative_maturity":"73",
    "seed_variety":null,
    "subdrainage_type":0,
    "surface_drainage_quality":1
}

Corn Growth Modify - v1.0

This endpoint allows a user to modify an existing corn growth.

URL Description

https://ag.clearapis.com/v1.0/crop_health/corn/growth/modify/{growth_id}?
app_id={string}&app_key={string}&account_id={string}&user_id={string}
&plant_date={timestamp}&relative_maturity={integer}&max_moisture_depletion={float}
&max_moisture_refill={float}&name={string}

Request Parameters

Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

Your Accounts API account ID.

user_id

string

yes

User ID provided by and used with the Accounts API. The user must have privileges to view information for the field to which the target growth is assigned.

plant_date, emergence_date

timestamp

yes

Epoch timestamp valid near the time that the crop reached emergence. Please refer to the Epoch/Unix Timestamp section of the Appendix for Iteris' definition of Epoch/Unix timestamp.

growth_id

string

yes

Growth ID provided by and used with the Accounts API. This ID is given when a growth is successfully modified on a field in the Accounts API.

relative_maturity

integer

no

Classification indicating how early a variety matures. Valid values range from 70 to 130, with lower values indicating an "early" relative maturity and higher values indicating a "late" relative maturity. Default is 100.

max_moisture_refill

float

no

Desired maximum amount of refill to be provided by irrigation recommendations, expressed as percent depletion from field capacity to wilting point. The default value is 0%, indicating recommended irrigation activities will try to not exceed field capacity. Valid values range from –50% (an increase in the allowed maximum soil moisture) to 50% (a decrease in the allowed maximum soil moisture). Negative values represent refill amounts that exceed field capacity and are internally limited to the soil-specific saturation point.

max_moisture_ depletion

float

no

Desired driest state the soil is allowed to attain before an irrigation recommendation is triggered, expressed as percent depletion from field capacity to wilting point. Default values are optimized to the soil composition, crop type, and crop growth stage, with typical values of around 50%. Valid values range from 0% (indicating soil moisture should not be allowed to fall below field capacity) to 100% (soil moisture is allowed to reach the permanent wilting point, at which crop death will occur). Practical values typically range from 30 to 70%. Values are internally limited to be greater than the max_moisture_refill value.

name

string

no

Unique name to assign to the growth.

Response Object

Returns "true" on success.

Example Request

https://ag.clearapis.com/v1.0/crop_health/corn/growth/modify/abc-123?app_id=456
&app_key=789&account_id=123&user_id=xyz-123&plant_date=1456890400
&relative_maturity=100

Example Response

true

Corn Growth Delete - v1.0

The endpoint allows a user to delete a corn growth. By deleting a growth, any applicable growth feedback and growth whitelist items will also be deleted.

URL Description

https://ag.clearapis.com/v1.0/crop_health/corn/growth/delete/{growth_id}?
app_id={string}&app_key={string}&account_id={string}&user_id={string}

Request Parameters

Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

growth_id

string

yes

The ID of the target growth to delete.

account_id

string

yes

A unique account ID provided by your Iteris account representative.

user_id

sring

yes

User ID provided by the Create User endpoint as a result of adding a new user to the user information database.

Response Object

Returns "true" on success.

Example Request

https://ag.clearapis.com/v1.0/crop_health/corn/growth/delete/abc-def?
app_id=456&app_key=789&account_id=123&user_id=xyz-123

Example Response

true

Corn Growth - v1.1

Leveraging Iteris' corn growth stage model, the Corn Growth endpoint allows users to model the maturation and development of corn crops. Users may also take advantage of Accounts API integration to provide crop growth feedback and optimize model results.

URL Description

https://ag.us.clearapis.com/v1.1/crop_health/corn/growth?app_id={string}
&app_key={string}&location={lat, lon coordinates}&plant_date={timestamp}
&days={integer}&account_id={string}&user_id={string}&growth_id={string}
&relative_maturity={integer}

Request Parameters

Parameter Type Location-based Accounts API Integration Description

app_id

string

yes

yes

API ID provided by Iteris.

app_key

string

yes

yes

API key provided by Iteris.

location

lat, lon coordinates

yes

 — 

User-provided latitude and longitude coordinates in decimal degrees. Please verify that latitude/longitude coordinates are over soil representative of your field. Users are allowed a maximum of five coordinates1, formatted as "&location=[(<lat_1>,<lon_1>),(<lat_2>,<lon_2>)]."

plant_date, emergence_date

timestamp

yes

 — 

Epoch timestamp valid near the time that the crop was planted or the date of emergence. Please refer to the Epoch/Unix Timestamp section of the Appendix for Iteris' definition of Epoch/Unix timestamp.

days

integer

yes

yes

Number of days for which to calculate results. Possible values range from 1 to 366.

relative_maturity

integer

no

 — 

Classification indicating how early a variety matures. Valid values range from 70 to 130, with lower values indicating an "early" relative maturity and higher values indicating a "late" relative maturity. Default is 100.

account_id

string

no

yes

Your Accounts API account ID.

user_id

string

no

yes

User ID provided by and used with the Accounts API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

no

yes

Specifies the ID given when a growth is successfully added to a field using the create growth endpoint.

1 Additional coordinates are not counted against a client’s account, but will count as additional requests in the future.

Response Object (JSON)

Field Description

attribution

Various model attributions.

agdd

Aggregate growing degree days from plant or emergence date, including the current date.

air_temp_max

Maximum daily air temperature valid for the current date. Obtained from historical, forecast, or climatological data, depending on the timeframe.

air_temp_min

Minimum daily air temperature valid for the current date. Obtained from historical, forecast, or climatological data, depending on the timeframe.

feedback_id

If this field is present, it indicates a confirmed or observed growth stage on the current date.

gdd

Growing degree days accumulated on the current date.

last_stage

The last known growth stage.

new_stage

The crop may have entered a new growth stage between the current date and the previous date. If new_stage is n/a, the crop is somewhere between the previous growth stage and the next growth stage.

harvest_window/end

Expected end date for harvest operations.

harvest_window/start

Expected start date for harvest operations.

advisor

Suggested field properties to check.

description

Text description for a stage.

images/attribution

Credit for image.

images/caption

Image description.

images/url

Image URL.

name

Growth stage name.

order

Relative position of the stage within the growth scale.

Example Request

https://ag.us.clearapis.com/v1.1/crop_health/corn/growth?app_id=123
&app_key=321&location=47,-97&plant_date=1462060800&days=160

Example Response

{
    "attribution":[
        "Growth model based on...",...
    ],
    "data":{
        "47,-97":{
            "growth":{
                "2016-09-15":{
                    "agdd":2459.0,
                    "air_temp_max":73.0,
                    "air_temp_min":58.0,
                    "gdd":15.5,
                    "last_stage":"r5",
                    "new_stage":"r6"
                },...
            },
            "harvest_window":{
                "end":"2016-10-29",
                "start":"2016-09-27"
            }
        }
    },
    "stage_descriptions":{
        "r6":{
            "advisor":"Harvest",
            "description":"A black layer forms at the base of the kernels blocking further dry matter accumulation. All starch in the kernels has hardened at this time.",
            "images":[
                {
                    "attribution":"Courtesy of...",
                    "caption":"R6 - Ear with silks and husk leaves (left) and without (right)",
                    "url":".../Figure_80_ISUE300.jpg"
                },...
            ],
            "name":"R6 - Physiological Maturity",
            "order":"11"
        },...
    }
}

Corn Growth Add Feedback - v1.0

By providing feedback relating to the growth stage estimates, Iteris will be able to make updates and adjustments to offer its users better results in the future. The given user providing feedback must have write privileges for the field in which the field growth belongs.

Additional information related to feedback timestamp, growth feedback, and feedback stage is available in the Appendix.

URL Description

https://ag.us.clearapis.com/v1.0/crop_health/corn/growth/feedback/add/
{growth_id}/{timestamp}/{stage}?account_id={string}&user_id={string}
&app_id={string}&app_key={string}&start_override={boolean}

Request Parameters

Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

Your Accounts API account ID.

user_id

string

yes

User ID provided by and used with the Accounts API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

yes

Specifies the ID given when a growth is successfully added to a field using the create growth endpoint.

timestamp

integer

yes

An epoch timestamp in seconds representing the date for which the feedback applies. Please refer to the Epoch/Unix Timestamp section of the Appendix for Iteris' definition of Epoch/Unix timestamp.

stage

string

yes

Inform the system that on the given date, the plant has entered or is currently in the provided stage. Please refer to the Crop Growth Stages section of the Appendix for a listing of accepted growth stage IDs.

start_override

boolean

no

When this is included, the corrector system will treat this feedback as meaning "the crop entered this stage on this date." In the absence of this parameter, the corrector will treat this feedback as meaning "the crop was observed in this stage on this date."

Response Object

A string representing a feedback ID.

Example Request

https://ag.us.clearapis.com/v1.0/crop_health/corn/growth/feedback/add/
xyz/1472688000/r6?account_id=abc&user_id=cba
&app_id=123&app_key=321

Example Response

def-345

Corn Growth Feedbacks by Growth - v1.0

Returns a list of growth feedback activities associated with the target growth_id.

URL Description

https://ag.us.clearapis.com/v1.0/crop_health/corn/growth/feedback/
get/by_growth/{growth_id}?app_id={string}&app_key={string}&account_id={string}
&user_id={string}

Request Parameters

Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

Your Accounts API account ID.

user_id

string

yes

User ID provided by and used with the Accounts API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

yes

Specifies the ID given when a growth is successfully added to a field using the create growth endpoint.

Response Object (JSON)

Field Description

user_id

User ID provided by and used with the Accounts API.

created

Timestamp denoting when the feedback was created.

data

Information pertaining to the activity.

subtype

Enumeration value representing the specific variety of the activity. Defaults to 0.

growth_feedback_id

ID of target growth feedback.

type

Enumeration value of plant.

feedback/date

Unix timestamp denoting when the feedback happened. Please refer to the Epoch/Unix Timestamp section of the Appendix for Iteris' definition of Epoch/Unix timestamp.

feedback/stage

Stage provided as feedback.

feedback/start_ override

True denotes this feedback as meaning "the crop entered this stage on this date." False denotes this feedback as meaning "the crop was observed in this stage on this date."

Example Request

https://ag.us.clearapis.com/v1.0/crop_health/corn/growth/feedback/
get/by_growth/xyz?app_id=123&app_key=321&account_id=abc
&user_id=cba

Example Response

[
    {
        "user_id":"1234",
        "feedback":{
            "date":1400371200,
            "type":51,
            "stage":"v1.0"
        },
        "created":1446229281,
        "data":"{}",
        "subtype":"0",
        "growth_feedback_id":"1111",
        "type":51
    },...
]

Corn Growth Modify Feedback - v1.0

The Corn Growth Modify Feedback endpoint allows users to modify previously provided growth stage estimate feedback. The given user providing feedback must have write privileges for the field in which the field growth belongs. At least one modification must be provided.

URL Description

https://ag.us.clearapis.com/v1.0/crop_health/corn/growth/feedback/modify/
{feedback_id}?account_id={string}&user_id={string}&app_id={string}
&app_key={string}&timestamp={integer}&stage={string}
Request Parameters
Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

Your Accounts API account ID.

user_id

string

yes

User ID provided by and used with the Accounts API. The user must have privileges to view information for the field to which the target growth is assigned.

feedback_id

string

yes

A unique ID returned as a result from successfully adding feedback.

timestamp

integer

yes

An epoch timestamp in seconds representing the date for which the feedback applies. Please refer to the Epoch/Unix Timestamp section of the Appendix for Iteris’ definition of Epoch/Unix timestamp.

stage

string

yes

Inform the system that on the given date, the plant has entered or is currently in the provided stage. Please refer to the Crop Growth Stages section of the Appendix for a listing of accepted growth stage IDs.

Response Object

A string representing success ("true") or failure ("false").

Example Request

https://ag.us.clearapis.com/v1.0/crop_health/corn/growth/feedback/
modify/abc-123?account_id=abc&user_id=cba&app_id=123&app_key=321
&timestamp=1472688000&stage=r6

Example Response

true

Corn Growth Delete Feedback - v1.0

This endpoint allows users to delete the previously provided growth stage estimate feedback. The given user deleting feedback must have write privileges for the field in which the field growth belongs.

URL Description

https://ag.us.clearapis.com/v1.0/crop_health/corn/growth/feedback/
delete/{feedback_id}?account_id={string}&user_id={string}&app_id={string}
&app_key={string}

Request Parameters

Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

Your Accounts API account ID.

user_id

string

yes

User ID provided by and used with the Accounts API. The user must have privileges to view information for the field to which the target growth is assigned.

feedback_id

string

yes

A unique ID returned as a result from successfully adding feedback.

Response Object

A string representing success ("true") or failure ("false").

Example Request

https://ag.us.clearapis.com/v1.0/crop_health/corn/growth/
feedback/delete/abc-123?account_id=abc&user_id=cba
&app_id=123&app_key=321

Example Response

true

Corn Growth with GDD Envelope - v1.1

The Corn Growth with GDD Envelope service provides corn growth information in addition to GDD envelope data. GDD envelope calculation begins from either the current day, or the planted/emergence date, whichever is further in the future. The envelope is constructed by compiling the previous 10 years of weather data, and simulating the maximum and minimum GDD that would have accumulated within those 10 years for each date. The calculated minimum and maximum values are then added to the current start of calculation date AGDD going onwards to show range of possibilities.

URL Description

https://ag.us.clearapis.com/v1.1/crop_health/corn/growth/
gdd_envelope?app_id={string}&app_key={string}&plant_date={timestamp}
&location={lat, lon coordinates}&days={integer}&account_id={string}
&user_id={string}&growth_id={string}
&relative_maturity={integer}

Request Parameters

Parameter Type Location-based Accounts API Integration Description

app_id

string

yes

yes

API ID provided by Iteris.

app_key

string

yes

yes

API key provided by Iteris.

location

lat, lon coordinates

yes

 — 

User-provided latitude and longitude coordinates in decimal degrees. Please verify that latitude/longitude coordinates are over soil representative of your field. Users are allowed a maximum of five coordinates1, formatted as "&location=[(<lat_1>,<lon_1>),(<lat_2>,<lon_2>)]."

plant_date, emergence_date

timestamp

yes

 — 

Epoch timestamp valid near the time that the crop was planted or the date of emergence. Please refer to the Epoch/Unix Timestamp section of the Appendix for Iteris' definition of Epoch/Unix timestamp.

days

integer

yes

yes

Number of days for which to calculate results. Possible values range from 1 to 366.

relative_maturity

integer

no

 — 

Classification indicating how early a variety matures. Valid values range from 70 to 130, with lower values indicating an "early" relative maturity and higher values indicating a "late" relative maturity. Default is 100.

account_id

string

no

yes

Your Accounts API account ID.

user_id

string

no

yes

User ID provided by and used with the Accounts API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

no

yes

Specifies the ID given when a growth is successfully added to a field using the create growth endpoint.

1 Additional coordinates are not counted against a client’s account, but will count as additional requests in the future.

Response Object (JSON)

Field Description

attribution

Various model attributions.

agdd

Aggregate growing degree days from plant or emergence date, including the current date.

agdd_envelope_max

Maximum observed AGDD of the past 10 years.

agdd_envelope_max_year

Year that the maximum AGDD value was observed.

agdd_envelope_min

Minimum observed AGDD of the past 10 years.

agdd_envelope_min_year

Year that the maximum AGDD value was observed.

air_temp_max

Maximum daily air temperature valid for the current date. Obtained from historical, forecast, or climatological data, depending on the timeframe.

air_temp_min

Minimum daily air temperature valid for the current date. Obtained from historical, forecast, or climatological data, depending on the timeframe.

feedback_id

If this field is present, it indicates a confirmed or observed growth stage on the current date.

gdd

Growing degree days accumulated on the current date.

last_stage

The last known growth stage.

new_stage

The crop may have entered a new growth stage between the current date and the previous date. If new_stage is n/a, the crop is somewhere between the previous growth stage and the next growth stage.

harvest_window/end

Expected end date for harvest operations.

harvest_window/start

Expected start date for harvest operations.

advisor

Suggested field properties to check.

description

Text description for a stage.

images/attribution

Credit for image.

images/caption

Image description.

images/url

Image URL.

name

Growth stage name.

order

Relative position of the stage within the growth scale.

Example Request

https://ag.us.clearapis.com/v1.1/crop_health/corn/growth/gdd_envelope?
app_id=123&app_key=321&location=47,-97&plant_date=1462060800&days=160

Example Response

{
    "attribution":[
        "Growth model based on...",...
    ],
    "data":{
        "47,-97":{
            "growth":{
                "2016-09-15":{
                    "agdd":2459.0,
                    "agdd_envelope_max":2550.0,
                    "agdd_envelope_max_year":"2015",
                    "agdd_envelope_min":2400.0,
                    "agdd_envelope_min_year":"2013",
                    "air_temp_max":73.0,
                    "air_temp_min":58.0,
                    "gdd":15.5,
                    "last_stage":"r5",
                    "new_stage":"r6"
                },...
            },
            "harvest_window":{
                "end":"2016-10-29",
                "start":"2016-09-27"
            }
        }
    },
    "stage_descriptions":{
        "r6":{
            "advisor":"Harvest",
            "description":"A black layer forms at the base of the kernels blocking further dry matter accumulation. All starch in the kernels has hardened at this time.",
            "images":[
                {
                    "attribution":"Courtesy of...",
                    "caption":"R6 - Ear with silks and husk leaves (left) and without (right)",
                    "url":".../Figure_80_ISUE300.jpg"
                },...
            ],
            "name":"R6 - Physiological Maturity",
            "order":"11"
        },...
    }
}

Cotton

Cotton Growth Creation - v1.0

This endpoint allows users to create a cotton growth on an existing field. The given user adding the cotton growth must have write privileges for the field being updated.

URL Description

https://ag.clearapis.com/v1.0/crop_health/cotton/growth/create/{field_id}?
app_id={string}&app_key={string}&account_id={string}&user_id={string}
&plant_date={timestamp}&relative_maturity={string}&plant_depth={float}
&max_moisture_depletion={float}&max_moisture_refill={float}&name={string}
&zone_map_id={string}

Request Parameters

Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string.

yes

Your Accounts API account ID.

field_id

string

yes

Specifies ID of field to be updated.

user_id

string

yes

User ID provided by and used with the Accounts API. The user must have privileges to view information for the field to which the target growth is assigned.

plant_date, emergence_date

timestamp

yes

Epoch timestamp valid near the time that the crop reached emergence. Please refer to the Epoch/Unix Timestamp section of the Appendix for Iteris' definition of Epoch/Unix timestamp.

relative_maturity

string

no

Classification indicating how early a variety matures. Valid values include "early," "medium-early," "medium," "medium-late," and "late." Default is "medium."

plant_depth

float

no

The depth in centimeters that the crop was planted. Plant depth must be a float between 0.1 and 4.9 cm. If no value is provided, the default plant depth is 3.5.

max_moisture_refill

float

no

Desired maximum amount of refill to be provided by irrigation recommendations, expressed as percent depletion from field capacity to wilting point. The default value is 0%, indicating recommended irrigation activities will try to not exceed field capacity. Valid values range from –50% (an increase in the allowed maximum soil moisture) to 50% (a decrease in the allowed maximum soil moisture). Negative values represent refill amounts that exceed field capacity and are internally limited to the soil-specific saturation point.

max_moisture_ depletion

float

no

Desired driest state the soil is allowed to attain before an irrigation recommendation is triggered, expressed as percent depletion from field capacity to wilting point. Default values are optimized to the soil composition, crop type, and crop growth stage, with typical values of around 50%. Valid values range from 0% (indicating soil moisture should not be allowed to fall below field capacity) to 100% (soil moisture is allowed to reach the permanent wilting point, at which crop death will occur). Practical values typically range from 30 to 70%. Values are internally limited to be greater than the max_moisture_refill value.

name

string

no

Unique name to assign to the growth. Default is "cotton."

zone_map_id

string

no

The target zone map id must exist for the target field. This will be a UUID. If provided and growth creation is successful, the growth will be treated as "zone aware," enabling zone management features. This property cannot be mutated after a growth has been created.

Response Object

A string representing a growth ID.

Example Request

https://ag.clearapis.com/v1.0/crop_health/cotton/growth/create/abc-123?
app_id=456&app_key=789&account_id=123&user_id=xyz-123
&plant_date=1393632000&relative_maturity=early

Example Response

abc-def

Cotton Get Growth - v1.0

This endpoint allows a user to receive a previously created growth based on growth ID.

URL Description

https://ag.clearapis.com/v1.0/crop_health/cotton/growth/get/{growth_id}?
app_id={string}&app_key={string}&account_id={string}
&user_id={string}

Request Parameters

Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

A unique account ID provided by your Iteris account representative.

user_id

string

yes

User ID provided by the Create User endpoint as a result of adding a new user to the user information database.

growth_id

string

yes

Specifies ID of crop growth to be queried from the user information database, provided by the Create Growth endpoint.

Response Object (JSON)

Field Description

acres

Areal size of the field in acres.

created

Epoch timestamp in seconds. Please refer to the Epoch/Unix Timestamp section of the Appendix for Iteris' definition of Epoch/Unix timestamp.

field_id

Specifies ID of field to which crop growth data has been assigned.

field_name

Name of the field.

growth_id

Specifies ID of crop growth queried.

harvest_date

An epoch timestamp in seconds for which harvest has begun. Please refer to the Epoch/Unix Timestamp section of the Appendix for Iteris' definition of Epoch/Unix timestamp.

irrigation_type

Represents whether or not the cropland utilizes pivot irrigation. Valid values: 0 is "false" and 1 is "true."

latitude

Latitude coordinate near the center of the field in decimal degrees. Please verify that latitude/longitude coordinates are over soil representative of your field.

longitude

Longitude coordinate near the center of the field in decimal degrees. Please verify that latitude/longitude coordinates are over soil representative of your field.

max_moisture_refill

Desired maximum amount of refill to be provided by irrigation recommendations, expressed as percent depletion from field capacity to wilting point. The default value is 0%, indicating recommended irrigation activities will try to not exceed field capacity. Valid values range from –50% (an increase in the allowed maximum soil moisture) to 50% (a decrease in the allowed maximum soil moisture). Negative values represent refill amounts that exceed field capacity and are internally limited to the soil-specific saturation point.

max_moisture_ depletion

Desired driest state the soil is allowed to attain before an irrigation recommendation is triggered, expressed as percent depletion from field capacity to wilting point. Default values are optimized to the soil composition, crop type, and crop growth stage, with typical values of around 50%. Valid values range from 0% (indicating soil moisture should not be allowed to fall below field capacity) to 100% (soil moisture is allowed to reach the permanent wilting point, at which crop death will occur). Practical values typically range from 30 to 70%. Values are internally limited to be greater than the max_moisture_refill value.

name

Name of the growth.

plant_date

Approximate time at which the crop was planted.

plant_name

Name of the crop plant.

plant_type

Value representing the type of crop planted. (See the Plant Enumerations section of the Appendix for a listing of plant type IDs.)

plant_subtype

Enumeration value representing plant sub-type.

relative_maturity

Classification indicating how early a variety matures. Valid values include "early," "medium-early," "medium," "medium-late," and "late." Default is "medium."

seed_variety

Additional description or notes for the seed used.

subdrainage_type

Represents whether or not the cropland utilizes drainage tile. Valid values: 0 is "false" (default) and 1 is "true."

surface_drainage_quality

Represents field drainage effectiveness. Valid values: 0 is poor, 1 is average, and 2 is good.

previous_crop

Type ID of previously planted crop.

previous_harvest_date

Epoch time which previous crop was harvested. Please refer to the Epoch/Unix Timestamp section of the Appendix for Iteris' definition of Epoch/Unix timestamp.

previous_yield

Yield of previous crop.

previous_yield_unit

Unit of measure for previous yield.

yield_goal

Yield target of current growth.

yield_goal_unit

Unit of measure for yield goal.

zone_map_id

Zone map ID to be used with this growth when utilizing zone management products. Value will be a UUID or null.

Example Request

https://ag.clearapis.com/v1.0/crop_health/cotton/growth/get/bcd-def?
app_id=456&app_key=789&account_id=123&user_id=xyz-123

Example Response

{
    "acres":1234.0,
    "created":1445972460,
    "emergence_date":null,
    "field_id":"abc-def",
    "field_name":"MyField",
    "growth_id":"bcd-def",
    "harvest_date":null,
    "irrigation_type":1,
    "latitude":30.107118606567383,
    "longitude":-82.3095703125,
    "max_moisture_depletion":50.0,
    "max_moisture_refill":-2.0,
    "name":"MyGrowth",
    "plant_date":1398920400,
    "plant_name":"cotton",
    "plant_subtype":0,
    "plant_type":65,
    "relative_maturity":"late",
    "seed_variety":null,
    "subdrainage_type":1,
    "surface_drainage_quality":1,
    "version":"v1.1"
}

Cotton Growth Modify - v1.0

This endpoint allows a user to modify an existing cotton growth.

URL Description

https://ag.clearapis.com/v1.0/crop_health/cotton/growth/modify/{growth_id}?
app_id={string}&app_key={string}&account_id={string}&user_id={string}
&plant_date={timestamp}&relative_maturity={string}
&max_moisture_depletion={float}&max_moisture_refill={float}&name={string}

Request Parameters

Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

Your Accounts API account ID.

user_id

string

yes

User ID provided by and used with the Accounts API. The user must have privileges to view information for the field to which the target growth is assigned.

plant_date, emergence_date

timestamp

yes

Epoch timestamp valid near the time that the crop reached emergence. Please refer to the Epoch/Unix Timestamp section of the Appendix for Iteris' definition of Epoch/Unix timestamp.

growth_id

string

yes

Growth ID provided by and used with the Accounts API. This ID is given when a growth is successfully modified on a field in the Accounts API.

relative_maturity

string

no

Classification indicating how early a variety matures. Valid values include "early," "medium-early," "medium," "medium-late," and "late." Default is "medium."

max_moisture_refill

float

no

Desired maximum amount of refill to be provided by irrigation recommendations, expressed as percent depletion from field capacity to wilting point. The default value is 0%, indicating recommended irrigation activities will try to not exceed field capacity. Valid values range from –50% (an increase in the allowed maximum soil moisture) to 50% (a decrease in the allowed maximum soil moisture). Negative values represent refill amounts that exceed field capacity and are internally limited to the soil-specific saturation point.

max_moisture_ depletion

float

no

Desired driest state the soil is allowed to attain before an irrigation recommendation is triggered, expressed as percent depletion from field capacity to wilting point. Default values are optimized to the soil composition, crop type, and crop growth stage, with typical values of around 50%. Valid values range from 0% (indicating soil moisture should not be allowed to fall below field capacity) to 100% (soil moisture is allowed to reach the permanent wilting point, at which crop death will occur). Practical values typically range from 30 to 70%. Values are internally limited to be greater than the max_moisture_refill value.

name

string

no

Unique name to assign to the growth.

Response Object

Returns "true" on success.

Example Request

https://ag.clearapis.com/v1.0/crop_health/cotton/growth/modify/abc-123?
app_id=456&app_key=789&account_id=123&user_id=xyz-123&plant_date=1456890400
&relative_maturity=medium

Example Response

true

Cotton Growth Delete - v1.0

This endpoint allows a user to delete a cotton growth. By deleting a growth, any applicable growth feedback and growth whitelist items will also be deleted.

URL Description

https://ag.clearapis.com/v1.0/crop_health/cotton/growth/delete/{growth_id}?
app_id={string}&app_key={string}&account_id={string}&user_id={string}

Request Parameters

Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

growth_id

string

yes

The ID of the target growth to delete.

account_id

string

yes

A unique account ID provided by your Iteris account representative.

user_id

sring

yes

User ID provided by the Create User endpoint as a result of adding a new user to the user information database.

Response Object

Returns "true" on success.

Example Request

https://ag.clearapis.com/v1.0/crop_health/cotton/growth/delete/abc-def?
app_id=456&app_key=789&account_id=123&user_id=xyz-123

Example Response

true

Cotton Growth - v1.1

Leveraging Iteris' cotton growth stage model, the Cotton Growth endpoint allows users to model the maturation and development of cotton crops. Users may also take advantage of Accounts API integration to provide crop growth feedback and optimize model results.

URL Description

https://ag.us.clearapis.com/v1.1/crop_health/cotton/growth?app_id={string}
&app_key={string}&location={lat, lon coordinates}&plant_date={timestamp}
&days={integer}&account_id={string}&user_id={string}&growth_id={string}
&relative_maturity={string}

Request Parameters

Parameter Type Location-based Accounts API Integration Description

app_id

string

yes

yes

API ID provided by Iteris.

app_key

string

yes

yes

API key provided by Iteris.

location

lat, lon coordinates

yes

 — 

User-provided latitude and longitude coordinates in decimal degrees. Please verify that latitude/longitude coordinates are over soil representative of your field. Users are allowed a maximum of five coordinates1, formatted as "&location=[(<lat_1>,<lon_1>),(<lat_2>,<lon_2>)]."

plant_date, emergence_date

timestamp

yes

 — 

Epoch timestamp valid near the time that the crop was planted or the date of emergence. Please refer to the Epoch/Unix Timestamp section of the Appendix for Iteris' definition of Epoch/Unix timestamp.

days

integer

yes

yes

Number of days for which to calculate results. Possible values range from 1 to 366.

relative_maturity

string

no

 — 

Classification indicating how early a variety matures. Valid values include "early," "medium-early," "medium," "medium-late," and "late." Default is "medium."

account_id

string

no

yes

Your Accounts API account ID.

user_id

string

no

yes

User ID provided by and used with the Accounts API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

no

yes

Specifies the ID given when a growth is successfully added to a field using the create growth endpoint.

1 Additional coordinates are not counted against a client’s account, but will count as additional requests in the future.

Response Object (JSON)

Field Description

attribution

Various model attributions.

agdd

Aggregate growing degree days from plant or emergence date, including the current date.

air_temp_max

Maximum daily air temperature valid for the current date. Obtained from historical, forecast, or climatological data, depending on the timeframe.

air_temp_min

Minimum daily air temperature valid for the current date. Obtained from historical, forecast, or climatological data, depending on the timeframe.

feedback_id

If this field is present, it indicates a confirmed or observed growth stage on the current date.

gdd

Growing degree days accumulated on the current date.

last_stage

The last known growth stage.

new_stage

The crop may have entered a new growth stage between the current date and the previous date. If new_stage is n/a, the crop is somewhere between the previous growth stage and the next growth stage.

harvest_window/end

Expected end date for harvest operations.

harvest_window/start

Expected start date for harvest operations.

advisor

Suggested field properties to check.

description

Text description for a stage.

images/attribution

Credit for image.

images/caption

Image description.

images/url

Image URL.

name

Growth stage name.

order

Relative position of the stage within the growth scale.

Example Request

https://ag.us.clearapis.com/v1.1/crop_health/cotton/growth?app_id=123
&app_key=321&location=47,-97&plant_date=1462060800&days=160

Example Response

{
    "attribution":[
        "Growth model based on...",...
    ],
    "data":{
        "47,-97":{
            "growth":{
                "2016-08-23":{
                    "agdd":1601.0,
                    "air_temp_max":89.0,
                    "air_temp_min":69.0,
                    "gdd":24.0,
                    "last_stage":"v2.0",
                    "new_stage":"v3.0"
                },...
            },
            "harvest_window":{
                "end":"n/a",
                "start":"n/a"
            }
        }
    },
    "stage_descriptions":{
        "v3.0":{
            "advisor":"Pest/Disease",
            "description":"The first flowers are visible. A flower is pollinated on the first day it is open (white bloom stage) and turns pink or red the next day.",
            "images":[
                {
                    "attribution":"Courtesy of...",
                    "caption":"White flower",
                    "url":".../Flower_bloom5.jpg"
                },...
            ],
            "name":"First Flowers",
            "order":"3"
        },...
    }
}

Cotton Growth Add Feedback - v1.0

By providing feedback relating to the growth stage estimates, Iteris will be able to make updates and adjustments to offer its users better results in the future. The given user providing feedback must have write privileges for the field in which the field growth belongs.

Additional information related to feedback timestamp, growth feedback, and feedback stage is available in the Appendix.

URL Description

https://ag.us.clearapis.com/v1.0/crop_health/cotton/growth/feedback/add/
{growth_id}/{timestamp}/{stage}?account_id={string}&user_id={string}
&app_id={string}&app_key={string}&start_override={boolean}

Request Parameters

Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

Your Accounts API account ID.

user_id

string

yes

User ID provided by and used with the Accounts API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

yes

Specifies the ID given when a growth is successfully added to a field using the create growth endpoint.

timestamp

integer

yes

An epoch timestamp in seconds representing the date for which the feedback applies. Please refer to the Epoch/Unix Timestamp section of the Appendix for Iteris' definition of Epoch/Unix timestamp.

stage

string

yes

Inform the system that on the given date, the plant has entered or is currently in the provided stage. Please refer to the Crop Growth Stages section of the Appendix for a listing of accepted growth stage IDs.

start_override

boolean

no

When this is included, the corrector system will treat this feedback as meaning "the crop entered this stage on this date." In the absence of this parameter, the corrector will treat this feedback as meaning "the crop was observed in this stage on this date."

Response Object

A string representing a feedback ID.

Example Request

https://ag.us.clearapis.com/v1.0/crop_health/cotton/growth/feedback/add/
xyz/1472688000/v7.0?account_id=abc&user_id=cba
&app_id=123&app_key=321

Example Response

def-345

Cotton Growth Feedbacks by Growth - v1.0

Returns a list of growth feedback activities associated with the target growth_id.

URL Description

https://ag.us.clearapis.com/v1.0/crop_health/cotton/growth/feedback/
get/by_growth/{growth_id}?app_id={string}&app_key={string}&account_id={string}
&user_id={string}

Request Parameters

Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

Your Accounts API account ID.

user_id

string

yes

User ID provided by and used with the Accounts API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

yes

Specifies the ID given when a growth is successfully added to a field using the create growth endpoint.

Response Object (JSON)

Field Description

user_id

User ID provided by and used with the Accounts API.

created

Timestamp denoting when the feedback was created.

data

Information pertaining to the activity.

subtype

Enumeration value representing the specific variety of the activity. Defaults to 0.

growth_feedback_id

ID of target growth feedback.

type

Enumeration value of plant.

feedback/date

Unix timestamp denoting when the feedback happened. Please refer to the Epoch/Unix Timestamp section of the Appendix for Iteris' definition of Epoch/Unix timestamp.

feedback/stage

Stage provided as feedback.

feedback/start_ override

True denotes this feedback as meaning "the crop entered this stage on this date." False denotes this feedback as meaning "the crop was observed in this stage on this date."

Example Request

https://ag.us.clearapis.com/v1.0/crop_health/cotton/growth/feedback/
get/by_growth/xyz?app_id=123&app_key=321&account_id=abc
&user_id=cba

Example Response

[
    {
        "user_id":"1234",
        "feedback":{
            "date":1400371200,
            "type":65,
            "stage":"v1.0"
        },
        "created":1446229281,
        "data":"{}",
        "subtype":"0",
        "growth_feedback_id":"1111",
        "type":65
    },...
]

Cotton Growth Modify Feedback - v1.0

The Cotton Growth Modify Feedback endpoint allows users to modify previously provided growth stage estimate feedback. The given user providing feedback must have write privileges for the field in which the field growth belongs. At least one modification must be provided.

URL Description

https://ag.us.clearapis.com/v1.0/crop_health/cotton/growth/feedback/modify/
{feedback_id}?account_id={string}&user_id={string}&app_id={string}
&app_key={string}&timestamp={integer}&stage={string}

Request Parameters

Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

Your Accounts API account ID.

user_id

string

yes

User ID provided by and used with the Accounts API. The user must have privileges to view information for the field to which the target growth is assigned.

feedback_id

string

yes

A unique ID returned as a result from successfully adding feedback.

timestamp

integer

yes

An epoch timestamp in seconds representing the date for which the feedback applies. Please refer to the Epoch/Unix Timestamp section of the Appendix for Iteris’ definition of Epoch/Unix timestamp.

stage

string

yes

Inform the system that on the given date, the plant has entered or is currently in the provided stage. Please refer to the Crop Growth Stages section of the Appendix for a listing of accepted growth stage IDs.

Response Object

A string representing success ("true") or failure ("false").

Example Request

https://ag.us.clearapis.com/v1.0/crop_health/cotton/growth/feedback/
modify/abc-123?account_id=abc&user_id=cba&app_id=123&app_key=321
&timestamp=1472688000&stage=v7.0

Example Response

true

Cotton Growth Delete Feedback - v1.0

This endpoint allows users to delete the previously provided growth stage estimate feedback. The given user deleting feedback must have write privileges for the field in which the field growth belongs.

URL Description

https://ag.us.clearapis.com/v1.0/crop_health/cotton/growth/feedback/
delete/{feedback_id}?account_id={string}&user_id={string}&app_id={string}
&app_key={string}

Request Parameters

Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

Your Accounts API account ID.

user_id

string

yes

User ID provided by and used with the Accounts API. The user must have privileges to view information for the field to which the target growth is assigned.

feedback_id

string

yes

A unique ID returned as a result from successfully adding feedback.

Response Object

A string representing success ("true") or failure ("false").

Example Request

https://ag.us.clearapis.com/v1.0/crop_health/cotton/growth/
feedback/delete/abc-123?account_id=abc&user_id=cba
&app_id=123&app_key=321

Example Response

true

Cotton Growth with GDD Envelope - v1.1

The Cotton Growth with GDD Envelope service provides cotton growth information in addition to GDD envelope data. GDD envelope calculation begins from either the current day, or the planted/emergence date, whichever is further in the future. The envelope is constructed by compiling the previous 10 years of weather data, and simulating the maximum and minimum GDD that would have accumulated within those 10 years for each date. The calculated minimum and maximum values are then added to the current start of calculation date AGDD going onwards to show range of possibilities.

URL Description

https://ag.us.clearapis.com/v1.1/crop_health/cotton/growth/
gdd_envelope?app_id={string}&app_key={string}&plant_date={timestamp}
&location={lat, lon coordinates}&days={integer}&account_id={string}
&user_id={string}&growth_id={string}
&relative_maturity={string}

Request Parameters

Parameter Type Location-based Accounts API Integration Description

app_id

string

yes

yes

API ID provided by Iteris.

app_key

string

yes

yes

API key provided by Iteris.

location

lat, lon coordinates

yes

 — 

User-provided latitude and longitude coordinates in decimal degrees. Please verify that latitude/longitude coordinates are over soil representative of your field. Users are allowed a maximum of five coordinates1, formatted as "&location=[(<lat_1>,<lon_1>),(<lat_2>,<lon_2>)]."

plant_date, emergence_date

timestamp

yes

 — 

Epoch timestamp valid near the time that the crop was planted or the date of emergence. Please refer to the Epoch/Unix Timestamp section of the Appendix for Iteris' definition of Epoch/Unix timestamp.

days

integer

yes

yes

Number of days for which to calculate results. Possible values range from 1 to 366.

relative_maturity

string

no

 — 

Classification indicating how early a variety matures. Valid values include "early," "medium-early," "medium," "medium-late," and "late." Default is "medium."

account_id

string

no

yes

Your Accounts API account ID.

user_id

string

no

yes

User ID provided by and used with the Accounts API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

no

yes

Specifies the ID given when a growth is successfully added to a field using the create growth endpoint.

1 Additional coordinates are not counted against a client’s account, but will count as additional requests in the future.

Response Object (JSON)

Field Description

attribution

Various model attributions.

agdd

Aggregate growing degree days from plant or emergence date, including the current date.

agdd_envelope_max

Maximum observed AGDD of the past 10 years.

agdd_envelope_max_year

Year that the maximum AGDD value was observed.

agdd_envelope_min

Minimum observed AGDD of the past 10 years.

agdd_envelope_min_year

Year that the maximum AGDD value was observed.

air_temp_max

Maximum daily air temperature valid for the current date. Obtained from historical, forecast, or climatological data, depending on the timeframe.

air_temp_min

Minimum daily air temperature valid for the current date. Obtained from historical, forecast, or climatological data, depending on the timeframe.

feedback_id

If this field is present, it indicates a confirmed or observed growth stage on the current date.

gdd

Growing degree days accumulated on the current date.

last_stage

The last known growth stage.

new_stage

The crop may have entered a new growth stage between the current date and the previous date. If new_stage is n/a, the crop is somewhere between the previous growth stage and the next growth stage.

harvest_window/end

Expected end date for harvest operations.

harvest_window/start

Expected start date for harvest operations.

advisor

Suggested field properties to check.

description

Text description for a stage.

images/attribution

Credit for image.

images/caption

Image description.

images/url

Image URL.

name

Growth stage name.

order

Relative position of the stage within the growth scale.

Example Request

https://ag.us.clearapis.com/v1.1/crop_health/cotton/growth/gdd_envelope?
app_id=123&app_key=321&location=47,-97&plant_date=1462060800&days=160

Example Response

{
    "attribution":[
        "Growth model based on...",...
    ],
    "data":{
        "47,-97":{
            "growth":{
                "2016-08-23":{
                    "agdd":1601.0,
                    "agdd_envelope_max":1750.0,
                    "agdd_envelope_max_year":"2015",
                    "agdd_envelope_min":1350.0,
                    "agdd_envelope_min_year":"2013",
                    "air_temp_max":89.0,
                    "air_temp_min":69.0,
                    "gdd":24.0,
                    "last_stage":"v2.0",
                    "new_stage":"v3.0"
                },...
            },
            "harvest_window":{
                "end":"n/a",
                "start":"n/a"
            }
        }
    },
    "stage_descriptions":{
        "v3.0":{
            "advisor":"Pest/Disease",
            "description":"The first flowers are visible. A flower is pollinated on the first day it is open (white bloom stage) and turns pink or red the next day.",
            "images":[
                {
                    "attribution":"Courtesy of...",
                    "caption":"White flower",
                    "url":".../Flower_bloom5.jpg"
                },...
            ],
            "name":"First Flowers",
            "order":"3"
        },...
    }
}

Peanut

Peanut Growth Creation - v1.0

This endpoint allows users to create a peanut growth on an existing field. The user adding the peanut growth must have write privileges for the field being updated.

URL Description

https://ag.us.clearapis.com/v1.0/crop_health/peanut/growth/create/{field_id}?
app_id={string}&app_key={string}&account_id={string}&user_id={string}
&plant_date={timestamp}&variety={string}&plant_depth={float}&name={string}
&zone_map_id={string}

Request Parameters

Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

Your Accounts API account ID.

user_id

string

yes

User ID provided by the Accounts API. The user must have privileges to view information for the field to which the target growth is assigned.

field_id

string

yes

ID of field on which to create the growth.

plant_date, emergence_date

timestamp

yes

Epoch timestamp valid near the time that the crop was planted or the date of emergence. Please refer to the Epoch/Unix Timestamp section of the Appendix for Iteris' definition of Epoch/Unix timestamp.

variety

string

yes

Subclass of peanut. Note that either variety name or ID may be provided, and will be represented only by its ID in the database. Please refer to the Variety Enumerations section of the Appendix for the listing of supported varieties.

plant_depth

float

no

The depth (in cm) that the crop was planted. Valid values range from 0.1 to 10.0 cm. Default is 5.0.

name

string

no

Unique name to assign to the growth. Default is "peanut."

zone_map_id

string

no

The target zone map id must exist for the target field. This will be a UUID. If provided and growth creation is successful, the growth will be treated as "zone aware," enabling zone management features. This property cannot be mutated after a growth has been created.

Response Object

A string representing a growth ID.

Example Request

https://ag.us.clearapis.com/v1.0/crop_health/peanut/growth/create/e1b?
app_id=123&app_key=321&account_id=abc&user_id=cba&plant_date=1462060800
&variety=0

Example Response

xyz

Peanut Get Growth - v1.0

This endpoint allows users to retrieve a previously created growth based on growth ID.

URL Description

https://ag.us.clearapis.com/v1.0/crop_health/peanut/growth/get/{growth_id}?
app_id={string}&app_key={string}&account_id={string}&user_id={string}

Request Parameters

Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

Your Accounts API account ID.

user_id

string

yes

User ID provided by the Create User endpoint as a result of adding a new user to the user information database.

growth_id

string

yes

Specifies ID of crop growth to be queried from the user information database, provided by the Create Growth endpoint.

Response Object (JSON)

Field Description

acres

Areal size of the field in acres.

created

Epoch timestamp when the growth was created. Please refer to the Epoch/Unix Timestamp section of the Appendix for Iteris' definition of Epoch/Unix timestamp.

emergence_date

Epoch timestamp when emergence was reached. Please refer to the Epoch/Unix Timestamp section of the Appendix for Iteris' definition of Epoch/Unix timestamp.

field_id

ID of field to which crop growth data has been assigned.

field_name

Name of the field.

growth_id

ID of crop growth queried.

harvest_date

Epoch timestamp when harvest began. Please refer to the Epoch/Unix Timestamp section of the Appendix for Iteris' definition of Epoch/Unix timestamp.

irrigation_type

Represents whether or not the cropland utilizes pivot irrigation. Valid values include 0 ("false") and 1 ("true").

latitude

Latitude coordinate near the center of the field in decimal degrees. Please verify that latitude/longitude coordinates are over soil representative of your field.

longitude

Longitude coordinate near the center of the field in decimal degrees. Please verify that latitude/longitude coordinates are over soil representative of your field.

name

Name of the growth.

plant_date

Epoch timestamp when the crop was planted. Please refer to the Epoch/Unix Timestamp section of the Appendix for Iteris' definition of Epoch/Unix timestamp.

plant_depth

The depth (in cm) that the crop was planted.

plant_name

Name of the crop plant.

plant_type

Value representing the type of crop planted. (See the Plant Enumerations section of the Appendix for a listing of plant type IDs.)

subdrainage_type

Represents whether or not the cropland utilizes drainage tile. Valid values include 0 ("false") and 1 ("true").

surface_drainage_quality

Represents field drainage effectiveness. Valid values include 0 ("poor"), 1 ("average"), and 2 ("good").

variety

Subclass of peanut. Please refer to the Variety Enumerations section of the Appendix for the listing of supported varieties.

version

Growth model version to which feedbacks are applicable. [deprecated]

zone_map_id

Zone map ID to be used with this growth when utilizing zone management products. Value will be a UUID or null.

Example Request

https://ag.us.clearapis.com/v1.0/crop_health/peanut/growth/get/bcd-def?
app_id=123&app_key=321&account_id=abc&user_id=cba

Example Response

{
    "acres":160.0,
    "created":1498069941,
    "emergence_date":null,
    "field_id":"e1b",
    "field_name":"My Field",
    "growth_id":"xyz",
    "harvest_date":null,
    "irrigation_type":0,
    "latitude":30.0,
    "longitude":-82.0,
    "name":"MyGrowth",
    "plant_date":1398920400,
    "plant_depth":5.0,
    "plant_name":"peanut",
    "plant_type":76,
    "subdrainage_type":0,
    "surface_drainage_quality":1,
    "variety":0,
    "version":"v1.0"
}

Peanut Growth Modify - v1.0

This endpoint allows users to modify an existing peanut growth.

URL Description

https://ag.us.clearapis.com/v1.0/crop_health/peanut/growth/modify/{growth_id}?
app_id={string}&app_key={string}&account_id={string}&user_id={string}
&plant_date={timestamp}&variety={string}&plant_depth={float}&name={string}

Request Parameters

Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

Your Accounts API account ID.

user_id

string

yes

User ID provided by the Accounts API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

yes

ID of target growth to modify.

plant_date, emergence_date

timestamp

no

Epoch timestamp valid near the time that the crop was planted or the date of emergence. Please refer to the Epoch/Unix Timestamp section of the Appendix for Iteris' definition of Epoch/Unix timestamp.

variety

string

no

Subclass of peanut. Note that either variety name or ID may be provided, and will be represented only by its ID in the database. Please refer to the Variety Enumerations section of the Appendix for the listing of supported varieties.

plant_depth

float

no

The depth (in cm) that the crop was planted. Valid values range from 0.1 to 10.0 cm.

name

string

no

Unique name to assign to the growth.

Response Object (JSON)

Returns "true" on success.

Example Request

https://ag.us.clearapis.com/v1.0/crop_health/peanut/growth/modify/xyz?
app_id=123&app_key=321&account_id=abc&user_id=cba
&plant_date=1462060800

Example Response

true

Peanut Growth Delete - v1.0

This endpoint allows users to delete a peanut growth. By deleting a growth, any applicable growth feedback and growth whitelist items will also be deleted.

URL Description

https://ag.us.clearapis.com/v1.0/crop_health/peanut/growth/delete/{growth_id}?
app_id={string}&app_key={string}&account_id={string}&user_id={string}

Request Parameters

Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

Your Accounts API account ID.

user_id

string

yes

User ID provided by the Create User endpoint as a result of adding a new user to the user information database.

growth_id

string

yes

The ID of the target growth to delete.

Response Object

Returns "true" on success.

Example Request

https://ag.us.clearapis.com/v1.0/crop_health/peanut/growth/delete/xyz?
app_id=123&app_key=321&account_id=abc&user_id=cba

Example Response

true

Peanut Growth - v1.0

Leveraging Iteris' peanut growth stage model, the Peanut Growth endpoint allows users to model the maturation and development of peanut crops.

URL Description

https://ag.us.clearapis.com/v1.0/crop_health/peanut/growth?app_id={string}
&app_key={string}&location={lat, lon coordinates}&plant_date={timestamp}
&days={integer}&account_id={string}&user_id={string}&growth_id={string}
&variety={string}&plant_depth={float}

Request Parameters

Parameter Type Location-based Accounts API Integration Description

app_id

string

yes

yes

API ID provided by Iteris.

app_key

string

yes

yes

API key provided by Iteris.

location

lat, lon coordinates

yes

 — 

User-provided latitude and longitude coordinates in decimal degrees. Please verify that latitude/longitude coordinates are over soil representative of your field. Users are allowed a maximum of five coordinates,1 formatted as "&location=[(<lat_1>,<lon_1>),(<lat_2>,<lon_2>)]."

plant_date, emergence_date

timestamp

yes

 — 

Epoch timestamp valid near the time that the crop was planted or the date of emergence. Please refer to the Epoch/Unix Timestamp section of the Appendix for Iteris' definition of Epoch/Unix timestamp.

days

integer

yes

yes

Number of days for which to calculate results. Possible values range from 1 to 366.

variety

string

yes

 — 

Subclass of peanut. Note that either variety name or ID may be provided. Please refer to the Variety Enumerations section of the Appendix for the listing of supported varieties.

plant_depth

float

no

 — 

The depth (in cm) that the crop was planted. Valid values range from 0.1 to 10.0 cm. Default is 5.0.

account_id

string

no

yes

Your Accounts API account ID.

user_id

string

no

yes

User ID provided by the Accounts API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

no

yes

Growth ID provided by the Peanut Growth Creation endpoint.

1 Additional coordinates are not counted against a client’s account.

Response Object (JSON)

Field Description

attribution

Various model attributions.

agdd

Aggregate growing degree days from planting or emergence date, including the current date.

air_temp_max

Maximum daily air temperature in degrees Fahrenheit, which may be a historical, forecast, or climatological value, depending on the timeframe.

air_temp_min

Minimum daily air temperature in degrees Fahrenheit, which may be a historical, forecast, or climatological value, depending on the timeframe.

gdd

Growing degree days accumulated on the current date.

last_reproductive_stage

The last known reproductive stage.

last_stage

The last known growth stage. Contains vegetative stages until the beginning of flowering is reached, after which only new reproductive stages are provided.

last_vegetative_stage

The last known vegetative stage.

new_reproductive_stage

The crop may have entered a new reproductive stage between the current date and the previous date. "n/a" if the crop is somewhere between the previous reproductive stage and the next reproductive stage.

new_stage

The crop may have entered a new growth stage between the current date and the previous date. "n/a" if the crop is somewhere between the previous growth stage and the next growth stage. Contains vegetative stages until the beginning of flowering is reached, after which only new reproductive stages are provided.

new_vegetative_stage

The crop may have entered a new vegetative stage between the current date and the previous date. "n/a" if the crop is somewhere between the previous vegetative stage and the next vegetative stage.

harvest_window/end

Expected end date for harvest operations.

harvest_window/start

Expected start date for harvest operations.

advisor

Suggested field properties to check.

description

Text description for a stage.

images/attribution

Credit for image.

images/caption

Image description.

images/url

Image URL.

name

Growth stage name.

order

Relative position of a stage within the growth scale.

Example Request

https://ag.us.clearapis.com/v1.0/crop_health/peanut/growth?app_id=123&app_key=321
&location=47,-97&plant_date=1462060800&days=160&variety=0

Example Response

{
    "attribution":[
        "Growth model based on...",...
    ],
    "data":{
        "47,-97":{
            "growth":{
                "2016-07-30":{
                    "agdd":1300.68,
                    "air_temp_max":81.0,
                    "air_temp_min":65.0,
                    "gdd":17.88,
                    "last_reproductive_stage":"R3",
                    "last_stage":"R3",
                    "last_vegetative_stage":"V14",
                    "new_reproductive_stage":"R5",
                    "new_stage":"R5",
                    "new_vegetative_stage":"V15"
                },...
            },
            "harvest_window":{
                "end":"n/a",
                "start":"n/a"
            }
        }
    },
    "stage_descriptions":{
        "R5":{
            "advisor":"Pest/Disease",
            "description":"Plants have at least one fully-expanded pod with seeds beginning to grow.",
            "images":[],
            "name":"R5 - First Seed",
            "order":"20"
        },...
    }
}

Potato

Potato Growth Creation - v1.0

This endpoint allows users to create a potato growth on an existing field. The user adding the potato growth must have write privileges for the field being updated.

URL Description

https://ag.us.clearapis.com/v1.0/crop_health/potato/growth/create/{field_id}?
app_id={string}&app_key={string}&account_id={string}&user_id={string}
&plant_date={timestamp}&variety={string}&max_moisture_depletion={float}
&max_moisture_refill={float}&name={string}&zone_map_id={string}

Request Parameters

Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

Your Accounts API account ID.

user_id

string

yes

User ID provided by the Accounts API. The user must have privileges to view information for the field to which the target growth is assigned.

field_id

string

yes

ID of field on which to create the growth.

plant_date, emergence_date

timestamp

yes

Epoch timestamp valid near the time that the crop was planted or the date of emergence. Please refer to the Epoch/Unix Timestamp section of the Appendix for Iteris' definition of Epoch/Unix timestamp.

variety

string

yes

Subclass of potato. Note that either variety name or ID may be provided, and will be represented only by its ID in the database. Please refer to the Variety Enumerations section of the Appendix for the listing of supported varieties.

max_moisture_refill

float

no

Desired maximum amount of refill to be provided by irrigation recommendations, expressed as percent depletion from field capacity to wilting point. The default value is 0%, indicating recommended irrigation activities will try to not exceed field capacity. Valid values range from –50% (an increase in the allowed maximum soil moisture) to 50% (a decrease in the allowed maximum soil moisture). Negative values represent refill amounts that exceed field capacity and are internally limited to the soil-specific saturation point.

max_moisture_ depletion

float

no

Desired driest state the soil is allowed to attain before an irrigation recommendation is triggered, expressed as percent depletion from field capacity to wilting point. Default values are optimized to the soil composition, crop type, and crop growth stage, with typical values of around 50%. Valid values range from 0% (indicating soil moisture should not be allowed to fall below field capacity) to 100% (soil moisture is allowed to reach the permanent wilting point, at which crop death will occur). Practical values typically range from 30 to 70%. Values are internally limited to be greater than the max_moisture_refill value.

name

string

no

Unique name to assign to the growth. Default is "potato."

zone_map_id

string

no

The target zone map id must exist for the target field. This will be a UUID. If provided and growth creation is successful, the growth will be treated as "zone aware," enabling zone management features. This property cannot be mutated after a growth has been created.

Response Object

A string representing a growth ID.

Example Request

https://ag.us.clearapis.com/v1.0/crop_health/potato/growth/create/e1b?
app_id=123&app_key=321&account_id=abc&user_id=cba&plant_date=1462060800
&variety=0

Example Response

xyz

Potato Get Growth - v1.0

This endpoint allows users to retrieve a previously created growth based on growth ID.

URL Description

https://ag.us.clearapis.com/v1.0/crop_health/potato/growth/get/{growth_id}?
app_id={string}&app_key={string}&account_id={string}&user_id={string}

Request Parameters

Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

Your Accounts API account ID.

user_id

string

yes

User ID provided by the Create User endpoint as a result of adding a new user to the user information database.

growth_id

string

yes

Specifies ID of crop growth to be queried from the user information database, provided by the Create Growth endpoint.

Response Object (JSON)

Field Description

acres

Areal size of the field in acres.

created

Epoch timestamp when the growth was created. Please refer to the Epoch/Unix Timestamp section of the Appendix for Iteris' definition of Epoch/Unix timestamp.

emergence_date

Epoch timestamp when emergence was reached. Please refer to the Epoch/Unix Timestamp section of the Appendix for Iteris' definition of Epoch/Unix timestamp.

field_id

ID of field to which crop growth data has been assigned.

field_name

Name of the field.

growth_id

ID of crop growth queried.

harvest_date

Epoch timestamp when harvest began. Please refer to the Epoch/Unix Timestamp section of the Appendix for Iteris' definition of Epoch/Unix timestamp.

irrigation_type

Represents whether or not the cropland utilizes pivot irrigation. Valid values: 0 is "false" and 1 is "true."

latitude

Latitude coordinate near the center of the field in decimal degrees. Please verify that latitude/longitude coordinates are over soil representative of your field.

longitude

Longitude coordinate near the center of the field in decimal degrees. Please verify that latitude/longitude coordinates are over soil representative of your field.

max_moisture_refill

Desired maximum amount of refill to be provided by irrigation recommendations, expressed as percent depletion from field capacity to wilting point. The default value is 0%, indicating recommended irrigation activities will try to not exceed field capacity. Valid values range from –50% (an increase in the allowed maximum soil moisture) to 50% (a decrease in the allowed maximum soil moisture). Negative values represent refill amounts that exceed field capacity and are internally limited to the soil-specific saturation point.

max_moisture_ depletion

Desired driest state the soil is allowed to attain before an irrigation recommendation is triggered, expressed as percent depletion from field capacity to wilting point. Default values are optimized to the soil composition, crop type, and crop growth stage, with typical values of around 50%. Valid values range from 0% (indicating soil moisture should not be allowed to fall below field capacity) to 100% (soil moisture is allowed to reach the permanent wilting point, at which crop death will occur). Practical values typically range from 30 to 70%. Values are internally limited to be greater than the max_moisture_refill value.

name

Name of the growth.

plant_date

Epoch timestamp when the crop was planted. Please refer to the Epoch/Unix Timestamp section of the Appendix for Iteris' definition of Epoch/Unix timestamp.

plant_name

Name of the crop plant.

plant_type

Value representing the type of crop planted. (See the Plant Enumerations section of the Appendix for a listing of plant type IDs.)

subdrainage_type

Represents whether or not the cropland utilizes drainage tile. Valid values: 0 is "false" (default) and 1 is "true."

surface_drainage_quality

Represents field drainage effectiveness. Valid values: 0 is poor, 1 is average, and 2 is good.

variety

Subclass of potato. Please refer to the Variety Enumerations section of the Appendix for the listing of supported varieties.

version

Growth model version to which feedbacks are applicable. [deprecated]

zone_map_id

Zone map ID to be used with this growth when utilizing zone management products. Value will be a UUID or null.

Example Request

https://ag.us.clearapis.com/v1.0/crop_health/potato/growth/get/bcd-def?
app_id=123&app_key=321&account_id=abc&user_id=cba

Example Response

{
    "acres":160.0,
    "created":1498069941,
    "emergence_date":null,
    "field_id":"e1b",
    "field_name":"My Field",
    "growth_id":"xyz",
    "harvest_date":null,
    "irrigation_type":0,
    "latitude":30.0,
    "longitude":-82.0,
    "max_moisture_depletion":50.0,
    "max_moisture_refill":-2.0,
    "name":"MyGrowth",
    "plant_date":1398920400,
    "plant_name":"potato",
    "plant_type":75,
    "subdrainage_type":0,
    "surface_drainage_quality":1,
    "variety":0,
    "version":"v1.0"
}

Potato Growth Modify - v1.0

This endpoint allows users to modify an existing potato growth.

URL Description

https://ag.us.clearapis.com/v1.0/crop_health/potato/growth/modify/{growth_id}?
app_id={string}&app_key={string}&account_id={string}&user_id={string}
&plant_date={timestamp}&variety={string}&max_moisture_depletion={float}
&max_moisture_refill={float}&name={string}

Request Parameters

Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

Your Accounts API account ID.

user_id

string

yes

User ID provided by the Accounts API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

yes

ID of target growth to modify.

plant_date, emergence_date

timestamp

no

Epoch timestamp valid near the time that the crop was planted or the date of emergence. Please refer to the Epoch/Unix Timestamp section of the Appendix for Iteris' definition of Epoch/Unix timestamp.

variety

string

no

Subclass of potato. Note that either variety name or ID may be provided, and will be represented only by its ID in the database. Please refer to the Variety Enumerations section of the Appendix for the listing of supported varieties.

max_moisture_refill

float

no

Desired maximum amount of refill to be provided by irrigation recommendations, expressed as percent depletion from field capacity to wilting point. The default value is 0%, indicating recommended irrigation activities will try to not exceed field capacity. Valid values range from –50% (an increase in the allowed maximum soil moisture) to 50% (a decrease in the allowed maximum soil moisture). Negative values represent refill amounts that exceed field capacity and are internally limited to the soil-specific saturation point.

max_moisture_ depletion

float

no

Desired driest state the soil is allowed to attain before an irrigation recommendation is triggered, expressed as percent depletion from field capacity to wilting point. Default values are optimized to the soil composition, crop type, and crop growth stage, with typical values of around 50%. Valid values range from 0% (indicating soil moisture should not be allowed to fall below field capacity) to 100% (soil moisture is allowed to reach the permanent wilting point, at which crop death will occur). Practical values typically range from 30 to 70%. Values are internally limited to be greater than the max_moisture_refill value.

name

string

no

Unique name to assign to the growth.

Response Object (JSON)

Returns "true" on success.

Example Request

https://ag.us.clearapis.com/v1.0/crop_health/potato/growth/modify/xyz?
app_id=123&app_key=321&account_id=abc&user_id=cba
&plant_date=1462060800

Example Response

true

Potato Growth Delete - v1.0

This endpoint allows users to delete a potato growth. By deleting a growth, any applicable growth feedback and growth whitelist items will also be deleted.

URL Description

https://ag.us.clearapis.com/v1.0/crop_health/potato/growth/delete/{growth_id}?
app_id={string}&app_key={string}&account_id={string}&user_id={string}

Request Parameters

Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

Your Accounts API account ID.

user_id

sring

yes

User ID provided by the Create User endpoint as a result of adding a new user to the user information database.

growth_id

string

yes

ID of the target growth to delete.

Response Object

Returns "true" on success.

Example Request

https://ag.us.clearapis.com/v1.0/crop_health/potato/growth/delete/xyz?
app_id=123&app_key=321&account_id=abc&user_id=cba

Example Response

true

Potato Growth - v1.0

Leveraging Iteris' potato growth stage model, the Potato Growth endpoint allows users to model the maturation and development of potato crops.

URL Description

https://ag.us.clearapis.com/v1.0/crop_health/potato/growth?app_id={string}
&app_key={string}&location={lat, lon coordinates}&plant_date={timestamp}
&days={integer}&account_id={string}&user_id={string}&growth_id={string}
&variety={string}

Request Parameters

Parameter Type Location-based Accounts API Integration Description

app_id

string

yes

yes

API ID provided by Iteris.

app_key

string

yes

yes

API key provided by Iteris.

location

lat, lon coordinates

yes

 — 

User-provided latitude and longitude coordinates in decimal degrees. Please verify that latitude/longitude coordinates are over soil representative of your field. Users are allowed a maximum of five coordinates1, formatted as "&location=[(<lat_1>,<lon_1>),(<lat_2>,<lon_2>)]."

plant_date, emergence_date

timestamp

yes

 — 

Epoch timestamp valid near the time that the crop was planted or the date of emergence. Please refer to the Epoch/Unix Timestamp section of the Appendix for Iteris' definition of Epoch/Unix timestamp.

days

integer

yes

yes

Number of days for which to calculate results. Possible values range from 1 to 366.

variety

string

yes

 — 

Subclass of potato. Note that either variety name or ID may be provided. Please refer to the Variety Enumerations section of the Appendix for the listing of supported varieties.

account_id

string

no

yes

Your Accounts API account ID.

user_id

string

no

yes

User ID provided by the Accounts API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

no

yes

Growth ID provided by the Potato Growth Creation endpoint.

1 Additional coordinates are not counted against a client’s account.

Response Object (JSON)

Field Description

attribution

Various model attributions.

agdd

Aggregate growing degree days from plant or emergence date, including the current date.

air_temp_max

Maximum daily air temperature valid for the current date. Obtained from historical, forecast, or climatological data, depending on the timeframe.

air_temp_min

Minimum daily air temperature valid for the current date. Obtained from historical, forecast, or climatological data, depending on the timeframe.

feedback_id

If this field is present, it indicates a confirmed or observed growth stage on the current date.

gdd

Growing degree days accumulated on the current date.

last_stage

The last known growth stage.

new_stage

The crop may have entered a new growth stage between the current date and the previous date. If new_stage is n/a, the crop is somewhere between the previous growth stage and the next growth stage.

harvest_window/end

Expected end date for harvest operations.

harvest_window/start

Expected start date for harvest operations.

advisor

Suggested field properties to check.

description

Text description for a stage.

images/attribution

Credit for image.

images/caption

Image description.

images/url

Image URL.

name

Growth stage name.

order

Relative position of the stage within the growth scale.

Example Request

https://ag.us.clearapis.com/v1.0/crop_health/potato/growth?app_id=123&app_key=321
&location=47,-97&plant_date=1462060800&days=160&variety=0

Example Response

{
    "attribution":[
        "Growth model based on...",...
    ],
    "data":{
        "47,-97":{
            "growth":{
                "2016-08-29":{
                    "agdd":1906.8,
                    "air_temp_max":83.0,
                    "air_temp_min":60.0,
                    "gdd":17.9,
                    "last_stage":"3",
                    "new_stage":"4"
                },...
            },
            "harvest_window":{
                "end":"2016-09-23",
                "start":"2016-08-29"
            }
        }
    },
    "stage_descriptions":{
        "4":{
            "advisor":"Harvest",
            "description":"Plants are completely dead; potatoes are harvest ready.",
            "images":[],
            "name":"Harvest",
            "order":"4"
        },...
    }
}

Sorghum

Sorghum Growth Creation - v1.0

This endpoint allows users to create a sorghum growth on an existing field. The given user adding the sorghum growth must have write privileges for the field being updated.

URL Description

https://ag.us.clearapis.com/v1.0/crop_health/sorghum/growth/create/{field_id}?
app_id={string}&app_key={string}&account_id={string}&field_id={string}
&user_id={string}&plant_date={timestamp}&relative_maturity={string}
&min_soil_moisture_allowed={float}&max_soil_moisture_allowed={float}
&name={string}&zone_map_id={string}

Request Parameters

Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

Your Accounts API account ID.

field_id

string

yes

Specifies ID of field to be updated.

user_id

string

yes

User ID provided by and used with the Accounts API. The user must have privileges to view information for the field to which the target growth is assigned.

plant_date, emergence_date

timestamp

yes

Epoch timestamp valid near the time that the crop reached emergence. Please refer to the Epoch/Unix Timestamp section of the Appendix for Iteris' definition of Epoch/Unix timestamp.

relative_maturity

string

no

Classification indicating how early a variety matures. Valid values include "early," "medium-early," "medium," "medium-late," and "late." Crops that have an "early" relative maturity are expected to mature relatively fast, and crops having a "late" relative maturity are expected to mature relatively slowly. Default is "medium."

max_moisture_refill

float

no

Desired maximum amount of refill to be provided by irrigation recommendations, expressed as percent depletion from field capacity to wilting point. The default value is 0%, indicating recommended irrigation activities will try to not exceed field capacity. Valid values range from –50% (an increase in the allowed maximum soil moisture) to 50% (a decrease in the allowed maximum soil moisture). Negative values represent refill amounts that exceed field capacity and are internally limited to the soil-specific saturation point.

max_moisture_ depletion

float

no

Desired driest state the soil is allowed to attain before an irrigation recommendation is triggered, expressed as percent depletion from field capacity to wilting point. Default values are optimized to the soil composition, crop type, and crop growth stage, with typical values of around 50%. Valid values range from 0% (indicating soil moisture should not be allowed to fall below field capacity) to 100% (soil moisture is allowed to reach the permanent wilting point, at which crop death will occur). Practical values typically range from 30 to 70%. Values are internally limited to be greater than the max_moisture_refill value.

name

string

no

Unique name to assign to the growth. Default is "sorghum."

zone_map_id

string

no

The target zone map id must exist for the target field. This will be a UUID. If provided and growth creation is successful, the growth will be treated as "zone aware," enabling zone management features. This property cannot be mutated after a growth has been created.

Response Object

A string representing a growth ID.

Example Request

https://ag.us.clearapis.com/v1.0/crop_health/sorghum/growth/create/nmvc-9875?
app_id=456&app_key=789&account_id=123&field_id=321-abc&user_id=xyz-123
&plant_date=1462060800

Example Response

def-345

Sorghum Get Growth - v1.0

This endpoint allows a user to receive a previously created growth based on growth ID.

URL Description

https://ag.clearapis.com/v1.0/crop_health/sorghum/growth/get/{growth_id}?
app_id={string}&app_key={string}&account_id={string}
&user_id={string}

Request Parameters

Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

A unique account ID provided by your Iteris account representative.

user_id

string

yes

User ID provided by the Create User endpoint as a result of adding a new user to the user information database.

growth_id

string

yes

Specifies ID of crop growth to be queried from the user information database, provided by the Create Growth endpoint.

Response Object (JSON)

Field Description

acres

Areal size of the field in acres.

created

Epoch timestamp in seconds. Please refer to the Epoch/Unix Timestamp section of the Appendix for Iteris' definition of Epoch/Unix timestamp.

field_id

Specifies ID of field to which crop growth data has been assigned.

field_name

Name of the field.

growth_id

Specifies ID of crop growth queried.

harvest_date

An epoch timestamp in seconds for which harvest has begun. Please refer to the Epoch/Unix Timestamp section of the Appendix for Iteris' definition of Epoch/Unix timestamp.

irrigation_type

Represents whether or not the cropland utilizes pivot irrigation. Valid values: 0 is "false" and 1 is "true."

latitude

Latitude coordinate near the center of the field in decimal degrees. Please verify that latitude/longitude coordinates are over soil representative of your field.

longitude

Longitude coordinate near the center of the field in decimal degrees. Please verify that latitude/longitude coordinates are over soil representative of your field.

max_moisture_refill

Desired maximum amount of refill to be provided by irrigation recommendations, expressed as percent depletion from field capacity to wilting point. The default value is 0%, indicating recommended irrigation activities will try to not exceed field capacity. Valid values range from –50% (an increase in the allowed maximum soil moisture) to 50% (a decrease in the allowed maximum soil moisture). Negative values represent refill amounts that exceed field capacity and are internally limited to the soil-specific saturation point.

max_moisture_ depletion

Desired driest state the soil is allowed to attain before an irrigation recommendation is triggered, expressed as percent depletion from field capacity to wilting point. Default values are optimized to the soil composition, crop type, and crop growth stage, with typical values of around 50%. Valid values range from 0% (indicating soil moisture should not be allowed to fall below field capacity) to 100% (soil moisture is allowed to reach the permanent wilting point, at which crop death will occur). Practical values typically range from 30 to 70%. Values are internally limited to be greater than the max_moisture_refill value.

name

Name of the growth.

plant_date

Approximate time at which the crop was planted.

plant_name

Name of the crop plant.

plant_type

Value representing the type of crop planted. (See the Plant Enumerations section of the Appendix for a listing of plant type IDs.)

plant_subtype

Enumeration value representing plant sub-type.

relative_maturity

Classification indicating how early a variety matures. Valid values include "early," "medium-early," "medium," "medium-late," and "late." Crops that have an "early" relative maturity are expected to mature relatively fast, and crops having a "late" relative maturity are expected to mature relatively slowly. Default is "medium."

seed_variety

Additional description or notes for the seed used.

subdrainage_type

Represents whether or not the cropland utilizes drainage tile. Valid values: 0 is "false" (default) and 1 is "true."

surface_drainage_quality

Represents field drainage effectiveness. Valid values: 0 is poor, 1 is average, and 2 is good.

previous_crop

Type ID of previously planted crop.

previous_harvest_date

Epoch time which previous crop was harvested. Please refer to the Epoch/Unix Timestamp section of the Appendix for Iteris' definition of Epoch/Unix timestamp.

previous_yield

Yield of previous crop.

previous_yield_unit

Unit of measure for previous yield.

yield_goal

Yield target of current growth.

yield_goal_unit

Unit of measure for yield goal.

zone_map_id

Zone map ID to be used with this growth when utilizing zone management products. Value will be a UUID or null.

Example Request

https://ag.clearapis.com/v1.0/crop_health/sorghum/growth/get/bcd-def?
app_id=456&app_key=789&account_id=123&user_id=xyz-123

Example Response

{
    "acres":160.0,
    "created":1498069941,
    "emergence_date":null,
    "field_id":"abc-def",
    "field_name":"My field",
    "growth_id":"bcd-def",
    "harvest_date":null,
    "irrigation_type":null,
    "latitude":30.107118606567383,
    "longitude":-82.3095703125,
    "max_moisture_depletion":50.0,
    "max_moisture_refill":-2.0,
    "name":"MyGrowth",
    "plant_date":1398920400,
    "plant_name":"sorghum",
    "plant_subtype":0,
    "plant_type":70,
    "relative_maturity":"medium-early",
    "seed_variety":"",
    "subdrainage_type":0,
    "surface_drainage_quality":1,
    "version":"v1.0"
}

Sorghum Growth Modify - v1.0

This endpoint allows the user to modify an existing sorghum growth.

URL Description

https://ag.us.clearapis.com/v1.0/crop_health/sorghum/growth/modify?
app_id={string}&app_key={string}&account_id={string}&user_id={string}
&plant_date={timestamp}&growth_id={string}&relative_maturity={string}
&max_moisture_depletion={float}&max_moisture_refill={float}
&name={string}

Request Parameters

Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

Your Accounts API account ID.

user_id

string

yes

User ID provided by and used with the Accounts API. The user must have privileges to view information for the field to which the target growth is assigned.

plant_date, emergence_date

timestamp

yes

Epoch timestamp valid near the time that the crop reached emergence. Please refer to the Epoch/Unix Timestamp section of the Appendix for Iteris' definition of Epoch/Unix timestamp.

growth_id

string

yes

Growth ID provided by and used with the Accounts API. This ID is given when a growth is successfully modified on a field in the Accounts API.

relative_maturity

string

no

Classification indicating how early a variety matures. Valid values include "early," "medium-early," "medium," "medium-late," and "late." Crops that have an "early" relative maturity are expected to mature relatively fast, and crops having a "late" relative maturity are expected to mature relatively slowly. Default is "medium."

max_moisture_refill

float

no

Desired maximum amount of refill to be provided by irrigation recommendations, expressed as percent depletion from field capacity to wilting point. The default value is 0%, indicating recommended irrigation activities will try to not exceed field capacity. Valid values range from –50% (an increase in the allowed maximum soil moisture) to 50% (a decrease in the allowed maximum soil moisture). Negative values represent refill amounts that exceed field capacity and are internally limited to the soil-specific saturation point.

max_moisture_ depletion

float

no

Desired driest state the soil is allowed to attain before an irrigation recommendation is triggered, expressed as percent depletion from field capacity to wilting point. Default values are optimized to the soil composition, crop type, and crop growth stage, with typical values of around 50%. Valid values range from 0% (indicating soil moisture should not be allowed to fall below field capacity) to 100% (soil moisture is allowed to reach the permanent wilting point, at which crop death will occur). Practical values typically range from 30 to 70%. Values are internally limited to be greater than the max_moisture_refill value.

name

string

no

Unique name to assign to the growth.

Response Object (JSON)

Returns "true" on success.

Example Request

https://ag.us.clearapis.com/v1.0/crop_health/sorghum/growth/modify?
app_id=456&app_key=789&account_id=123&user_id=xyz-123
&plant_date=1462060800&growth_id=321

Example Response

true

Sorghum Growth Delete - v1.0

This endpoint allows a user to delete a sorghum growth. By deleting a growth, any applicable growth feedback and growth whitelist items will also be deleted.

URL Description

https://ag.clearapis.com/v1.0/crop_health/sorghum/growth/delete/{growth_id}?
app_id={string}&app_key={string}&account_id={string}&user_id={string}

Request Parameters

Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

growth_id

string

yes

The ID of the target growth to delete.

account_id

string

yes

A unique account ID provided by your Iteris account representative.

user_id

string

yes

User ID provided by the Create User endpoint as a result of adding a new user to the user information database.

Response Object

Returns "true" on success.

Example Request

https://ag.clearapis.com/v1.0/crop_health/sorghum/growth/delete/abc-def?
app_id=456&app_key=789&account_id=123&user_id=xyz-123

Example Response

true

Sorghum Growth - v1.0

Leveraging Iteris' sorghum growth stage model, the Sorghum Growth endpoint allows users to model the maturation and development of sorghum crops. Users may also take advantage of Accounts API integration to provide crop growth feedback and optimize model results.

URL Description

https://ag.us.clearapis.com/v1.0/crop_health/sorghum/growth?app_id={string}
&app_key={string}&location={lat, lon coordinates}&plant_date={timestamp}
&days={integer}&account_id={string}&user_id={string}&growth_id={string}
&relative_maturity={string}

Request Parameters

Parameter Type Location-based Accounts API Integration Description

app_id

string

yes

yes

API ID provided by Iteris.

app_key

string

yes

yes

API key provided by Iteris.

location

lat, lon coordinates

yes

 — 

User-provided latitude and longitude coordinates in decimal degrees. Please verify that latitude/longitude coordinates are over soil representative of your field. Users are allowed a maximum of five coordinates1, formatted as "&location=[(<lat_1>,<lon_1>),(<lat_2>,<lon_2>)]."

plant_date, emergence_date

timestamp

yes

 — 

Epoch timestamp valid near the time that the crop was planted or the date of emergence. Please refer to the Epoch/Unix Timestamp section of the Appendix for Iteris' definition of Epoch/Unix timestamp.

days

integer

yes

yes

Number of days for which to calculate results. Possible values range from 1 to 366.

relative_maturity

string

no

 — 

Classification indicating how early a variety matures. Valid values include "early," "medium-early," "medium," "medium-late," and "late." Crops that have an "early" relative maturity are expected to mature relatively fast, and crops having a "late" relative maturity are expected to mature relatively slowly. Default is "medium."

account_id

string

no

yes

Your Accounts API account ID.

user_id

string

no

yes

User ID provided by and used with the Accounts API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

no

yes

Specifies the ID given when a growth is successfully added to a field using the create growth endpoint.

1 Additional coordinates are not counted against a client’s account, but will count as additional requests in the future.

Response Object (JSON)

Field Description

attribution

Various model attributions.

agdd

Aggregate growing degree days from plant or emergence date, including the current date.

air_temp_max

Maximum daily air temperature valid for the current date. Obtained from historical, forecast, or climatological data, depending on the timeframe.

air_temp_min

Minimum daily air temperature valid for the current date. Obtained from historical, forecast, or climatological data, depending on the timeframe.

feedback_id

If this field is present, it indicates a confirmed or observed growth stage on the current date.

gdd

Growing degree days accumulated on the current date.

last_stage

The last known growth stage.

new_stage

The crop may have entered a new growth stage between the current date and the previous date. If new_stage is n/a, the crop is somewhere between the previous growth stage and the next growth stage.

harvest_window/end

Expected end date for harvest operations.

harvest_window/start

Expected start date for harvest operations.

advisor

Suggested field properties to check.

description

Text description for a stage.

images/attribution

Credit for image.

images/caption

Image description.

images/url

Image URL.

name

Growth stage name.

order

Relative position of the stage within the growth scale.

Example Request

https://ag.us.clearapis.com/v1.0/crop_health/sorghum/growth?app_id=123
&app_key=321&location=47,-97&plant_date=1462060800&days=160

Example Response

{
    "attribution":[
        "Growth model based on...",...
    ],
    "data":{
        "47,-97":{
            "growth":{
                "2016-10-15":{
                    "agdd":2757.5,
                    "air_temp_max":72.0,
                    "air_temp_min":44.0,
                    "gdd":11.0,
                    "last_stage":"11",
                    "new_stage":"12"
                },...
            },
            "harvest_window":{
                "end":"2016-11-17",
                "start":"2016-10-22"
            }
        }
    },
    "stage_descriptions":{
        "12":{
            "advisor":"Harvest",
            "description":"Grain achieves its maximum dry weight. Mature grain is identified by looking for the dark spot, the black layer, on the bottom of the kernel. Grain moisture ranges from 25 to 35%.",
            "images":[
                {
                    "attribution":"Courtesy of...",
                    "caption":"Physiological Maturity",
                    "url":".../Physiological+Maturity.png"
                },...
            ],
            "name":"Physiological Maturity",
            "order":"12"
        },...
    }
}

Sorghum Growth Add Feedback - v1.0

By providing feedback relating to the growth stage estimates, Iteris will be able to make updates and adjustments to offer its users better results in the future. The given user providing feedback must have write privileges for the field in which the field growth belongs.

Additional information related to feedback timestamp, growth feedback, and feedback stage is available in the Appendix.

URL Description

https://ag.us.clearapis.com/v1.0/crop_health/sorghum/growth/feedback/add/
{growth_id}/{timestamp}/{stage}?account_id={string}&user_id={string}
&app_id={string}&app_key={string}&start_override={boolean}

Request Parameters

Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

Your Accounts API account ID.

user_id

string

yes

User ID provided by and used with the Accounts API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

yes

Specifies the ID given when a growth is successfully added to a field using the create growth endpoint.

timestamp

integer

yes

An epoch timestamp in seconds representing the date for which the feedback applies. Please refer to the Epoch/Unix Timestamp section of the Appendix for Iteris' definition of Epoch/Unix timestamp.

stage

string

yes

Inform the system that on the given date, the plant has entered or is currently in the provided stage. Please refer to the Crop Growth Stages section of the Appendix for a listing of accepted growth stage IDs.

start_override

boolean

no

When this is included, the corrector system will treat this feedback as meaning "the crop entered this stage on this date." In the absence of this parameter, the corrector will treat this feedback as meaning "the crop was observed in this stage on this date."

Response Object

A string representing a feedback ID.

Example Request

https://ag.us.clearapis.com/v1.0/crop_health/sorghum/growth/feedback/add/
xyz/1472688000/v7.0?account_id=abc&user_id=cba
&app_id=123&app_key=321

Example Response

def-345

Sorghum Growth Feedbacks by Growth - v1.0

Returns a list of growth feedback activities associated with the target growth_id.

URL Description

https://ag.us.clearapis.com/v1.0/crop_health/sorghum/growth/feedback/
get/by_growth/{growth_id}?app_id={string}&app_key={string}&account_id={string}
&user_id={string}

Request Parameters

Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

Your Accounts API account ID.

user_id

string

yes

User ID provided by and used with the Accounts API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

yes

Specifies the ID given when a growth is successfully added to a field using the create growth endpoint.

Response Object (JSON)

Field Description

user_id

User ID provided by and used with the Accounts API.

created

Timestamp denoting when the feedback was created.

data

Information pertaining to the activity.

subtype

Enumeration value representing the specific variety of the activity. Defaults to 0.

growth_feedback_id

ID of target growth feedback.

type

Enumeration value of plant.

feedback/date

Unix timestamp denoting when the feedback happened. Please refer to the Epoch/Unix Timestamp section of the Appendix for Iteris' definition of Epoch/Unix timestamp.

feedback/stage

Stage provided as feedback.

feedback/start_ override

True denotes this feedback as meaning "the crop entered this stage on this date." False denotes this feedback as meaning "the crop was observed in this stage on this date."

Example Request

https://ag.us.clearapis.com/v1.0/crop_health/sorghum/growth/feedback/
get/by_growth/xyz?app_id=123&app_key=321&account_id=abc
&user_id=cba

Example Response

[
    {
        "user_id":"1234",
        "feedback":{
            "date":1400371200,
            "type":70,
            "stage":"R0"
        },
        "created":1446229281,
        "data":"{}",
        "subtype":"0",
        "growth_feedback_id":"1111",
        "type":70
    },...
]

Sorghum Growth Modify Feedback - v1.0

The Sorghum Growth Modify Feedback endpoint allows users to modify previously provided growth stage estimate feedback. The given user providing feedback must have write privileges for the field in which the field growth belongs. At least one modification must be provided.

URL Description

https://ag.us.clearapis.com/v1.0/crop_health/sorghum/growth/feedback/modify/
{feedback_id}?account_id={string}&user_id={string}&app_id={string}
&app_key={string}&timestamp={integer}&stage={string}

Request Parameters

Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

Your Accounts API account ID.

user_id

string

yes

User ID provided by and used with the Accounts API. The user must have privileges to view information for the field to which the target growth is assigned.

feedback_id

string

yes

A unique ID returned as a result from successfully adding feedback.

timestamp

integer

yes

An epoch timestamp in seconds representing the date for which the feedback applies. Please refer to the Epoch/Unix Timestamp section of the Appendix for Iteris’ definition of Epoch/Unix timestamp.

stage

string

yes

Inform the system that on the given date, the plant has entered or is currently in the provided stage. Please refer to the Crop Growth Stages section of the Appendix for a listing of accepted growth stage IDs.

Response Object

A string representing success ("true") or failure ("false").

Example Request

https://ag.us.clearapis.com/v1.0/crop_health/sorghum/growth/feedback/
modify/abc-123?account_id=abc&user_id=cba&app_id=123&app_key=321
&timestamp=1472688000&stage=v7.0

Example Response

true

Sorghum Growth Delete Feedback - v1.0

This endpoint allows users to delete the previously provided growth stage estimate feedback. The given user deleting feedback must have write privileges for the field in which the field growth belongs.

URL Description

https://ag.us.clearapis.com/v1.0/crop_health/sorghum/growth/feedback/
delete/{feedback_id}?account_id={string}&user_id={string}&app_id={string}
&app_key={string}

Request Parameters

Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

Your Accounts API account ID.

user_id

string

yes

User ID provided by and used with the Accounts API. The user must have privileges to view information for the field to which the target growth is assigned.

feedback_id

string

yes

A unique ID returned as a result from successfully adding feedback.

Response Object

A string representing success ("true") or failure ("false").

Example Request

https://ag.us.clearapis.com/v1.0/crop_health/sorghum/growth/
feedback/delete/abc-123?account_id=abc&user_id=cba
&app_id=123&app_key=321

Example Response

true

Soybean

Soybean Growth Creation - v1.0

This endpoint allows users to create a soybean growth on an existing field. The given user adding the soybean growth must have write privileges for the field being updated.

URL Description

https://ag.clearapis.com/v1.0/crop_health/soybean/growth/create/{field_id}?
app_id={string}&app_key={string}&account_id={string}&user_id={string}
&plant_date={timestamp}&maturity_group={string}&plant_depth={float}
&max_moisture_depletion={float}&max_moisture_refill={float}&name={string}
&zone_map_id={string}

Request Parameters

Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

Your Accounts API account ID.

user_id

string

yes

User ID provided by and used with the Accounts API. The user must have privileges to view information for the field to which the target growth is assigned.

field_id

string

yes

Specifies ID of field to be updated.

plant_date, emergence_date

timestamp

yes

Epoch timestamp valid near the time that the crop was planted or the date of emergence. Please refer to the Epoch/Unix Timestamp section of the Appendix for Iteris' definition of Epoch/Unix timestamp.

maturity_group, relative_maturity

string

no

Classification indicating how early a variety matures. Valid values fall into the following range bins: 000.0 to 000.9, 00.0 to 00.9, and 0.0 to 10.9. Multi-zero range bins indicate the earliest maturities, with values near 10.9 indicating the latest maturities. Default is 3.0. Please note that if neither relative maturity nor maturity group are specified, the default value will be stored as relative maturity; if maturity group is specified, it will be stored as relative maturity.

plant_depth

float

no

The depth (in cm) that the crop was planted. Valid values range from 0.1 to 7.5 cm. Default is 3.5.

max_moisture_refill

float

no

Desired maximum amount of refill to be provided by irrigation recommendations, expressed as percent depletion from field capacity to wilting point. The default value is 0%, indicating recommended irrigation activities will try to not exceed field capacity. Valid values range from –50% (an increase in the allowed maximum soil moisture) to 50% (a decrease in the allowed maximum soil moisture). Negative values represent refill amounts that exceed field capacity and are internally limited to the soil-specific saturation point.

max_moisture_ depletion

float

no

Desired driest state the soil is allowed to attain before an irrigation recommendation is triggered, expressed as percent depletion from field capacity to wilting point. Default values are optimized to the soil composition, crop type, and crop growth stage, with typical values of around 50%. Valid values range from 0% (indicating soil moisture should not be allowed to fall below field capacity) to 100% (soil moisture is allowed to reach the permanent wilting point, at which crop death will occur). Practical values typically range from 30 to 70%. Values are internally limited to be greater than the max_moisture_refill value.

name

string

no

Unique name to assign to the growth. Default is "soybean."

zone_map_id

string

no

The target zone map id must exist for the target field. This will be a UUID. If provided and growth creation is successful, the growth will be treated as "zone aware," enabling zone management features. This property cannot be mutated after a growth has been created.

Response Object

A string representing a growth ID.

Example Request

https://ag.clearapis.com/v1.0/crop_health/soybean/create/abc-123?
app_id=456&app_key=789&account_id=123&user_id=xyz-123
&plant_date=1393632000&maturity_group=4.0&plant_depth=4.0

Example Response

abc-def

Soybean Get Growth - v1.0

This endpoint allows a user to receive a previously created growth based on growth ID.

URL Description

https://ag.clearapis.com/v1.0/crop_health/soybean/growth/get/{growth_id}?
app_id={string}&app_key={string}&account_id={string}
&user_id={string}

Request Parameters

Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

A unique account ID provided by your Iteris account representative.

user_id

string

yes

User ID provided by the Create User endpoint as a result of adding a new user to the user information database.

growth_id

string

yes

Specifies ID of crop growth to be queried from the user information database, provided by the Create Growth endpoint.

Response Object (JSON)

Field Description

acres

Areal size of the field in acres.

created

Epoch timestamp in seconds. Please refer to the Epoch/Unix Timestamp section of the Appendix for Iteris' definition of Epoch/Unix timestamp.

field_id

Specifies ID of field to which crop growth data has been assigned.

field_name

Name of the field.

growth_id

Specifies ID of crop growth queried.

harvest_date

An epoch timestamp in seconds for which harvest has begun. Please refer to the Epoch/Unix Timestamp section of the Appendix for Iteris' definition of Epoch/Unix timestamp.

irrigation_type

Represents whether or not the cropland utilizes pivot irrigation. Valid values: 0 is "false" and 1 is "true."

latitude

Latitude coordinate near the center of the field in decimal degrees. Please verify that latitude/longitude coordinates are over soil representative of your field.

longitude

Longitude coordinate near the center of the field in decimal degrees. Please verify that latitude/longitude coordinates are over soil representative of your field.

max_moisture_refill

Desired maximum amount of refill to be provided by irrigation recommendations, expressed as percent depletion from field capacity to wilting point. The default value is 0%, indicating recommended irrigation activities will try to not exceed field capacity. Valid values range from –50% (an increase in the allowed maximum soil moisture) to 50% (a decrease in the allowed maximum soil moisture). Negative values represent refill amounts that exceed field capacity and are internally limited to the soil-specific saturation point.

max_moisture_ depletion

Desired driest state the soil is allowed to attain before an irrigation recommendation is triggered, expressed as percent depletion from field capacity to wilting point. Default values are optimized to the soil composition, crop type, and crop growth stage, with typical values of around 50%. Valid values range from 0% (indicating soil moisture should not be allowed to fall below field capacity) to 100% (soil moisture is allowed to reach the permanent wilting point, at which crop death will occur). Practical values typically range from 30 to 70%. Values are internally limited to be greater than the max_moisture_refill value.

name

Name of the growth.

plant_date

Approximate time at which the crop was planted.

plant_name

Name of the crop plant.

plant_type

Value representing the type of crop planted. (See the Plant Enumerations section of the Appendix for a listing of plant type IDs.)

plant_subtype

Enumeration value representing plant sub-type.

relative_maturity

Classification indicating how early a variety matures. Valid values fall into the following range bins: 000.0 to 000.9, 00.0 to 00.9, and 0.0 to 10.9. Multi-zero range bins indicate the earliest maturities, with values near 10.9 indicating the latest maturities. Default is 3.0.

seed_variety

Additional description or notes for the seed used.

subdrainage_type

Represents whether or not the cropland utilizes drainage tile. Valid values: 0 is "false" (default) and 1 is "true."

surface_drainage_quality

Represents field drainage effectiveness. Valid values: 0 is poor, 1 is average, and 2 is good.

previous_crop

Type ID of previously planted crop.

previous_harvest_date

Epoch time which previous crop was harvested. Please refer to the Epoch/Unix Timestamp section of the Appendix for Iteris' definition of Epoch/Unix timestamp.

previous_yield

Yield of previous crop.

previous_yield_unit

Unit of measure for previous yield.

yield_goal

Yield target of current growth.

yield_goal_unit

Unit of measure for yield goal.

zone_map_id

Zone map ID to be used with this growth when utilizing zone management products. Value will be a UUID or null.

Example Request

https://ag.clearapis.com/v1.0/crop_health/soybean/growth/get/bcd-def?
app_id=456&app_key=789&account_id=123&user_id=xyz-123

Example Response

{
    "acres":160.0,
    "created":1496777654,
    "field_id":"abc-def",
    "field_name":"MyField",
    "growth_id":"bcd-def",
    "harvest_date":null,
    "irrigation_type":0,
    "latitude":47.92338180541992,
    "longitude":-97.0919189453125,
    "max_moisture_depletion":50.0,
    "max_moisture_refill":-2.0,
    "name":"MyGrowth",
    "plant_date":1398920400,
    "plant_name":"soybean",
    "plant_subtype":0,
    "plant_type":66,
    "relative_maturity":"000.6",
    "seed_variety":null,
    "subdrainage_type":0,
    "surface_drainage_quality":1
}

Soybean Growth Modify - v1.0

This endpoint allows a user to modify an existing soybean growth.

URL Description

https://ag.clearapis.com/v1.0/crop_health/soybean/growth/modify/{growth_id}?
app_id={string}&app_key={string}&account_id={string}&user_id={string}
&plant_date={timestamp}&maturity_group={string}&plant_depth={float}
&max_moisture_depletion={float}&max_moisture_refill={float}&name={string}

Request Parameters

Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

Your Accounts API account ID.

user_id

string

yes

User ID provided by and used with the Accounts API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

yes

Growth ID provided by the Soybean Growth Creation endpoint. This ID is given when a growth is successfully created on a field.

plant_date, emergence_date

timestamp

yes

Epoch timestamp valid near the time that the crop was planted or the date of emergence. Please refer to the Epoch/Unix Timestamp section of the Appendix for Iteris' definition of Epoch/Unix timestamp.

maturity_group, relative_maturity

string

no

Classification indicating how early a variety matures. Valid values fall into the following range bins: 000.0 to 000.9, 00.0 to 00.9, and 0.0 to 10.9. Multi-zero range bins indicate the earliest maturities, with values near 10.9 indicating the latest maturities. Default is 3.0. Please note that if maturity group is specified, it will be stored as relative maturity.

plant_depth

float

no

The depth (in cm) that the crop was planted. Valid values range from 0.1 to 7.5 cm. Default is 3.5.

max_moisture_refill

float

no

Desired maximum amount of refill to be provided by irrigation recommendations, expressed as percent depletion from field capacity to wilting point. The default value is 0%, indicating recommended irrigation activities will try to not exceed field capacity. Valid values range from –50% (an increase in the allowed maximum soil moisture) to 50% (a decrease in the allowed maximum soil moisture). Negative values represent refill amounts that exceed field capacity and are internally limited to the soil-specific saturation point.

max_moisture_ depletion

float

no

Desired driest state the soil is allowed to attain before an irrigation recommendation is triggered, expressed as percent depletion from field capacity to wilting point. Default values are optimized to the soil composition, crop type, and crop growth stage, with typical values of around 50%. Valid values range from 0% (indicating soil moisture should not be allowed to fall below field capacity) to 100% (soil moisture is allowed to reach the permanent wilting point, at which crop death will occur). Practical values typically range from 30 to 70%. Values are internally limited to be greater than the max_moisture_refill value.

name

string

no

Unique name to assign to the growth.

Response Object

Returns "true" on success.

Example Request

https://ag.clearapis.com/v1.0/crop_health/soybean/growth/modify/abc-123?
app_id=456&app_key=789&account_id=123&user_id=xyz-123&plant_date=1456890400
&maturity_group=3.0&plant_depth=3.5

Example Response

true

Soybean Growth Delete - v1.0

This endpoint allows a user to delete a soybean growth. By deleting a growth, any applicable growth feedback and growth whitelist items will also be deleted.

URL Description

https://ag.clearapis.com/v1.0/crop_health/soybean/growth/delete/{growth_id}?
app_id={string}&app_key={string}&account_id={string}&user_id={string}

Request Parameters

Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

growth_id

string

yes

The ID of the target growth to delete.

account_id

string

yes

A unique account ID provided by your Iteris account representative.

user_id

sring

yes

User ID provided by the Create User endpoint as a result of adding a new user to the user information database.

Response Object

Returns "true" on success.

Example Request

https://ag.clearapis.com/v1.0/crop_health/soybean/growth/delete/abc-def?
app_id=456&app_key=789&account_id=123&user_id=xyz-123

Example Response

true

Soybean Growth - v1.1

Leveraging Iteris' soybean growth stage model, the Soybean Growth endpoint allows users to model the maturation and development of soybean crops. Users may also take advantage of Accounts API integration to provide crop growth feedback and optimize model results.

URL Description

https://ag.us.clearapis.com/v1.1/crop_health/soybean/growth?app_id={string}
&app_key={string}&location={lat, lon coordinates}&plant_date={timestamp}
&days={integer}&account_id={string}&user_id={string}&growth_id={string}
&maturity_group={string}&plant_depth={float}

Request Parameters

Parameter Type Location-based Accounts API Integration Description

app_id

string

yes

yes

API ID provided by Iteris.

app_key

string

yes

yes

API key provided by Iteris.

location

lat, lon coordinates

yes

 — 

User-provided latitude and longitude coordinates in decimal degrees. Please verify that latitude/longitude coordinates are over soil representative of your field. Users are allowed a maximum of five coordinates1, formatted as "&location=[(<lat_1>,<lon_1>),(<lat_2>,<lon_2>)]."

plant_date, emergence_date

timestamp

yes

 — 

Epoch timestamp valid near the time that the crop was planted or the date of emergence. Please refer to the Epoch/Unix Timestamp section of the Appendix for Iteris' definition of Epoch/Unix timestamp.

days

integer

yes

yes

Number of days for which to calculate results. Possible values range from 1 to 366.

maturity_group

string

no

 — 

Classification indicating how early a variety matures. Valid values fall into the following range bins: 000.0 to 000.9, 00.0 to 00.9, and 0.0 to 10.9. Multi-zero range bins indicate the earliest maturities, with values near 10.9 indicating the latest maturities. Default is 3.0.

plant_depth

float

no

 — 

The depth (in cm) that the crop was planted. Valid values range from 0.1 to 7.5 cm. Default is 3.5.

account_id

string

no

yes

Your Accounts API account ID.

user_id

string

no

yes

User ID provided by and used with the Accounts API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

no

yes

Specifies the ID given when a growth is successfully added to a field using the create growth endpoint.

1 Additional coordinates are not counted against a client’s account, but will count as additional requests in the future.

Response Object (JSON)

Field Description

attribution

Various model attributions.

agdd

Aggregate growing degree days from planting or emergence date, including the current date.

air_temp_avg

Average daily air temperature in degrees Fahrenheit, which may be a historical, forecast, or climatological value, depending on the timeframe.

air_temp_max

Maximum daily air temperature in degrees Fahrenheit, which may be a historical, forecast, or climatological value, depending on the timeframe.

air_temp_min

Minimum daily air temperature in degrees Fahrenheit, which may be a historical, forecast, or climatological value, depending on the timeframe.

feedback_id

If this field is present, it indicates a confirmed or observed growth stage on the current date.

gdd

Growing degree days accumulated on the current date.

last_reproductive_stage

The last known reproductive stage.

last_stage

The last known growth stage. Contains vegetative stages until the beginning of flowering is reached, after which only new reproductive stages are provided.

last_vegetative_stage

The last known vegetative stage.

new_reproductive_stage

The crop may have entered a new reproductive stage between the current date and the previous date. "n/a" if the crop is somewhere between the previous reproductive stage and the next reproductive stage.

new_stage

The crop may have entered a new growth stage between the current date and the previous date. "n/a" if the crop is somewhere between the previous growth stage and the next growth stage. Contains vegetative stages until the beginning of flowering is reached, after which only new reproductive stages are provided.

new_vegetative_stage

The crop may have entered a new vegetative stage between the current date and the previous date. "n/a" if the crop is somewhere between the previous vegetative stage and the next vegetative stage.

relative_humidity_avg

Average daily relative humidity.

harvest_window/end

Expected end date for harvest operations.

harvest_window/start

Expected start date for harvest operations.

advisor

Suggested field properties to check.

description

Text description for a stage.

images/attribution

Credit for image.

images/caption

Image description.

images/url

Image URL.

name

Growth stage name.

order

Relative position of a stage within the growth scale.

Example Request

https://ag.us.clearapis.com/v1.1/crop_health/soybean/growth?app_id=123
&app_key=321&location=47,-97&plant_date=1462060800&days=160

Example Response

{
    "attribution":[
        "Growth model based on...",...
    ],
    "data":{
        "47,-97":{
            "growth":{
                "2016-08-20":{
                    "agdd":1656.57,
                    "air_temp_avg":61.0,
                    "air_temp_max":69.0,
                    "air_temp_min":53.0,
                    "gdd":11.31,
                    "last_reproductive_stage":"R7",
                    "last_stage":"R7",
                    "last_vegetative_stage":"V10",
                    "new_reproductive_stage":"R8",
                    "new_stage":"R8",
                    "new_vegetative_stage":"n/a",
                    "relative_humidity_avg":72.0
                },...
            },
            "harvest_window":{
                "end":"2016-09-14",
                "start":"2016-08-20"
            }
        }
    },
    "stage_descriptions":{
        "R8":{
            "advisor":"Harvest",
            "description":"Plants have at least 95 percent of pods that are brown.",
            "images":[
                {
                    "attribution":"Courtesy of...",
                    "caption":"R8 - Full maturity",
                    "url":".../R8.jpg"
                },...
            ],
            "name":"R8 - Harvest Maturity",
            "order":"21"
        },...
    }
}

Soybean Growth Add Feedback - v1.0

By providing feedback relating to the growth stage estimates, Iteris will be able to make updates and adjustments to offer its users better results in the future. The given user providing feedback must have write privileges for the field in which the field growth belongs.

Additional information related to feedback timestamp, growth feedback, and feedback stage is available in the Appendix.

URL Description

https://ag.us.clearapis.com/v1.0/crop_health/soybean/growth/feedback/add/
{growth_id}/{timestamp}/{stage}?account_id={string}&user_id={string}
&app_id={string}&app_key={string}&start_override={boolean}

Request Parameters

Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

Your Accounts API account ID.

user_id

string

yes

User ID provided by and used with the Accounts API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

yes

Specifies the ID given when a growth is successfully added to a field using the create growth endpoint.

timestamp

integer

yes

An epoch timestamp in seconds representing the date for which the feedback applies. Please refer to the Epoch/Unix Timestamp section of the Appendix for Iteris' definition of Epoch/Unix timestamp.

stage

string

yes

Inform the system that on the given date, the plant has entered or is currently in the provided stage. Please refer to the Crop Growth Stages section of the Appendix for a listing of accepted growth stage IDs.

start_override

boolean

no

When this is included, the corrector system will treat this feedback as meaning "the crop entered this stage on this date." In the absence of this parameter, the corrector will treat this feedback as meaning "the crop was observed in this stage on this date."

Response Object

A string representing a feedback ID.

Example Request

https://ag.us.clearapis.com/v1.0/crop_health/soybean/growth/feedback/add/
xyz/1472688000/R8?account_id=abc&user_id=cba
&app_id=123&app_key=321

Example Response

def-345

Soybean Growth Feedbacks by Growth - v1.0

Returns a list of growth feedback activities associated with the target growth_id.

URL Description

https://ag.us.clearapis.com/v1.0/crop_health/soybean/growth/feedback/
get/by_growth/{growth_id}?app_id={string}&app_key={string}&account_id={string}
&user_id={string}

Request Parameters

Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

Your Accounts API account ID.

user_id

string

yes

User ID provided by and used with the Accounts API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

yes

Specifies the ID given when a growth is successfully added to a field using the create growth endpoint.

Response Object (JSON)

Field Description

user_id

User ID provided by and used with the Accounts API.

created

Timestamp denoting when the feedback was created.

data

Information pertaining to the activity.

subtype

Enumeration value representing the specific variety of the activity. Defaults to 0.

growth_feedback_id

ID of target growth feedback.

type

Enumeration value of plant.

feedback/date

Unix timestamp denoting when the feedback happened. Please refer to the Epoch/Unix Timestamp section of the Appendix for Iteris' definition of Epoch/Unix timestamp.

feedback/stage

Stage provided as feedback.

feedback/start_ override

True denotes this feedback as meaning "the crop entered this stage on this date." False denotes this feedback as meaning "the crop was observed in this stage on this date."

Example Request

https://ag.us.clearapis.com/v1.0/crop_health/soybean/growth/feedback/
get/by_growth/xyz?app_id=123&app_key=321&account_id=abc
&user_id=cba

Example Response

[
    {
        "user_id":"1234",
        "feedback":{
            "date":1400371200,
            "type":66,
            "stage":"V1"
        },
        "created":1446229281,
        "data":"{}",
        "subtype":"0",
        "growth_feedback_id":"1111",
        "type":66
    },...
]

Soybean Growth Modify Feedback - v1.0

The Soybean Growth Modify Feedback endpoint allows users to modify previously provided growth stage estimate feedback. The given user providing feedback must have write privileges for the field in which the field growth belongs. At least one modification must be provided.

URL Description

https://ag.us.clearapis.com/v1.0/crop_health/soybean/growth/feedback/modify/
{feedback_id}?account_id={string}&user_id={string}&app_id={string}
&app_key={string}&timestamp={integer}&stage={string}

Request Parameters

Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

Your Accounts API account ID.

user_id

string

yes

User ID provided by and used with the Accounts API. The user must have privileges to view information for the field to which the target growth is assigned.

feedback_id

string

yes

A unique ID returned as a result from successfully adding feedback.

timestamp

integer

yes

An epoch timestamp in seconds representing the date for which the feedback applies. Please refer to the Epoch/Unix Timestamp section of the Appendix for Iteris’ definition of Epoch/Unix timestamp.

stage

string

yes

Inform the system that on the given date, the plant has entered or is currently in the provided stage. Please refer to the Crop Growth Stages section of the Appendix for a listing of accepted growth stage IDs.

Response Object

A string representing success ("true") or failure ("false").

Example Request

https://ag.us.clearapis.com/v1.0/crop_health/soybean/growth/feedback/
modify/abc-123?account_id=abc&user_id=cba&app_id=123&app_key=321
&timestamp=1472688000&stage=R8

Example Response

true

Soybean Growth Delete Feedback - v1.0

This endpoint allows users to delete the previously provided growth stage estimate feedback. The given user deleting feedback must have write privileges for the field in which the field growth belongs.

URL Description

https://ag.us.clearapis.com/v1.0/crop_health/soybean/growth/feedback/
delete/{feedback_id}?account_id={string}&user_id={string}&app_id={string}
&app_key={string}

Request Parameters

Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

Your Accounts API account ID.

user_id

string

yes

User ID provided by and used with the Accounts API. The user must have privileges to view information for the field to which the target growth is assigned.

feedback_id

string

yes

A unique ID returned as a result from successfully adding feedback.

Response Object

A string representing success ("true") or failure ("false").

Example Request

https://ag.us.clearapis.com/v1.0/crop_health/soybean/growth/
feedback/delete/abc-123?account_id=abc&user_id=cba
&app_id=123&app_key=321

Example Response

true

Soybean Growth with GDD Envelope - v1.1

The Soybean Growth with GDD Envelope service provides soybean growth information in addition to GDD envelope data. GDD envelope calculation begins from either the current day, or the planted/emergence date, whichever is further in the future. The envelope is constructed by compiling the previous 10 years of weather data, and simulating the maximum and minimum GDD that would have accumulated within those 10 years for each date. The calculated minimum and maximum values are then added to the current start of calculation date AGDD going onwards to show range of possibilities.

URL Description

https://ag.us.clearapis.com/v1.1/crop_health/soybean/growth/
gdd_envelope?app_id={string}&app_key={string}&plant_date={timestamp}
&location={lat, lon coordinates}&days={integer}&account_id={string}
&user_id={string}&growth_id={string}
&maturity_group={string}&plant_depth={float}

Request Parameters

Parameter Type Location-based Accounts API Integration Description

app_id

string

yes

yes

API ID provided by Iteris.

app_key

string

yes

yes

API key provided by Iteris.

location

lat, lon coordinates

yes

 — 

User-provided latitude and longitude coordinates in decimal degrees. Please verify that latitude/longitude coordinates are over soil representative of your field. Users are allowed a maximum of five coordinates1, formatted as "&location=[(<lat_1>,<lon_1>),(<lat_2>,<lon_2>)]."

plant_date, emergence_date

timestamp

yes

 — 

Epoch timestamp valid near the time that the crop was planted or the date of emergence. Please refer to the Epoch/Unix Timestamp section of the Appendix for Iteris' definition of Epoch/Unix timestamp.

days

integer

yes

yes

Number of days for which to calculate results. Possible values range from 1 to 366.

maturity_group

string

no

 — 

Classification indicating how early a variety matures. Valid values fall into the following range bins: 000.0 to 000.9, 00.0 to 00.9, and 0.0 to 10.9. Multi-zero range bins indicate the earliest maturities, with values near 10.9 indicating the latest maturities. Default is 3.0.

plant_depth

float

no

 — 

The depth (in cm) that the crop was planted. Valid values range from 0.1 to 7.5 cm. Default is 3.5.

account_id

string

no

yes

Your Accounts API account ID.

user_id

string

no

yes

User ID provided by and used with the Accounts API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

no

yes

Specifies the ID given when a growth is successfully added to a field using the create growth endpoint.

1 Additional coordinates are not counted against a client’s account, but will count as additional requests in the future.

Response Object (JSON)

Field Description

attribution

Various model attributions.

agdd

Aggregate growing degree days from planting or emergence date, including the current date.

agdd_envelope_max

Maximum observed AGDD of the past 10 years.

agdd_envelope_max_year

Year that the maximum AGDD value was observed.

agdd_envelope_min

Minimum observed AGDD of the past 10 years.

agdd_envelope_min_year

Year that the maximum AGDD value was observed.

air_temp_avg

Average daily air temperature in degrees Fahrenheit, which may be a historical, forecast, or climatological value, depending on the timeframe.

air_temp_max

Maximum daily air temperature in degrees Fahrenheit, which may be a historical, forecast, or climatological value, depending on the timeframe.

air_temp_min

Minimum daily air temperature in degrees Fahrenheit, which may be a historical, forecast, or climatological value, depending on the timeframe.

feedback_id

If this field is present, it indicates a confirmed or observed growth stage on the current date.

gdd

Growing degree days accumulated on the current date.

last_reproductive_stage

The last known reproductive stage.

last_stage

The last known growth stage. Contains vegetative stages until the beginning of flowering is reached, after which only new reproductive stages are provided.

last_vegetative_stage

The last known vegetative stage.

new_reproductive_stage

The crop may have entered a new reproductive stage between the current date and the previous date. "n/a" if the crop is somewhere between the previous reproductive stage and the next reproductive stage.

new_stage

The crop may have entered a new growth stage between the current date and the previous date. "n/a" if the crop is somewhere between the previous growth stage and the next growth stage. Contains vegetative stages until the beginning of flowering is reached, after which only new reproductive stages are provided.

new_vegetative_stage

The crop may have entered a new vegetative stage between the current date and the previous date. "n/a" if the crop is somewhere between the previous vegetative stage and the next vegetative stage.

relative_humidity_avg

Average daily relative humidity.

harvest_window/end

Expected end date for harvest operations.

harvest_window/start

Expected start date for harvest operations.

advisor

Suggested field properties to check.

description

Text description for a stage.

images/attribution

Credit for image.

images/caption

Image description.

images/url

Image URL.

name

Growth stage name.

order

Relative position of a stage within the growth scale.

Example Request

https://ag.us.clearapis.com/v1.1/crop_health/soybean/growth/gdd_envelope?
app_id=123&app_key=321&location=47,-97&plant_date=1462060800&days=160

Example Response

{
    "attribution":[
        "Growth model based on...",...
    ],
    "data":{
        "47,-97":{
            "growth":{
                "2016-08-20":{
                    "agdd":1656.57,
                    "agdd_envelope_max":1750.0,
                    "agdd_envelope_max_year":"2015",
                    "agdd_envelope_min":1550.0,
                    "agdd_envelope_min_year":"2013",
                    "air_temp_avg":61.0,
                    "air_temp_max":69.0,
                    "air_temp_min":53.0,
                    "gdd":11.31,
                    "last_reproductive_stage":"R7",
                    "last_stage":"R7",
                    "last_vegetative_stage":"V10",
                    "new_reproductive_stage":"R8",
                    "new_stage":"R8",
                    "new_vegetative_stage":"n/a",
                    "relative_humidity_avg":72.0
                },...
            },
            "harvest_window":{
                "end":"2016-09-14",
                "start":"2016-08-20"
            }
        }
    },
    "stage_descriptions":{
        "R8":{
            "advisor":"Harvest",
            "description":"Plants have at least 95 percent of pods that are brown.",
            "images":[
                {
                    "attribution":"Courtesy of...",
                    "caption":"R8 - Full maturity",
                    "url":".../R8.jpg"
                },...
            ],
            "name":"R8 - Harvest Maturity",
            "order":"21"
        },...
    }
}

Spring Wheat

Spring Wheat Growth Creation - v1.0

This endpoint allows users to create a spring wheat growth on an existing field. The given user adding the spring wheat growth must have write privileges for the field being updated.

URL Description

https://ag.clearapis.com/v1.0/crop_health/springwheat/growth/create/{field_id}?
app_id={string}&app_key={string}&account_id={string}&user_id={string}
&plant_date={timestamp}&relative_maturity={string}&max_moisture_depletion={float}
&max_moisture_refill={float}&name={string}&zone_map_id={string}

Request Parameters

Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

Your Accounts API account ID.

field_id

string

yes

Specifies ID of field to be updated.

user_id

string

yes

User ID provided by and used with the Accounts API. The user must have privileges to view information for the field to which the target growth is assigned.

plant_date, emergence_date

timestamp

yes

Epoch timestamp valid near the time that the crop reached emergence. Please refer to the Epoch/Unix Timestamp section of the Appendix for Iteris' definition of Epoch/Unix timestamp.

relative_maturity

string

no

Classification indicating how early a variety matures. Valid values include "early," "medium-early," "medium," "medium-late," and "late." Crops that have an "early" relative maturity are expected to mature relatively fast, and crops having a "late" relative maturity are expected to mature relatively slowly. Default is "medium."

max_moisture_refill

float

no

Desired maximum amount of refill to be provided by irrigation recommendations, expressed as percent depletion from field capacity to wilting point. The default value is 0%, indicating recommended irrigation activities will try to not exceed field capacity. Valid values range from –50% (an increase in the allowed maximum soil moisture) to 50% (a decrease in the allowed maximum soil moisture). Negative values represent refill amounts that exceed field capacity and are internally limited to the soil-specific saturation point.

max_moisture_ depletion

float

no

Desired driest state the soil is allowed to attain before an irrigation recommendation is triggered, expressed as percent depletion from field capacity to wilting point. Default values are optimized to the soil composition, crop type, and crop growth stage, with typical values of around 50%. Valid values range from 0% (indicating soil moisture should not be allowed to fall below field capacity) to 100% (soil moisture is allowed to reach the permanent wilting point, at which crop death will occur). Practical values typically range from 30 to 70%. Values are internally limited to be greater than the max_moisture_refill value.

name

string

no

Unique name to assign to the growth. Default is "spring wheat."

zone_map_id

string

no

The target zone map id must exist for the target field. This will be a UUID. If provided and growth creation is successful, the growth will be treated as "zone aware," enabling zone management features. This property cannot be mutated after a growth has been created.

Response Object

A string representing a growth ID.

Example Request

https://ag.clearapis.com/v1.0/crop_health/springwheat/growth/create/abc-123?
app_id=456&app_key=789&account_id=123&user_id=xyz-123
&plant_date=1393632000&relative_maturity=early

Example Response

abc-def

Spring Wheat Get Growth - v1.0

This endpoint allows a user to receive a previously created growth based on growth ID.

URL Description

https://ag.clearapis.com/v1.0/crop_health/springwheat/growth/get/{growth_id}?
app_id={string}&app_key={string}&account_id={string}
&user_id={string}

Request Parameters

Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

A unique account ID provided by your Iteris account representative.

user_id

string

yes

User ID provided by the Create User endpoint as a result of adding a new user to the user information database.

growth_id

string

yes

Specifies ID of crop growth to be queried from the user information database, provided by the Create Growth endpoint.

Response Object (JSON)

Field Description

acres

Areal size of the field in acres.

created

Epoch timestamp in seconds. Please refer to the Epoch/Unix Timestamp section of the Appendix for Iteris' definition of Epoch/Unix timestamp.

field_id

Specifies ID of field to which crop growth data has been assigned.

field_name

Name of the field.

growth_id

Specifies ID of crop growth queried.

harvest_date

An epoch timestamp in seconds for which harvest has begun. Please refer to the Epoch/Unix Timestamp section of the Appendix for Iteris' definition of Epoch/Unix timestamp.

irrigation_type

Represents whether or not the cropland utilizes pivot irrigation. Valid values: 0 is "false" and 1 is "true."

latitude

Latitude coordinate near the center of the field in decimal degrees. Please verify that latitude/longitude coordinates are over soil representative of your field.

longitude

Longitude coordinate near the center of the field in decimal degrees. Please verify that latitude/longitude coordinates are over soil representative of your field.

max_moisture_refill

Desired maximum amount of refill to be provided by irrigation recommendations, expressed as percent depletion from field capacity to wilting point. The default value is 0%, indicating recommended irrigation activities will try to not exceed field capacity. Valid values range from –50% (an increase in the allowed maximum soil moisture) to 50% (a decrease in the allowed maximum soil moisture). Negative values represent refill amounts that exceed field capacity and are internally limited to the soil-specific saturation point.

max_moisture_ depletion

Desired driest state the soil is allowed to attain before an irrigation recommendation is triggered, expressed as percent depletion from field capacity to wilting point. Default values are optimized to the soil composition, crop type, and crop growth stage, with typical values of around 50%. Valid values range from 0% (indicating soil moisture should not be allowed to fall below field capacity) to 100% (soil moisture is allowed to reach the permanent wilting point, at which crop death will occur). Practical values typically range from 30 to 70%. Values are internally limited to be greater than the max_moisture_refill value.

name

Name of the growth.

plant_date

Approximate time at which the crop was planted.

plant_name

Name of the crop plant.

plant_type

Value representing the type of crop planted. (See the Plant Enumerations section of the Appendix for a listing of plant type IDs.)

plant_subtype

Enumeration value representing plant sub-type.

relative_maturity

Classification indicating how early a variety matures. Valid values include "early," "medium-early," "medium," "medium-late," and "late." Crops that have an "early" relative maturity are expected to mature relatively fast, and crops having a "late" relative maturity are expected to mature relatively slowly. Default is "medium."

seed_variety

Additional description or notes for the seed used.

subdrainage_type

Represents whether or not the cropland utilizes drainage tile. Valid values: 0 is "false" (default) and 1 is "true."

surface_drainage_quality

Represents field drainage effectiveness. Valid values: 0 is poor, 1 is average, and 2 is good.

previous_crop

Type ID of previously planted crop.

previous_harvest_date

Epoch time which previous crop was harvested. Please refer to the Epoch/Unix Timestamp section of the Appendix for Iteris' definition of Epoch/Unix timestamp.

previous_yield

Yield of previous crop.

previous_yield_unit

Unit of measure for previous yield.

yield_goal

Yield target of current growth.

yield_goal_unit

Unit of measure for yield goal.

zone_map_id

Zone map ID to be used with this growth when utilizing zone management products. Value will be a UUID or null.

Example Request

https://ag.clearapis.com/v1.0/crop_health/springwheat/growth/get/bcd-def?
app_id=456&app_key=789&account_id=123&user_id=xyz-123

Example Response

{
    "acres":160.0,
    "created":1496777599,
    "field_id":"abc-def",
    "field_name":"MyField",
    "growth_id":"bcd-def",
    "harvest_date":null,
    "irrigation_type":0,
    "latitude":47.92338180541992,
    "longitude":-97.0919189453125,
    "max_moisture_depletion":50.0,
    "max_moisture_refill":-2.0,
    "name":"MyGrowth",
    "plant_date":1398920400,
    "plant_name":"spring wheat",
    "plant_subtype":0,
    "plant_type":57,
    "relative_maturity":"",
    "seed_variety":null,
    "subdrainage_type":0,
    "surface_drainage_quality":1
}

Spring Wheat Growth Modify - v1.0

This endpoint allows a user to modify an existing spring wheat growth.

URL Description

https://ag.clearapis.com/v1.0/crop_health/springwheat/growth/modify/{growth_id}?
app_id={string}&app_key={string}&account_id={string}&user_id={string}
&plant_date={timestamp}&relative_maturity={string}
&max_moisture_depletion={float}&max_moisture_refill={float}
&name={string}

Request Parameters

Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

Your Accounts API account ID.

user_id

string

yes

User ID provided by and used with the Accounts API. The user must have privileges to view information for the field to which the target growth is assigned.

plant_date, emergence_date

timestamp

yes

Epoch timestamp valid near the time that the crop reached emergence. Please refer to the Epoch/Unix Timestamp section of the Appendix for Iteris' definition of Epoch/Unix timestamp.

growth_id

string

yes

Growth ID provided by and used with the Accounts API. This ID is given when a growth is successfully modified on a field in the Accounts API.

relative_maturity

string

no

Classification indicating how early a variety matures. Valid values include "early," "medium-early," "medium," "medium-late," and "late." Crops that have an "early" relative maturity are expected to mature relatively fast, and crops having a "late" relative maturity are expected to mature relatively slowly. Default is "medium."

max_moisture_refill

float

no

Desired maximum amount of refill to be provided by irrigation recommendations, expressed as percent depletion from field capacity to wilting point. The default value is 0%, indicating recommended irrigation activities will try to not exceed field capacity. Valid values range from –50% (an increase in the allowed maximum soil moisture) to 50% (a decrease in the allowed maximum soil moisture). Negative values represent refill amounts that exceed field capacity and are internally limited to the soil-specific saturation point.

max_moisture_ depletion

float

no

Desired driest state the soil is allowed to attain before an irrigation recommendation is triggered, expressed as percent depletion from field capacity to wilting point. Default values are optimized to the soil composition, crop type, and crop growth stage, with typical values of around 50%. Valid values range from 0% (indicating soil moisture should not be allowed to fall below field capacity) to 100% (soil moisture is allowed to reach the permanent wilting point, at which crop death will occur). Practical values typically range from 30 to 70%. Values are internally limited to be greater than the max_moisture_refill value.

name

string

no

Unique name to assign to the growth.

Response Object

Returns "true" on success.

Example Request

https://ag.clearapis.com/v1.0/crop_health/springwheat/growth/modify/abc-123?
app_id=456&app_key=789&account_id=123&user_id=xyz-123&relative_maturity=medium

Example Response

true

Spring Wheat Growth Delete - v1.0

This endpoint allows a user to delete a spring wheat growth. By deleting a growth, any applicable growth feedback and growth whitelist items will also be deleted.

URL Description

https://ag.clearapis.com/v1.0/crop_health/springwheat/growth/delete/{growth_id}?
app_id={string}&app_key={string}&account_id={string}&user_id={string}

Request Parameters

Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

growth_id

string

yes

The ID of the target growth to delete.

account_id

string

yes

A unique account ID provided by your Iteris account representative.

user_id

sring

yes

User ID provided by the Create User endpoint as a result of adding a new user to the user information database.

Response Object

Returns "true" on success.

Example Request

https://ag.clearapis.com/v1.0/crop_health/springwheat/growth/delete/abc-def?
app_id=456&app_key=789&account_id=123&user_id=xyz-123

Example Response

true

Spring Wheat Growth - v1.1

Leveraging Iteris' spring wheat growth stage model, the Spring Wheat Growth endpoint allows users to model the maturation and development of spring wheat crops. Users may also take advantage of Accounts API integration to provide crop growth feedback and optimize model results.

URL Description

https://ag.us.clearapis.com/v1.1/crop_health/springwheat/growth?app_id={string}
&app_key={string}&location={lat, lon coordinates}&plant_date={timestamp}
&days={integer}&account_id={string}&user_id={string}&growth_id={string}
&relative_maturity={string}&scale={string}

Request Parameters

Parameter Type Location-based Accounts API Integration Description

app_id

string

yes

yes

API ID provided by Iteris.

app_key

string

yes

yes

API key provided by Iteris.

location

lat, lon coordinates

yes

 — 

User-provided latitude and longitude coordinates in decimal degrees. Please verify that latitude/longitude coordinates are over soil representative of your field. Users are allowed a maximum of five coordinates1, formatted as "&location=[(<lat_1>,<lon_1>),(<lat_2>,<lon_2>)]."

plant_date, emergence_date

timestamp

yes

 — 

Epoch timestamp valid near the time that the crop was planted or the date of emergence. Please refer to the Epoch/Unix Timestamp section of the Appendix for Iteris' definition of Epoch/Unix timestamp.

days

integer

yes

yes

Number of days for which to calculate results. Possible values range from 1 to 366.

relative_maturity

string

no

 — 

Classification indicating how early a variety matures. Valid values include "early," "medium-early," "medium," "medium-late," and "late." Crops that have an "early" relative maturity are expected to mature relatively fast, and crops having a "late" relative maturity are expected to mature relatively slowly. Default is "medium."

scale

string

no

no

Specifies which growth scale the response will display. Valid values include "feekes," "haun," and "zadoks." Default behavior is to utilize a unified scale and display the equivalent stages from all three scales in the response.

account_id

string

no

yes

Your Accounts API account ID.

user_id

string

no

yes

User ID provided by and used with the Accounts API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

no

yes

Specifies the ID given when a growth is successfully added to a field using the create growth endpoint.

1 Additional coordinates are not counted against a client’s account, but will count as additional requests in the future.

Response Object (JSON)

Field Description

attribution

Various model attributions.

agdd

Aggregate growing degree days from plant or emergence date, including the current date.

air_temp_max

Maximum daily air temperature valid for the current date. Obtained from historical, forecast, or climatological data, depending on the timeframe.

air_temp_min

Minimum daily air temperature valid for the current date. Obtained from historical, forecast, or climatological data, depending on the timeframe.

feedback_id

If this field is present, it indicates a confirmed or observed growth stage on the current date.

gdd

Growing degree days accumulated on the current date.

last_stage

The last known growth stage.

new_stage

The crop may have entered a new growth stage between the current date and the previous date. If new_stage is n/a, the crop is somewhere between the previous growth stage and the next growth stage.

harvest_window/end

Expected end date for harvest operations.

harvest_window/start

Expected start date for harvest operations.

advisor

Suggested field properties to check.

description

Text description for a stage.

images/attribution

Credit for image.

images/caption

Image description.

images/url

Image URL.

name

Growth stage name.

order

Relative position of the stage within the growth scale.

applicable_scales/feekes

Stage equivalent in the Feekes scale.

applicable_scales/haun

Stage equivalent in the Haun scale.

applicable_scales/zadoks

Stage equivalent in the Zadoks scale.

Example Request

https://ag.us.clearapis.com/v1.1/crop_health/springwheat/growth?app_id=123
&app_key=321&location=47,-97&plant_date=1462060800&days=160

Example Response

{
    "attribution":[
        "Growth model based on...",...
    ],
    "data":{
        "47,-97":{
            "growth":{
                "2016-07-22":{
                    "agdd":2783.0,
                    "air_temp_max":91.0,
                    "air_temp_min":64.0,
                    "gdd":45.5,
                    "last_stage":"120",
                    "new_stage":"121"
                },...
            },
            "harvest_window":{
                "end":"2016-08-25",
                "start":"2016-08-03"
            }
        }
    },
    "stage_descriptions":{
        "121":{
            "advisor":"Harvest",
            "applicable_scales":{
                "feekes":"11.3",
                "haun":"15.6",
                "zadoks":"92"
            },
            "description":"Kernels are hard, but a fingernail can still make an imprint. Plants have lost all green color.",
            "images":[],
            "name":"Physiological Maturity",
            "order":"21"
        },...
    }
}

Spring Wheat Growth Add Feedback - v1.0

By providing feedback relating to the growth stage estimates, Iteris will be able to make updates and adjustments to offer its users better results in the future. The given user providing feedback must have write privileges for the field in which the field growth belongs.

Additional information related to feedback timestamp, growth feedback, and feedback stage is available in the Appendix.

URL Description

https://ag.us.clearapis.com/v1.0/crop_health/springwheat/growth/feedback/add/
{growth_id}/{timestamp}/{stage}?account_id={string}&user_id={string}
&app_id={string}&app_key={string}&start_override={boolean}

Request Parameters

Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

Your Accounts API account ID.

user_id

string

yes

User ID provided by and used with the Accounts API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

yes

Specifies the ID given when a growth is successfully added to a field using the create growth endpoint.

timestamp

integer

yes

An epoch timestamp in seconds representing the date for which the feedback applies. Please refer to the Epoch/Unix Timestamp section of the Appendix for Iteris' definition of Epoch/Unix timestamp.

stage

string

yes

Inform the system that on the given date, the plant has entered or is currently in the provided stage. Please refer to the Crop Growth Stages section of the Appendix for a listing of accepted growth stage IDs.

start_override

boolean

no

When this is included, the corrector system will treat this feedback as meaning "the crop entered this stage on this date." In the absence of this parameter, the corrector will treat this feedback as meaning "the crop was observed in this stage on this date."

Response Object

A string representing a feedback ID.

Example Request

https://ag.us.clearapis.com/v1.0/crop_health/springwheat/growth/feedback/add/
xyz/1472688000/121?account_id=abc&user_id=cba
&app_id=123&app_key=321

Example Response

def-345

Spring Wheat Growth Feedbacks by Growth - v1.1

Returns a list of growth feedback activities associated with the target growth_id.

URL Description

https://ag.us.clearapis.com/v1.1/crop_health/springwheat/growth/feedback/
get/by_growth/{growth_id}?app_id={string}&app_key={string}&account_id={string}
&user_id={string}

Request Parameters

Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

Your Accounts API account ID.

user_id

string

yes

User ID provided by and used with the Accounts API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

yes

Specifies the ID given when a growth is successfully added to a field using the create growth endpoint.

Response Object (JSON)

Field Description

user_id

User ID provided by and used with the Accounts API.

created

Timestamp denoting when the feedback was created.

data

Information pertaining to the activity.

subtype

Enumeration value representing the specific variety of the activity. Defaults to 0.

growth_feedback_id

ID of target growth feedback.

type

Enumeration value of plant.

feedback/date

Unix timestamp denoting when the feedback happened. Please refer to the Epoch/Unix Timestamp section of the Appendix for Iteris' definition of Epoch/Unix timestamp.

feedback/stage

Stage provided as feedback.

feedback/start_ override

True denotes this feedback as meaning "the crop entered this stage on this date." False denotes this feedback as meaning "the crop was observed in this stage on this date."

Example Request

https://ag.us.clearapis.com/v1.1/crop_health/springwheat/growth/feedback/
get/by_growth/xyz?app_id=123&app_key=321&account_id=abc
&user_id=cba

Example Response

[
    {
        "user_id":"1234",
        "feedback":{
            "date":1400371200,
            "type":57,
            "stage":"101"
        },
        "created":1446229281,
        "data":"{}",
        "subtype":"0",
        "growth_feedback_id":"1111",
        "type":57
    },...
]

Spring Wheat Growth Modify Feedback - v1.0

The Spring Wheat Growth Modify Feedback endpoint allows users to modify previously provided growth stage estimate feedback. The given user providing feedback must have write privileges for the field in which the field growth belongs. At least one modification must be provided.

URL Description

https://ag.us.clearapis.com/v1.0/crop_health/springwheat/growth/feedback/modify/
{feedback_id}?account_id={string}&user_id={string}&app_id={string}
&app_key={string}&timestamp={integer}&stage={string}

Request Parameters

Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

Your Accounts API account ID.

user_id

string

yes

User ID provided by and used with the Accounts API. The user must have privileges to view information for the field to which the target growth is assigned.

feedback_id

string

yes

A unique ID returned as a result from successfully adding feedback.

timestamp

integer

yes

An epoch timestamp in seconds representing the date for which the feedback applies. Please refer to the Epoch/Unix Timestamp section of the Appendix for Iteris’ definition of Epoch/Unix timestamp.

stage

string

yes

Inform the system that on the given date, the plant has entered or is currently in the provided stage. Please refer to the Crop Growth Stages section of the Appendix for a listing of accepted growth stage IDs.

Response Object

A string representing success ("true") or failure ("false").

Example Request

https://ag.us.clearapis.com/v1.0/crop_health/springwheat/growth/feedback/
modify/abc-123?account_id=abc&user_id=cba&app_id=123&app_key=321
&timestamp=1472688000&stage=121

Example Response

true

Spring Wheat Growth Delete Feedback - v1.0

This endpoint allows users to delete the previously provided growth stage estimate feedback. The given user deleting feedback must have write privileges for the field in which the field growth belongs.

URL Description

https://ag.us.clearapis.com/v1.0/crop_health/springwheat/growth/feedback/
delete/{feedback_id}?account_id={string}&user_id={string}&app_id={string}
&app_key={string}

Request Parameters

Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

Your Accounts API account ID.

user_id

string

yes

User ID provided by and used with the Accounts API. The user must have privileges to view information for the field to which the target growth is assigned.

feedback_id

string

yes

A unique ID returned as a result from successfully adding feedback.

Response Object

A string representing success ("true") or failure ("false").

Example Request

https://ag.us.clearapis.com/v1.0/crop_health/springwheat/growth/
feedback/delete/abc-123?account_id=abc&user_id=cba
&app_id=123&app_key=321

Example Response

true

Spring Wheat Growth with GDD Envelope - v1.1

The Spring Wheat Growth with GDD Envelope service provides spring wheat growth information in addition to GDD envelope data. GDD envelope calculation begins from either the current day, or the planted/emergence date, whichever is further in the future. The envelope is constructed by compiling the previous 10 years of weather data, and simulating the maximum and minimum GDD that would have accumulated within those 10 years for each date. The calculated minimum and maximum values are then added to the current start of calculation date AGDD going onwards to show range of possibilities.

URL Description

https://ag.us.clearapis.com/v1.1/crop_health/springwheat/growth/
gdd_envelope?app_id={string}&app_key={string}&plant_date={timestamp}
&location={lat, lon coordinates}&days={integer}&account_id={string}
&user_id={string}&growth_id={string}
&relative_maturity={string}&scale={string}

Request Parameters

Parameter Type Location-based Accounts API Integration Description

app_id

string

yes

yes

API ID provided by Iteris.

app_key

string

yes

yes

API key provided by Iteris.

location

lat, lon coordinates

yes

 — 

User-provided latitude and longitude coordinates in decimal degrees. Please verify that latitude/longitude coordinates are over soil representative of your field. Users are allowed a maximum of five coordinates1, formatted as "&location=[(<lat_1>,<lon_1>),(<lat_2>,<lon_2>)]."

plant_date, emergence_date

timestamp

yes

 — 

Epoch timestamp valid near the time that the crop was planted or the date of emergence. Please refer to the Epoch/Unix Timestamp section of the Appendix for Iteris' definition of Epoch/Unix timestamp.

days

integer

yes

yes

Number of days for which to calculate results. Possible values range from 1 to 366.

relative_maturity

string

no

 — 

Classification indicating how early a variety matures. Valid values include "early," "medium-early," "medium," "medium-late," and "late." Crops that have an "early" relative maturity are expected to mature relatively fast, and crops having a "late" relative maturity are expected to mature relatively slowly. Default is "medium."

scale

string

no

no

Specifies which growth scale the response will display. Valid values include "feekes," "haun," and "zadoks." Default behavior is to utilize a unified scale and display the equivalent stages from all three scales in the response.

account_id

string

no

yes

Your Accounts API account ID.

user_id

string

no

yes

User ID provided by and used with the Accounts API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

no

yes

Specifies the ID given when a growth is successfully added to a field using the create growth endpoint.

1 Additional coordinates are not counted against a client’s account, but will count as additional requests in the future.

Response Object (JSON)

Field Description

attribution

Various model attributions.

agdd

Aggregate growing degree days from plant or emergence date, including the current date.

agdd_envelope_max

Maximum observed AGDD of the past 10 years.

agdd_envelope_max_year

Year that the maximum AGDD value was observed.

agdd_envelope_min

Minimum observed AGDD of the past 10 years.

agdd_envelope_min_year

Year that the maximum AGDD value was observed.

air_temp_max

Maximum daily air temperature valid for the current date. Obtained from historical, forecast, or climatological data, depending on the timeframe.

air_temp_min

Minimum daily air temperature valid for the current date. Obtained from historical, forecast, or climatological data, depending on the timeframe.

feedback_id

If this field is present, it indicates a confirmed or observed growth stage on the current date.

gdd

Growing degree days accumulated on the current date.

last_stage

The last known growth stage.

new_stage

The crop may have entered a new growth stage between the current date and the previous date. If new_stage is n/a, the crop is somewhere between the previous growth stage and the next growth stage.

harvest_window/end

Expected end date for harvest operations.

harvest_window/start

Expected start date for harvest operations.

advisor

Suggested field properties to check.

description

Text description for a stage.

images/attribution

Credit for image.

images/caption

Image description.

images/url

Image URL.

name

Growth stage name.

order

Relative position of the stage within the growth scale.

applicable_scales/feekes

Stage equivalent in the Feekes scale.

applicable_scales/haun

Stage equivalent in the Haun scale.

applicable_scales/zadoks

Stage equivalent in the Zadoks scale.

Example Request

https://ag.us.clearapis.com/v1.1/crop_health/springwheat/growth/gdd_envelope?
app_id=123&app_key=321&location=47,-97&plant_date=1462060800&days=160

Example Response

{
    "attribution":[
        "Growth model based on...",...
    ],
    "data":{
        "47,-97":{
            "growth":{
                "2016-07-22":{
                    "agdd":2783.0,
                    "agdd_envelope_max":2850.0,
                    "agdd_envelope_max_year":"2015",
                    "agdd_envelope_min":2550.0,
                    "agdd_envelope_min_year":"2013",
                    "air_temp_max":91.0,
                    "air_temp_min":64.0,
                    "gdd":45.5,
                    "last_stage":"120",
                    "new_stage":"121"
                },...
            },
            "harvest_window":{
                "end":"2016-08-25",
                "start":"2016-08-03"
            }
        }
    },
    "stage_descriptions":{
        "121":{
            "advisor":"Harvest",
            "applicable_scales":{
                "feekes":"11.3",
                "haun":"15.6",
                "zadoks":"92"
            },
            "description":"Kernels are hard, but a fingernail can still make an imprint. Plants have lost all green color.",
            "images":[],
            "name":"Physiological Maturity",
            "order":"21"
        },...
    }
}

Sugar Beet

Sugar Beet Growth Creation - v1.0

This endpoint allows users to create a sugar beet growth on an existing field. The given user adding the sugar beet growth must have write privileges for the field being updated.

URL Description

https://ag.clearapis.com/v1.0/crop_health/sugarbeet/growth/create/{field_id}?
app_id={string}&app_key={string}&account_id={string}&user_id={string}
&plant_date={timestamp}&name={string}&zone_map_id={string}

Request Parameters

Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

Your Accounts API account ID.

field_id

string

yes

Specifies ID of field to be updated.

user_id

string

yes

User ID provided by and used with the Accounts API. The user must have privileges to view information for the field to which the target growth is assigned.

plant_date, emergence_date

timestamp

yes

Epoch timestamp valid near the time that the crop reached emergence. Please refer to the Epoch/Unix Timestamp section of the Appendix for Iteris' definition of Epoch/Unix timestamp.

name

string

no

Unique name to assign to the growth. Default is "sugar beet."

zone_map_id

string

no

The target zone map id must exist for the target field. This will be a UUID. If provided and growth creation is successful, the growth will be treated as "zone aware," enabling zone management features. This property cannot be mutated after a growth has been created.

Response Object

A string representing a growth ID.

Example Request

https://ag.clearapis.com/v1.0/crop_health/sugarbeet/growth/create/abc-123?
app_id=456&app_key=789&account_id=123&user_id=xyz-123&plant_date=1393632000

Example Response

abc-def

Sugar Beet Get Growth - v1.0

This endpoint allows a user to receive a previously created growth based on growth ID.

URL Description

https://ag.clearapis.com/v1.0/crop_health/sugarbeet/growth/get/{growth_id}?
app_id={string}&app_key={string}&account_id={string}
&user_id={string}

Request Parameters

Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

A unique account ID provided by your Iteris account representative.

user_id

string

yes

User ID provided by the Create User endpoint as a result of adding a new user to the user information database.

growth_id

string

yes

Specifies ID of crop growth to be queried from the user information database, provided by the Create Growth endpoint.

Response Object (JSON)

Field Description

acres

Areal size of the field in acres.

created

Epoch timestamp in seconds. Please refer to the Epoch/Unix Timestamp section of the Appendix for Iteris' definition of Epoch/Unix timestamp.

emergence_date

Epoch timestamp when emergence was reached. Please refer to the Epoch/Unix Timestamp section of the Appendix for Iteris' definition of Epoch/Unix timestamp.

field_id

Specifies ID of field to which crop growth data has been assigned.

field_name

Name of the field.

growth_id

Specifies ID of crop growth queried.

harvest_date

An epoch timestamp in seconds for which harvest has begun. Please refer to the Epoch/Unix Timestamp section of the Appendix for Iteris' definition of Epoch/Unix timestamp.

irrigation_type

Represents whether or not the cropland utilizes pivot irrigation. Valid values: 0 is "false" and 1 is "true."

latitude

Latitude coordinate near the center of the field in decimal degrees. Please verify that latitude/longitude coordinates are over soil representative of your field.

longitude

Longitude coordinate near the center of the field in decimal degrees. Please verify that latitude/longitude coordinates are over soil representative of your field.

name

Name of the growth.

plant_date

Approximate time at which the crop was planted.

plant_name

Name of the crop plant.

plant_type

Value representing the type of crop planted. (See the Plant Enumerations section of the Appendix for a listing of plant type IDs.)

plant_subtype

Enumeration value representing plant sub-type.

seed_variety

Additional description or notes for the seed used.

subdrainage_type

Represents whether or not the cropland utilizes drainage tile. Valid values: 0 is "false" (default) and 1 is "true."

surface_drainage_quality

Represents field drainage effectiveness. Valid values: 0 is poor, 1 is average, and 2 is good.

version

Growth model version to which feedbacks are applicable. [deprecated]

zone_map_id

Zone map ID to be used with this growth when utilizing zone management products. Value will be a UUID or null.

Example Request

https://ag.clearapis.com/v1.0/crop_health/sugarbeet/growth/get/bcd-def?
app_id=456&app_key=789&account_id=123&user_id=xyz-123

Example Response

{
    "acres":160.0,
    "created":1496777647,
    "emergence_date":null,
    "field_id":"abc-def",
    "field_name":"MyField",
    "growth_id":"bcd-def",
    "harvest_date":null,
    "irrigation_type":0,
    "latitude":47.92338180541992,
    "longitude":-97.0919189453125,
    "name":"MyGrowth",
    "plant_date":1398920400,
    "plant_name":"sugarbeet",
    "plant_subtype":0,
    "plant_type":60,
    "seed_variety":null,
    "subdrainage_type":0,
    "surface_drainage_quality":1,
    "version":"v1.0"
}

Sugar Beet Growth Modify - v1.0

This endpoint allows a user to modify an existing sugar beet growth.

URL Description

https://ag.clearapis.com/v1.0/crop_health/sugarbeet/growth/modify/{growth_id}?
app_id={string}&app_key={string}&account_id={string}&user_id={string}
&plant_date={timestamp}&name={string}

Request Parameters

Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

Your Accounts API account ID.

user_id

string

yes

User ID provided by and used with the Accounts API. The user must have privileges to view information for the field to which the target growth is assigned.

plant_date, emergence_date

timestamp

yes

Epoch timestamp valid near the time that the crop reached emergence. Please refer to the Epoch/Unix Timestamp section of the Appendix for Iteris' definition of Epoch/Unix timestamp.

growth_id

string

yes

Growth ID provided by and used with the Accounts API. This ID is given when a growth is successfully modified on a field in the Accounts API.

name

string

no

Unique name to assign to the growth.

Response Object

Returns "true" on success.

Example Request

https://ag.clearapis.com/v1.0/crop_health/sugarbeet/growth/modify/abc-123?
app_id=456&app_key=789&account_id=123&user_id=xyz-123&plant_date=1456890400

Example Response

true

Sugar Beet Growth Delete - v1.0

The endpoint allows a user to delete a sugar beet growth. By deleting a growth, any applicable growth feedback and growth whitelist items will also be deleted.

URL Description

https://ag.clearapis.com/v1.0/crop_health/sugarbeet/growth/delete/{growth_id}?
app_id={string}&app_key={string}&account_id={string}&user_id={string}

Request Parameters

Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

growth_id

string

yes

The ID of the target growth to delete.

account_id

string

yes

A unique account ID provided by your Iteris account representative.

user_id

sring

yes

User ID provided by the Create User endpoint as a result of adding a new user to the user information database.

Response Object

Returns "true" on success.

Example Request

https://ag.clearapis.com/v1.0/crop_health/sugarbeet/growth/delete/abc-def?
app_id=456&app_key=789&account_id=123&user_id=xyz-123

Example Response

true

Sugar Beet Growth - v1.1

Leveraging Iteris' sugar beet growth stage model, the Sugar Beet Growth endpoint allows users to model the maturation and development of sugar beet crops. Users may also take advantage of Accounts API integration to provide crop growth feedback and optimize model results.

URL Description

https://ag.us.clearapis.com/v1.1/crop_health/sugarbeet/growth?app_id={string}
&app_key={string}&location={lat, lon coordinates}&plant_date={timestamp}
&days={integer}&account_id={string}&user_id={string}&growth_id={string}

Request Parameters

Parameter Type Location-based Accounts API Integration Description

app_id

string

yes

yes

API ID provided by Iteris.

app_key

string

yes

yes

API key provided by Iteris.

location

lat, lon coordinates

yes

 — 

User-provided latitude and longitude coordinates in decimal degrees. Please verify that latitude/longitude coordinates are over soil representative of your field. Users are allowed a maximum of five coordinates1, formatted as "&location=[(<lat_1>,<lon_1>),(<lat_2>,<lon_2>)]."

plant_date, emergence_date

timestamp

yes

 — 

Epoch timestamp valid near the time that the crop was planted or the date of emergence. Please refer to the Epoch/Unix Timestamp section of the Appendix for Iteris' definition of Epoch/Unix timestamp.

days

integer

yes

yes

Number of days for which to calculate results. Possible values range from 1 to 366.

account_id

string

no

yes

Your Accounts API account ID.

user_id

string

no

yes

User ID provided by and used with the Accounts API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

no

yes

Specifies the ID given when a growth is successfully added to a field using the create growth endpoint.

1 Additional coordinates are not counted against a client’s account, but will count as additional requests in the future.

Response Object (JSON)

Field Description

attribution

Various model attributions.

agdd

Aggregate growing degree days from plant or emergence date, including the current date.

air_temp_max

Maximum daily air temperature valid for the current date. Obtained from historical, forecast, or climatological data, depending on the timeframe.

air_temp_min

Minimum daily air temperature valid for the current date. Obtained from historical, forecast, or climatological data, depending on the timeframe.

feedback_id

If this field is present, it indicates a confirmed or observed growth stage on the current date.

gdd

Growing degree days accumulated on the current date.

last_stage

The last known growth stage.

new_stage

The crop may have entered a new growth stage between the current date and the previous date. If new_stage is n/a, the crop is somewhere between the previous growth stage and the next growth stage.

harvest_window/end

Expected end date for harvest operations.

harvest_window/start

Expected start date for harvest operations.

advisor

Suggested field properties to check.

description

Text description for a stage.

images/attribution

Credit for image.

images/caption

Image description.

images/url

Image URL.

name

Growth stage name.

order

Relative position of the stage within the growth scale.

Example Request

https://ag.us.clearapis.com/v1.1/crop_health/sugarbeet/growth?app_id=123
&app_key=321&location=47,-97&plant_date=1462060800&days=160

Example Response

{
    "attribution":[
        "Growth model based on...",...
    ],
    "data":{
        "47,-97":{
            "growth":{
                "2016-06-14":{
                    "agdd":1261.0,
                    "air_temp_max":70.0,
                    "air_temp_min":61.0,
                    "gdd":31.5,
                    "last_stage":"v9.0",
                    "new_stage":"v10.0"
                },...
            },
            "harvest_window":{
                "end":"n/a",
                "start":"n/a"
            },
        }
    },
    "stage_descriptions":{
        "v10.0":{
            "advisor":"Pest/Disease",
            "description":"Ten true leaves have unfolded and there is no sign of the next leaf stage.",
            "images":[],
            "name":"10 Leaves",
            "order":"10"
        },...
    }
}

Sugar Beet Growth Add Feedback - v1.0

By providing feedback relating to the growth stage estimates, Iteris will be able to make updates and adjustments to offer its users better results in the future. The given user providing feedback must have write privileges for the field in which the field growth belongs.

Additional information related to feedback timestamp, growth feedback, and feedback stage is available in the Appendix.

URL Description

https://ag.us.clearapis.com/v1.0/crop_health/sugarbeet/growth/feedback/add/
{growth_id}/{timestamp}/{stage}?account_id={string}&user_id={string}
&app_id={string}&app_key={string}&start_override={boolean}

Request Parameters

Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

Your Accounts API account ID.

user_id

string

yes

User ID provided by and used with the Accounts API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

yes

Specifies the ID given when a growth is successfully added to a field using the create growth endpoint.

timestamp

integer

yes

An epoch timestamp in seconds representing the date for which the feedback applies. Please refer to the Epoch/Unix Timestamp section of the Appendix for Iteris' definition of Epoch/Unix timestamp.

stage

string

yes

Inform the system that on the given date, the plant has entered or is currently in the provided stage. Please refer to the Crop Growth Stages section of the Appendix for a listing of accepted growth stage IDs.

start_override

boolean

no

When this is included, the corrector system will treat this feedback as meaning "the crop entered this stage on this date." In the absence of this parameter, the corrector will treat this feedback as meaning "the crop was observed in this stage on this date."

Response Object

A string representing a feedback ID.

Example Request

https://ag.us.clearapis.com/v1.0/crop_health/sugarbeet/growth/feedback/add/
xyz/1472688000/v9.0?account_id=abc&user_id=cba
&app_id=123&app_key=321

Example Response

def-345

Sugar Beet Growth Feedbacks by Growth - v1.0

Returns a list of growth feedback activities associated with the target growth_id.

URL Description

https://ag.us.clearapis.com/v1.0/crop_health/sugarbeet/growth/feedback/
get/by_growth/{growth_id}?app_id={string}&app_key={string}&account_id={string}
&user_id={string}

Request Parameters

Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

Your Accounts API account ID.

user_id

string

yes

User ID provided by and used with the Accounts API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

yes

Specifies the ID given when a growth is successfully added to a field using the create growth endpoint.

Response Object (JSON)

Field Description

user_id

User ID provided by and used with the Accounts API.

created

Timestamp denoting when the feedback was created.

data

Information pertaining to the activity.

subtype

Enumeration value representing the specific variety of the activity. Defaults to 0.

growth_feedback_id

ID of target growth feedback.

type

Enumeration value of plant.

feedback/date

Unix timestamp denoting when the feedback happened. Please refer to the Epoch/Unix Timestamp section of the Appendix for Iteris' definition of Epoch/Unix timestamp.

feedback/stage

Stage provided as feedback.

feedback/start_ override

True denotes this feedback as meaning "the crop entered this stage on this date." False denotes this feedback as meaning "the crop was observed in this stage on this date."

Example Request

https://ag.us.clearapis.com/v1.0/crop_health/sugarbeet/growth/feedback/
get/by_growth/xyz?app_id=123&app_key=321&account_id=abc
&user_id=cba

Example Response

[
    {
        "user_id":"1234",
        "feedback":{
            "date":1400371200,
            "type":60,
            "stage":"v1.0"
        },
        "created":1446229281,
        "data":"{}",
        "subtype":"0",
        "growth_feedback_id":"1111",
        "type":60
    },...
]

Sugar Beet Growth Modify Feedback - v1.0

The Sugar Beet Growth Modify Feedback endpoint allows users to modify previously provided growth stage estimate feedback. The given user providing feedback must have write privileges for the field in which the field growth belongs. At least one modification must be provided.

URL Description

https://ag.us.clearapis.com/v1.0/crop_health/sugarbeet/growth/feedback/modify/
{feedback_id}?account_id={string}&user_id={string}&app_id={string}
&app_key={string}&timestamp={integer}&stage={string}

Request Parameters

Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

Your Accounts API account ID.

user_id

string

yes

User ID provided by and used with the Accounts API. The user must have privileges to view information for the field to which the target growth is assigned.

feedback_id

string

yes

A unique ID returned as a result from successfully adding feedback.

timestamp

integer

yes

An epoch timestamp in seconds representing the date for which the feedback applies. Please refer to the Epoch/Unix Timestamp section of the Appendix for Iteris’ definition of Epoch/Unix timestamp.

stage

string

yes

Inform the system that on the given date, the plant has entered or is currently in the provided stage. Please refer to the Crop Growth Stages section of the Appendix for a listing of accepted growth stage IDs.

Response Object

A string representing success ("true") or failure ("false").

Example Request

https://ag.us.clearapis.com/v1.0/crop_health/sugarbeet/growth/feedback/
modify/abc-123?account_id=abc&user_id=cba&app_id=123&app_key=321
&timestamp=1472688000&stage=v9.0

Example Response

true

Sugar Beet Growth Delete Feedback - v1.0

This endpoint allows users to delete the previously provided growth stage estimate feedback. The given user deleting feedback must have write privileges for the field in which the field growth belongs.

URL Description

https://ag.us.clearapis.com/v1.0/crop_health/sugarbeet/growth/feedback/
delete/{feedback_id}?account_id={string}&user_id={string}&app_id={string}
&app_key={string}

Request Parameters

Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

Your Accounts API account ID.

user_id

string

yes

User ID provided by and used with the Accounts API. The user must have privileges to view information for the field to which the target growth is assigned.

feedback_id

string

yes

A unique ID returned as a result from successfully adding feedback.

Response Object

A string representing success ("true") or failure ("false").

Example Request

https://ag.us.clearapis.com/v1.0/crop_health/sugarbeet/growth/
feedback/delete/abc-123?account_id=abc&user_id=cba
&app_id=123&app_key=321

Example Response

true

Sugar Beet Growth with GDD Envelope - v1.1

The Sugar Beet Growth with GDD Envelope service provides sugar beet growth information in addition to GDD envelope data. GDD envelope calculation begins from either the current day, or the planted/emergence date, whichever is further in the future. The envelope is constructed by compiling the previous 10 years of weather data, and simulating the maximum and minimum GDD that would have accumulated within those 10 years for each date. The calculated minimum and maximum values are then added to the current start of calculation date AGDD going onwards to show range of possibilities.

URL Description

https://ag.us.clearapis.com/v1.1/crop_health/sugarbeet/growth/
gdd_envelope?app_id={string}&app_key={string}&plant_date={timestamp}
&location={lat, lon coordinates}&days={integer}&account_id={string}
&user_id={string}&growth_id={string}

Request Parameters

Parameter Type Location-based Accounts API Integration Description

app_id

string

yes

yes

API ID provided by Iteris.

app_key

string

yes

yes

API key provided by Iteris.

location

lat, lon coordinates

yes

 — 

User-provided latitude and longitude coordinates in decimal degrees. Please verify that latitude/longitude coordinates are over soil representative of your field. Users are allowed a maximum of five coordinates1, formatted as "&location=[(<lat_1>,<lon_1>),(<lat_2>,<lon_2>)]."

plant_date, emergence_date

timestamp

yes

 — 

Epoch timestamp valid near the time that the crop was planted or the date of emergence. Please refer to the Epoch/Unix Timestamp section of the Appendix for Iteris' definition of Epoch/Unix timestamp.

days

integer

yes

yes

Number of days for which to calculate results. Possible values range from 1 to 366.

account_id

string

no

yes

Your Accounts API account ID.

user_id

string

no

yes

User ID provided by and used with the Accounts API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

no

yes

Specifies the ID given when a growth is successfully added to a field using the create growth endpoint.

1 Additional coordinates are not counted against a client’s account, but will count as additional requests in the future.

Response Object (JSON)

Field Description

attribution

Various model attributions.

agdd

Aggregate growing degree days from plant or emergence date, including the current date.

agdd_envelope_max

Maximum observed AGDD of the past 10 years.

agdd_envelope_max_year

Year that the maximum AGDD value was observed.

agdd_envelope_min

Minimum observed AGDD of the past 10 years.

agdd_envelope_min_year

Year that the maximum AGDD value was observed.

air_temp_max

Maximum daily air temperature valid for the current date. Obtained from historical, forecast, or climatological data, depending on the timeframe.

air_temp_min

Minimum daily air temperature valid for the current date. Obtained from historical, forecast, or climatological data, depending on the timeframe.

feedback_id

If this field is present, it indicates a confirmed or observed growth stage on the current date.

gdd

Growing degree days accumulated on the current date.

last_stage

The last known growth stage.

new_stage

The crop may have entered a new growth stage between the current date and the previous date. If new_stage is n/a, the crop is somewhere between the previous growth stage and the next growth stage.

harvest_window/end

Expected end date for harvest operations.

harvest_window/start

Expected start date for harvest operations.

advisor

Suggested field properties to check.

description

Text description for a stage.

images/attribution

Credit for image.

images/caption

Image description.

images/url

Image URL.

name

Growth stage name.

order

Relative position of the stage within the growth scale.

Example Request

https://ag.us.clearapis.com/v1.1/crop_health/sugarbeet/growth/gdd_envelope?
app_id=123&app_key=321&location=47,-97&plant_date=1462060800&days=160

Example Response

{
    "attribution":[
        "Growth model based on...",...
    ],
    "data":{
        "47,-97":{
            "growth":{
                "2016-06-14":{
                    "agdd":1261.0,
                    "agdd_envelope_max":1450.0,
                    "agdd_envelope_max_year":"2015",
                    "agdd_envelope_min":1100.0,
                    "agdd_envelope_min_year":"2013",
                    "air_temp_max":70.0,
                    "air_temp_min":61.0,
                    "gdd":31.5,
                    "last_stage":"v9.0",
                    "new_stage":"v10.0"
                },...
            },
            "harvest_window":{
                "end":"n/a",
                "start":"n/a"
            }
        }
    },
    "stage_descriptions":{
        "v10.0":{
            "advisor":"Pest/Disease",
            "description":"Ten true leaves have unfolded and there is no sign of the next leaf stage.",
            "images":[],
            "name":"10 Leaves",
            "order":"10"
        },...
    }
}

Sunflower

Sunflower Growth Creation - v1.0

This endpoint allows users to create a sunflower growth on an existing field. The given user adding the sunflower growth must have write privileges for the field being updated.

URL Description

https://ag.us.clearapis.com/v1.0/crop_health/sunflower/growth/create/{field_id}?
app_id={string}&app_key={string}&account_id={string}&field_id={string}
&user_id={string}&plant_date={timestamp}&relative_maturity={string}
&name={string}&zone_map_id={string}

Request Parameters

Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

Your Accounts API account ID.

field_id

string

yes

Specifies ID of field to be updated.

user_id

string

yes

User ID provided by and used with the Accounts API. The user must have privileges to view information for the field to which the target growth is assigned.

plant_date, emergence_date

timestamp

yes

Epoch timestamp valid near the time that the crop reached emergence. Please refer to the Epoch/Unix Timestamp section of the Appendix for Iteris' definition of Epoch/Unix timestamp.

relative_maturity

string

no

Classification indicating how early a variety matures. Valid values include "early," "medium-early," "medium," "medium-late," and "late." Crops that have an "early" relative maturity are expected to mature relatively fast, and crops having a "late" relative maturity are expected to mature relatively slowly. Default is "medium."

name

string

no

Unique name to assign to the growth. Default is "sunflower."

zone_map_id

string

no

The target zone map id must exist for the target field. This will be a UUID. If provided and growth creation is successful, the growth will be treated as "zone aware," enabling zone management features. This property cannot be mutated after a growth has been created.

Response Object

A string representing a growth ID.

Example Request

https://ag.us.clearapis.com/v1.0/crop_health/sunflower/growth/create/avb-8987?
app_id=456&app_key=789&account_id=123&field_id=321-abc&user_id=xyz-123
&plant_date=1462060800

Example Response

def-345

Sunflower Get Growth - v1.0

This endpoint allows a user to receive a previously created growth based on growth ID.

URL Description

https://ag.clearapis.com/v1.0/crop_health/sunflower/growth/get/{growth_id}?
app_id={string}&app_key={string}&account_id={string}
&user_id={string}

Request Parameters

Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

A unique account ID provided by your Iteris account representative.

user_id

string

yes

User ID provided by and used with the Accounts API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

yes

Specifies ID of crop growth to be queried from the user information database, provided by the Create Growth endpoint.

Response Object (JSON)

Field Description

acres

Areal size of the field in acres.

created

Epoch timestamp in seconds. Please refer to the Epoch/Unix Timestamp section of the Appendix for Iteris' definition of Epoch/Unix timestamp.

field_id

Specifies ID of field to which crop growth data has been assigned.

field_name

Name of the field.

growth_id

Specifies ID of crop growth queried.

harvest_date

An epoch timestamp in seconds for which harvest has begun. Please refer to the Epoch/Unix Timestamp section of the Appendix for Iteris' definition of Epoch/Unix timestamp.

irrigation_type

Represents whether or not the cropland utilizes pivot irrigation. Valid values: 0 is "false" and 1 is "true."

latitude

Latitude coordinate near the center of the field in decimal degrees. Please verify that latitude/longitude coordinates are over soil representative of your field.

longitude

Longitude coordinate near the center of the field in decimal degrees. Please verify that latitude/longitude coordinates are over soil representative of your field.

name

Name of the growth.

plant_date

Approximate time at which the crop was planted.

plant_name

Name of the crop plant.

plant_type

Value representing the type of crop planted. (See the Plant Enumerations section of the Appendix for a listing of plant type IDs.)

plant_subtype

Enumeration value representing plant sub-type.

relative_maturity

Classification indicating how early a variety matures. Valid values include "early," "medium-early," "medium," "medium-late," and "late." Crops that have an "early" relative maturity are expected to mature relatively fast, and crops having a "late" relative maturity are expected to mature relatively slowly. Default is "medium."

seed_variety

Additional description or notes for the seed used.

subdrainage_type

Represents whether or not the cropland utilizes drainage tile. Valid values: 0 is "false" (default) and 1 is "true."

surface_drainage_quality

Represents field drainage effectiveness. Valid values: 0 is poor, 1 is average, and 2 is good.

previous_crop

Type ID of previously planted crop.

previous_harvest_date

Epoch time which previous crop was harvested. Please refer to the Epoch/Unix Timestamp section of the Appendix for Iteris' definition of Epoch/Unix timestamp.

previous_yield

Yield of previous crop.

previous_yield_unit

Unit of measure for previous yield.

yield_goal

Yield target of current growth.

yield_goal_unit

Unit of measure for yield goal.

zone_map_id

Zone map ID to be used with this growth when utilizing zone management products. Value will be a UUID or null.

Example Request

https://ag.clearapis.com/v1.0/crop_health/sunflower/growth/get/bcd-def?
app_id=456&app_key=789&account_id=123&user_id=xyz-123

Example Response

{
    "acres":160.0,
    "created":1498071470,
    "emergence_date":null,
    "field_id":"abc-def",
    "field_name":"MyField",
    "growth_id":"bcd-def",
    "harvest_date":null,
    "irrigation_type":null,
    "latitude":47.92338180541992,
    "longitude":-97.0919189453125,
    "name":"MyGrowth",
    "plant_date":1398920400,
    "plant_name":"sunflower",
    "plant_subtype":0,
    "plant_type":72,
    "relative_maturity":"medium-early",
    "seed_variety":"",
    "subdrainage_type":0,
    "surface_drainage_quality":1,
    "version":"v1.0"
}

Sunflower Growth Modify - v1.0

The endpoint allows a user to modify or update a sunflower growth.

URL Description

https://ag.clearapis.com/v1.0/crop_health/sunflower/growth/modify/{growth_id}?
app_id={string}&app_key={string}&account_id={string}&user_id={string}
&plant_date={timestamp}&emergence_date={timestamp}&harvest_date={timestamp}
&plant_subtype={integer}name={string}&seed_variety={string}
&relative_maturity={string}&name={string}

Request Parameters

Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

growth_id

string

yes

The ID of the target growth to be modified.

plant_date

timestamp

no

Epoch timestamp in seconds. Please refer to the Epoch/Unix Timestamp section of the Appendix for Iteris' definition of Epoch/Unix timestamp.

emergence_date

timestamp

no

Epoch timestamp in seconds. Please refer to the Epoch/Unix Timestamp section of the Appendix for Iteris' definition of Epoch/Unix timestamp.

harvest_date

timestamp

no

Epoch timestamp in seconds. Please refer to the Epoch/Unix Timestamp section of the Appendix for Iteris' definition of Epoch/Unix timestamp.

plant_subtype

integer

no

Coded value representing the specific variety of crop planted.

name

string

no

New name of the field.

seed_variety

string

no

Additional description or notes for the seed used.

account_id

string

yes

Your Accounts API account ID.

user_id

string

yes

User ID provided by and used with the Accounts API. The user must have privileges to view information for the field to which the target growth is assigned.

relative_maturity

string

no

Classification indicating how early a variety matures. Valid values include "early," "medium-early," "medium," "medium-late," and "late." Crops that have an "early" relative maturity are expected to mature relatively fast, and crops having a "late" relative maturity are expected to mature relatively slowly. Default is "medium."

name

string

no

Unique name to assign to the growth.

Response Object

Returns "true" on success.

Example Request

https://ag.clearapis.com/v1.0/crop_health/sunflower/growth/modify/abc-def?
app_id=456&app_key=789&account_id=123&user_id=xyz-123

Example Response

true

Sunflower Growth Delete - v1.0

The endpoint allows a user to delete a sunflower growth. By deleting a growth, any applicable growth feedback and growth whitelist items will also be deleted.

URL Description

https://ag.clearapis.com/v1.0/crop_health/sunflower/growth/delete/{growth_id}?
app_id={string}&app_key={string}&account_id={string}&user_id={string}

Request Parameters

Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

growth_id

string

yes

The ID of the target growth to delete.

account_id

string

yes

A unique account ID provided by your Iteris account representative.

user_id

sring

yes

User ID provided by and used with the Accounts API. The user must have privileges to view information for the field to which the target growth is assigned.

Response Object

Returns "true" on success.

Example Request

https://ag.clearapis.com/v1.0/crop_health/sunflower/growth/delete/abc-def?
app_id=456&app_key=789&account_id=123&user_id=xyz-123

Example Response

true

Sunflower Growth - v1.0

Leveraging Iteris' sunflower growth stage model, the Sunflower Growth endpoint allows users to model the maturation and development of sunflower crops. Users may also take advantage of Accounts API integration to provide crop growth feedback and optimize model results.

URL Description

https://ag.us.clearapis.com/v1.0/crop_health/sunflower/growth?app_id={string}
&app_key={string}&location={lat, lon coordinates}&plant_date={timestamp}
&days={integer}&account_id={string}&user_id={string}&growth_id={string}
&relative_maturity={string}

Request Parameters

Parameter Type Location-based Accounts API Integration Description

app_id

string

yes

yes

API ID provided by Iteris.

app_key

string

yes

yes

API key provided by Iteris.

location

lat, lon coordinates

yes

 — 

User-provided latitude and longitude coordinates in decimal degrees. Please verify that latitude/longitude coordinates are over soil representative of your field. Users are allowed a maximum of five coordinates1, formatted as "&location=[(<lat_1>,<lon_1>),(<lat_2>,<lon_2>)]."

plant_date, emergence_date

timestamp

yes

 — 

Epoch timestamp valid near the time that the crop was planted or the date of emergence. Please refer to the Epoch/Unix Timestamp section of the Appendix for Iteris' definition of Epoch/Unix timestamp.

days

integer

yes

yes

Number of days for which to calculate results. Possible values range from 1 to 366.

relative_maturity

string

no

 — 

Classification indicating how early a variety matures. Valid values include "early," "medium-early," "medium," "medium-late," and "late." Crops that have an "early" relative maturity are expected to mature relatively fast, and crops having a "late" relative maturity are expected to mature relatively slowly. Default is "medium."

account_id

string

no

yes

Your Accounts API account ID.

user_id

string

no

yes

User ID provided by and used with the Accounts API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

no

yes

Specifies the ID given when a growth is successfully added to a field using the create growth endpoint.

1 Additional coordinates are not counted against a client’s account, but will count as additional requests in the future.

Response Object (JSON)

Field Description

attribution

Various model attributions.

agdd

Aggregate growing degree days from plant or emergence date, including the current date.

air_temp_max

Maximum daily air temperature valid for the current date. Obtained from historical, forecast, or climatological data, depending on the timeframe.

air_temp_min

Minimum daily air temperature valid for the current date. Obtained from historical, forecast, or climatological data, depending on the timeframe.

feedback_id

If this field is present, it indicates a confirmed or observed growth stage on the current date.

gdd

Growing degree days accumulated on the current date.

last_stage

The last known growth stage.

new_stage

The crop may have entered a new growth stage between the current date and the previous date. If new_stage is n/a, the crop is somewhere between the previous growth stage and the next growth stage.

harvest_window/end

Expected end date for harvest operations.

harvest_window/start

Expected start date for harvest operations.

advisor

Suggested field properties to check.

description

Text description for a stage.

images/attribution

Credit for image.

images/caption

Image description.

images/url

Image URL.

name

Growth stage name.

order

Relative position of the stage within the growth scale.

Example Request

https://ag.us.clearapis.com/v1.0/crop_health/sunflower/growth?app_id=123
&app_key=321&location=47,-97&plant_date=1462060800&days=160

Example Response

{
    "attribution":[
        "Growth model based on...",...
    ],
    "data":{
        "47,-97":{
            "growth":{
                "2016-08-30":{
                    "agdd":2886.0,
                    "air_temp_max":81.0,
                    "air_temp_min":50.0,
                    "gdd":21.5,
                    "last_stage":"30",
                    "new_stage":"31"
                },...
            },
            "harvest_window":{
                "end":"2016-10-08",
                "start":"2016-09-13"
            }
        }
    },
    "stage_descriptions":{
        "31":{
            "advisor":"Harvest",
            "description":"The back of the head is brown; the bracts turn yellow/brown.",
            "images":[
                {
                    "attribution":"Courtesy of...",
                    "caption":"R9 stage",
                    "url":".../R9.jpg"
                },...
            ],
            "name":"R9 - Physiological Maturity",
            "order":"17"
        },...
    }
}

Sunflower Growth Add Feedback - v1.0

By providing feedback relating to the growth stage estimates, Iteris will be able to make updates and adjustments to offer its users better results in the future. The given user providing feedback must have write privileges for the field in which the field growth belongs.

Additional information related to feedback timestamp, growth feedback, and feedback stage is available in the Appendix.

URL Description

https://ag.us.clearapis.com/v1.0/crop_health/sunflower/growth/feedback/add/
{growth_id}/{timestamp}/{stage}?account_id={string}&user_id={string}
&app_id={string}&app_key={string}&start_override={boolean}

Request Parameters

Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

Your Accounts API account ID.

user_id

string

yes

User ID provided by and used with the Accounts API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

yes

Specifies the ID given when a growth is successfully added to a field using the create growth endpoint.

timestamp

integer

yes

An epoch timestamp in seconds representing the date for which the feedback applies. Please refer to the Epoch/Unix Timestamp section of the Appendix for Iteris' definition of Epoch/Unix timestamp.

stage

string

yes

Inform the system that on the given date, the plant has entered or is currently in the provided stage. Please refer to the Crop Growth Stages section of the Appendix for a listing of accepted growth stage IDs.

start_override

boolean

no

When this is included, the corrector system will treat this feedback as meaning "the crop entered this stage on this date." In the absence of this parameter, the corrector will treat this feedback as meaning "the crop was observed in this stage on this date."

Response Object

A string representing a feedback ID.

Example Request

https://ag.us.clearapis.com/v1.0/crop_health/sunflower/growth/feedback/add/
xyz/1472688000/v9.0?account_id=abc&user_id=cba
&app_id=123&app_key=321

Example Response

def-345

Sunflower Growth Feedbacks by Growth - v1.0

Returns a list of growth feedback activities associated with the target growth_id.

URL Description

https://ag.us.clearapis.com/v1.0/crop_health/sunflower/growth/feedback/
get/by_growth/{growth_id}?app_id={string}&app_key={string}&account_id={string}
&user_id={string}

Request Parameters

Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

Your Accounts API account ID.

user_id

string

yes

User ID provided by and used with the Accounts API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

yes

Specifies the ID given when a growth is successfully added to a field using the create growth endpoint.

Response Object (JSON)

Field Description

user_id

User ID provided by and used with the Accounts API.

created

Timestamp denoting when the feedback was created.

data

Information pertaining to the activity.

subtype

Enumeration value representing the specific variety of the activity. Defaults to 0.

growth_feedback_id

ID of target growth feedback.

type

Enumeration value of plant.

feedback/date

Unix timestamp denoting when the feedback happened. Please refer to the Epoch/Unix Timestamp section of the Appendix for Iteris' definition of Epoch/Unix timestamp.

feedback/stage

Stage provided as feedback.

feedback/start_ override

True denotes this feedback as meaning "the crop entered this stage on this date." False denotes this feedback as meaning "the crop was observed in this stage on this date."

Example Request

https://ag.us.clearapis.com/v1.0/crop_health/sunflower/growth/feedback/
get/by_growth/xyz?app_id=123&app_key=321&account_id=abc
&user_id=cba

Example Response

[
    {
        "user_id":"1234",
        "feedback":{
            "date":1400371200,
            "type":72,
            "stage":"1"
        },
        "created":1446229281,
        "data":"{}",
        "subtype":"0",
        "growth_feedback_id":"1111",
        "type":72
    },...
]

Sunflower Growth Modify Feedback - v1.0

The Sunflower Growth Modify Feedback endpoint allows users to modify previously provided growth stage estimate feedback. The given user providing feedback must have write privileges for the field in which the field growth belongs. At least one modification must be provided.

URL Description

https://ag.us.clearapis.com/v1.0/crop_health/sunflower/growth/feedback/modify/
{feedback_id}?account_id={string}&user_id={string}&app_id={string}
&app_key={string}&timestamp={integer}&stage={string}
Request Parameters
Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

Your Accounts API account ID.

user_id

string

yes

User ID provided by and used with the Accounts API. The user must have privileges to view information for the field to which the target growth is assigned.

feedback_id

string

yes

A unique ID returned as a result from successfully adding feedback.

timestamp

integer

yes

An epoch timestamp in seconds representing the date for which the feedback applies. Please refer to the Epoch/Unix Timestamp section of the Appendix for Iteris’ definition of Epoch/Unix timestamp.

stage

string

yes

Inform the system that on the given date, the plant has entered or is currently in the provided stage. Please refer to the Crop Growth Stages section of the Appendix for a listing of accepted growth stage IDs.

Response Object

A string representing success ("true") or failure ("false").

Example Request

https://ag.us.clearapis.com/v1.0/crop_health/sunflower/growth/feedback/
modify/abc-123?account_id=abc&user_id=cba&app_id=123&app_key=321
&timestamp=1472688000&stage=v9.0

Example Response

true

Sunflower Growth Delete Feedback - v1.0

This endpoint allows users to delete the previously provided growth stage estimate feedback. The given user deleting feedback must have write privileges for the field in which the field growth belongs.

URL Description

https://ag.us.clearapis.com/v1.0/crop_health/sunflower/growth/feedback/
delete/{feedback_id}?account_id={string}&user_id={string}&app_id={string}
&app_key={string}

Request Parameters

Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

Your Accounts API account ID.

user_id

string

yes

User ID provided by and used with the Accounts API. The user must have privileges to view information for the field to which the target growth is assigned.

feedback_id

string

yes

A unique ID returned as a result from successfully adding feedback.

Response Object

A string representing success ("true") or failure ("false").

Example Request

https://ag.us.clearapis.com/v1.0/crop_health/sunflower/growth/
feedback/delete/abc-123?account_id=abc&user_id=cba
&app_id=123&app_key=321

Example Response

true

Winter Wheat

Winter Wheat Growth Creation - v1.0

This endpoint allows users to create a winter wheat growth on an existing field. The given user adding the winter wheat growth must have write privileges for the field being updated.

URL Description

https://ag.clearapis.com/v1.0/crop_health/winter_wheat/growth/create/{field_id}?
app_id={string}&app_key={string}&account_id={string}&user_id={string}
&plant_date={timestamp}&relative_maturity={string}&plant_depth={float}
&max_moisture_depletion={float}&max_moisture_refill={float}&name={string}
&zone_map_id={string}

Request Parameters

Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

Your Accounts API account ID.

field_id

string

yes

Specifies ID of field to be updated.

user_id

string

yes

User ID provided by and used with the Accounts API. The user must have privileges to view information for the field to which the target growth is assigned.

plant_date, emergence_date

timestamp

yes

Epoch timestamp valid near the time that the crop reached emergence. Please refer to the Epoch/Unix Timestamp section of the Appendix for Iteris' definition of Epoch/Unix timestamp.

relative_maturity

string

no

Classification indicating how early a variety matures. Valid values include "early," "medium-early," "medium," "medium-late," and "late." Crops that have an "early" relative maturity are expected to mature relatively fast, and crops having a "late" relative maturity are expected to mature relatively slowly. Default is "medium."

plant_depth

float

no

The depth in centimeters that the crop was planted. Plant depth must be a float between 0.1 and 10.0 cm. If no value is provided, the default plant depth is 5.

max_moisture_refill

float

no

Desired maximum amount of refill to be provided by irrigation recommendations, expressed as percent depletion from field capacity to wilting point. The default value is 0%, indicating recommended irrigation activities will try to not exceed field capacity. Valid values range from –50% (an increase in the allowed maximum soil moisture) to 50% (a decrease in the allowed maximum soil moisture). Negative values represent refill amounts that exceed field capacity and are internally limited to the soil-specific saturation point.

max_moisture_ depletion

float

no

Desired driest state the soil is allowed to attain before an irrigation recommendation is triggered, expressed as percent depletion from field capacity to wilting point. Default values are optimized to the soil composition, crop type, and crop growth stage, with typical values of around 50%. Valid values range from 0% (indicating soil moisture should not be allowed to fall below field capacity) to 100% (soil moisture is allowed to reach the permanent wilting point, at which crop death will occur). Practical values typically range from 30 to 70%. Values are internally limited to be greater than the max_moisture_refill value.

name

string

no

Unique name to assign to the growth. Default is "winter wheat."

zone_map_id

string

no

The target zone map id must exist for the target field. This will be a UUID. If provided and growth creation is successful, the growth will be treated as "zone aware," enabling zone management features. This property cannot be mutated after a growth has been created.

Response Object

A string representing a growth ID.

Example Request

https://ag.clearapis.com/v1.0/crop_health/winter_wheat/create/abc-123?
app_id=456&app_key=789&account_id=123&user_id=xyz-123
&plant_date=1393632000&relative_maturity=early&plant_depth=4.0

Example Response

abc-def

Winter Wheat Get Growth - v1.0

This endpoint allows a user to receive a previously created growth based on growth ID.

URL Description

https://ag.clearapis.com/v1.0/crop_health/winter_wheat/growth/get/{growth_id}?
app_id={string}&app_key={string}&account_id={string}
&user_id={string}

Request Parameters

Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

A unique account ID provided by your Iteris account representative.

user_id

string

yes

User ID provided by the Create User endpoint as a result of adding a new user to the user information database.

growth_id

string

yes

Specifies ID of crop growth to be queried from the user information database, provided by the Create Growth endpoint.

Response Object (JSON)

Field Description

acres

Areal size of the field in acres.

created

Epoch timestamp in seconds. Please refer to the Epoch/Unix Timestamp section of the Appendix for Iteris' definition of Epoch/Unix timestamp.

field_id

Specifies ID of field to which crop growth data has been assigned.

field_name

Name of the field.

growth_id

Specifies ID of crop growth queried.

harvest_date

An epoch timestamp in seconds for which harvest has begun. Please refer to the Epoch/Unix Timestamp section of the Appendix for Iteris' definition of Epoch/Unix timestamp.

irrigation_type

Represents whether or not the cropland utilizes pivot irrigation. Valid values: 0 is "false" and 1 is "true."

latitude

Latitude coordinate near the center of the field in decimal degrees. Please verify that latitude/longitude coordinates are over soil representative of your field.

longitude

Longitude coordinate near the center of the field in decimal degrees. Please verify that latitude/longitude coordinates are over soil representative of your field.

max_moisture_refill

Desired maximum amount of refill to be provided by irrigation recommendations, expressed as percent depletion from field capacity to wilting point. The default value is 0%, indicating recommended irrigation activities will try to not exceed field capacity. Valid values range from –50% (an increase in the allowed maximum soil moisture) to 50% (a decrease in the allowed maximum soil moisture). Negative values represent refill amounts that exceed field capacity and are internally limited to the soil-specific saturation point.

max_moisture_ depletion

Desired driest state the soil is allowed to attain before an irrigation recommendation is triggered, expressed as percent depletion from field capacity to wilting point. Default values are optimized to the soil composition, crop type, and crop growth stage, with typical values of around 50%. Valid values range from 0% (indicating soil moisture should not be allowed to fall below field capacity) to 100% (soil moisture is allowed to reach the permanent wilting point, at which crop death will occur). Practical values typically range from 30 to 70%. Values are internally limited to be greater than the max_moisture_refill value.

name

Name of the growth.

plant_date

Approximate time at which the crop was planted.

plant_name

Name of the crop plant.

plant_type

Value representing the type of crop planted. (See the Plant Enumerations section of the Appendix for a listing of plant type IDs.)

plant_subtype

Enumeration value representing plant sub-type.

relative_maturity

Classification indicating how early a variety matures. Valid values include "early," "medium-early," "medium," "medium-late," and "late." Crops that have an "early" relative maturity are expected to mature relatively fast, and crops having a "late" relative maturity are expected to mature relatively slowly. Default is "medium."

seed_variety

Additional description or notes for the seed used.

subdrainage_type

Represents whether or not the cropland utilizes drainage tile. Valid values: 0 is "false" (default) and 1 is "true."

surface_drainage_quality

Represents field drainage effectiveness. Valid values: 0 is poor, 1 is average, and 2 is good.

previous_crop

Type ID of previously planted crop.

previous_harvest_date

Epoch time which previous crop was harvested. Please refer to the Epoch/Unix Timestamp section of the Appendix for Iteris' definition of Epoch/Unix timestamp.

previous_yield

Yield of previous crop.

previous_yield_unit

Unit of measure for previous yield.

yield_goal

Yield target of current growth.

yield_goal_unit

Unit of measure for yield goal.

zone_map_id

Zone map ID to be used with this growth when utilizing zone management products. Value will be a UUID or null.

Example Request

https://ag.clearapis.com/v1.0/crop_health/winter_wheat/growth/get/bcd-def?
app_id=456&app_key=789&account_id=123&user_id=xyz-123

Example Response

{
    "acres":160.0,
    "created":1496777689,
    "field_id":"abc-def",
    "field_name":"MyField",
    "growth_id":"bcd-def",
    "harvest_date":null,
    "irrigation_type":0,
    "latitude":47.92338180541992,
    "longitude":-97.0919189453125,
    "max_moisture_depletion":50.0,
    "max_moisture_refill":-2.0,
    "name":"MyGrowth",
    "plant_date":1410757200,
    "plant_name":"winter wheat",
    "plant_subtype":0,
    "plant_type":68,
    "relative_maturity":"",
    "seed_variety":null,
    "subdrainage_type":0,
    "surface_drainage_quality":1
}

Winter Wheat Growth Modify - v1.0

This endpoint allows a user to modify an existing winter wheat growth.

URL Description

https://ag.clearapis.com/v1.0/crop_health/winter_wheat/modify/{growth_id}?
app_id={string}&app_key={string}&account_id={string}&user_id={string}
&plant_date={timestamp}&relative_maturity={string}&plant_depth={float}
&max_moisture_depletion={float}&max_moisture_refill={float}&name={string}

Request Parameters

Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

Your Accounts API account ID.

user_id

string

yes

User ID provided by and used with the Accounts API. The user must have privileges to view information for the field to which the target growth is assigned.

plant_date, emergence_date

timestamp

yes

Epoch timestamp valid near the time that the crop reached emergence. Please refer to the Epoch/Unix Timestamp section of the Appendix for Iteris' definition of Epoch/Unix timestamp.

growth_id

string

yes

Growth ID provided by and used with the Accounts API. This ID is given when a growth is successfully modified on a field in the Accounts API.

relative_maturity

string

no

Classification indicating how early a variety matures. Valid values include "early," "medium-early," "medium," "medium-late," and "late." Crops that have an "early" relative maturity are expected to mature relatively fast, and crops having a "late" relative maturity are expected to mature relatively slowly. Default is "medium."

plant_depth

float

no

The depth in centimeters that the crop was planted. Plant depth must be a float between 0.1 and 10.0 cm. If no value is provided, the default plant depth is 5.

max_moisture_refill

float

no

Desired maximum amount of refill to be provided by irrigation recommendations, expressed as percent depletion from field capacity to wilting point. The default value is 0%, indicating recommended irrigation activities will try to not exceed field capacity. Valid values range from –50% (an increase in the allowed maximum soil moisture) to 50% (a decrease in the allowed maximum soil moisture). Negative values represent refill amounts that exceed field capacity and are internally limited to the soil-specific saturation point.

max_moisture_ depletion

float

no

Desired driest state the soil is allowed to attain before an irrigation recommendation is triggered, expressed as percent depletion from field capacity to wilting point. Default values are optimized to the soil composition, crop type, and crop growth stage, with typical values of around 50%. Valid values range from 0% (indicating soil moisture should not be allowed to fall below field capacity) to 100% (soil moisture is allowed to reach the permanent wilting point, at which crop death will occur). Practical values typically range from 30 to 70%. Values are internally limited to be greater than the max_moisture_refill value.

name

string

no

Unique name to assign to the growth.

Response Object

Returns "true" on success.

Example Request

https://ag.clearapis.com/v1.0/crop_health/winter_wheat/modify/abc-123?
app_id=456&app_key=789&account_id=123&user_id=xyz-123
&plant_date=1456890400&relative_maturity=medium&plant_depth=5

Example Response

true

Winter Wheat Growth Delete - v1.0

This endpoint allows a user to delete a winter wheat growth. By deleting a growth, any applicable growth feedback and growth whitelist items will also be deleted.

URL Description

https://ag.clearapis.com/v1.0/crop_health/winterwheat/growth/delete/{growth_id}?
app_id={string}&app_key={string}&account_id={string}&user_id={string}

Request Parameters

Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

growth_id

string

yes

The ID of the target growth to delete.

account_id

string

yes

A unique account ID provided by your Iteris account representative.

user_id

string

yes

User ID provided by the Create User endpoint as a result of adding a new user to the user information database.

Response Object

Returns "true" on success.

Example Request

https://ag.clearapis.com/v1.0/crop_health/winterwheat/growth/delete/abc-def?
app_id=456&app_key=789&account_id=123&user_id=xyz-123

Example Response

true

Winter Wheat Growth - v1.1

Leveraging Iteris' winter wheat growth stage model, the Winter Wheat Growth endpoint allows users to model the maturation and development of winter wheat crops. Users may also take advantage of Accounts API integration to provide crop growth feedback and optimize model results.

Please note that winter wheat has a vernalization (cold) requirement that must be satisfied before floral initiation can occur. This requirement will not be met if winter temperatures do not get low enough, which means that the model will not go past the First Tiller stage.

URL Description

https://ag.us.clearapis.com/v1.1/crop_health/winter_wheat/growth?app_id={string}
&app_key={string}&location={lat, lon coordinates}&plant_date={timestamp}
&days={integer}&account_id={string}&user_id={string}&growth_id={string}
&relative_maturity={string}&scale={string}&plant_depth={float}

Request Parameters

Parameter Type Location-based Accounts API Integration Description

app_id

string

yes

yes

API ID provided by Iteris.

app_key

string

yes

yes

API key provided by Iteris.

location

lat, lon coordinates

yes

 — 

User-provided latitude and longitude coordinates in decimal degrees. Please verify that latitude/longitude coordinates are over soil representative of your field. Users are allowed a maximum of five coordinates1, formatted as "&location=[(<lat_1>,<lon_1>),(<lat_2>,<lon_2>)]."

plant_date, emergence_date

timestamp

yes

 — 

Epoch timestamp valid near the time that the crop was planted or the date of emergence. Please refer to the Epoch/Unix Timestamp section of the Appendix for Iteris' definition of Epoch/Unix timestamp.

days

integer

yes

yes

Number of days for which to calculate results. Possible values range from 1 to 366.

relative_maturity

string

no

 — 

Classification indicating how early a variety matures. Valid values include "early," "medium-early," "medium," "medium-late," and "late." Crops that have an "early" relative maturity are expected to mature relatively fast, and crops having a "late" relative maturity are expected to mature relatively slowly. Default is "medium."

scale

string

no

no

Specifies which growth scale (feekes, haun, or zadoks) the response will display. Default behavior is to utilize a unified scale and display the equivalent stages from all three scales in the response.

plant_depth

float

no

 — 

The depth in centimeters that the crop was planted. Possible values range from 0.1 to 10.0 cm. The default is 5.0 cm.

account_id

string

no

yes

Your Accounts API account ID.

user_id

string

no

yes

User ID provided by and used with the Accounts API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

no

yes

Specifies the ID given when a growth is successfully added to a field using the create growth endpoint.

1 Additional coordinates are not counted against a client’s account, but will count as additional requests in the future.

Response Object (JSON)

Field Description

attribution

Various model attributions.

agdd

Aggregate growing degree days from plant or emergence date, including the current date.

air_temp_max

Maximum daily air temperature valid for the current date. Obtained from historical, forecast, or climatological data, depending on the timeframe.

air_temp_min

Minimum daily air temperature valid for the current date. Obtained from historical, forecast, or climatological data, depending on the timeframe.

feedback_id

If this field is present, it indicates a confirmed or observed growth stage on the current date.

gdd

Growing degree days accumulated on the current date.

last_stage

The last known growth stage.

new_stage

The crop may have entered a new growth stage between the current date and the previous date. If new_stage is n/a, the crop is somewhere between the previous growth stage and the next growth stage.

harvest_window/end

Expected end date for harvest operations.

harvest_window/start

Expected start date for harvest operations.

advisor

Suggested field properties to check.

description

Text description for a stage.

images/attribution

Credit for image.

images/caption

Image description.

images/url

Image URL.

name

Growth stage name.

order

Relative position of the stage within the growth scale.

applicable_scales/feekes

Stage equivalent in the Feekes scale.

applicable_scales/haun

Stage equivalent in the Haun scale.

applicable_scales/zadoks

Stage equivalent in the Zadoks scale.

Example Request

https://ag.us.clearapis.com/v1.1/crop_health/winter_wheat/growth?app_id=123
&app_key=321&location=47,-97&plant_date=1462060800&days=160

Example Response

{
    "attribution":[
        "Growth model based on...",...
    ],
    "data":{
        "47,-97":{
            "growth":{
                "2017-07-25":{
                    "agdd":2386.88,
                    "air_temp_max":81.0,
                    "air_temp_min":68.0,
                    "gdd":23.4,
                    "last_stage":"12",
                    "new_stage":"13"
                },...
            },
            "harvest_window":{
                "end":"2017-08-12",
                "start":"2017-07-25"
            }
        }
    },
    "stage_descriptions":{
        "13":{
            "advisor":"Harvest",
            "applicable_scales":{
                "feekes":"11.4",
                "haun":"n/a",
                "zadoks":"93"
            },
            "description":"The grain has dried after physiological maturity. The wheat crop is ready to be harvested.",
            "images":[],
            "name":"Harvest Ready",
            "order":"14"
        },...
    }
}

Winter Wheat Growth Add Feedback - v1.0

By providing feedback relating to the growth stage estimates, Iteris will be able to make updates and adjustments to offer its users better results in the future. The given user providing feedback must have write privileges for the field in which the field growth belongs.

Additional information related to feedback timestamp, growth feedback, and feedback stage is available in the Appendix.

URL Description

https://ag.us.clearapis.com/v1.0/crop_health/winter_wheat/growth/feedback/add/
{growth_id}/{timestamp}/{stage}?account_id={string}&user_id={string}
&app_id={string}&app_key={string}&start_override={boolean}

Request Parameters

Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

Your Accounts API account ID.

user_id

string

yes

User ID provided by and used with the Accounts API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

yes

Specifies the ID given when a growth is successfully added to a field using the create growth endpoint.

timestamp

integer

yes

An epoch timestamp in seconds representing the date for which the feedback applies. Please refer to the Epoch/Unix Timestamp section of the Appendix for Iteris' definition of Epoch/Unix timestamp.

stage

string

yes

Inform the system that on the given date, the plant has entered or is currently in the provided stage. Please refer to the Crop Growth Stages section of the Appendix for a listing of accepted growth stage IDs.

start_override

boolean

no

When this is included, the corrector system will treat this feedback as meaning "the crop entered this stage on this date." In the absence of this parameter, the corrector will treat this feedback as meaning "the crop was observed in this stage on this date."

Response Object

A string representing a feedback ID.

Example Request

https://ag.us.clearapis.com/v1.0/crop_health/winter_wheat/growth/feedback/add/
xyz/1472688000/1?account_id=abc&user_id=cba
&app_id=123&app_key=321

Example Response

def-345

Winter Wheat Growth Feedbacks by Growth - v1.0

Returns a list of growth feedback activities associated with the target growth_id.

URL Description

https://ag.us.clearapis.com/v1.0/crop_health/winter_wheat/growth/feedback/
get/by_growth/{growth_id}?app_id={string}&app_key={string}&account_id={string}
&user_id={string}

Request Parameters

Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

Your Accounts API account ID.

user_id

string

yes

User ID provided by and used with the Accounts API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

yes

Specifies the ID given when a growth is successfully added to a field using the create growth endpoint.

Response Object (JSON)

Field Description

user_id

User ID provided by and used with the Accounts API.

created

Timestamp denoting when the feedback was created.

data

Information pertaining to the activity.

subtype

Enumeration value representing the specific variety of the activity. Defaults to 0.

growth_feedback_id

ID of target growth feedback.

type

Enumeration value of plant.

feedback/date

Unix timestamp denoting when the feedback happened. Please refer to the Epoch/Unix Timestamp section of the Appendix for Iteris' definition of Epoch/Unix timestamp.

feedback/stage

Stage provided as feedback.

feedback/start_ override

True denotes this feedback as meaning "the crop entered this stage on this date." False denotes this feedback as meaning "the crop was observed in this stage on this date."

Example Request

https://ag.us.clearapis.com/v1.0/crop_health/winter_wheat/growth/feedback/
get/by_growth/xyz?app_id=123&app_key=321&account_id=abc
&user_id=cba

Example Response

[
    {
        "user_id":"1234",
        "feedback":{
            "date":1400371200,
            "type":68,
            "stage":"1"
        },
        "created":1446229281,
        "data":"{}",
        "subtype":"0",
        "growth_feedback_id":"1111",
        "type":68
    },...
]

Winter Wheat Growth Modify Feedback - v1.0

The Winter Wheat Growth Modify Feedback endpoint allows users to modify previously provided growth stage estimate feedback. The given user providing feedback must have write privileges for the field in which the field growth belongs. At least one modification must be provided.

URL Description

https://ag.us.clearapis.com/v1.0/crop_health/winter_wheat/growth/feedback/modify/
{feedback_id}?account_id={string}&user_id={string}&app_id={string}
&app_key={string}&timestamp={integer}&stage={string}

Request Parameters

Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

Your Accounts API account ID.

user_id

string

yes

User ID provided by and used with the Accounts API. The user must have privileges to view information for the field to which the target growth is assigned.

feedback_id

string

yes

A unique ID returned as a result from successfully adding feedback.

timestamp

integer

yes

An epoch timestamp in seconds representing the date for which the feedback applies. Please refer to the Epoch/Unix Timestamp section of the Appendix for Iteris’ definition of Epoch/Unix timestamp.

stage

string

yes

Inform the system that on the given date, the plant has entered or is currently in the provided stage. Please refer to the Crop Growth Stages section of the Appendix for a listing of accepted growth stage IDs.

Response Object

A string representing success ("true") or failure ("false").

Example Request

https://ag.us.clearapis.com/v1.0/crop_health/winter_wheat/growth/feedback/
modify/abc-123?account_id=abc&user_id=cba&app_id=123&app_key=321
&timestamp=1472688000&stage=1

Example Response

true

Winter Wheat Growth Delete Feedback - v1.0

This endpoint allows users to delete the previously provided growth stage estimate feedback. The given user deleting feedback must have write privileges for the field in which the field growth belongs.

URL Description

https://ag.us.clearapis.com/v1.0/crop_health/winter_wheat/growth/feedback/
delete/{feedback_id}?account_id={string}&user_id={string}&app_id={string}
&app_key={string}

Request Parameters

Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

Your Accounts API account ID.

user_id

string

yes

User ID provided by and used with the Accounts API. The user must have privileges to view information for the field to which the target growth is assigned.

feedback_id

string

yes

A unique ID returned as a result from successfully adding feedback.

Response Object

A string representing success ("true") or failure ("false").

Example Request

https://ag.us.clearapis.com/v1.0/crop_health/winter_wheat/growth/
feedback/delete/abc-123?account_id=abc&user_id=cba
&app_id=123&app_key=321

Example Response

true

Winter Wheat Growth with GDD Envelope - v1.1

The Winter Wheat Growth with GDD Envelope service provides winter wheat growth information in addition to GDD envelope data. GDD envelope calculation begins from either the current day, or the planted/emergence date, whichever is further in the future. The envelope is constructed by compiling the previous 10 years of weather data, and simulating the maximum and minimum GDD that would have accumulated within those 10 years for each date. The calculated minimum and maximum values are then added to the current start of calculation date AGDD going onwards to show range of possibilities.

URL Description

https://ag.us.clearapis.com/v1.1/crop_health/winter_wheat/growth/
gdd_envelope?app_id={string}&app_key={string}&plant_date={timestamp}
&location={lat, lon coordinates}&days={integer}&account_id={string}
&user_id={string}&growth_id={string}
&relative_maturity={string}&scale={string}&plant_depth={float}

Request Parameters

Parameter Type Location-based Accounts API Integration Description

app_id

string

yes

yes

API ID provided by Iteris.

app_key

string

yes

yes

API key provided by Iteris.

location

lat, lon coordinates

yes

 — 

User-provided latitude and longitude coordinates in decimal degrees. Please verify that latitude/longitude coordinates are over soil representative of your field. Users are allowed a maximum of five coordinates1, formatted as "&location=[(<lat_1>,<lon_1>),(<lat_2>,<lon_2>)]."

plant_date, emergence_date

timestamp

yes

 — 

Epoch timestamp valid near the time that the crop was planted or the date of emergence. Please refer to the Epoch/Unix Timestamp section of the Appendix for Iteris' definition of Epoch/Unix timestamp.

days

integer

yes

yes

Number of days for which to calculate results. Possible values range from 1 to 366.

relative_maturity

string

no

 — 

Classification indicating how early a variety matures. Valid values include "early," "medium-early," "medium," "medium-late," and "late." Crops that have an "early" relative maturity are expected to mature relatively fast, and crops having a "late" relative maturity are expected to mature relatively slowly. Default is "medium."

scale

string

no

no

Specifies which growth scale (feekes, haun, or zadoks) the response will display. Default behavior is to utilize a unified scale and display the equivalent stages from all three scales in the response.

plant_depth

float

no

 — 

The depth in centimeters that the crop was planted. Possible values range from 0.1 to 10.0 cm. The default is 5.0 cm.

account_id

string

no

yes

Your Accounts API account ID.

user_id

string

no

yes

User ID provided by and used with the Accounts API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

no

yes

Specifies the ID given when a growth is successfully added to a field using the create growth endpoint.

1 Additional coordinates are not counted against a client’s account, but will count as additional requests in the future.

Response Object (JSON)

Field Description

attribution

Various model attributions.

agdd

Aggregate growing degree days from plant or emergence date, including the current date.

agdd_envelope_max

Maximum observed AGDD of the past 10 years.

agdd_envelope_max_year

Year that the maximum AGDD value was observed.

agdd_envelope_min

Minimum observed AGDD of the past 10 years.

agdd_envelope_min_year

Year that the maximum AGDD value was observed.

air_temp_max

Maximum daily air temperature valid for the current date. Obtained from historical, forecast, or climatological data, depending on the timeframe.

air_temp_min

Minimum daily air temperature valid for the current date. Obtained from historical, forecast, or climatological data, depending on the timeframe.

feedback_id

If this field is present, it indicates a confirmed or observed growth stage on the current date.

gdd

Growing degree days accumulated on the current date.

last_stage

The last known growth stage.

new_stage

The crop may have entered a new growth stage between the current date and the previous date. If new_stage is n/a, the crop is somewhere between the previous growth stage and the next growth stage.

harvest_window/end

Expected end date for harvest operations.

harvest_window/start

Expected start date for harvest operations.

advisor

Suggested field properties to check.

description

Text description for a stage.

images/attribution

Credit for image.

images/caption

Image description.

images/url

Image URL.

name

Growth stage name.

order

Relative position of the stage within the growth scale.

applicable_scales/feekes

Stage equivalent in the Feekes scale.

applicable_scales/haun

Stage equivalent in the Haun scale.

applicable_scales/zadoks

Stage equivalent in the Zadoks scale.

Example Request

https://ag.us.clearapis.com/v1.1/crop_health/winter_wheat/growth/gdd_envelope?
app_id=123&app_key=321&location=47,-97&plant_date=1462060800&days=160

Example Response

{
    "attribution":[
        "Growth model based on...",...
    ],
    "data":{
        "47,-97":{
            "growth":{
                "2017-07-25":{
                    "agdd":2386.88,
                    "agdd_envelope_max":2550.0,
                    "agdd_envelope_max_year":"2015",
                    "agdd_envelope_min":2250.0,
                    "agdd_envelope_min_year":"2013",
                    "air_temp_max":81.0,
                    "air_temp_min":68.0,
                    "gdd":23.4,
                    "last_stage":"12",
                    "new_stage":"13"
                },...
            },
            "harvest_window":{
                "end":"2017-08-12",
                "start":"2017-07-25"
            }
        }
    },
    "stage_descriptions":{
        "13":{
            "advisor":"Harvest",
            "applicable_scales":{
                "feekes":"11.4",
                "haun":"n/a",
                "zadoks":"93"
            },
            "description":"The grain has dried after physiological maturity. The wheat crop is ready to be harvested.",
            "images":[],
            "name":"Harvest Ready",
            "order":"14"
        },...
    }
}

Zoysia Turfgrass

Zoysia Turfgrass Growth Creation - v1.0

This endpoint allows users to create a zoysia turfgrass growth on an existing field. The user adding the zoysia turfgrass growth must have write privileges for the field being updated.

URL Description

https://ag.us.clearapis.com/v1.0/crop_health/turfgrass_zoysia/growth/create/
{field_id}?app_id={string}&app_key={string}&account_id={string}
&user_id={string}&start_date={string}&variety={string}&name={string}
&max_moisture_depletion={float}&max_moisture_refill={float}
&zone_map_id={string}

Request Parameters

Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

Your Accounts API account ID.

user_id

string

yes

User ID provided by the Accounts API. The user must have privileges to view information for the field to which the target growth is assigned.

field_id

string

yes

ID of field on which to create the growth.

start_date

string

yes

Start time of the model, formatted either as a date string (YYYY-MM-DD) or an epoch timestamp. (Note that this is stored only as a timestamp in the database.) Please refer to the Epoch/Unix Timestamp section of the Appendix for Iteris' definition of Epoch/Unix timestamp.

variety

string

yes

Subclass of zoysia turfgrass. Currently, only "generic" is supported.

name

string

no

Unique name to assign to the growth. Default is "turfgrass zoysia."

max_moisture_ depletion

float

no

Desired driest state the soil is allowed to attain before an irrigation recommendation is triggered, expressed as percent depletion from field capacity to wilting point. Default values are optimized to the soil composition, crop type, and crop growth stage, with typical values of around 50%. Valid values range from 0% (indicating soil moisture should not be allowed to fall below field capacity) to 100% (soil moisture is allowed to reach the permanent wilting point, at which crop death will occur). Practical values typically range from 30 to 70%. Values are internally limited to be greater than the max_moisture_refill value.

max_moisture_refill

float

no

Desired maximum amount of refill to be provided by irrigation recommendations, expressed as percent depletion from field capacity to wilting point. The default value is 0%, indicating recommended irrigation activities will try to not exceed field capacity. Valid values range from –50% (an increase in the allowed maximum soil moisture) to 50% (a decrease in the allowed maximum soil moisture). Negative values represent refill amounts that exceed field capacity and are internally limited to the soil-specific saturation point.

zone_map_id

string

no

The target zone map id must exist for the target field. This will be a UUID. If provided and growth creation is successful, the growth will be treated as "zone aware," enabling zone management features. This property cannot be mutated after a growth has been created.

Response Object

A string representing a growth ID.

Example Request

https://ag.us.clearapis.com/v1.0/crop_health/turfgrass_zoysia/growth/create/e1b?
app_id=123&app_key=321&account_id=abc&user_id=cba&start_date=1462060800
variety=generic

Example Response

xyz

Zoysia Turfgrass Get Growth - v1.0

This endpoint allows users to retrieve a previously created growth based on growth ID.

URL Description

https://ag.us.clearapis.com/v1.0/crop_health/turfgrass_zoysia/growth/get/{growth_id}?
app_id={string}&app_key={string}&account_id={string}&user_id={string}

Request Parameters

Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

Your Accounts API account ID.

user_id

string

yes

User ID provided by the Create User endpoint as a result of adding a new user to the user information database.

growth_id

string

yes

Specifies ID of crop growth to be queried from the user information database, provided by the Create Growth endpoint.

Response Object (JSON)

Field Description

acres

Areal size of the field in acres.

created

Epoch timestamp when the growth was created. Please refer to the Epoch/Unix Timestamp section of the Appendix for Iteris' definition of Epoch/Unix timestamp.

field_id

ID of field to which crop growth data has been assigned.

field_name

Name of the field.

growth_id

ID of crop growth queried.

irrigation_type

Represents whether or not the cropland utilizes pivot irrigation. Valid values include 0 ("false") and 1 ("true").

latitude

Latitude coordinate near the center of the field in decimal degrees.

longitude

Longitude coordinate near the center of the field in decimal degrees.

max_moisture_depletion

Desired driest state the soil is allowed to attain before an irrigation recommendation is triggered, expressed as percent depletion from field capacity to wilting point.

max_moisture_refill

Desired maximum amount of refill to be provided by irrigation recommendations, expressed as percent depletion from field capacity to wilting point.

name

Name of the growth.

plant_name

Name of the crop plant.

plant_type

Value representing the type of crop planted. (See the Plant Enumerations section of the Appendix for a listing of plant type IDs.)

start_date

Start time of the model, formatted as an epoch timestamp. Please refer to the Epoch/Unix Timestamp section of the Appendix for Iteris' definition of Epoch/Unix timestamp.

subdrainage_type

Represents whether or not the cropland utilizes drainage tile. Valid values include 0 ("false") and 1 ("true").

surface_drainage_quality

Represents field drainage effectiveness. Valid values include 0 ("poor"), 1 ("average"), and 2 ("good").

variety

Subclass of zoysia turfgrass.

version

Growth model version to which feedbacks are applicable. [deprecated]

zone_map_id

Zone map ID to be used with this growth when utilizing zone management products. Value will be a UUID or null.

Example Request

https://ag.us.clearapis.com/v1.0/crop_health/turfgrass_zoysia/growth/get/bcd-def?
app_id=123&app_key=321&account_id=abc&user_id=cba

Example Response

{
    "acres":160.0,
    "created":1498069941,
    "field_id":"e1b",
    "field_name":"My Field",
    "growth_id":"xyz",
    "irrigation_type":0,
    "latitude":30.0,
    "longitude":-82.0,
    "max_moisture_depletion":75.0,
    "max_moisture_refill":15.0,
    "name":"MyGrowth",
    "plant_name":"turfgrass zoysia",
    "plant_type":79,
    "start_date":1398920400,
    "subdrainage_type":0,
    "surface_drainage_quality":1,
    "variety":"generic",
    "version":"v1.0"
}

Zoysia Turfgrass Growth Modify - v1.0

This endpoint allows users to modify an existing zoysia turfgrass growth.

URL Description

https://ag.us.clearapis.com/v1.0/crop_health/turfgrass_zoysia/growth/modify/
{growth_id}?app_id={string}&app_key={string}&account_id={string}
&user_id={string}&start_date={string}&variety={string}&name={string}
&max_moisture_depletion={float}&max_moisture_refill={float}

Request Parameters

Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

Your Accounts API account ID.

user_id

string

yes

User ID provided by the Accounts API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

yes

ID of target growth to modify.

start_date

string

no

Start time of the model, formatted either as a date string (YYYY-MM-DD) or an epoch timestamp. (Note that this is stored only as a timestamp in the database.) Please refer to the Epoch/Unix Timestamp section of the Appendix for Iteris' definition of Epoch/Unix timestamp.

variety

string

no

Subclass of zoysia turfgrass. Currently, only "generic" is supported.

name

string

no

Unique name to assign to the growth.

max_moisture_ depletion

float

no

Desired driest state the soil is allowed to attain before an irrigation recommendation is triggered, expressed as percent depletion from field capacity to wilting point. Valid values range from 0% (indicating soil moisture should not be allowed to fall below field capacity) to 100% (soil moisture is allowed to reach the permanent wilting point, at which crop death will occur). Practical values typically range from 30 to 70%. Values are internally limited to be greater than the max_moisture_refill value.

max_moisture_refill

float

no

Desired maximum amount of refill to be provided by irrigation recommendations, expressed as percent depletion from field capacity to wilting point. Valid values range from –50% (an increase in the allowed maximum soil moisture) to 50% (a decrease in the allowed maximum soil moisture). Negative values represent refill amounts that exceed field capacity and are internally limited to the soil-specific saturation point.

Response Object (JSON)

Returns "true" on success.

Example Request

https://ag.us.clearapis.com/v1.0/crop_health/turfgrass_zoysia/growth/modify/xyz?
app_id=123&app_key=321&account_id=abc&user_id=cba
&start_date=1462060800

Example Response

true

Zoysia Turfgrass Growth Delete - v1.0

This endpoint allows users to delete a zoysia turfgrass growth. By deleting a growth, any applicable growth feedback and growth whitelist items will also be deleted.

URL Description

https://ag.us.clearapis.com/v1.0/crop_health/turfgrass_zoysia/growth/delete/
{growth_id}?app_id={string}&app_key={string}&account_id={string}
&user_id={string}

Request Parameters

Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

account_id

string

yes

Your Accounts API account ID.

user_id

string

yes

User ID provided by the Create User endpoint as a result of adding a new user to the user information database.

growth_id

string

yes

The ID of the target growth to delete.

Response Object

Returns "true" on success.

Example Request

https://ag.us.clearapis.com/v1.0/crop_health/turfgrass_zoysia/growth/delete/xyz?
app_id=123&app_key=321&account_id=abc&user_id=cba

Example Response

true

Zoysia Turfgrass Growth - v1.0

The Zoysia Turfgrass Growth endpoint allows users to simulate dormancy of zoysia turfgrass and determine when it is expected to be fully dormant, fully active, and in a transition phase between these two.

URL Description

https://ag.us.clearapis.com/v1.0/crop_health/turfgrass_zoysia/growth?app_id={string}
&app_key={string}&location={lat, lon coordinates}&start_date={start_date}
&days={integer}&variety={string}&account_id={string}&user_id={string}
&growth_id={string}

Request Parameters

Parameter Type Location-based Accounts API Integration Description

app_id

string

yes

yes

API ID provided by Iteris.

app_key

string

yes

yes

API key provided by Iteris.

location

lat, lon coordinates

yes

 — 

User-provided latitude and longitude coordinates in decimal degrees. Users are allowed a maximum of five coordinates,1 formatted as "&location=[(<lat_1>,<lon_1>),(<lat_2>,<lon_2>)]."

start_date

string

yes

 — 

Start time of the model, formatted either as a date string (YYYY-MM-DD) or an epoch timestamp. Please refer to the Epoch/Unix Timestamp section of the Appendix for Iteris' definition of Epoch/Unix timestamp.

days

integer

yes

yes

Number of days for which to calculate results. Possible values range from 1 to 366.

variety

string

yes

 — 

Subclass of zoysia turfgrass. Currently, only "generic" is supported.

account_id

string

no

yes

Your Accounts API account ID.

user_id

string

no

yes

User ID provided by the Accounts API. The user must have privileges to view information for the field to which the target growth is assigned.

growth_id

string

no

yes

Growth ID provided by the Zoysia Turfgrass Growth Creation endpoint.

1 Additional coordinates are not counted against a client’s account.

Response Object (JSON)

Field Description

attribution

Various model attributions.

air_temp_max

Maximum daily air temperature in degrees Fahrenheit, which may be a historical, forecast, or climatological value, depending on the timeframe.

air_temp_min

Minimum daily air temperature in degrees Fahrenheit, which may be a historical, forecast, or climatological value, depending on the timeframe.

last_stage

The last known growth stage.

new_stage

The crop may have entered a new growth stage between the current date and the previous date. The output is "n/a" if the crop is somewhere between the previous growth stage and the next growth stage. Note that due to the perennial nature of turfgrass, the same stages can be reached multiple times in the simulation.

description

Text description for a stage.

images/attribution