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 Harvest Modeling

last updated 5/10/19

Crop Harvest Modeling delivers precise and relevant data and modeling to improve the management of harvest activities and grain drydown costs. Specifically, ClearAg harvest modeling estimates grain drydown rates using field-level analysis of weather conditions and user-supplied measurements of grain crop conditions, and estimates mechanical drydown cost through robust modeling. Please refer to the Appendix for a list of Supported Crops by Feature.

This bundle requires and includes the Accounts API and the Crop Growth Model bundle.

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.

In-Field Drydown

Barley In-Field Drydown - v1.0

Drawing from the ClearAg Field Weather API and spring barley growth model, the Barley In-Field Drydown endpoint simulates the drying process of spring barley in the field after the crop achieves full maturity, and provides daily moisture estimates during the drydown period. If Accounts API integration is used, any available moisture measurements are used to improve model results.

URL Description

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

Request Parameters

Parameter Type Location-based Account API Integration Description

app_id

string

yes

yes

API ID provided by Iteris.

app_key

string

yes

yes

API key provided by Iteris.

account_id

string

no

yes

A unique account ID provided by your Iteris account representative.

user_id

string

no

yes

User ID provided by the Account 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 Growth Creation endpoint. If provided, properties of this growth will be used to generate model results.

location

lat, lon coordinates

yes

 — 

Lat-lon coordinates of the field in decimal degrees. Format is: [(lat1, lon1), ...]. Users are allowed a maximum of five coordinates.1

plant_date

timestamp

no*

 — 

Date that the crop was planted in the form of a Unix timestamp. *Required if emergence_date is not provided.

emergence_date

timestamp

no*

 — 

Date that the crop began to emerge from the soil, in the form of a Unix timestamp. *Required if plant_date is not provided.

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."

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 in degrees Fahrenheit. Obtained from historical, forecast, or climatological data, depending on the timeframe.

air_temp_min

Minimum daily air temperature in degrees Fahrenheit. Obtained from historical, forecast, or climatological data, depending on the timeframe.

equilibrium_moisture_content

The wet-basis moisture content, in percent, at which the grain is neither gaining nor losing moisture. Changes with relative humidity and air temperature. Provided after the crop fully matures. Note that wet-basis moisture content is defined as the ratio of the mass of water to the total mass of a sample of grain.

feedback_id

If this parameter is present, it indicates a confirmed or observed growth stage.

field_activity_id

If this parameter is present, it indicates a confirmed or observed moisture sample.

gdd

Growing degree days accumulated on the current date.

grain_moisture_content

Percent wet-basis moisture content of the grain at the end of the day. Provided after the crop fully matures.

grain_moisture_content_change

The change in the amount of wet-basis moisture in the grain since the previous day, in percent. Positive values indicate that the moisture content has increased, and negative values indicate that the moisture content has decreased. Provided after the crop fully matures.

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. "n/a" if 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/barley/infield_drydown?app_id=456&app_key=789&account_id=123&user_id=xyz-123&growth_id=abc-def

Example Response

{
    "attribution":[
        "Growth model based on...",...
    ],
    "data":{
        "39,-103":{
            "2016-06-05":{
                "agdd":1721.0,
                "air_temp_max":80.0,
                "air_temp_min":52.0,
                "equilibrium_moisture_content":"n/a",
                "feedback_id":"111-b2b",
                "gdd":36.0,
                "grain_moisture_content":"n/a",
                "grain_moisture_content_change":"n/a",
                "last_stage":"11.0",
                "new_stage":"11.5"
            },...
        }
    },
    "harvest_window":{
        "end":"2016-07-29",
        "start":"2016-07-08"
    },
    "stage_descriptions":{
        "11.5":{
            "advisor":"Harvest",
            "description":"Kernel width and length are set; not much dry matter has accumulated.",
            "images":[
                {
                    "attribution":"Courtesy of...",
                    "caption":"Watery ripe",
                    "url":".../Watery_ripe.png"
                },...
            ],
            "name":"11.5 - Kernel Watery Ripe",
            "order":"14"
        },...
    }
}

Canola In-Field Drydown - v1.0

Drawing from the ClearAg Field Weather API and canola growth model, the Canola In-Field Drydown endpoint simulates the drying process of canola in the field after the crop achieves full maturity, and provides daily moisture estimates during the drydown period. If Accounts API integration is used, any available moisture measurements are used to improve model results.

URL Description

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

Request Parameters

Parameter Type Location-based Account API Integration Description

app_id

string

yes

yes

API ID provided by Iteris.

app_key

string

yes

yes

API key provided by Iteris.

account_id

string

no

yes

A unique account ID provided by your Iteris account representative.

user_id

string

no

yes

User ID provided by the Account 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 Growth Creation endpoint. If provided, properties of this growth will be used to generate model results.

location

lat, lon coordinates

yes

 — 

Lat-lon coordinates of the field in decimal degrees. Format is: [(lat1, lon1), ...]. Users are allowed a maximum of five coordinates.1

plant_date

timestamp

no*

 — 

Date that the crop was planted in the form of a Unix timestamp. *Required if emergence_date is not provided.

emergence_date

timestamp

no*

 — 

Date that the crop began to emerge from the soil, in the form of a Unix timestamp. *Required if plant_date is not provided.

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."

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 in degrees Fahrenheit. Obtained from historical, forecast, or climatological data, depending on the timeframe.

air_temp_min

Minimum daily air temperature in degrees Fahrenheit. Obtained from historical, forecast, or climatological data, depending on the timeframe.

equilibrium_moisture_content

The wet-basis moisture content, in percent, at which the grain is neither gaining nor losing moisture. Changes with relative humidity and air temperature. Provided after the crop fully matures. Note that wet-basis moisture content is defined as the ratio of the mass of water to the total mass of a sample of grain.

feedback_id

If this parameter is present, it indicates a confirmed or observed growth stage.

field_activity_id

If this parameter is present, it indicates a confirmed or observed moisture sample.

gdd

Growing degree days accumulated on the current date.

grain_moisture_content

Percent wet-basis moisture content of the grain at the end of the day. Provided after the crop fully matures.

grain_moisture_content_change

The change in the amount of wet-basis moisture in the grain since the previous day, in percent. Positive values indicate that the moisture content has increased, and negative values indicate that the moisture content has decreased. Provided after the crop fully matures.

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. "n/a" if 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/canola/infield_drydown?app_id=456&app_key=789&account_id=123&user_id=xyz-123&growth_id=abc-def

Example Response

{
    "attribution":[
        "Growth model based on...",...
    ],
    "data":{
        "39,-103":{
            "2016-04-14":{
                "agdd":392.5,
                "air_temp_max":75.0,
                "air_temp_min":42.0,
                "equilibrium_moisture_content":"8.61",
                "feedback_id":"111-b2b",
                "gdd":17.5,
                "grain_moisture_content":"n/a",
                "grain_moisture_content_change":"n/a",
                "last_stage":"S",
                "new_stage":"n/a"
            },...
        }
    },
    "harvest_window":{
        "end":"2016-07-27",
        "start":"2016-07-07"
    },
    "stage_descriptions":{
        "S":{
            "advisor":"Nutrient",
            "description":"Emergence occurs when the seedling pushes through the soil surface.",
            "images":[
                {
                    "attribution":"Courtesy of...",
                    "caption":"Seedling (cotyledon)",
                    "url":".../cotyledon_150.jpg"
                },...
            ],
            "name":"Emergence",
            "order":"1"
        },...
    }
}

Corn In-Field Drydown - v1.0

Drawing from the ClearAg Field Weather API and corn growth model, the Corn In-Field Drydown endpoint simulates the drying process of corn in the field after the crop achieves full maturity, and provides daily moisture estimates during the drydown period. If Accounts API integration is used, any available moisture measurements are used to improve model results.

Please note that due to the nature of corn, full maturity may not always be attained in a growing season. In these cases, the in-field drydown model for corn will start when the simulation reaches the stage prior to physiological maturity.

URL Description

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

Request Parameters

Parameter Type Location-based Account API Integration Description

app_id

string

yes

yes

API ID provided by Iteris.

app_key

string

yes

yes

API key provided by Iteris.

account_id

string

no

yes

A unique account ID provided by your Iteris account representative.

user_id

string

no

yes

User ID provided by the Account 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 Growth Creation endpoint. If provided, properties of this growth will be used to generate model results.

location

lat, lon coordinates

yes

 — 

Lat-lon coordinates of the field in decimal degrees. Format is: [(lat1, lon1), ...]. Users are allowed a maximum of five coordinates.1

plant_date

timestamp

no*

 — 

Date that the crop was planted in the form of a Unix timestamp. *Required if emergence_date is not provided.

emergence_date

timestamp

no*

 — 

Date that the crop began to emerge from the soil, in the form of a Unix timestamp. *Required if plant_date is not provided.

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.

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 in degrees Fahrenheit. Obtained from historical, forecast, or climatological data, depending on the timeframe.

air_temp_min

Minimum daily air temperature in degrees Fahrenheit. Obtained from historical, forecast, or climatological data, depending on the timeframe.

equilibrium_moisture_content

The wet-basis moisture content, in percent, at which the grain is neither gaining nor losing moisture. Changes with relative humidity and air temperature. Provided after the crop fully matures. Note that wet-basis moisture content is defined as the ratio of the mass of water to the total mass of a sample of grain.

feedback_id

If this parameter is present, it indicates a confirmed or observed growth stage.

field_activity_id

If this parameter is present, it indicates a confirmed or observed moisture sample.

gdd

Growing degree days accumulated on the current date.

grain_moisture_content

Percent wet-basis moisture content of the grain at the end of the day. Provided after the crop fully matures.

grain_moisture_content_change

The change in the amount of wet-basis moisture in the grain since the previous day, in percent. Positive values indicate that the moisture content has increased, and negative values indicate that the moisture content has decreased. Provided after the crop fully matures.

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. "n/a" if 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/corn/infield_drydown?app_id=456&app_key=789&account_id=123&user_id=xyz-123&growth_id=abc-def

Example Response

{
    "attribution":[
        "Growth model based on...",...
    ],
    "data":{
        "45,-97":{
            "2016-10-01":{
                "agdd":2300.0,
                "air_temp_max":58,
                "air_temp_min":40,
                "equilibrium_moisture_content":7.43,
                "feedback_id":"111-b2b",
                "gdd":3.5,
                "grain_moisture_content":31.92,
                "grain_moisture_content_change":-1.0,
                "last_stage":"r6",
                "new_stage":"n/a"
            },...
        }
    },
    "harvest_window":{
        "end":"2016-10-19",
        "start":"2016-09-17"
    },
    "stage_descriptions":{
        "ve":{
            "advisor":"Nutrient",
            "description":"Emergence - VE (emergence) occurs when the coleoptile (spike) pushes through the soil surface. Corn plants can emerge within five days in ideal heat and moisture conditions. But in practice, due to early planting under seasonably cool conditions, at least two weeks are normally required from planting to emergence.",
            "images":[
                {
                    "attribution":"Courtesy of...",
                    "caption":"Emergence",
                    "url":".../Figure_12_ISUE300.jpg"
                },...
            ],
            "name":"VE - Emergence",
            "order":"1"
        },...
    }
}

Sorghum In-Field Drydown - v1.0

Drawing from the ClearAg Field Weather API and sorghum growth model, the Sorghum In-Field Drydown endpoint simulates the drying process of sorghum in the field after the crop achieves full maturity, and provides daily moisture estimates during the drydown period. If Accounts API integration is used, any available moisture measurements are used to improve model results.

URL Description

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

Request Parameters

Parameter Type Location-based Account API Integration Description

app_id

string

yes

yes

API ID provided by Iteris.

app_key

string

yes

yes

API key provided by Iteris.

account_id

string

no

yes

A unique account ID provided by your Iteris account representative.

user_id

string

no

yes

User ID provided by the Account 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 Growth Creation endpoint. If provided, properties of this growth will be used to generate model results.

location

lat, lon coordinates

yes

 — 

Lat-lon coordinates of the field in decimal degrees. Format is: [(lat1, lon1), ...]. Users are allowed a maximum of five coordinates.1

plant_date

timestamp

no*

 — 

Date that the crop was planted in the form of a Unix timestamp. *Required if emergence_date is not provided.

emergence_date

timestamp

no*

 — 

Date that the crop began to emerge from the soil, in the form of a Unix timestamp. *Required if plant_date is not provided.

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."

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 in degrees Fahrenheit. Obtained from historical, forecast, or climatological data, depending on the timeframe.

air_temp_min

Minimum daily air temperature in degrees Fahrenheit. Obtained from historical, forecast, or climatological data, depending on the timeframe.

equilibrium_moisture_content

The wet-basis moisture content, in percent, at which the grain is neither gaining nor losing moisture. Changes with relative humidity and air temperature. Provided after the crop fully matures. Note that wet-basis moisture content is defined as the ratio of the mass of water to the total mass of a sample of grain.

feedback_id

If this parameter is present, it indicates a confirmed or observed growth stage.

field_activity_id

If this parameter is present, it indicates a confirmed or observed moisture sample.

gdd

Growing degree days accumulated on the current date.

grain_moisture_content

Percent wet-basis moisture content of the grain at the end of the day. Provided after the crop fully matures.

grain_moisture_content_change

The change in the amount of wet-basis moisture in the grain since the previous day, in percent. Positive values indicate that the moisture content has increased, and negative values indicate that the moisture content has decreased. Provided after the crop fully matures.

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. "n/a" if 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/infield_drydown?app_id=456&app_key=789&account_id=123&user_id=xyz-123&growth_id=abc-def

Example Response

{
    "attribution":[
        "Growth model based on...",...
    ],
    "data":{
        "47,-97":{
            "2016-10-15":{
                "agdd":2746.5,
                "air_temp_max":70.0,
                "air_temp_min":42.0,
                "equilibrium_moisture_content":11.54,
                "feedback_id":"111-b2b",
                "gdd":11.0,
                "grain_moisture_content":29.56,
                "grain_moisture_content_change":"n/a",
                "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"
        },...
    }
}

Soybean In-Field Drydown - v1.0

Drawing from the ClearAg Field Weather API and soybean growth model, the Soybean In-Field Drydown endpoint simulates the drying process of soybean in the field after the crop achieves full maturity, and provides daily moisture estimates during the drydown period. If Accounts API integration is used, any available moisture measurements are used to improve model results.

URL Description

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

Request Parameters

Parameter Type Location-based Account API Integration Description

app_id

string

yes

yes

API ID provided by Iteris.

app_key

string

yes

yes

API key provided by Iteris.

account_id

string

no

yes

A unique account ID provided by your Iteris account representative.

user_id

string

no

yes

User ID provided by the Account 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 Growth Creation endpoint. If provided, properties of this growth will be used to generate model results.

location

lat, lon coordinates

yes

 — 

Lat-lon coordinates of the field in decimal degrees. Format is: [(lat1, lon1), ...]. Users are allowed a maximum of five coordinates.1

plant_date

timestamp

no*

 — 

Date that the crop was planted in the form of a Unix timestamp. *Required if emergence_date is not provided.

emergence_date

timestamp

no*

 — 

Date that the crop began to emerge from the soil, in the form of a Unix timestamp. *Required if plant_date is not provided.

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 centimeters that the crop was planted. Valid values range from 0.1 to 7.5 cm. Default is 3.5.

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_avg

Average daily air temperature in degrees Fahrenheit. Obtained from historical, forecast, or climatological data, depending on the timeframe.

air_temp_max

Maximum daily air temperature in degrees Fahrenheit. Obtained from historical, forecast, or climatological data, depending on the timeframe.

air_temp_min

Minimum daily air temperature in degrees Fahrenheit. Obtained from historical, forecast, or climatological data, depending on the timeframe.

equilibrium_moisture_content

The wet-basis moisture content, in percent, at which the grain is neither gaining nor losing moisture. Changes with relative humidity and air temperature. Provided after the crop fully matures. Note that wet-basis moisture content is defined as the ratio of the mass of water to the total mass of a sample of grain.

feedback_id

If this parameter is present, it indicates a confirmed or observed growth stage.

field_activity_id

If this parameter is present, it indicates a confirmed or observed moisture sample.

gdd

Growing degree days accumulated on the current date.

grain_moisture_content

Percent wet-basis moisture content of the grain at the end of the day. Provided after the crop fully matures.

grain_moisture_content_change

The change in the amount of wet-basis moisture in the grain since the previous day, in percent. Positive values indicate that the moisture content has increased, and negative values indicate that the moisture content has decreased. Provided after the crop fully matures.

last_reproductive_stage

The last known reproductive stage.

last_stage

Growing degree days accumulated on the current date. 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 last known reproductive 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. Obtained from historical, forecast, or climatological data, depending on the timeframe.

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/soybean/infield_drydown?app_id=456&app_key=789&account_id=123&user_id=xyz-123&growth_id=abc-def

Example Response

{
    "attribution":[
        "Growth model based on...",...
    ],
    "data":{
        "47,-97":{
            "2016-08-10":{
                "agdd":1546.09,
                "air_temp_avg":71.0,
                "air_temp_max":86.0,
                "air_temp_min":57.0,
                "equilibrium_moisture_content":7.22,
                "feedback_id":"111-b2b",
                "gdd":16.58,
                "grain_moisture_content":11.62,
                "grain_moisture_content_change":1.33,
                "last_reproductive_stage":"R6",
                "last_stage":"R6",
                "last_vegetative_stage":"V1",
                "new_reproductive_stage":"n/a",
                "new_stage":"n/a",
                "new_vegetative_stage":"n/a",
                "relative_humidity_avg":54.0
            },...
        }
    },
    "harvest_window":{
        "end":"2016-10-12",
        "start":"2016-09-17"
    },
    "stage_descriptions":{
        "R6":{
            "advisor":"Harvest",
            "description":"Full Seed - pod containing a green seed that fills the pod cavity at one of the four uppermost nodes on the main stem with a fully developed trifoliate leaf node",
            "images":[
                {
                    "attribution":"Courtesy of...",
                    "caption":"R6 - Full seed",
                    "url":".../R6.jpg"
                },...
            ],
            "name":"R6 - Full Seed",
            "order":"12"
        },...
    }
}

Spring Wheat In-Field Drydown - v1.0

Drawing from the ClearAg Field Weather API and spring wheat growth model, the Spring Wheat In-Field Drydown endpoint simulates the drying process of spring wheat in the field after the crop achieves full maturity, and provides daily moisture estimates during the drydown period. If Accounts API integration is used, any available moisture measurements are used to improve model results.

URL Description

https://ag.us.clearapis.com/v1.0/crop_health/springwheat/infield_drydown?app_id={string}&app_key={string}&account_id={string}&user_id={string}&growth_id={string}&location={lat, lon coordinates}&plant_date={timestamp}&emergence_date={timestamp}&relative_maturity={string}&scale={string}

Request Parameters

Parameter Type Location-based Account API Integration Description

app_id

string

yes

yes

API ID provided by Iteris.

app_key

string

yes

yes

API key provided by Iteris.

account_id

string

no

yes

A unique account ID provided by your Iteris account representative.

user_id

string

no

yes

User ID provided by the Account 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 Growth Creation endpoint. If provided, properties of this growth will be used to generate model results.

location

lat, lon coordinates

yes

 — 

Lat-lon coordinates of the field in decimal degrees. Format is: [(lat1, lon1), ...]. Users are allowed a maximum of five coordinates.1

plant_date

timestamp

no*

 — 

Date that the crop was planted in the form of a Unix timestamp. *Required if emergence_date is not provided.

emergence_date

timestamp

no*

 — 

Date that the crop began to emerge from the soil, in the form of a Unix timestamp. *Required if plant_date is not provided.

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.

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 in degrees Fahrenheit. Obtained from historical, forecast, or climatological data, depending on the timeframe.

air_temp_min

Minimum daily air temperature in degrees Fahrenheit. Obtained from historical, forecast, or climatological data, depending on the timeframe.

equilibrium_moisture_content

The wet-basis moisture content, in percent, at which the grain is neither gaining nor losing moisture. Changes with relative humidity and air temperature. Provided after the crop fully matures. Note that wet-basis moisture content is defined as the ratio of the mass of water to the total mass of a sample of grain.

feedback_id

If this parameter is present, it indicates a confirmed or observed growth stage.

field_activity_id

If this parameter is present, it indicates a confirmed or observed moisture sample.

gdd

Growing degree days accumulated on the current date.

grain_moisture_content

Percent wet-basis moisture content of the grain at the end of the day. Provided after the crop fully matures.

grain_moisture_content_change

The change in the amount of wet-basis moisture in the grain since the previous day, in percent. Positive values indicate that the moisture content has increased, and negative values indicate that the moisture content has decreased. Provided after the crop fully matures.

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. "n/a" if 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.

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.

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/springwheat/infield_drydown?app_id=456&app_key=789&account_id=123&user_id=xyz-123&growth_id=abc-def

Example Response

{
    "attribution":[
        "Growth model based on...",...
    ],
    "data":{
        "39,-103":{
            "2016-08-10":{
                "agdd":4451.5,
                "air_temp_max":84.0,
                "air_temp_min":56.0,
                "equilibrium_moisture_content":6.65,
                "feedback_id":"111-b2b",
                "gdd":40.0,
                "grain_moisture_content":6.55,
                "grain_moisture_content_change":0.02,
                "last_stage":"20",
                "new_stage":"n/a"
            },...
        }
    },
    "harvest_window":{
        "end":"2016-10-12",
        "start":"2016-09-17"
    },
    "stage_descriptions":{
        "101":{
            "advisor":"Nutrient",
            "applicable_scales":{
                "feekes":"1",
                "haun":"0.5",
                "zadoks":"10"
            },
            "description":"The first leaf is at half of its final length.",
            "images":[
                {
                    "attribution":"Courtesy of...",
                    "caption":"Emergence",
                    "url":".../Coleoptile.jpg"
                },...
            ],
            "name":"Emergence",
            "order":"1"
        },...
    }
}

Sunflower In-Field Drydown - v1.0

Drawing from the ClearAg Field Weather API and sunflower growth model, the Sunflower In-Field Drydown endpoint simulates the drying process of sunflower in the field after the crop achieves full maturity, and provides daily moisture estimates during the drydown period. If Accounts API integration is used, any available moisture measurements are used to improve model results.

URL Description

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

Request Parameters

Parameter Type Location-based Account API Integration Description

app_id

string

yes

yes

API ID provided by Iteris.

app_key

string

yes

yes

API key provided by Iteris.

account_id

string

no

yes

A unique account ID provided by your Iteris account representative.

user_id

string

no

yes

User ID provided by the Account 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 Growth Creation endpoint. If provided, properties of this growth will be used to generate model results.

location

lat, lon coordinates

yes

 — 

Lat-lon coordinates of the field in decimal degrees. Format is: [(lat1, lon1), ...]. Users are allowed a maximum of five coordinates.1

plant_date

timestamp

no*

 — 

Date that the crop was planted in the form of a Unix timestamp. *Required if emergence_date is not provided.

emergence_date

timestamp

no*

 — 

Date that the crop began to emerge from the soil, in the form of a Unix timestamp. *Required if plant_date is not provided.

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."

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 in degrees Fahrenheit. Obtained from historical, forecast, or climatological data, depending on the timeframe.

air_temp_min

Minimum daily air temperature in degrees Fahrenheit. Obtained from historical, forecast, or climatological data, depending on the timeframe.

equilibrium_moisture_content

The wet-basis moisture content, in percent, at which the grain is neither gaining nor losing moisture. Changes with relative humidity and air temperature. Provided after the crop fully matures. Note that wet-basis moisture content is defined as the ratio of the mass of water to the total mass of a sample of grain.

feedback_id

If this parameter is present, it indicates a confirmed or observed growth stage.

field_activity_id

If this parameter is present, it indicates a confirmed or observed moisture sample.

gdd

Growing degree days accumulated on the current date.

grain_moisture_content

Percent wet-basis moisture content of the grain at the end of the day. Provided after the crop fully matures.

grain_moisture_content_change

The change in the amount of wet-basis moisture in the grain since the previous day, in percent. Positive values indicate that the moisture content has increased, and negative values indicate that the moisture content has decreased. Provided after the crop fully matures.

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. "n/a" if 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/infield_drydown?app_id=456&app_key=789&account_id=123&user_id=xyz-123&growth_id=abc-def

Example Response

{
    "attribution":[
        "Growth model based on...",...
    ],
    "data":{
        "47,-97":{
            "2016-08-30":{
                "agdd":2886.0,
                "air_temp_max":81.0,
                "air_temp_min":50.0,
                "equilibrium_moisture_content":5.8,
                "gdd":21.5,
                "grain_moisture_content":30.99,
                "grain_moisture_content_change":"n/a",
                "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"
        },...
    }
}

Winter Wheat In-Field Drydown - v1.0

Drawing from the ClearAg Field Weather API and winter wheat growth model, the Winter Wheat In-Field Drydown endpoint simulates the drying process of winter wheat in the field after the crop achieves full maturity, and provides daily moisture estimates during the drydown period. If Accounts API integration is used, any available moisture measurements are used to improve model results.

URL Description

https://ag.us.clearapis.com/v1.0/crop_health/winter_wheat/infield_drydown?app_id={string}&app_key={string}&account_id={string}&user_id={string}&growth_id={string}&location={lat, lon coordinates}&plant_date={timestamp}&emergence_date={timestamp}&relative_maturity={string}&plant_depth={float}&scale={string}

Request Parameters

Parameter Type Location-based Account API Integration Description

app_id

string

yes

yes

API ID provided by Iteris.

app_key

string

yes

yes

API key provided by Iteris.

account_id

string

no

yes

A unique account ID provided by your Iteris account representative.

user_id

string

no

yes

User ID provided by the Account 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 Growth Creation endpoint. If provided, properties of this growth will be used to generate model results.

location

lat, lon coordinates

yes

 — 

Lat-lon coordinates of the field in decimal degrees. Format is: [(lat1, lon1), ...]. Users are allowed a maximum of five coordinates.1

plant_date

timestamp

no*

 — 

Date that the crop was planted in the form of a Unix timestamp. *Required if emergence_date is not provided.

emergence_date

timestamp

no*

 — 

Date that the crop began to emerge from the soil, in the form of a Unix timestamp. *Required if plant_date is not provided.

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. Possible values range from 0.1 to 10.0 cm. The default is 5.0 cm.

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.

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

Response Object (JSON)

Field Description

agdd

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

air_temp_max

Maximum daily air temperature in degrees Fahrenheit. Obtained from historical, forecast, or climatological data, depending on the timeframe.

air_temp_min

Minimum daily air temperature in degrees Fahrenheit. Obtained from historical, forecast, or climatological data, depending on the timeframe.

equilibrium_moisture_content

The wet-basis moisture content, in percent, at which the grain is neither gaining nor losing moisture. Changes with relative humidity and air temperature. Provided after the crop fully matures. Note that wet-basis moisture content is defined as the ratio of the mass of water to the total mass of a sample of grain.

feedback_id

If this parameter is present, it indicates a confirmed or observed growth stage.

field_activity_id

If this parameter is present, it indicates a confirmed or observed moisture sample.

gdd

Growing degree days accumulated on the current date.

grain_moisture_content

Percent wet-basis moisture content of the grain at the end of the day. Provided after the crop fully matures.

grain_moisture_content_change

The change in the amount of wet-basis moisture in the grain since the previous day, in percent. Positive values indicate that the moisture content has increased, and negative values indicate that the moisture content has decreased. Provided after the crop fully matures.

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. "n/a" if 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.

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.

description

Text description for a stage.

order

Relative position of the stage within the growth scale.

Example Request

https://ag.us.clearapis.com/v1.0/crop_health/winter_wheat/infield_drydown?app_id=456&app_key=789&account_id=123&user_id=xyz-123&growth_id=abc-def

Example Response

{
    "data":{
        "39,-103":{
            "2016-08-10":{
                "agdd":4439.61,
                "air_temp_max":80.0,
                "air_temp_min":65.0,
                "equilibrium_moisture_content":6.48,
                "feedback_id":"111-b2b",
                "gdd":22.97,
                "grain_moisture_content":5.62,
                "grain_moisture_content_change":-0.10,
                "last_stage":"13",
                "new_stage":"n/a"
            },...
        }
    },
    "harvest_window":{
        "end":"2016-08-26",
        "start":"2016-08-08"
    },
    "stage_descriptions":{
        "0":{
            "advisor":"Nutrient",
            "applicable_scales":{
                "feekes":"n/a",
                "haun":"n/a",
                "zadoks":"05"
            },
            "description":"Germination",
            "order":"1"
        },...
    }
}

Mechanical Drying

Barley Mechanical Drying - v1.0

The Barley Mechanical Drying endpoint simulates the drydown process of spring barley using either fan-powered low-temperature drying or burner-driven high-temperature drying facilities to provide drying statistics and cost projections. The mechanical drying process is simulated using up to 10 future days of grain moisture estimates. Results from the spring barley in-field drying model are also returned for comparison.

Note that a field, growth, and drying facility are required to utilize this feature. Any available moisture measurements are used to improve model results.

Please be aware that mechanical drying data will not be returned if moisture estimates are unable to be obtained from the spring barley in-field drying model. This may occur if one of the following conditions are met:

  • The spring barley growth model simulation does not bring the crop to maturity. This is more likely to occur for certain location (e.g., cooler climates) and relative maturity combinations.

  • The crop planting date or emergence date are too far in the past. The models are designed for future planning; users can utilize the "current_date" argument to determine what model results could have been on a past date. These results can be different than what would have been seen on the emulated date, as the forecast timeframes are now filled with historical data.

URL Description

https://ag.us.clearapis.com/v1.0/crop_health/barley/mechanical_drying?app_id={string}&app_key={string}&account_id={string}&user_id={string}&growth_id={string}&drying_facility_ids={string}&target_moisture_content_wb={float}&grain_unit={string}&current_date={timestamp}

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 Account 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 Growth Creation endpoint. Properties of this growth will be used to generate model results.

drying_facility_ids

string

no

Comma-delimited list of drying facility IDs to be used. Currently, only the most recently created facility in the list will be used. Default behavior is to use the most recently created facility overall. Note that the calling user must have at least read privileges for the asset (drying facility).

target_moisture_content_wb

float

yes

Desired wet-basis moisture level for safe storage, in percent. Wet-basis moisture content is defined as the ratio of the mass of water to the total mass of a sample of grain.

grain_unit

string

yes

Units to use when returning unit costs of drying. Valid values include "bu" (bushel) and "mt" (metric ton).

current_date

timestamp

no

Since by default the model only provides results for dates in the future, this feature can be useful when paired with a growth from a past growing season to provide historical model results.

Response Object (JSON)

Field Description

asset_id

The ID given to a particular drying facility.

burner_fuel_type

Type of fuel consumed by the burner.

burner_fuel_unit

Unit of measure associated with the fuel type.

driest_datetime

Time that the grain reached its lowest moisture content of the model run. Represented by a date string in the case of low-temperature drying or hours and minutes in the case of high-temperature drying. Note that the simulation will stop when the user-specified target moisture content is reached, in which case this will indicate the timing of the grain reaching that threshold.

driest_moisture_content_db

Driest dry-basis grain moisture content of the simulation, in percent. Dry-basis moisture content is defined as the ratio of the mass of water to the dry mass of a sample of grain.

driest_moisture_content_wb

Driest wet-basis grain moisture content of the simulation, in percent. Wet-basis moisture content is defined as the ratio of the mass of water to the total mass of a sample of grain.

dryer_throughput_grain_units_per_hour

Amount of grain dried per hour. Applicable only in high-temperature drying facilities.

drying_time

Amount of time, in seconds, that elapsed for the grain to reach its lowest moisture content.

grain_storability

Likelihood of spoilage. Possible values include "0," indicating that grain is not likely to spoil; "1," indicating a marginal risk; and "2," warning that spoilage is likely. When high-temperature drying is in use, "n/a" will be used.

grain_unit

Unit of measure associated with the volume of grain as provided by the user.

per_grain_unit/burner_fuel_cost

Expected burner fuel cost per unit of grain, in the user’s local currency, and in the grain unit provided by the user.

per_grain_unit/burner_fuel_units_consumed

Expected amount of fuel consumed by the burner per unit of grain, in the grain unit provided by the user.

per_grain_unit/burner_kwh_consumed

Expected amount of fuel energy, in kilowatt-hours, consumed by the burner per unit of grain, in the grain unit provided by the user.

per_grain_unit/electricity_cost

Expected electricity cost per unit of grain, in the user’s local currency, and in the grain unit provided by the user.

per_grain_unit/electricity_kwh_consumed

Expected amount of electrical energy, in kilowatt-hours, consumed by the fan per unit of grain, in the grain unit provided by the user.

per_grain_unit/total_cost

Expected total drying cost per unit of grain, in the user’s local currency, and in the grain unit provided by the user.

per_grain_unit_per_percent_moisture/total_cost

Expected total drying cost per unit of grain per percent moisture change, in the user’s local currency, and in the grain unit provided by the user.

sample_datetime

Valid time of the grain moisture sample provided by the in-field drydown model.

sample_moisture_content_wb

Starting wet-basis moisture content of the grain sample, in percent, provided by the in-field drydown model.

simulation_length

Total length of time, in seconds, over which the drydown process was modeled.

target_moisture_reached

Flag indicating whether the target storage moisture content is reached in the simulation, where "1" indicates that the storage moisture is reached and "0" indicates it is not. Primarily applicable in low-temperature drying facilities, where ambient environmental conditions may not permit an adequate amount of drying.

name

The user-provided name of the drying facility. If this is not supplied, a generic name of "Drying Facility" followed by a number is used.

agdd

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

air_temp_max

Maximum daily air temperature in degrees Fahrenheit. Obtained from historical, forecast, or climatological data, depending on the timeframe.

air_temp_min

Minimum daily air temperature in degrees Fahrenheit. Obtained from historical, forecast, or climatological data, depending on the timeframe.

equilibrium_moisture_content

The wet-basis moisture content, in percent, at which the grain is neither gaining nor losing moisture. Changes with relative humidity and air temperature. Provided after the crop fully matures. Note that wet-basis moisture content is defined as the ratio of the mass of water to the total mass of a sample of grain.

feedback_id

If this parameter is present, it indicates a confirmed or observed growth stage.

field_activity_id

If this parameter is present, it indicates a confirmed or observed moisture sample.

gdd

Growing degree days accumulated on the current date.

grain_moisture_content

Percent wet-basis moisture content of the grain at the end of the day. Provided after the crop fully matures.

grain_moisture_content_change

The change in the amount of wet-basis moisture in the grain since the previous day, in percent. Positive values indicate that the moisture content has increased, and negative values indicate that the moisture content has decreased. Provided after the crop fully matures.

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. "n/a" if the crop is somewhere between the previous growth stage and the next growth stage.

Example Request

https://ag.us.clearapis.com/v1.0/crop_health/barley/mechanical_drying?app_id=456&app_key=789&account_id=123&user_id=xyz-123&growth_id=abc-def&target_moisture_content_wb=14.5&grain_unit=bu

Example Response

{
    "drying_facilities":[
        {
            "asset_id":"abc-123",
            "data":[
                {
                    "burner_fuel_type":"liquid_propane",
                    "burner_fuel_unit":"gallon",
                    "driest_datetime":"02:38",
                    "driest_moisture_content_db":16.95,
                    "driest_moisture_content_wb":14.49,
                    "dryer_throughput_grain_units_per_hour":537.0,
                    "drying_time":9505,
                    "grain_storability":"n/a",
                    "grain_unit":"bu",
                    "per_grain_unit":{
                        "burner_fuel_cost":0.233,
                        "burner_fuel_units_consumed":0.259,
                        "burner_kwh_consumed":6.39,
                        "electricity_cost":0.209,
                        "electricity_kwh_consumed":0.42,
                        "total_cost":0.442
                    },
                    "per_grain_unit_per_percent_moisture":{
                        "total_cost":0.023
                    },
                    "sample_datetime":"2016-07-07",
                    "sample_moisture_content_wb":33.77,
                    "simulation_length":9505,
                    "target_moisture_reached":1
                },...
            ],
            "name":"Barley Dryer"
        }
    ],
    "infield_drydown_data":{
        "47,-97":{
            "2016-07-07":{
                "agdd":2208.0,
                "air_temp_max":78.0,
                "air_temp_min":64.0,
                "equilibrium_moisture_content":12.18,
                "gdd":39.0,
                "grain_moisture_content":33.77,
                "grain_moisture_content_change":"n/a",
                "last_stage":13.0,
                "new_stage":15.0
            },...
        }
    }
}

Canola Mechanical Drying - v1.0

The Canola Mechanical Drying endpoint simulates the drydown process of canola using either fan-powered low-temperature drying or burner-driven high-temperature drying facilities to provide drying statistics and cost projections. The mechanical drying process is simulated using up to 10 future days of grain moisture estimates. Results from the canola in-field drying model are also returned for comparison.

Note that a field, growth, and drying facility are required to utilize this feature. Any available moisture measurements are used to improve model results.

Please be aware that mechanical drying data will not be returned if moisture estimates are unable to be obtained from the canola in-field drying model. This may occur if one of the following conditions are met:

  • The canola growth model simulation does not bring the crop to maturity. This is more likely to occur for certain location (e.g., cooler climates) and relative maturity combinations.

  • The crop planting date or emergence date are too far in the past. The models are designed for future planning; users can utilize the "current_date" argument to determine what model results could have been on a past date. These results can be different than what would have been seen on the emulated date, as the forecast timeframes are now filled with historical data.

URL Description

https://ag.us.clearapis.com/v1.0/crop_health/canola/mechanical_drying?app_id={string}&app_key={string}&account_id={string}&user_id={string}&growth_id={string}&drying_facility_ids={string}&target_moisture_content_wb={float}&grain_unit={string}&current_date={timestamp}

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 Account 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 Growth Creation endpoint. Properties of this growth will be used to generate model results.

drying_facility_ids

string

no

Comma-delimited list of drying facility IDs to be used. Currently, only the most recently created facility in the list will be used. Default behavior is to use the most recently created facility overall. Note that the calling user must have at least read privileges for the asset (drying facility).

target_moisture_content_wb

float

yes

Desired wet-basis moisture level for safe storage, in percent. Wet-basis moisture content is defined as the ratio of the mass of water to the total mass of a sample of grain.

grain_unit

string

yes

Units to use when returning unit costs of drying. Valid values include "bu" (bushel) and "mt" (metric ton).

current_date

timestamp

no

Since by default the model only provides results for dates in the future, this feature can be useful when paired with a growth from a past growing season to provide historical model results.

Response Object (JSON)

Field Description

asset_id

The ID given to a particular drying facility.

burner_fuel_type

Type of fuel consumed by the burner.

burner_fuel_unit

Unit of measure associated with the fuel type.

driest_datetime

Time that the grain reached its lowest moisture content of the model run. Represented by a date string in the case of low-temperature drying or hours and minutes in the case of high-temperature drying. Note that the simulation will stop when the user-specified target moisture content is reached, in which case this will indicate the timing of the grain reaching that threshold.

driest_moisture_content_db

Driest dry-basis grain moisture content of the simulation, in percent. Dry-basis moisture content is defined as the ratio of the mass of water to the dry mass of a sample of grain.

driest_moisture_content_wb

Driest wet-basis grain moisture content of the simulation, in percent. Wet-basis moisture content is defined as the ratio of the mass of water to the total mass of a sample of grain.

dryer_throughput_grain_units_per_hour

Amount of grain dried per hour. Applicable only in high-temperature drying facilities.

drying_time

Amount of time, in seconds, that elapsed for the grain to reach its lowest moisture content.

grain_storability

Likelihood of spoilage. Possible values include "0," indicating that grain is not likely to spoil; "1," indicating a marginal risk; and "2," warning that spoilage is likely. When high-temperature drying is in use, "n/a" will be used.

grain_unit

Unit of measure associated with the volume of grain as provided by the user.

per_grain_unit/burner_fuel_cost

Expected burner fuel cost per unit of grain, in the user’s local currency, and in the grain unit provided by the user.

per_grain_unit/burner_fuel_units_consumed

Expected amount of fuel consumed by the burner per unit of grain, in the grain unit provided by the user.

per_grain_unit/burner_kwh_consumed

Expected amount of fuel energy, in kilowatt-hours, consumed by the burner per unit of grain, in the grain unit provided by the user.

per_grain_unit/electricity_cost

Expected electricity cost per unit of grain, in the user’s local currency, and in the grain unit provided by the user.

per_grain_unit/electricity_kwh_consumed

Expected amount of electrical energy, in kilowatt-hours, consumed by the fan per unit of grain, in the grain unit provided by the user.

per_grain_unit/total_cost

Expected total drying cost per unit of grain, in the user’s local currency, and in the grain unit provided by the user.

per_grain_unit_per_percent_moisture/total_cost

Expected total drying cost per unit of grain per percent moisture change, in the user’s local currency, and in the grain unit provided by the user.

sample_datetime

Valid time of the grain moisture sample provided by the in-field drydown model.

sample_moisture_content_wb

Starting wet-basis moisture content of the grain sample, in percent, provided by the in-field drydown model.

simulation_length

Total length of time, in seconds, over which the drydown process was modeled.

target_moisture_reached

Flag indicating whether the target storage moisture content is reached in the simulation, where "1" indicates that the storage moisture is reached and "0" indicates it is not. Primarily applicable in low-temperature drying facilities, where ambient environmental conditions may not permit an adequate amount of drying.

name

The user-provided name of the drying facility. If this is not supplied, a generic name of "Drying Facility" followed by a number is used.

agdd

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

air_temp_max

Maximum daily air temperature in degrees Fahrenheit. Obtained from historical, forecast, or climatological data, depending on the timeframe.

air_temp_min

Minimum daily air temperature in degrees Fahrenheit. Obtained from historical, forecast, or climatological data, depending on the timeframe.

equilibrium_moisture_content

The wet-basis moisture content, in percent, at which the grain is neither gaining nor losing moisture. Changes with relative humidity and air temperature. Provided after the crop fully matures. Note that wet-basis moisture content is defined as the ratio of the mass of water to the total mass of a sample of grain.

feedback_id

If this parameter is present, it indicates a confirmed or observed growth stage.

field_activity_id

If this parameter is present, it indicates a confirmed or observed moisture sample.

gdd

Growing degree days accumulated on the current date.

grain_moisture_content

Percent wet-basis moisture content of the grain at the end of the day. Provided after the crop fully matures.

grain_moisture_content_change

The change in the amount of wet-basis moisture in the grain since the previous day, in percent. Positive values indicate that the moisture content has increased, and negative values indicate that the moisture content has decreased. Provided after the crop fully matures.

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. "n/a" if the crop is somewhere between the previous growth stage and the next growth stage.

Example Request

https://ag.us.clearapis.com/v1.0/crop_health/canola/mechanical_drying?app_id=456&app_key=789&account_id=123&user_id=xyz-123&growth_id=abc-def&target_moisture_content_wb=14.5&grain_unit=bu

Example Response

{
    "drying_facilities":[
        {
            "asset_id":"abc-123",
            "data":[
                {
                    "burner_fuel_type":"liquid_propane",
                    "burner_fuel_unit":"gallon",
                    "driest_datetime":"01:32",
                    "driest_moisture_content_db":16.96,
                    "driest_moisture_content_wb":14.5,
                    "dryer_throughput_grain_units_per_hour":922.0,
                    "drying_time":5540,
                    "grain_storability":"n/a",
                    "grain_unit":"bu",
                    "per_grain_unit":{
                        "burner_fuel_cost":0.168,
                        "burner_fuel_units_consumed":0.186,
                        "burner_kwh_consumed":4.6,
                        "electricity_cost":0.395,
                        "electricity_kwh_consumed":0.79,
                        "total_cost":0.563
                    },
                    "per_grain_unit_per_percent_moisture":{
                        "total_cost":0.031
                    },
                    "sample_datetime":"2016-07-16",
                    "sample_moisture_content_wb":32.87,
                    "simulation_length":5540,
                    "target_moisture_reached":1
                },...
            ],
            "name":"Canola Dryer"
        }
    ],
    "infield_drydown_data":{
        "47,-97":{
            "2016-07-16":{
                "agdd":1894.0,
                "air_temp_max":77.0,
                "air_temp_min":58.0,
                "equilibrium_moisture_content":6.32,
                "gdd":26.5,
                "grain_moisture_content":32.87,
                "grain_moisture_content_change":"n/a",
                "last_stage":"ER",
                "new_stage":"R"
            },...
        }
    }
}

Corn Mechanical Drying - v1.0

The Corn Mechanical Drying endpoint simulates the drydown process of corn using either fan-powered low-temperature drying or burner-driven high-temperature drying facilities to provide drying statistics and cost projections. The mechanical drying process is simulated using up to 10 future days of grain moisture estimates. Results from the corn in-field drying model are also returned for comparison.

Note that a field, growth, and drying facility are required to utilize this feature. Any available moisture measurements are used to improve model results.

Please be aware that mechanical drying data will not be returned if moisture estimates are unable to be obtained from the corn in-field drying model. This may occur if one of the following conditions are met:

  • The corn growth model simulation does not bring the crop to maturity. This is more likely to occur for certain location (e.g., cooler climates) and relative maturity combinations.

  • The crop planting date or emergence date are too far in the past. The models are designed for future planning; users can utilize the "current_date" argument to determine what model results could have been on a past date. These results can be different than what would have been seen on the emulated date, as the forecast timeframes are now filled with historical data.

URL Description

https://ag.us.clearapis.com/v1.0/crop_health/corn/mechanical_drying?app_id={string}&app_key={string}&account_id={string}&user_id={string}&growth_id={string}&drying_facility_ids={string}&target_moisture_content_wb={float}&grain_unit={string}&current_date={timestamp}

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 Account 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 Growth Creation endpoint. Properties of this growth will be used to generate model results.

drying_facility_ids

string

no

Comma-delimited list of drying facility IDs to be used. Currently, only the most recently created facility in the list will be used. Default behavior is to use the most recently created facility overall. Note that the calling user must have at least read privileges for the asset (drying facility).

target_moisture_content_wb

float

yes

Desired wet-basis moisture level for safe storage, in percent. Wet-basis moisture content is defined as the ratio of the mass of water to the total mass of a sample of grain.

grain_unit

string

yes

Units to use when returning unit costs of drying. Valid values include "bu" (bushel) and "mt" (metric ton).

current_date

timestamp

no

Since by default the model only provides results for dates in the future, this feature can be useful when paired with a growth from a past growing season to provide historical model results.

Response Object (JSON)

Field Description

asset_id

The ID given to a particular drying facility.

burner_fuel_type

Type of fuel consumed by the burner.

burner_fuel_unit

Unit of measure associated with the fuel type.

driest_datetime

Time that the grain reached its lowest moisture content of the model run. Represented by a date string in the case of low-temperature drying or hours and minutes in the case of high-temperature drying. Note that the simulation will stop when the user-specified target moisture content is reached, in which case this will indicate the timing of the grain reaching that threshold.

driest_moisture_content_db

Driest dry-basis grain moisture content of the simulation, in percent. Dry-basis moisture content is defined as the ratio of the mass of water to the dry mass of a sample of grain.

driest_moisture_content_wb

Driest wet-basis grain moisture content of the simulation, in percent. Wet-basis moisture content is defined as the ratio of the mass of water to the total mass of a sample of grain.

dryer_throughput_grain_units_per_hour

Amount of grain dried per hour. Applicable only in high-temperature drying facilities.

drying_time

Amount of time, in seconds, that elapsed for the grain to reach its lowest moisture content.

grain_storability

Likelihood of spoilage. Possible values include "0," indicating that grain is not likely to spoil; "1," indicating a marginal risk; and "2," warning that spoilage is likely. When high-temperature drying is in use, "n/a" will be used.

grain_unit

Unit of measure associated with the volume of grain as provided by the user.

per_grain_unit/burner_fuel_cost

Expected burner fuel cost per unit of grain, in the user’s local currency, and in the grain unit provided by the user.

per_grain_unit/burner_fuel_units_consumed

Expected amount of fuel consumed by the burner per unit of grain, in the grain unit provided by the user.

per_grain_unit/burner_kwh_consumed

Expected amount of fuel energy, in kilowatt-hours, consumed by the burner per unit of grain, in the grain unit provided by the user.

per_grain_unit/electricity_cost

Expected electricity cost per unit of grain, in the user’s local currency, and in the grain unit provided by the user.

per_grain_unit/electricity_kwh_consumed

Expected amount of electrical energy, in kilowatt-hours, consumed by the fan per unit of grain, in the grain unit provided by the user.

per_grain_unit/total_cost

Expected total drying cost per unit of grain, in the user’s local currency, and in the grain unit provided by the user.

per_grain_unit_per_percent_moisture/total_cost

Expected total drying cost per unit of grain per percent moisture change, in the user’s local currency, and in the grain unit provided by the user.

sample_datetime

Valid time of the grain moisture sample provided by the in-field drydown model.

sample_moisture_content_wb

Starting wet-basis moisture content of the grain sample, in percent, provided by the in-field drydown model.

simulation_length

Total length of time, in seconds, over which the drydown process was modeled.

target_moisture_reached

Flag indicating whether the target storage moisture content is reached in the simulation, where "1" indicates that the storage moisture is reached and "0" indicates it is not. Primarily applicable in low-temperature drying facilities, where ambient environmental conditions may not permit an adequate amount of drying.

name

The user-provided name of the drying facility. If this is not supplied, a generic name of "Drying Facility" followed by a number is used.

agdd

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

air_temp_max

Maximum daily air temperature in degrees Fahrenheit. Obtained from historical, forecast, or climatological data, depending on the timeframe.

air_temp_min

Minimum daily air temperature in degrees Fahrenheit. Obtained from historical, forecast, or climatological data, depending on the timeframe.

equilibrium_moisture_content

The wet-basis moisture content, in percent, at which the grain is neither gaining nor losing moisture. Changes with relative humidity and air temperature. Provided after the crop fully matures. Note that wet-basis moisture content is defined as the ratio of the mass of water to the total mass of a sample of grain.

feedback_id

If this parameter is present, it indicates a confirmed or observed growth stage.

field_activity_id

If this parameter is present, it indicates a confirmed or observed moisture sample.

gdd

Growing degree days accumulated on the current date.

grain_moisture_content

Percent wet-basis moisture content of the grain at the end of the day. Provided after the crop fully matures.

grain_moisture_content_change

The change in the amount of wet-basis moisture in the grain since the previous day, in percent. Positive values indicate that the moisture content has increased, and negative values indicate that the moisture content has decreased. Provided after the crop fully matures.

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. "n/a" if the crop is somewhere between the previous growth stage and the next growth stage.

Example Request

https://ag.us.clearapis.com/v1.0/crop_health/corn/mechanical_drying?app_id=456&app_key=789&account_id=123&user_id=xyz-123&growth_id=abc-def&target_moisture_content_wb=14.5&grain_unit=bu

Example Response

{
    "drying_facilities":[
        {
            "asset_id":"abc-123",
            "data":[
                {
                    "burner_fuel_type":"liquid_propane",
                    "burner_fuel_unit":"gallon",
                    "driest_datetime":"03:16",
                    "driest_moisture_content_db":16.9,
                    "driest_moisture_content_wb":14.46,
                    "dryer_throughput_grain_units_per_hour":433.0,
                    "drying_time":11790,
                    "grain_storability":"n/a",
                    "grain_unit":"bu",
                    "per_grain_unit":{
                        "burner_fuel_cost":0.265,
                        "burner_fuel_units_consumed":0.294,
                        "burner_kwh_consumed":7.27,
                        "electricity_cost":0.186,
                        "electricity_kwh_consumed":0.37,
                        "total_cost":0.451
                    },
                    "per_grain_unit_per_percent_moisture":{
                        "total_cost":0.027
                    },
                    "sample_datetime":"2016-09-12",
                    "sample_moisture_content_wb":31.02,
                    "simulation_length":11790,
                    "target_moisture_reached":1
                },...
            ],
            "name":"Neco 24180"
        }
    ],
    "infield_drydown_data":{
        "47,-97":{
            "2016-09-12":{
                "agdd":2392.5,
                "air_temp_max":72.0,
                "air_temp_min":50.0,
                "equilibrium_moisture_content":10.39,
                "gdd":11.0,
                "grain_moisture_content":31.02,
                "grain_moisture_content_change":"n/a",
                "last_stage":"r5",
                "new_stage":"r6"
            },...
        }
    }
}

Sorghum Mechanical Drying - v1.0

The Sorghum Mechanical Drying endpoint simulates the drydown process of sorghum using either fan-powered low-temperature drying or burner-driven high-temperature drying facilities to provide drying statistics and cost projections. The mechanical drying process is simulated using up to 10 future days of grain moisture estimates. Results from the sorghum in-field drying model are also returned for comparison.

Note that a field, growth, and drying facility are required to utilize this feature. Any available moisture measurements are used to improve model results.

Please be aware that mechanical drying data will not be returned if moisture estimates are unable to be obtained from the sorghum in-field drying model. This may occur if one of the following conditions are met:

  • The sorghum growth model simulation does not bring the crop to maturity. This is more likely to occur for certain location (e.g., cooler climates) and relative maturity combinations.

  • The crop planting date or emergence date are too far in the past. The models are designed for future planning; users can utilize the "current_date" argument to determine what model results could have been on a past date. These results can be different than what would have been seen on the emulated date, as the forecast timeframes are now filled with historical data.

URL Description

https://ag.us.clearapis.com/v1.0/crop_health/sorghum/mechanical_drying?app_id={string}&app_key={string}&account_id={string}&user_id={string}&growth_id={string}&drying_facility_ids={string}&target_moisture_content_wb={float}&grain_unit={string}&current_date={timestamp}

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 Account 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 Growth Creation endpoint. Properties of this growth will be used to generate model results.

drying_facility_ids

string

no

Comma-delimited list of drying facility IDs to be used. Currently, only the most recently created facility in the list will be used. Default behavior is to use the most recently created facility overall. Note that the calling user must have at least read privileges for the asset (drying facility).

target_moisture_content_wb

float

yes

Desired wet-basis moisture level for safe storage, in percent. Wet-basis moisture content is defined as the ratio of the mass of water to the total mass of a sample of grain.

grain_unit

string

yes

Units to use when returning unit costs of drying. Valid values include "bu" (bushel) and "mt" (metric ton).

current_date

timestamp

no

Since by default the model only provides results for dates in the future, this feature can be useful when paired with a growth from a past growing season to provide historical model results.

Response Object (JSON)

Field Description

asset_id

The ID given to a particular drying facility.

burner_fuel_type

Type of fuel consumed by the burner.

burner_fuel_unit

Unit of measure associated with the fuel type.

driest_datetime

Time that the grain reached its lowest moisture content of the model run. Represented by a date string in the case of low-temperature drying or hours and minutes in the case of high-temperature drying. Note that the simulation will stop when the user-specified target moisture content is reached, in which case this will indicate the timing of the grain reaching that threshold.

driest_moisture_content_db

Driest dry-basis grain moisture content of the simulation, in percent. Dry-basis moisture content is defined as the ratio of the mass of water to the dry mass of a sample of grain.

driest_moisture_content_wb

Driest wet-basis grain moisture content of the simulation, in percent. Wet-basis moisture content is defined as the ratio of the mass of water to the total mass of a sample of grain.

dryer_throughput_grain_units_per_hour

Amount of grain dried per hour. Applicable only in high-temperature drying facilities.

drying_time

Amount of time, in seconds, that elapsed for the grain to reach its lowest moisture content.

grain_storability

Likelihood of spoilage. Possible values include "0," indicating that grain is not likely to spoil; "1," indicating a marginal risk; and "2," warning that spoilage is likely. When high-temperature drying is in use, "n/a" will be used.

grain_unit

Unit of measure associated with the volume of grain as provided by the user.

per_grain_unit/burner_fuel_cost

Expected burner fuel cost per unit of grain, in the user’s local currency, and in the grain unit provided by the user.

per_grain_unit/burner_fuel_units_consumed

Expected amount of fuel consumed by the burner per unit of grain, in the grain unit provided by the user.

per_grain_unit/burner_kwh_consumed

Expected amount of fuel energy, in kilowatt-hours, consumed by the burner per unit of grain, in the grain unit provided by the user.

per_grain_unit/electricity_cost

Expected electricity cost per unit of grain, in the user’s local currency, and in the grain unit provided by the user.

per_grain_unit/electricity_kwh_consumed

Expected amount of electrical energy, in kilowatt-hours, consumed by the fan per unit of grain, in the grain unit provided by the user.

per_grain_unit/total_cost

Expected total drying cost per unit of grain, in the user’s local currency, and in the grain unit provided by the user.

per_grain_unit_per_percent_moisture/total_cost

Expected total drying cost per unit of grain per percent moisture change, in the user’s local currency, and in the grain unit provided by the user.

sample_datetime

Valid time of the grain moisture sample provided by the in-field drydown model.

sample_moisture_content_wb

Starting wet-basis moisture content of the grain sample, in percent, provided by the in-field drydown model.

simulation_length

Total length of time, in seconds, over which the drydown process was modeled.

target_moisture_reached

Flag indicating whether the target storage moisture content is reached in the simulation, where "1" indicates that the storage moisture is reached and "0" indicates it is not. Primarily applicable in low-temperature drying facilities, where ambient environmental conditions may not permit an adequate amount of drying.

name

The user-provided name of the drying facility. If this is not supplied, a generic name of "Drying Facility" followed by a number is used.

agdd

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

air_temp_max

Maximum daily air temperature in degrees Fahrenheit. Obtained from historical, forecast, or climatological data, depending on the timeframe.

air_temp_min

Minimum daily air temperature in degrees Fahrenheit. Obtained from historical, forecast, or climatological data, depending on the timeframe.

equilibrium_moisture_content

The wet-basis moisture content, in percent, at which the grain is neither gaining nor losing moisture. Changes with relative humidity and air temperature. Provided after the crop fully matures. Note that wet-basis moisture content is defined as the ratio of the mass of water to the total mass of a sample of grain.

feedback_id

If this parameter is present, it indicates a confirmed or observed growth stage.

field_activity_id

If this parameter is present, it indicates a confirmed or observed moisture sample.

gdd

Growing degree days accumulated on the current date.

grain_moisture_content

Percent wet-basis moisture content of the grain at the end of the day. Provided after the crop fully matures.

grain_moisture_content_change

The change in the amount of wet-basis moisture in the grain since the previous day, in percent. Positive values indicate that the moisture content has increased, and negative values indicate that the moisture content has decreased. Provided after the crop fully matures.

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. "n/a" if the crop is somewhere between the previous growth stage and the next growth stage.

Example Request

https://ag.us.clearapis.com/v1.0/crop_health/sorghum/mechanical_drying?app_id=456&app_key=789&account_id=123&user_id=xyz-123&growth_id=abc-def&target_moisture_content_wb=14.5&grain_unit=bu

Example Response

{
    "drying_facilities":[
        {
            "asset_id":"abc-123",
            "data":[
                {
                    "burner_fuel_type":"liquid_propane",
                    "burner_fuel_unit":"gallon",
                    "driest_datetime":"09:50",
                    "driest_moisture_content_db":16.96,
                    "driest_moisture_content_wb":14.5,
                    "dryer_throughput_grain_units_per_hour":176.0,
                    "drying_time":35430,
                    "grain_storability":"n/a",
                    "grain_unit":"bu",
                    "per_grain_unit":{
                        "burner_fuel_cost":0.412,
                        "burner_fuel_units_consumed":0.458,
                        "burner_kwh_consumed":11.3,
                        "electricity_cost":0.025,
                        "electricity_kwh_consumed":0.2,
                        "total_cost":0.438
                    },
                    "per_grain_unit_per_percent_moisture":{
                        "total_cost":0.031
                    },
                    "sample_datetime":"2016-08-13",
                    "sample_moisture_content_wb":28.7,
                    "simulation_length":35430,
                    "target_moisture_reached":1
                },...
            ],
            "name":"Sorghum Dryer"
        }
    ],
    "infield_drydown_data":{
        "32,-100":{
            "2016-08-13":{
                "agdd":2765.5,
                "air_temp_max":87.0,
                "air_temp_min":66.0,
                "equilibrium_moisture_content":11.38,
                "gdd":26.5,
                "grain_moisture_content":28.7,
                "grain_moisture_content_change":"n/a",
                "last_stage":"11",
                "new_stage":"12"
            },...
        }
    }
}

Soybean Mechanical Drying - v1.0

The Soybean Mechanical Drying endpoint simulates the drydown process of soybean using either fan-powered low-temperature drying or burner-driven high-temperature drying facilities to provide drying statistics and cost projections. The mechanical drying process is simulated using up to 10 future days of grain moisture estimates. Results from the soybean in-field drying model are also returned for comparison.

Note that a field, growth, and drying facility are required to utilize this feature. Any available moisture measurements are used to improve model results.

Please be aware that mechanical drying data will not be returned if moisture estimates are unable to be obtained from the soybean in-field drying model. This may occur if one of the following conditions are met:

  • The soybean growth model simulation does not bring the crop to maturity. This is more likely to occur for certain location (e.g., cooler climates) and relative maturity combinations.

  • The crop planting date or emergence date are too far in the past. The models are designed for future planning; users can utilize the "current_date" argument to determine what model results could have been on a past date. These results can be different than what would have been seen on the emulated date, as the forecast timeframes are now filled with historical data.

URL Description

https://ag.us.clearapis.com/v1.0/crop_health/soybean/mechanical_drying?app_id={string}&app_key={string}&account_id={string}&user_id={string}&growth_id={string}&drying_facility_ids={string}&target_moisture_content_wb={float}&grain_unit={string}&current_date={timestamp}

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 Account 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 Growth Creation endpoint. Properties of this growth will be used to generate model results.

drying_facility_ids

string

no

Comma-delimited list of drying facility IDs to be used. Currently, only the most recently created facility in the list will be used. Default behavior is to use the most recently created facility overall. Note that the calling user must have at least read privileges for the asset (drying facility).

target_moisture_content_wb

float

yes

Desired wet-basis moisture level for safe storage, in percent. Wet-basis moisture content is defined as the ratio of the mass of water to the total mass of a sample of grain.

grain_unit

string

yes

Units to use when returning unit costs of drying. Valid values include "bu" (bushel) and "mt" (metric ton).

current_date

timestamp

no

Since by default the model only provides results for dates in the future, this feature can be useful when paired with a growth from a past growing season to provide historical model results.

Response Object (JSON)

Field Description

asset_id

The ID given to a particular drying facility.

burner_fuel_type

Type of fuel consumed by the burner.

burner_fuel_unit

Unit of measure associated with the fuel type.

driest_datetime

Time that the grain reached its lowest moisture content of the model run. Represented by a date string in the case of low-temperature drying or hours and minutes in the case of high-temperature drying. Note that the simulation will stop when the user-specified target moisture content is reached, in which case this will indicate the timing of the grain reaching that threshold.

driest_moisture_content_db

Driest dry-basis grain moisture content of the simulation, in percent. Dry-basis moisture content is defined as the ratio of the mass of water to the dry mass of a sample of grain.

driest_moisture_content_wb

Driest wet-basis grain moisture content of the simulation, in percent. Wet-basis moisture content is defined as the ratio of the mass of water to the total mass of a sample of grain.

dryer_throughput_grain_units_per_hour

Amount of grain dried per hour. Applicable only in high-temperature drying facilities.

drying_time

Amount of time, in seconds, that elapsed for the grain to reach its lowest moisture content.

grain_storability

Likelihood of spoilage. Possible values include "0," indicating that grain is not likely to spoil; "1," indicating a marginal risk; and "2," warning that spoilage is likely. When high-temperature drying is in use, "n/a" will be used.

grain_unit

Unit of measure associated with the volume of grain as provided by the user.

per_grain_unit/burner_fuel_cost

Expected burner fuel cost per unit of grain, in the user’s local currency, and in the grain unit provided by the user.

per_grain_unit/burner_fuel_units_consumed

Expected amount of fuel consumed by the burner per unit of grain, in the grain unit provided by the user.

per_grain_unit/burner_kwh_consumed

Expected amount of fuel energy, in kilowatt-hours, consumed by the burner per unit of grain, in the grain unit provided by the user.

per_grain_unit/electricity_cost

Expected electricity cost per unit of grain, in the user’s local currency, and in the grain unit provided by the user.

per_grain_unit/electricity_kwh_consumed

Expected amount of electrical energy, in kilowatt-hours, consumed by the fan per unit of grain, in the grain unit provided by the user.

per_grain_unit/total_cost

Expected total drying cost per unit of grain, in the user’s local currency, and in the grain unit provided by the user.

per_grain_unit_per_percent_moisture/total_cost

Expected total drying cost per unit of grain per percent moisture change, in the user’s local currency, and in the grain unit provided by the user.

sample_datetime

Valid time of the grain moisture sample provided by the in-field drydown model.

sample_moisture_content_wb

Starting wet-basis moisture content of the grain sample, in percent, provided by the in-field drydown model.

simulation_length

Total length of time, in seconds, over which the drydown process was modeled.

target_moisture_reached

Flag indicating whether the target storage moisture content is reached in the simulation, where "1" indicates that the storage moisture is reached and "0" indicates it is not. Primarily applicable in low-temperature drying facilities, where ambient environmental conditions may not permit an adequate amount of drying.

name

The user-provided name of the drying facility. If this is not supplied, a generic name of "Drying Facility" followed by a number is used.

agdd

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

air_temp_avg

Average daily air temperature in degrees Fahrenheit. Obtained from historical, forecast, or climatological data, depending on the timeframe.

air_temp_max

Maximum daily air temperature in degrees Fahrenheit. Obtained from historical, forecast, or climatological data, depending on the timeframe.

air_temp_min

Minimum daily air temperature in degrees Fahrenheit. Obtained from historical, forecast, or climatological data, depending on the timeframe.

equilibrium_moisture_content

The wet-basis moisture content, in percent, at which the grain is neither gaining nor losing moisture. Changes with relative humidity and air temperature. Provided after the crop fully matures. Note that wet-basis moisture content is defined as the ratio of the mass of water to the total mass of a sample of grain.

feedback_id

If this parameter is present, it indicates a confirmed or observed growth stage.

field_activity_id

If this parameter is present, it indicates a confirmed or observed moisture sample.

gdd

Growing degree days accumulated on the current date.

grain_moisture_content

Percent wet-basis moisture content of the grain at the end of the day. Provided after the crop fully matures.

grain_moisture_content_change

The change in the amount of wet-basis moisture in the grain since the previous day, in percent. Positive values indicate that the moisture content has increased, and negative values indicate that the moisture content has decreased. Provided after the crop fully matures.

last_reproductive_stage

The last known reproductive stage.

last_stage

Likelihood of spoilage. Possible values include "0," indicating that grain is not likely to spoil; "1," indicating a marginal risk; and "2," warning that spoilage is likely. When high-temperature drying is in use, "n/a" will be used. 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

Expected amount of fuel consumed by the burner per unit of grain, in the grain unit provided by the user. 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. Obtained from historical, forecast, or climatological data, depending on the timeframe.

Example Request

https://ag.us.clearapis.com/v1.0/crop_health/soybean/mechanical_drying?app_id=456&app_key=789&account_id=123&user_id=xyz-123&growth_id=abc-def&target_moisture_content_wb=14.5&grain_unit=bu

Example Response

{
    "drying_facilities":[
        {
            "asset_id":"abc-123",
            "data":[
                {
                    "burner_fuel_type":"liquid_propane",
                    "burner_fuel_unit":"gallon",
                    "driest_datetime":"04:14",
                    "driest_moisture_content_db":16.9,
                    "driest_moisture_content_wb":14.46,
                    "dryer_throughput_grain_units_per_hour":335.0,
                    "drying_time":15240,
                    "grain_storability":"n/a",
                    "grain_unit":"bu",
                    "per_grain_unit":{
                        "burner_fuel_cost":0.359,
                        "burner_fuel_units_consumed":0.399,
                        "burner_kwh_consumed":9.85,
                        "electricity_cost":0.148,
                        "electricity_kwh_consumed":0.3,
                        "total_cost":0.507
                    },
                    "per_grain_unit_per_percent_moisture":{
                        "total_cost":0.031
                    },
                    "sample_datetime":"2016-09-28",
                    "sample_moisture_content_wb":31.09,
                    "simulation_length":15240,
                    "target_moisture_reached":1
                },...
            ],
            "name":"Soybean Dryer"
        }
    ],
    "infield_drydown_data":{
        "47,-97":{
            "2016-09-28":{
                "agdd":2135.94,
                "air_temp_avg":52.0,
                "air_temp_max":65.0,
                "air_temp_min":39.0,
                "equilibrium_moisture_content":7.54,
                "gdd":8.0,
                "grain_moisture_content":31.09,
                "grain_moisture_content_change":"n/a",
                "last_reproductive_stage":"R7",
                "last_stage":"R7",
                "last_vegetative_stage":"V15",
                "new_reproductive_stage":"R8",
                "new_stage":"R8",
                "new_vegetative_stage":"n/a",
                "relative_humidity_avg":62.0
            },...
        }
    }
}

Spring Wheat Mechanical Drying - v1.0

The Spring Wheat Mechanical Drying endpoint simulates the drydown process of spring wheat using either fan-powered low-temperature drying or burner-driven high-temperature drying facilities to provide drying statistics and cost projections. The mechanical drying process is simulated using up to 10 future days of grain moisture estimates. Results from the spring wheat in-field drying model are also returned for comparison.

Note that a field, growth, and drying facility are required to utilize this feature. Any available moisture measurements are used to improve model results.

Please be aware that mechanical drying data will not be returned if moisture estimates are unable to be obtained from the spring wheat in-field drying model. This may occur if one of the following conditions are met:

  • The spring wheat growth model simulation does not bring the crop to maturity. This is more likely to occur for certain location (e.g., cooler climates) and relative maturity combinations.

  • The crop planting date or emergence date are too far in the past. The models are designed for future planning; users can utilize the "current_date" argument to determine what model results could have been on a past date. These results can be different than what would have been seen on the emulated date, as the forecast timeframes are now filled with historical data.

URL Description

https://ag.us.clearapis.com/v1.0/crop_health/springwheat/mechanical_drying?app_id={string}&app_key={string}&account_id={string}&user_id={string}&growth_id={string}&drying_facility_ids={string}&target_moisture_content_wb={float}&grain_unit={string}&current_date={timestamp}

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 Account 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 Growth Creation endpoint. Properties of this growth will be used to generate model results.

drying_facility_ids

string

no

Comma-delimited list of drying facility IDs to be used. Currently, only the most recently created facility in the list will be used. Default behavior is to use the most recently created facility overall. Note that the calling user must have at least read privileges for the asset (drying facility).

target_moisture_content_wb

float

yes

Desired wet-basis moisture level for safe storage, in percent. Wet-basis moisture content is defined as the ratio of the mass of water to the total mass of a sample of grain.

grain_unit

string

yes

Units to use when returning unit costs of drying. Valid values include "bu" (bushel) and "mt" (metric ton).

current_date

timestamp

no

Since by default the model only provides results for dates in the future, this feature can be useful when paired with a growth from a past growing season to provide historical model results.

Response Object (JSON)

Field Description

asset_id

The ID given to a particular drying facility.

burner_fuel_type

Type of fuel consumed by the burner.

burner_fuel_unit

Unit of measure associated with the fuel type.

driest_datetime

Time that the grain reached its lowest moisture content of the model run. Represented by a date string in the case of low-temperature drying or hours and minutes in the case of high-temperature drying. Note that the simulation will stop when the user-specified target moisture content is reached, in which case this will indicate the timing of the grain reaching that threshold.

driest_moisture_content_db

Driest dry-basis grain moisture content of the simulation, in percent. Dry-basis moisture content is defined as the ratio of the mass of water to the dry mass of a sample of grain.

driest_moisture_content_wb

Driest wet-basis grain moisture content of the simulation, in percent. Wet-basis moisture content is defined as the ratio of the mass of water to the total mass of a sample of grain.

dryer_throughput_grain_units_per_hour

Amount of grain dried per hour. Applicable only in high-temperature drying facilities.

drying_time

Amount of time, in seconds, that elapsed for the grain to reach its lowest moisture content.

grain_storability

Likelihood of spoilage. Possible values include "0," indicating that grain is not likely to spoil; "1," indicating a marginal risk; and "2," warning that spoilage is likely. When high-temperature drying is in use, "n/a" will be used.

grain_unit

Unit of measure associated with the volume of grain as provided by the user.

per_grain_unit/burner_fuel_cost

Expected burner fuel cost per unit of grain, in the user’s local currency, and in the grain unit provided by the user.

per_grain_unit/burner_fuel_units_consumed

Expected amount of fuel consumed by the burner per unit of grain, in the grain unit provided by the user.

per_grain_unit/burner_kwh_consumed

Expected amount of fuel energy, in kilowatt-hours, consumed by the burner per unit of grain, in the grain unit provided by the user.

per_grain_unit/electricity_cost

Expected electricity cost per unit of grain, in the user’s local currency, and in the grain unit provided by the user.

per_grain_unit/electricity_kwh_consumed

Expected amount of electrical energy, in kilowatt-hours, consumed by the fan per unit of grain, in the grain unit provided by the user.

per_grain_unit/total_cost

Expected total drying cost per unit of grain, in the user’s local currency, and in the grain unit provided by the user.

per_grain_unit_per_percent_moisture/total_cost

Expected total drying cost per unit of grain per percent moisture change, in the user’s local currency, and in the grain unit provided by the user.

sample_datetime

Valid time of the grain moisture sample provided by the in-field drydown model.

sample_moisture_content_wb

Starting wet-basis moisture content of the grain sample, in percent, provided by the in-field drydown model.

simulation_length

Total length of time, in seconds, over which the drydown process was modeled.

target_moisture_reached

Flag indicating whether the target storage moisture content is reached in the simulation, where "1" indicates that the storage moisture is reached and "0" indicates it is not. Primarily applicable in low-temperature drying facilities, where ambient environmental conditions may not permit an adequate amount of drying.

name

The user-provided name of the drying facility. If this is not supplied, a generic name of "Drying Facility" followed by a number is used.

agdd

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

air_temp_max

Maximum daily air temperature in degrees Fahrenheit. Obtained from historical, forecast, or climatological data, depending on the timeframe.

air_temp_min

Minimum daily air temperature in degrees Fahrenheit. Obtained from historical, forecast, or climatological data, depending on the timeframe.

equilibrium_moisture_content

The wet-basis moisture content, in percent, at which the grain is neither gaining nor losing moisture. Changes with relative humidity and air temperature. Provided after the crop fully matures. Note that wet-basis moisture content is defined as the ratio of the mass of water to the total mass of a sample of grain.

feedback_id

If this parameter is present, it indicates a confirmed or observed growth stage.

field_activity_id

If this parameter is present, it indicates a confirmed or observed moisture sample.

gdd

Growing degree days accumulated on the current date.

grain_moisture_content

Percent wet-basis moisture content of the grain at the end of the day. Provided after the crop fully matures.

grain_moisture_content_change

The change in the amount of wet-basis moisture in the grain since the previous day, in percent. Positive values indicate that the moisture content has increased, and negative values indicate that the moisture content has decreased. Provided after the crop fully matures.

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. "n/a" if the crop is somewhere between the previous growth stage and the next growth stage.

Example Request

https://ag.us.clearapis.com/v1.0/crop_health/springwheat/mechanical_drying?app_id=456&app_key=789&account_id=123&user_id=xyz-123&growth_id=abc-def&target_moisture_content_wb=14.5&grain_unit=bu

Example Response

{
    "drying_facilities":[
        {
            "asset_id":"abc-123",
            "data":[
                {
                    "burner_fuel_type":"liquid_propane",
                    "burner_fuel_unit":"gallon",
                    "driest_datetime":"04:11",
                    "driest_moisture_content_db":16.96,
                    "driest_moisture_content_wb":14.5,
                    "dryer_throughput_grain_units_per_hour":339.0,
                    "drying_time":15075,
                    "grain_storability":"n/a",
                    "grain_unit":"bu",
                    "per_grain_unit":{
                        "burner_fuel_cost":0.431,
                        "burner_fuel_units_consumed":0.479,
                        "burner_kwh_consumed":11.8,
                        "electricity_cost":0.499,
                        "electricity_kwh_consumed":1.0,
                        "total_cost":0.93
                    },
                    "per_grain_unit_per_percent_moisture":{
                        "total_cost":0.051
                    },
                    "sample_datetime":"2016-07-13",
                    "sample_moisture_content_wb":32.88,
                    "simulation_length":15075,
                    "target_moisture_reached":1
                },...
            ],
            "name":"Spring Wheat Dryer"
        }
    ],
    "infield_drydown_data":{
        "47,-97":{
            "2016-07-13":{
                "agdd":2432.5,
                "air_temp_max":74.0,
                "air_temp_min":64.0,
                "equilibrium_moisture_content":10.0,
                "gdd":37.0,
                "grain_moisture_content":32.88,
                "grain_moisture_content_change":"n/a",
                "last_stage":"20",
                "new_stage":"21"
            },...
        }
    }
}

Sunflower Mechanical Drying - v1.0

The Sunflower Mechanical Drying endpoint simulates the drydown process of sunflower using either fan-powered low-temperature drying or burner-driven high-temperature drying facilities to provide drying statistics and cost projections. The mechanical drying process is simulated using up to 10 future days of grain moisture estimates. Results from the sunflower in-field drying model are also returned for comparison.

Note that a field, growth, and drying facility are required to utilize this feature. Any available moisture measurements are used to improve model results.

Please be aware that mechanical drying data will not be returned if moisture estimates are unable to be obtained from the sunflower in-field drying model. This may occur if one of the following conditions are met:

  • The sunflower growth model simulation does not bring the crop to maturity. This is more likely to occur for certain location (e.g., cooler climates) and relative maturity combinations.

  • The crop planting date or emergence date are too far in the past. The models are designed for future planning; users can utilize the "current_date" argument to determine what model results could have been on a past date. These results can be different than what would have been seen on the emulated date, as the forecast timeframes are now filled with historical data.

URL Description

https://ag.us.clearapis.com/v1.0/crop_health/sunflower/mechanical_drying?app_id={string}&app_key={string}&account_id={string}&user_id={string}&growth_id={string}&drying_facility_ids={string}&target_moisture_content_wb={float}&grain_unit={string}&current_date={timestamp}

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 Account 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 Growth Creation endpoint. Properties of this growth will be used to generate model results.

drying_facility_ids

string

no

Comma-delimited list of drying facility IDs to be used. Currently, only the most recently created facility in the list will be used. Default behavior is to use the most recently created facility overall. Note that the calling user must have at least read privileges for the asset (drying facility).

target_moisture_content_wb

float

yes

Desired wet-basis moisture level for safe storage, in percent. Wet-basis moisture content is defined as the ratio of the mass of water to the total mass of a sample of grain.

grain_unit

string

yes

Units to use when returning unit costs of drying. Valid values include "bu" (bushel) and "mt" (metric ton).

current_date

timestamp

no

Since by default the model only provides results for dates in the future, this feature can be useful when paired with a growth from a past growing season to provide historical model results.

Response Object (JSON)

Field Description

asset_id

The ID given to a particular drying facility.

burner_fuel_type

Type of fuel consumed by the burner.

burner_fuel_unit

Unit of measure associated with the fuel type.

driest_datetime

Time that the grain reached its lowest moisture content of the model run. Represented by a date string in the case of low-temperature drying or hours and minutes in the case of high-temperature drying. Note that the simulation will stop when the user-specified target moisture content is reached, in which case this will indicate the timing of the grain reaching that threshold.

driest_moisture_content_db

Driest dry-basis grain moisture content of the simulation, in percent. Dry-basis moisture content is defined as the ratio of the mass of water to the dry mass of a sample of grain.

driest_moisture_content_wb

Driest wet-basis grain moisture content of the simulation, in percent. Wet-basis moisture content is defined as the ratio of the mass of water to the total mass of a sample of grain.

dryer_throughput_grain_units_per_hour

Amount of grain dried per hour. Applicable only in high-temperature drying facilities.

drying_time

Amount of time, in seconds, that elapsed for the grain to reach its lowest moisture content.

grain_storability

Likelihood of spoilage. Possible values include "0," indicating that grain is not likely to spoil; "1," indicating a marginal risk; and "2," warning that spoilage is likely. When high-temperature drying is in use, "n/a" will be used.

grain_unit

Unit of measure associated with the volume of grain as provided by the user.

per_grain_unit/burner_fuel_cost

Expected burner fuel cost per unit of grain, in the user’s local currency, and in the grain unit provided by the user.

per_grain_unit/burner_fuel_units_consumed

Expected amount of fuel consumed by the burner per unit of grain, in the grain unit provided by the user.

per_grain_unit/burner_kwh_consumed

Expected amount of fuel energy, in kilowatt-hours, consumed by the burner per unit of grain, in the grain unit provided by the user.

per_grain_unit/electricity_cost

Expected electricity cost per unit of grain, in the user’s local currency, and in the grain unit provided by the user.

per_grain_unit/electricity_kwh_consumed

Expected amount of electrical energy, in kilowatt-hours, consumed by the fan per unit of grain, in the grain unit provided by the user.

per_grain_unit/total_cost

Expected total drying cost per unit of grain, in the user’s local currency, and in the grain unit provided by the user.

per_grain_unit_per_percent_moisture/total_cost

Expected total drying cost per unit of grain per percent moisture change, in the user’s local currency, and in the grain unit provided by the user.

sample_datetime

Valid time of the grain moisture sample provided by the in-field drydown model.

sample_moisture_content_wb

Starting wet-basis moisture content of the grain sample, in percent, provided by the in-field drydown model.

simulation_length

Total length of time, in seconds, over which the drydown process was modeled.

target_moisture_reached

Flag indicating whether the target storage moisture content is reached in the simulation, where "1" indicates that the storage moisture is reached and "0" indicates it is not. Primarily applicable in low-temperature drying facilities, where ambient environmental conditions may not permit an adequate amount of drying.

name

The user-provided name of the drying facility. If this is not supplied, a generic name of "Drying Facility" followed by a number is used.

agdd

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

air_temp_max

Maximum daily air temperature in degrees Fahrenheit. Obtained from historical, forecast, or climatological data, depending on the timeframe.

air_temp_min

Minimum daily air temperature in degrees Fahrenheit. Obtained from historical, forecast, or climatological data, depending on the timeframe.

equilibrium_moisture_content

The wet-basis moisture content, in percent, at which the grain is neither gaining nor losing moisture. Changes with relative humidity and air temperature. Provided after the crop fully matures. Note that wet-basis moisture content is defined as the ratio of the mass of water to the total mass of a sample of grain.

feedback_id

If this parameter is present, it indicates a confirmed or observed growth stage.

field_activity_id

If this parameter is present, it indicates a confirmed or observed moisture sample.

gdd

Growing degree days accumulated on the current date.

grain_moisture_content

Percent wet-basis moisture content of the grain at the end of the day. Provided after the crop fully matures.

grain_moisture_content_change

The change in the amount of wet-basis moisture in the grain since the previous day, in percent. Positive values indicate that the moisture content has increased, and negative values indicate that the moisture content has decreased. Provided after the crop fully matures.

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. "n/a" if the crop is somewhere between the previous growth stage and the next growth stage.

Example Request

https://ag.us.clearapis.com/v1.0/crop_health/sunflower/mechanical_drying?app_id=456&app_key=789&account_id=123&user_id=xyz-123&growth_id=abc-def&target_moisture_content_wb=14.5&grain_unit=bu

Example Response

{
    "drying_facilities":[
        {
            "asset_id":"abc-123",
            "data":[
                {
                    "burner_fuel_type":"liquid_propane",
                    "burner_fuel_unit":"gallon",
                    "driest_datetime":"03:10",
                    "driest_moisture_content_db":16.95,
                    "driest_moisture_content_wb":14.49,
                    "dryer_throughput_grain_units_per_hour":546.0,
                    "drying_time":11430,
                    "grain_storability":"n/a",
                    "grain_unit":"bu",
                    "per_grain_unit":{
                        "burner_fuel_cost":0.252,
                        "burner_fuel_units_consumed":0.28,
                        "burner_kwh_consumed":6.91,
                        "electricity_cost":0.008,
                        "electricity_kwh_consumed":0.07,
                        "total_cost":0.26
                    },
                    "per_grain_unit_per_percent_moisture":{
                        "total_cost":0.015
                    },
                    "sample_datetime":"2016-08-30",
                    "sample_moisture_content_wb":31.63,
                    "simulation_length":11430,
                    "target_moisture_reached":1
                },...
           ],
           "name":"Sunflower Dryer"
       }
   ],
    "infield_drydown_data":{
        "47,-97":{
            "2016-08-30":{
                "agdd":2886.0,
                "air_temp_max":81.0,
                "air_temp_min":50.0,
                "equilibrium_moisture_content":5.8,
                "gdd":21.5,
                "grain_moisture_content":30.99,
                "grain_moisture_content_change":"n/a",
                "last_stage":"30",
                "new_stage":"31"
            },...
        }
    }
}

Winter Wheat Mechanical Drying - v1.0

The Winter Wheat Mechanical Drying endpoint simulates the drydown process of winter wheat using either fan-powered low-temperature drying or burner-driven high-temperature drying facilities to provide drying statistics and cost projections. The mechanical drying process is simulated using up to 10 future days of grain moisture estimates. Results from the winter wheat in-field drying model are also returned for comparison.

Note that a field, growth, and drying facility are required to utilize this feature. Any available moisture measurements are used to improve model results.

Please be aware that mechanical drying data will not be returned if moisture estimates are unable to be obtained from the winter wheat in-field drying model. This may occur if one of the following conditions are met:

  • The winter wheat growth model simulation does not bring the crop to maturity. This is more likely to occur for certain location (e.g., cooler climates) and relative maturity combinations.

  • The crop planting date or emergence date are too far in the past. The models are designed for future planning; users can utilize the "current_date" argument to determine what model results could have been on a past date. These results can be different than what would have been seen on the emulated date, as the forecast timeframes are now filled with historical data.

URL Description

https://ag.us.clearapis.com/v1.0/crop_health/winter_wheat/mechanical_drying?app_id={string}&app_key={string}&account_id={string}&user_id={string}&growth_id={string}&drying_facility_ids={string}&target_moisture_content_wb={float}&grain_unit={string}&current_date={timestamp}

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 Account 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 Growth Creation endpoint. Properties of this growth will be used to generate model results.

drying_facility_ids

string

no

Comma-delimited list of drying facility IDs to be used. Currently, only the most recently created facility in the list will be used. Default behavior is to use the most recently created facility overall. Note that the calling user must have at least read privileges for the asset (drying facility).

target_moisture_content_wb

float

yes

Desired wet-basis moisture level for safe storage, in percent. Wet-basis moisture content is defined as the ratio of the mass of water to the total mass of a sample of grain.

grain_unit

string

yes

Units to use when returning unit costs of drying. Valid values include "bu" (bushel) and "mt" (metric ton).

current_date

timestamp

no

Since by default the model only provides results for dates in the future, this feature can be useful when paired with a growth from a past growing season to provide historical model results.

Response Object (JSON)

Field Description

asset_id

The ID given to a particular drying facility.

burner_fuel_type

Type of fuel consumed by the burner.

burner_fuel_unit

Unit of measure associated with the fuel type.

driest_datetime

Time that the grain reached its lowest moisture content of the model run. Represented by a date string in the case of low-temperature drying or hours and minutes in the case of high-temperature drying. Note that the simulation will stop when the user-specified target moisture content is reached, in which case this will indicate the timing of the grain reaching that threshold.

driest_moisture_content_db

Driest dry-basis grain moisture content of the simulation, in percent. Dry-basis moisture content is defined as the ratio of the mass of water to the dry mass of a sample of grain.

driest_moisture_content_wb

Driest wet-basis grain moisture content of the simulation, in percent. Wet-basis moisture content is defined as the ratio of the mass of water to the total mass of a sample of grain.

dryer_throughput_grain_units_per_hour

Amount of grain dried per hour. Applicable only in high-temperature drying facilities.

drying_time

Amount of time, in seconds, that elapsed for the grain to reach its lowest moisture content.

grain_storability

Likelihood of spoilage. Possible values include "0," indicating that grain is not likely to spoil; "1," indicating a marginal risk; and "2," warning that spoilage is likely. When high-temperature drying is in use, "n/a" will be used.

grain_unit

Unit of measure associated with the volume of grain as provided by the user.

per_grain_unit/burner_fuel_cost

Expected burner fuel cost per unit of grain, in the user’s local currency, and in the grain unit provided by the user.

per_grain_unit/burner_fuel_units_consumed

Expected amount of fuel consumed by the burner per unit of grain, in the grain unit provided by the user.

per_grain_unit/burner_kwh_consumed

Expected amount of fuel energy, in kilowatt-hours, consumed by the burner per unit of grain, in the grain unit provided by the user.

per_grain_unit/electricity_cost

Expected electricity cost per unit of grain, in the user’s local currency, and in the grain unit provided by the user.

per_grain_unit/electricity_kwh_consumed

Expected amount of electrical energy, in kilowatt-hours, consumed by the fan per unit of grain, in the grain unit provided by the user.

per_grain_unit/total_cost

Expected total drying cost per unit of grain, in the user’s local currency, and in the grain unit provided by the user.

per_grain_unit_per_percent_moisture/total_cost

Expected total drying cost per unit of grain per percent moisture change, in the user’s local currency, and in the grain unit provided by the user.

sample_datetime

Valid time of the grain moisture sample provided by the in-field drydown model.

sample_moisture_content_wb

Starting wet-basis moisture content of the grain sample, in percent, provided by the in-field drydown model.

simulation_length

Total length of time, in seconds, over which the drydown process was modeled.

target_moisture_reached

Flag indicating whether the target storage moisture content is reached in the simulation, where "1" indicates that the storage moisture is reached and "0" indicates it is not. Primarily applicable in low-temperature drying facilities, where ambient environmental conditions may not permit an adequate amount of drying.

name

The user-provided name of the drying facility. If this is not supplied, a generic name of "Drying Facility" followed by a number is used.

agdd

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

air_temp_max

Maximum daily air temperature in degrees Fahrenheit. Obtained from historical, forecast, or climatological data, depending on the timeframe.

air_temp_min

Minimum daily air temperature in degrees Fahrenheit. Obtained from historical, forecast, or climatological data, depending on the timeframe.

equilibrium_moisture_content

The wet-basis moisture content, in percent, at which the grain is neither gaining nor losing moisture. Changes with relative humidity and air temperature. Provided after the crop fully matures. Note that wet-basis moisture content is defined as the ratio of the mass of water to the total mass of a sample of grain.

feedback_id

If this parameter is present, it indicates a confirmed or observed growth stage.

field_activity_id

If this parameter is present, it indicates a confirmed or observed moisture sample.

gdd

Growing degree days accumulated on the current date.

grain_moisture_content

Percent wet-basis moisture content of the grain at the end of the day. Provided after the crop fully matures.

grain_moisture_content_change

The change in the amount of wet-basis moisture in the grain since the previous day, in percent. Positive values indicate that the moisture content has increased, and negative values indicate that the moisture content has decreased. Provided after the crop fully matures.

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. "n/a" if the crop is somewhere between the previous growth stage and the next growth stage.

Example Request

https://ag.us.clearapis.com/v1.0/crop_health/winter_wheat/mechanical_drying?app_id=456&app_key=789&account_id=123&user_id=xyz-123&growth_id=abc-def&target_moisture_content_wb=14.5&grain_unit=bu

Example Response

{
    "drying_facilities":[
        {
            "asset_id":"abc-123",
            "data":[
                {
                    "burner_fuel_type":"liquid_propane",
                    "burner_fuel_unit":"gallon",
                    "driest_datetime":"03:31",
                    "driest_moisture_content_db":16.96,
                    "driest_moisture_content_wb":14.5,
                    "dryer_throughput_grain_units_per_hour":402.0,
                    "drying_time":12710,
                    "grain_storability":"n/a"
                    "grain_unit":"bu",
                    "per_grain_unit":{
                        "burner_fuel_cost":0.381,
                        "burner_fuel_units_consumed":0.423,
                        "burner_kwh_consumed":10.4,
                        "electricity_cost":0.421,
                        "electricity_kwh_consumed":0.8,
                        "total_cost":0.801
                    },
                    "per_grain_unit_per_percent_moisture":{
                        "total_cost":0.047
                    },
                    "sample_datetime":"2016-07-12",
                    "sample_moisture_content_wb":31.39,
                    "simulation_length":12710,
                    "target_moisture_reached":1
                },...
            ],
            "name":"Winter Wheat Dryer"
        }
    ],
    "infield_drydown_data":{
        "47,-97":{
            "2016-07-12":{
                "agdd":2126.41,
                "air_temp_max":84.0,
                "air_temp_min":61.0,
                "equilibrium_moisture_content":9.88,
                "gdd":22.56,
                "grain_moisture_content":31.39,
                "grain_moisture_content_change":"n/a",
                "last_stage":"11",
                "new_stage":"12"
            },...
        }
    }
}

Moisture Sample

Add Moisture Sample - v1.0

This endpoint is to be used for recording moisture samples. When adding a moisture sample activity, the activity will be automatically added to the growth and field whitelist. While active on a whitelist, the moisture sample activity will be used to improve various model/advisor results (e.g., the in-field and mechanical drydown advisors).

URL Description

https://ag.us.clearapis.com/v1.0/crop_health/{plant_name}/activity/moisture_sample/add/{growth_id}/{value}?user_id={string}&app_id={string}&app_key={string}&account_id={string}&activity_time={timestamp}

Request Parameters

Parameter Type Required Description

app_id

string

yes

API ID provided by Iteris.

app_key

string

yes

API key provided by Iteris.

plant_name

string

yes

Plant name pertaining to the activity. Please refer to the Plant Enumerations section of the Appendix for a list of supported plant name values.

growth_id

string

yes

ID of created growth.

value

float

yes

Float between 0.0 - 100.0, represents the percentage of moisture found in the sample.

user_id

string

yes

User ID provided by and used with the Accounts API.

account_id

string

yes

Your Accounts API account ID.

activity_time

timestamp

no

Timestamp denoting when the activity took place, in the form of Unix timestamp. The minimum value is 31552800.

Response Object

200 response results in a UUID of the new moisture sample activity.

Example Request

https://ag.us.clearapis.com/v1.0/crop_health/cotton/activity/moisture_sample/add/456-789/100.0?user_id=xyz-123&app_id=123&app_key=321&account_id=123&activity_time=31552800

Example Response

def-234

Get Moisture Sample - v1.0

This feature is to be used for the retrieval of a single moisture sample.

URL Description

https://ag.us.clearapis.com/v1.0/crop_health/{plant_name}/activity/moisture_sample/get/{activity_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.

plant_name

string

yes

Plant name of the target moisture sample. Please refer to the Plant Enumerations section of the Appendix for a list of supported plant_name values.

activity id

string

yes

ID of the target moisture sample.

account_id

string

yes

Your Accounts API account ID.

user_id

string

yes

User ID provided by and used with the Accounts API.

Response Object

Field Description

activity_time

Timestamp of moisture sample, in the form of Unix timestamp.

activity_type

Enumeration value representing the type of activity performed (312 for moisture sample).

subtype

Subtype of moisture sample. Default is 0 for generic.

activity_time

Timestamp of moisture sample, in the form of Unix timestamp.

created

Timestamp of creation.

field_activity_id

ID of activity.

modified

Timestamp of last modification.

plant_type

ID of the type of plant. Please refer to the Plant Enumerations section of the Appendix for a list of supported plant type IDs.

unit

Unit of moisture sample measurement.

value

Moisture sample measurement.

Example Request

https://ag.us.clearapis.com/v1.1/crop_health/corn/growth/gdd_envelope?app_id=123&app_key=321&location=42.22851735620852,-100.986328125&plant_date=1454363558&days=20&relative_maturity=107

Example Response

{
    "plant_type":68,
    "field_activity_id":"def-234",
    "created":1469830861,
    "modified":null,
    "value":45,
    "subtype":0,
    "activity_time":1469830861,
    "unit":"%",
    "activity_type":312
}

Get Moisture Sample by Growth - v1.0

This endpoint is to be used for retrieving all moisture samples associated with a target growth.

URL Description

https://ag.us.clearapis.com/v1.0/crop_health/{plant_name}/activity/moisture_sample/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.

plant_name

string

yes

Plant name of the target moisture samples. Please refer to the Plant Enumerations section of the Appendix for a list of supported plant_name values.

growth_id

string

yes

ID of growth in which to get moisture samples.

account_id

string

yes

Your Accounts API account ID.

user_id

string

yes

User ID provided by and used with the Accounts API.

Response Object

Field Description

activity_time

Timestamp of moisture sample.

activity_type

Enumeration value representing the type of activity performed (312 for moisture sample).

subtype

Subtype of moisture sample. Default is 0 for generic.

created

Timestamp of creation.

created_by

User_id of user that added activity.

growth_activity_id

Unique ID of growth activity object.

growth_id

Growth to which the activity applies.

field_id

ID of the given field.

modified

Timestamp of last modification.

modified_by

User_id of user that last modified activity.

plant_type

ID of the type of plant. Please refer to the Plant Enumerations section of the Appendix for a list of supported plant_name values.

unit

Unit of moisture sample measurement.

value

Moisture sample measurement.

whitelist

Boolean denoting if the activity is a member of the growth’s whitelist.

Example Request

https://ag.us.clearapis.com/v1.0/crop_health/corn/activity/moisture_sample/get/by_growth/456-789?app_id=123&app_key=321&account_id=123&user_id=xyz-123

Example Response

[
    {
        "plant_type":51,
        "field_activity_id":"def-234",
        "created":1469830861,
        "modified":null,
        "value":45,
        "subtype":0,
        "activity_time":1469830861,
        "unit":"%",
        "activity_type":312,
        “whitelist”:true
    },...
]

Modify Moisture Sample - v1.0

This endpoint allows for the modification of moisture sample activity properties.

URL Description

https://ag.us.clearapis.com/v1.0/crop_health/{plant_name}/activity/moisture_sample/modify/{growth_activity_id}?user_id={string}&app_id={string}&app_key={string}&account_id={string}&activity_time={timestamp}&value={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.

plant_name

string

yes

Plant name pertaining to the target activity. Please refer to the Plant Enumerations section of the Appendix for a list of supported plant_name values.

growth_activity_id

string

yes

Target growth activity to modify.

user_id

string

yes

User ID provided by and used with the Accounts API.

account_id

string

yes

Your Accounts API account ID.

activity_time

timestamp

no

Time the moisture sample activity took place, in the form of Unix timestamp. Minimum value is 31552800.

value

float

no

Float between 0.0 and 100.0.

Response Object

200 response results in true.

Please note that if at least one of subtype, value, or activity_time is not included in the http request, a 400 response is returned because no update is to be made.

Example Request

https://ag.us.clearapis.com/v1.0/crop_health/barley/activity/moisture_sample/modify/abc-def?user_id=xyz-123&app_id=123&app_key=321&account_id=123&activity_time=31552800&value=100.0

Example Response

true

Delete Moisture Sample - v1.0

The Delete Moisture Sample endpoint allows users to delete a moisture sample activity. In doing so, the activity will automatically be removed from the associated whitelist table.

URL Description

https://ag.us.clearapis.com/v1.0/crop_health/{plant_name}/activity/moisture_sample/delete/{growth_activity_id}?app_id={string}&app_key={string}&user_id={string}&account_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.

plant_name

string

yes

Plant name pertaining to the target activity. Please refer to the Plant Enumerations section of the Appendix for a list of supported plant_name values.

activity_id

string

yes

Target growth activity to be deleted.

user_id

string

yes

User ID provided by and used with the Accounts API.

account_id

string

yes

Your Accounts API account ID.

Response Object

200 response results in true.

Example Request

https://ag.us.clearapis.com/v1.0/crop_health/soybean/activity/moisture_sample/delete/abc-def?app_id=123&app_key=321&user_id=xyz-123&account_id=123

Example Response

true

Create Low Temperature Drying Facility - v1.0

This endpoint allows a user to create a low temperature drying facility asset (type 0).

URL Description

https://ag.us.clearapis.com/v1.0/asset/drying_facility/low_temp/create?
app_id={string}&app_key={string}&account_id={string}&user_id={string}
&electricity_cost={float}&electricity_cost_unit={string}
&fan_distribution_area={float}&fan_distribution_area_unit={string}
&grain_thickness={float}&grain_thickness_unit={string}
&name={string}&fan_efficiency={float}&latitude={float}
&longitude={float}&location={lat, lon coordinates}
&field_id={string}&fan_power={float}
&fan_power_unit={string}&airflow={float}
&airflow_unit={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

sting

yes

User ID provided by and used with the Accounts API.

electricity_cost

float

yes

The cost to supply energy to the drying facility. Entry must be greater than zero.

electricity_cost_unit

string

yes

The unit denoting electricity cost ("kwh").

fan_distribution_area

float

yes

The area to which the drying fan impacts. Entry must be greater than zero.

fan_distribution_area_unit

string

yes

The unit denoting the fan distribution ("m^2" or "ft^2").

grain_thickness

float

yes

The thickness of the grain being dryed in the given facility. Entry must be greater than zero.

grain_thickness_unit

string

yes

The unit denoting the thickness of grain being dried ("m" or "ft").

name

string

no

Defaults to "unnamed."

fan_efficiency

float

no

If fan_efficiency is not provided, the default will be a value of 0.47. If fan_efficiency is provided, but a value of "null" is used, the property will be stored as "null."

latitude

float

no

The range varies from -90 to 90. Longitude is required but if location or field_id are provided a 400 response is returned. Please verify that latitude/longitude coordinates are over soil representative of your field.

longitude

float

no

The range varies from -360 to 360. Latitude is required but if location or field_id are provided a 400 response is returned. Please verify that latitude/longitude coordinates are over soil representative of your field.

location

lat, lon coordinates

no

In the form of "<latitude>,<longitude>." If latitude, longitude, or field_id are provided a 400 response is returned. Please verify that latitude/longitude coordinates are over soil representative of your field.

field_id

string

yes3

Used to get latitude and longitude. If latitude, longitude, or field_id are provided a 400 response is returned.

fan_power

float

yes3

The value of the entry must be greater than zero and requires fan_power_unit. If airflow or airflow_unit are provided a 400 response is returned.

fan_power_unit

string

yes3

The units include "kw" or "hp" and requires fan_power. If airflow or airflow_unit are provided a 400 response is returned.

airflow

float

yes3

This entry must be greater than zero and requires airflow_unit. If fan_power or fan_power_unit are provided a 400 response is returned.

airflow_unit

float

yes3

The units include "m^3/s" or "ft^3/min," and requires airflow. If fan_power or fan_power_unit are provided a 400 response is returned.

3 Denotes special rules for if a parameter is required or not.

Response Object

Returns asset ID.

Example Request

https://ag.us.clearapis.com/v1.0/asset/drying_facility/low_temp/create?
app_id=123&app_key=321&account_id=123&user_id=xyz-123
&electricity_cost=10&electricity_cost_unit=kwh
&fan_distribution_area=15&fan_distribution_area_unit=ft^2
&grain_thickness=2&grain_thickness_unit=f
t&location=47.279229,-101.381836&fan_power=12
&fan_power_unit=kw

Example Response

fgh-567

Create High Temperature Drying Facility - v1.0

This endpoint allows users to create a high temperature drying facility asset (type 1).

URL Description

https://ag.us.clearapis.com/v1.0/asset/drying_facility/high_temp/create?
app_id={string}&app_key={string}&account_id={string}&user_id={string}
&electricity_cost={float}&electricity_cost_unit={string}
&fan_distribution_area={float}&fan_distribution_area_unit={string}
&grain_thickness={float}&grain_thickness_unit={string}
&fuel_type={string}&fuel_unit={string}&fuel_cost_per_unit={float}
&plenum_temperature={float}&plenum_temperature_unit={float}
&name={string}&fan_efficiency={float}&latitude={float}
&longitude={float}&location={lat, lon coordinates}&field_id={string}
&fan_power={float}&fan_power_unit={string}
&airflow={float}&airflow_unit={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

sting

yes

User ID provided by and used with the Accounts API.

electricity_cost

float

yes

The cost to supply energy to the drying facility. Entry must be greater than zero.

electricity_cost_unit

string

yes

The unit denoting electricity cost ("kwh").

fan_distribution_area

float

yes

The area to which the drying fan impacts. Entry must be greater than zero.

fan_distribution_area_unit

string

yes

The unit denoting the fan distribution ("m^2" or "ft^2").

grain_thickness

float

yes

The thickness of the grain being dryed in the given facility. Entry must be greater than zero.

grain_thickness_unit

string

yes

The unit denoting the thickness of grain being dried ("m" or "ft").

fuel_type

string

yes

This is either liquid_propane or natural_gas. If a fuel type of "liquid_propane" is provided, then the following fuel_unit values are valid: "l, "gal," "lb," or "kg." If a fuel type of "natural_gas" is provided, then the following fuel_unit values are valid: "lb" or "kg."

fuel_unit

string

yes

If a fuel type of "liquid_propane" is provided, then the following fuel_unit values are valid: "l, "gal," "lb," or "kg." If a fuel type of "natural_gas" is provided, then the following fuel_unit values are valid: "lb" or "kg."

fuel_cost_per_unit

float

yes

This entry must be greater than zero.

plenum_temperature

float

yes

Temperature output in drying facility.

plenum_temperature_unit

string

yes

Unit can be either "c" or "f," and is required if plenum_temperature is provided.

name

string

no

Defaults to "unnamed."

fan_efficiency

float

no

If fan_efficiency is not provided, the default will be a value of 0.47. If fan_efficiency is provided, but a value of "null" is used, the property will be stored as "null."

latitude

float

no

The range varies from -90 to 90. Longitude is required but if location or field_id are provided a 400 response is returned. Please verify that latitude/longitude coordinates are over soil representative of your field.

longitude

float

no

The range varies from -360 to 360. Latitude is required but if location or field_id are provided a 400 response is returned. Please verify that latitude/longitude coordinates are over soil representative of your field.

location

lat, lon coordinates

no

In the form of "<latitude>,<longitude>." If latitude, longitude, or field_id are provided a 400 response is returned. Please verify that latitude/longitude coordinates are over soil representative of your field.

field_id

string

yes3

Used to get latitude and longitude. If latitude, longitude, or field_id are provided then a 400 response is returned.

fan_power

float

yes3

The value of the entry must be greater than zero and requires fan_power_unit. If airflow or airflow_unit are provided then a 400 response is returned.

fan_power_unit

string

yes3

The units include "kw" or "hp" and requires fan_power. If airflow or airflow_unit are provided then a 400 response is returned.

airflow

float

yes3

This entry must be greater than zero and requires airflow_unit. If fan_power or fan_power_unit are provided then a 400 response is returned.

airflow_unit

float

yes3

The units include "m^3/s" or "ft^3/min," and requires airflow. If fan_power or fan_power_unit are provided then a 400 response is returned.

3 Denotes special rules for if a parameter is required or not.

Response Object

Returns asset ID.

Example Request

https://ag.us.clearapis.com/v1.0/asset/drying_facility/high_temp/create?
app_id=123&app_key=321&account_id=123&user_id=xyz-123
&electricity_cost=10&electricity_cost_unit=kwh
&fan_distribution_area=15&fan_distribution_area_unit=ft^2
&grain_thickness=2&grain_thickness_unit=ft&
&fuel_type=liquid_propane&fuel_unit=l&fuel_cost_per_unit=20
&plenum_temperature=20&plenum_temperature_unit=c
&name=unnamed&fan_efficiency=0.47
location=47.279229,-101.381836&field_id=321-abc&
fan_power=12&fan_power_unit=kw

Example Response

fgh-567

Get Drying Facility by Asset ID - v1.0

This endpoint allows a user (with read or write privileges) to retrieve information pertaining to either a low temperature facility (type 0) or high temperature facility (type 1).

URL Description

https://ag.us.clearapis.com/v1.0/asset/drying_facility/get/
{asset_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.

asset_id

string

yes

Specifies ID of the asset to be retreived.

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. (Calling user must have at least read privileges on the target asset.)

Response Object (JSON)

In addition to the listed keys, please refer to the high/low temperature (depending on drying facility type being listed) creation documentation for additional keys.

Field Description

asset_id

Specifies ID of the asset.

created

Unix timestamp.

modified

Unix timestamp.

type

Enumeration value of the type of asset.

Example Request

https://ag.us.clearapis.com/v1.0/asset/drying_facility/get/
fgh-567?app_id=123&app_key=321&account_id=def-345
&user_id=bcd-678

Example Response

{
    "asset_id":"fgh-567",
    "electricity_cost":4,
    "airflow":99,
    "fan_power_unit":null,
    "name":"Drying facility 1",
    "fan_distribution_area_unit":"m^2",
    "fan_efficiency":0.47,
    "fan_power":null,
    "modified":1464727035,
    "longitude":4,
    "grain_thickness_unit":"m",
    "created":1464726969,
    "latitude":12,
    "airflow_unit":"m^3/s",
    "electricity_cost_unit":"kwh",
    "type":0,
    "fan_distribution_area":99,
    "grain_thickness":4
}

Get Drying Facility Asset by User Access - v1.0

This endpoint allows a user to obtain information pertaining to a target user’s access level to all drying facility assets to which the calling user has rights.

URL Description

https://ag.us.clearapis.com/v1.0/asset/drying_facility/get/by_access/
{target_user_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.

target_user_id

string

yes

Specifies the user UUID in order to retrieve all facilities associated with the UUID to which user has access.

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. (Calling user must have at least read privileges on the target asset.)

Response Object (JSON)

Field Description

airflow

The value of airflow in the drying facility.

airflow_unit

Unit can be "m^3/s" or "ft^3/min."

asset_id

Specifies ID of the asset.

calling_user_privs

Enumeration value of the privileges (read or write) that the calling user has on the facility.

created

Unix timestamp.

electricity_cost

The cost to supply energy to the drying facility. Entry must be greater than zero.

electricity_cost_unit

The unit denoting electricity cost ("kwh").

fan_distribution_area

The area to which the drying fan impacts. Entry must be greater than zero.

fan_distribution_area_unit

Unit provided can be either "m2" or "ft^2," and is required if fan_distribution is provided.

fan_efficiency

The efficiency of the fan being used to dry the given crop.

fan_power

The value of fan power.

fan_power_unit

Unit provided can be either "kw" or "hp."

grain_thickness

The thickness of the grain being dried in the given facility. Entry must be greater than zero.

grain_thickness_unit

The unit denoting the thickness of grain being dried ("m" or "ft").

latitude

The range varies from -90 to 90. Please verify that latitude/longitude coordinates are over soil representative of your field.

longitude

The range varies from -360 to 360. Please verify that latitude/longitude coordinates are over soil representative of your field.

modified

Unix timestamp.

name

The name of the facility.

target_user_privs

Enumeration value of the privileges (read or write) that the target user has on the facility.

type

Enumeration value of the type of asset.

plenum_temperature

Temperature output in drying facility.

plenum_temperature_unit

Unit can be either "c" or "f," and is required if plenum_temperature is provided.

fuel_type

This is either liquid_propane or natural_gas.

fuel_unit

The unit of fuel. For liquid_propane: "gal," "l," "lb," or "kg." For natural_gas: "lb," "l," or "gal."

fuel_cost_per_unit

This entry must be greater than zero.

Example Request

https://ag.us.clearapis.com/v1.0/asset/drying_facility/get/by_access/
xyz-123?app_id=123&app_key=321&account_id=def-345&user_id=bcd-678

Example Response

{
    "asset_id":"fgh-567",
    "electricity_cost":4,
    "airflow":99,
    "fan_power_unit":null,
    "name":"Drying facility 1",
    "fan_distribution_area_unit":"m^2",
    "fan_efficiency":0.47,
    "fan_power":null,
    "modified":1464727035,
    "longitude":4,
    "grain_thickness_unit":"m",
    "created":1464726969,
    "latitude":12,
    "airflow_unit":"m^3/s",
    "electricity_cost_unit":"kwh",
    "fan_distribution_area":99,
    "grain_thickness":4
}

Modify Drying Facility (Low or High Temperature) - v1.0

This endpoint allows for the modification of a low (type 0) or high (type 1) temperature drying facility asset.

URL Description

https://ag.us.clearapis.com/v1.0/asset/drying_facility/modify/{target_asset_id}?
app_id={string}&app_key={string}&account_id={string}&user_id={string}
&electricity_cost={float}&electricity_cost_unit={string}
&fan_distribution_area={float}&fan_distribution_area_unit={string}
&grain_thickness={float}&grain_thickness_unit={string}
&fuel_type={string}&fuel_unit={string}&fuel_cost_per_unit={float}
&plenum_temperature={float}&plenum_temperature_unit={string}
&name={string}&fan_efficiency={float}&latitude={float}
&longitude={float}&location={lat, lon coordinates}&field_id={string}
&fan_power={float}&fan_power_unit={string}
&airflow={float}&airflow_unit={float}

Request Parameters

Please note that all valid properties for low and high temperature drying facilities are also described in the associated drying facility creation endpoints.

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

sting

yes

User ID provided by and used with the Accounts API.

target_asset_id

string

yes

Drying facility that is being modified.

electricity_cost

float

no3

Entry must be greater than zero and is required if electricity_cost_unit is provided.

electricity_cost_unit

string

no3

This unit is required if electricity_cost is provided and must be in the form of "kwh."

fan_distribution_area

float

no3

Entry must be greater than zero and is required if fan_distribution_unit is provided.

fan_distribution_area_unit

string

no3

Unit provided can be either "m^2" or "ft^2," and is required if fan_distribution is provided.

grain_thickness

float

no3

Entry must be greater than zero and is required if grain_thickness_unit is provided.

grain_thickness_unit

string

no3

Unit provided can be either "m" or "ft," and is required if grain_thickness is provided.

fuel_type

string

no3

Fuel type can be either liquid_propane or natural_gas, and is required if fuel_unit and/or fuel_cost_per_unit is provided. Only a valid parameter if the target drying facility is of type 1 (high temperature)

grain_thickness_unit

string

no3

Unit provided can be either "m" or "ft," and is required if grain_thickness is provided.

fuel_unit

string

no3

Required if fuel_type and/or fuel_cost_per_unit is provided. If a fuel type of "liquid_propane" is provided, then the following fuel_unit values are valid: "l," "gal," "lb," or "kg." If a fuel type of "natural_gas" is provided, then the following fuel_unit values are valid: "lb" or "kg." Only a valid parameter if the target drying facility is of type 1 (high temperature)

fuel_cost_per_unit

float

no3

Entry must be greater than zero and is required if fuel_unit and/or fuel_type is provided. Only a valid parameter if the target drying facility is of type 1 (high temperature)

plenum_temperature

float

no3

Required if plenum_temperature_unit is provided. Only a valid parameter if the target drying facility is of type 1 (high temperature)

plenum_temperature_unit

string

no3

Unit can be either "c" or "f," and is required if plenum_temperature is provided. Only a valid parameter if the target drying facility is of type 1 (high temperature)

name

string

no

Defaults to "unnamed."

fan_efficiency

float

no

If fan_efficiency is not provided, the default will be a value of 0.47. If fan_efficiency is provided, but a value of "null" is used, the property will be stored as "null."

latitude

float

no3

Range is -90 to 90. This is required if longitude is provided, but is invalid if location or field_id are provided. Please verify that latitude/longitude coordinates are over soil representative of your field.

longitude

float

no3

Range is -360 to 360. This is required if latitude is provided, but is invalid if location or field_id are provided. Please verify that latitude/longitude coordinates are over soil representative of your field.

location

lat, lon coordinates

no3

In the form of "<latitude>,<longitude>." This is invalid if latitude, longitude, or field_id are provided. Please verify that latitude/longitude coordinates are over soil representative of your field.

field_id

string

no3

Used to get latitude and longitude. This is invalid if latitude, longitude or field_id are provided.

fan_power

float

no3

Entry must be greater than zero and is required if fan_power_unit is provided. This is invalid if airflow and/or airflow_unit are provided.

fan_power_unit

string

no3

Unit provided can be either "kw" or "hp." This is required if fan_power is provided, but is invalid if airflow or airflow_unit are provided.

airflow

float

no3

Entry must be greater than zero. This is required if airflow_unit is provided, but is invalid if fan_power and/or fan_power_unit are provided.

airflow_unit

float

no3

Unit can be "m^3/s" or "ft^3/min." This is required if airflow is provided, but is invalid if fan_power and/or fan_power_unit are provided.

3 Denotes special rules for if a parameter is required or not.

Response Object

Returns "true" if the field drying facility asset was updated.

All valid properties for low and high temperature drying facilities are also described in the associated drying facility creation endpoints.

Example Request

https://ag.us.clearapis.com/v1.0/asset/drying_facility/modify/
fgh-567?app_id=123&app_key=321&account_id=123&user_id=xyz-123
&airflow=99&airflow_unit=m^3/s&fuel_type=liquid_propane
&fuel_unit=l&fuel_cost_per_unit=44

Example Response

{
    "asset_id":"fgh-567",
    "electricity_cost":4,
    "airflow":99,
    "fan_power_unit":null,
    "name":"Drying facility 1",
    "fan_distribution_area_unit":"m^2",
    "fan_efficiency":0.47,
    "fan_power":null,
    "modified":1464727035,
    "longitude":4,
    "grain_thickness_unit":"m",
    "created":1464726969,
    "latitude":12,
    "airflow_unit":"m^3/s",
    "electricity_cost_unit":"kwh",
    "type":0,
    "fan_distribution_area":99,
    "grain_thickness":4
}

Delete Drying Facility Asset - v1.0

This endpoint allows a user (with write privileges) to delete a drying facility asset and all permissions pertaining to that asset.

URL Description

https://ag.us.clearapis.com/v1.0/asset/drying_facility/delete/{asset_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.

asset_id

string

yes

Specifies ID of the asset to be deleted

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. (Must have write access on the asset in order to assign privileges.)

Response Object

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

Example Request

https://ag.us.clearapis.com/v1.0/asset/drying_facility/delete/fgh-567?
app_id=123&app_key=321&account_id=def-345&user_id=bcd-678

Example Response

true

Add Asset Permissions - v1.0

This endpoint allows a user (with write privileges) to add read or write privileges to an asset.

URL Description

https://ag.us.clearapis.com/v1.0/asset/permissions/add/{asset_id}/{target_user_ids}/
{privilege}?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.

asset_id

string

yes

Specifies ID of the asset to which the target user is being given privileges.

target_user_ids

string

yes

Specifies a comma-delimited list of IDs of user_ids to grant privileges.

privilege

string

yes

Specifies what type of privilege the target user(s) will be given. Valid options are "read" or "write."

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. (Must have write access on the asset in order to assign privileges.)

Response Object

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

Example Request

https://ag.us.clearapis.com/v1.0/asset/permissions/add/fgh-567/xyz-123/
read?app_id=123&app_key=321&account_id=def-345&user_id=bcd-678

Example Response

true

Modify Asset Permissions - v1.0

This endpoint allows a user (with write privileges) to modify privileges of other users on an asset.

URL Description

https://ag.us.clearapis.com/v1.0/asset/permissions/modify/{asset_id}/
{target_user_ids}/{privilege}?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.

asset_id

string

yes

Specifies ID of the asset to which the given target user is being given privileges.

target_user_ids

string

yes

Specifies a comma-delimited list of IDs of user_ids to grant privileges.

privilege

string

yes

Specifies what type of privilege the target user(s) will be given. Valid options are "read" or "write."

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. (Must have write access on the asset in order to assign privileges.)

Response Object

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

Example Request

https://ag.us.clearapis.com/v1.0/asset/permissions/modify/fgh-567/
xyz-123/write?app_id=123&app_key=321&account_id=def-345
&user_id=bcd-678

Example Response

true

Delete Asset Permissions - v1.0

This endpoint allows a user (with write privileges) to delete privileges on an asset.

URL Description

https://ag.us.clearapis.com/v1.0/asset/permissions/delete/{asset_id}/
{target_user_ids}?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.

asset_id

string

yes

Asset for which privileges are to be modified.

target_user_ids

string

yes

Comma-delimited list of user id’s for which privileges are to be removed.

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. (Must have write access on the asset in order to assign privileges.)

Response Object

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

Example Request

https://ag.us.clearapis.com/v1.0/asset/permissions/delete/fgh-567/
xyz-123?app_id=123&app_key=321&account_id=def-345
&user_id=bcd-678

Example Response

true

Add Harvest Activity - v1.0

This endpoint is to be used for the recording of harvest activities for a growth.

URL Description

https://ag.us.clearapis.com/v1.0/crop_health/growth/activity/harvest/add/{growth_id}?
app_id={string}&app_key={string}&account_id={string}&user_id={string}
&unit={string}&value={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 and used with the Accounts API.

growth_id

string

yes

Growth ID provided after successful growth creation.

unit

string

yes

Measurement of "value" parameter. Valid values include "kg/ha," "lb/ac," and "bu/ac."

value

float

yes

Numeric indicator of activity. Value must be a float greater than 0.0.

Response Object

Returns UUID of created harvest activity.

Example Request

https://ag.us.clearapis.com/v1.0/crop_health/growth/activity/harvest/add/321?
app_id=456&app_key=789&account_id=123&user_id=xyz-123&unit=lb/ac&value=2

Example Response

8888888-4444-4444-4444-cccccccccccc

Get Harvest Activity - v1.0

This endpoint allows a user (with read or write privileges) to receive information pertaining to a harvest activity by using an activity ID.

URL Description

https://ag.us.clearapis.com/v1.0/crop_health/growth/activity/
harvest/get/{activity_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.

activity_id

string

yes

Harvest activity ID for which to retrieve information.

Response Object (JSON)

Field Description

field_activity_id

ID of the harvest activity.

created

Unix timestamp.

modified

Returns "null" if not modified. Otherwise, a Unix timestamp is provided.

subtype

Enumeration value of the type of this harvest activity (integer).

value

Provided quantity of harvest.

activity_time

Unix timestamp.

unit

Applicable unit can be "kg/ha," "lb/ac," or "bu/ac."

activity_type

A valid entry is 302 (harvest).

Example Request

https://ag.us.clearapis.com/v1.0/crop_health/growth/activity/
harvest/get/123-5813?app_id=456&app_key=789&account_id=321&user_id=456

Example Response

{
    "field_activity_id":"7f012b65-d773-4274-a993-a3f389540143",
    "created":1470240044,
    "modified":null,
    "subtype":0,
    "value":2.3,
    "activity_time":1470240044,
    "unit":"kg/ha",
    "activity_type":302
}

Modify Harvest Activity - v1.0

This endpoint allows the user to modify a harvest activity.

URL Description

https://ag.us.clearapis.com/v1.0/crop_health/growth/activity/harvest/modify/
{activity_id}?app_id={string}&app_key={string}&activity_time={timestamp}
&unit={string}&value={float}&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.

activity_id

string

yes

Target harvest activity to modify.

activity_time

timestamp

no

Time the activity took place.

unit

string

yes

Unit of measurement for harvest. Valid values include "kg/ha," "lb/ac," and "bu/ac."

value

float

yes

Quantity of harvest. Value must be greater than zero.

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. Must have write privileges.

Response Object

Returns "true" on success.

Example Request

https://ag.us.clearapis.com/v1.0/crop_health/growth/activity/harvest/modify/12345f?
app_id=456&app_key=789&activity_time=1469134178&unit=lb/Ac&value=99
&account_id=124&user_id=xyz-123

Example Response

true

Delete Harvest Activity - v1.0

This endpoint allows for an existing harvest activity to be deleted.

URL Description

https://ag.us.clearapis.com/v1.0/crop_health/growth/activity/harvest/delete/
{activity_id}?app_id={string}&app_key={string}&user_id={string}
&account_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.

activity_id

UUID

yes

Specifies ID of the harvest activity that is to be deleted.

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.us.clearapis.com/v1.0/crop_health/growth/activity/harvest/delete/
321?app_id=456&app_key=789&account_id=123&user_id=xyz-123

Example Response

true

Appendix

Common HTTP response codes

The following are common HTTP response codes and their meanings. These are standard across all API services.

  • 200 OK - The request was successful.

  • 400 Bad Request - The request was invalid. An accompanying error message will be provided if available.

  • 401 Unauthorized - Authentication to the API has failed. Authentication credentials are missing or incorrect.

  • 403 Forbidden - You are trying to access a resource for which you do not have the appropriate privileges.

  • 404 Not found - The requested resource was not found. An accompanying error message will be provided if available.

  • 500 Internal Server Error - An internal server error has occurred while processing the request.

  • 502 Bad Gateway - The service is not reachable.

Null or Empty Values

In some cases values will be represented as "n/a." This indicates that the requested data is not available or is not applicable.

Unix Timestamp

Iteris employs Unix timestamps for some time-based parameters. Unix timestamps are defined as the number of seconds since 1970-01-01 00:00 Coordinated Universal Time (UTC), and are an absolute and universal measure of time, independent of timezones. For example, when the current Unix time is 1457543400, it is 1457543400 everywhere, whether it is the middle of the night or middle of the day at any particular location on Earth.

When requesting hourly or sub-hourly data, the use of Unix timestamps is straightforward. Simply convert the desired date/time/timezone into its corresponding Unix timestamp, and pass the resulting value in via the URL associated with the API request. For instance, if you wish to retrieve hourly data for the period spanning 2001-03-09 12:00 Central Standard Time (CST) to 2001-03-10 12:00 CST, you would pass in Unix timestamps of 984160800 and 984247200, respectively.

When requesting daily data, however, the use of Unix timestamps is less straightforward. Ideally, the Unix timestamps provided would be evaluated in the timezone of the requested location in order to interpret the date ranges desired from the request. However, since many of Iteris’ API endpoints permit requesting data for many different locations in a single query, the timezone may vary between the different locations included in the query. If the Unix timestamps were evaluated in the local timezone of each of the query locations, there would be instances when the data returned would be for a date range that is shifted by a day between the different locations, which is generally an undesirable behavior. For example, while 984160800 evaluates to 2001-03-09 in Central Standard Time (CST; which is equivalent to UTC-6), it evaluates to 2001-03-10 in New Zealand (UTC+12).

Because of this, when Unix timestamps are used in queries for daily data, the method employed by Iteris is to do all conversions between Unix timestamps and year/month/day assuming the timezone is UTC (equivalent to UTC+0). If you desire daily data for 2001-03-09, you must pass in a Unix timestamp that falls within the range 984096000 (corresponding to 2001-03-09 00:00 UTC) and 984182399 (2001-03-09 23:59:59 UTC). It is generally easiest to find an appropriate Unix timestamp by just converting the date/time/timezone string of “YYYY-MM-DD 00:00 UTC” replacing the year (YYYY), month (MM), and day (DD) as desired. If you wish for any particular date to be included, the Unix timestamps provided for the start and end of the query must encapsulate that date when evaluated in the UTC+0 timezone.

It is important to note that while the system Iteris employs for converting Unix timestamps in query URLs into the associated date ranges operates under the assumption of a UTC+0 timezone for daily data requests, the data that are returned from the requests are aligned to midnight-to-midnight local time in the timezone of each location contained in the request. For example, if locations in the Central and Mountain timezones of the United States are included in the same request, the data from locations falling in the Central timezone would be valid for the period spanning midnight-to-midnight CST (Central Standard Time), while the data from locations falling in the Mountain timezone would be valid for the period spanning midnight-to-midnight MST (Mountain Standard Time). Thus, if one were to create any sort of spatial display of data returned from Iteris’ daily data endpoints, the boundaries between timezones may be evident (for instance if rain fell in the hour prior to midnight immediately on the west side of the timezone boundary, while it fell in the hour following midnight immediately on the east side of the timezone boundary).

Regional-based Account Access

Any data stored by the Account API in one region is not available in another. Each region will require a unique set of credentials. Please contact your account representative if interested in utilizing an additional region. When attempting to use the credentials from one region with the services in another, an 'account not found' error will be returned with HTTP status code 400. See example below:

<title>400 Bad Request</title>
<h1>Bad Request</h1>
<p>Account not found.</p>

Plant Enumerations

Below is a listing of available values for plant_type and plant_name.

Plant Type Plant Name

50

barley

51

corn

57

springwheat

59

canola

60

sugarbeet

65

cotton

66

soybean

68

winter wheat

70

sorghum

72

sunflower

75

potato

76

peanut

77

tomato

78

bermuda turfgrass

79

zoysia turfgrass

Supported Crops by Feature

Crop Type Growth Model Growth Model Feedback Growth GDD Envelope Nutrient (Nitrogen) Modeling Harvest (Drydown) Modeling Focus Soil Conditions IMFocus Irrigation

Barley

X

X

X

X

X

X

X

Bermuda Turfgrass

X

X

X

Canola

X

X

X

X

X

X

X

Corn

X

X

X

X

X

X

X

Cotton

X

X

X

X

X

X

Peanut

X

Potato

X

Preset Almond

X

X

X

X

Preset Leaf Lettuce

X

X

X

X

Preset Lemon

X

X

X

X

Preset Orange

X

X

X

X

Preset Potato

X

X

X

X

Preset Strawberry

X

X

X

X

Preset Table Grape

X

X

X

X

Preset Tomato

X

X

X

X

Preset Wine Grape

X

X

X

X

Sorghum

X

X

X

X

X

X

Soybean

X

X

X

X

X

X

Spring wheat

X

X

X

X

X

X

X

Sugar Beet

X

X

X

Sunflower

X

X

X

X

X

X

Winter Wheat

X

X

X

X

X

X

X

Zoysia Turfgrass

X

X

X

Activity Enumerations

Activity Type

Coded Value Meaning

300

Planting

301

Spraying

302

Harvesting

303

Row Crop Cultivating

304

Post-harvest Tillage

305

Pre-planting Tillage

306

Cutting

307

Soil Test

308

Fertilizer Treatment

309

Grain Moisture Test

310

Scouting Report

311

Irrigation

Activity Subtype

Activity Type Subtype Code Meaning

Planting

0

Generic

Planting

50

Barley

Planting

51

Corn

Planting

57

Spring Wheat

Planting

59

Canola

Planting

60

Sugar Beets

Planting

65

Cotton

Spraying

0

Generic

Harvesting

0

Generic

Row Crop Cultivating

0

Generic

Post-harvest Tillage

0

Generic

Pre-planting Tillage

0

Generic

Cutting

0

Generic

Cutting

1

Alfalfa

Soil Test

0

Generic

Fertilizer Treatment

0

Generic

Grain Moisture Test

0

Generic

Scouting Report

0

Generic

Irrigation

0

Generic

Changelog

This section describes document changes occurring in the two most recent versions.

5/10/19

Revised definition for the "target_user_id" parameter in the Get Drying Facility Asset by User Access endpoint.

4/1/19

Text updates to introductory section.