Crop Factors API
getCropFactorsThe getCropFactors API provides weather data/factors specific to Ag Industry. With this API, you can retrieve satellite imagery derived weather factors, like Normalized Difference Vegetation Index (NDVI), Normalized Difference Water Index (NDWI), and Land Surface Temperature(LSTD & LSTN), and station collected weather data, like air temperature(TMAX & TMIN), and accumulated precipitation(PRCP). Data can be requested for a combination of counties and observation windows.
View All APIsContact Us to Get Access
Inputs
countyCoderequired
A county FIPS code or a code that identifies multiple counties. A valid code consists of multiple county FIPS codes separated by a comma, and the code can contain up to 100 counties. Mutually exclusive with stateCode.
Please click here to get a list of possible values.
Type
list (A comma or semi-colon delimited string.)
Example
19041,17019stateCodeoptional
A state FIPS code or a code that identifies multiple states. A valid code consists of multiple state FIPS codes separated by a comma, and the code can contain up to 20 states.
Please click here to get a list of possible values.
Type
list (A comma or semi-colon delimited string.)
Example
19,17startDaterequired
The start date of the historical data query. This parameter should be set to the desired start date/time for the query (the result set will include records back to, and including, this value). If not set, the value will default to 20240101
Type
dateTime (A date and time in the format of YYYY-MM-DD HH:MI:SS<TIMEZONE_OFFSET>.)
Example
20241101Default
20240101
endDateoptional
The end data of the historical data query. This parameter should be set to the desired end date/time for the query (the result set will include records up to, and including, this value). If not set, the value will default to the day specified in the start parameter.
Type
dateTime (A date and time in the format of YYYY-MM-DD HH:MI:SS<TIMEZONE_OFFSET>.)
Example
20241231Default
20241231
fieldsoptional
Additional as per-requested fields that the user can define. Requested fields should be separated by a comma.
Type
list-enum (A comma or semi-colon delimited string that must match a list of valid possible values.)
Example
ndviCount,ndwiCountValid Values
ndviCount, ndwiCount, lstdCount, lstnCount, tmaxCount, tminCount, prcpCount
Outputs
countyCode
always returned
always returned
FIPS code for the county. Concatenation of stateFipsCode and countyFipsCode.
string
A sequence of characters. (example: GOOG)
A sequence of characters. (example: GOOG)
county
always returned
always returned
The name of the county corresponds to the weather data.
string
A sequence of characters. (example: GOOG)
A sequence of characters. (example: GOOG)
state
always returned
always returned
2-char abbreviation of the state.
string
A sequence of characters. (example: GOOG)
A sequence of characters. (example: GOOG)
startDate
always returned
always returned
Start date of 8-days composite window.
date
A date in the format of YYYY-MM-DD.
A date in the format of YYYY-MM-DD.
endDate
always returned
always returned
End date of 8-days composite window.
date
A date in the format of YYYY-MM-DD.
A date in the format of YYYY-MM-DD.
ndvi
always returned
always returned
Average Normalized Difference Vegetation Index (NDVI) for croplands within a county calculated based on MODIS with daily updating.
double
A numeric type defining a number with fractional parts. (example: 2.14)
A numeric type defining a number with fractional parts. (example: 2.14)
ndviCount
as requested
as requested
Count of cropland grids(250m * 250m) that contributed to calculating NDVI
int
A numeric type defining a whole number. (example: 2)
A numeric type defining a whole number. (example: 2)
ndwi
always returned
always returned
Average Normalized Difference Water Index (NDWI) for croplands within a county calculated based on MODIS with daily updating.
double
A numeric type defining a number with fractional parts. (example: 2.14)
A numeric type defining a number with fractional parts. (example: 2.14)
ndwiCount
as requested
as requested
Count of cropland grids(250m * 250m) that contributed to calculating NDWI
int
A numeric type defining a whole number. (example: 2)
A numeric type defining a whole number. (example: 2)
lstd
always returned
always returned
Average Land Surface Temperature Daytime (LSTD) in Celsius degrees for croplands within a county calculated based on MODIS with daily updating. Unit in celsius degrees.
double
A numeric type defining a number with fractional parts. (example: 2.14)
A numeric type defining a number with fractional parts. (example: 2.14)
lstdCount
as requested
as requested
Count of cropland grids(250m * 250m) that contributed to calculating LSTD
int
A numeric type defining a whole number. (example: 2)
A numeric type defining a whole number. (example: 2)
lstn
always returned
always returned
Average Land Surface Temperature Nighttime (LSTN) in Celsius degrees for croplands within a county calculated based on MODIS with daily updating. Unit in celsius degrees.
double
A numeric type defining a number with fractional parts. (example: 2.14)
A numeric type defining a number with fractional parts. (example: 2.14)
lstnCount
as requested
as requested
Count of cropland grids(250m * 250m) that contributed to calculating LSTN.
int
A numeric type defining a whole number. (example: 2)
A numeric type defining a whole number. (example: 2)
tmax
always returned
always returned
Average Maximum Air Temperature in Celsius degrees for a county calculated based on land surface stations with daily updating.
double
A numeric type defining a number with fractional parts. (example: 2.14)
A numeric type defining a number with fractional parts. (example: 2.14)
tmaxCount
as requested
as requested
Count of land surface stations that contributed to calculating TMAX.
int
A numeric type defining a whole number. (example: 2)
A numeric type defining a whole number. (example: 2)
tmin
always returned
always returned
Average Minimum Air Temperature in Celsius degrees for a county calculated based on land surface stations with daily updating.
double
A numeric type defining a number with fractional parts. (example: 2.14)
A numeric type defining a number with fractional parts. (example: 2.14)
tminCount
as requested
as requested
Count of land surface stations that contributed to calculating TMIN.
int
A numeric type defining a whole number. (example: 2)
A numeric type defining a whole number. (example: 2)
prcp
always returned
always returned
Average accumulated precipitation in millimeter for a county in the 8-days window.
double
A numeric type defining a number with fractional parts. (example: 2.14)
A numeric type defining a number with fractional parts. (example: 2.14)
prcpCount
as requested
as requested
Count of land surface stations that contributed to calculating PRCP.
int
A numeric type defining a whole number. (example: 2)
A numeric type defining a whole number. (example: 2)
updatedAt
always returned
always returned
Date that factors were last updated for a county.
dateTime
A date and time in the format of YYYY-MM-DD HH:MI:SS<TIMEZONE_OFFSET>.
A date and time in the format of YYYY-MM-DD HH:MI:SS<TIMEZONE_OFFSET>.
Status Code Responses
200
OK
Success
400
Bad Request
The request was invalid, please see the message for more information.
500
Internal Server Error
Something is not working correctly, please contact support.
JSON
GET
GET https://ondemand.websol.barchart.com/getCropFactors.json?apikey=YOUR_API_KEY&countyCode=19041%2C17019&stateCode=19%2C17&startDate=20241101&endDate=20241231&fields=ndviCount%2CndwiCount
Host: ondemand.websol.barchart.com
POST
POST https://ondemand.websol.barchart.com/getCropFactors.json
Host: ondemand.websol.barchart.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length
apikey=YOUR_API_KEY&countyCode=19041%2C17019&stateCode=19%2C17&startDate=20241101&endDate=20241231&fields=ndviCount%2CndwiCount
Response
{
"status": {
"code": 204,
"message": "Success, but no content to return."
},
"results": []
}XML
GET
GET https://ondemand.websol.barchart.com/getCropFactors.xml?apikey=YOUR_API_KEY&countyCode=19041%2C17019&stateCode=19%2C17&startDate=20241101&endDate=20241231&fields=ndviCount%2CndwiCount
Host: ondemand.websol.barchart.com
POST
POST https://ondemand.websol.barchart.com/getCropFactors.xml
Host: ondemand.websol.barchart.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length
apikey=YOUR_API_KEY&countyCode=19041%2C17019&stateCode=19%2C17&startDate=20241101&endDate=20241231&fields=ndviCount%2CndwiCount
Response
<?xml version="1.0" encoding="utf-8"?>
<getCropFactors>
<status>
<code>204</code>
<message>Success, but no content to return.</message>
</status>
</getCropFactors>
CSV
GET
GET https://ondemand.websol.barchart.com/getCropFactors.csv?apikey=YOUR_API_KEY&countyCode=19041%2C17019&stateCode=19%2C17&startDate=20241101&endDate=20241231&fields=ndviCount%2CndwiCount
Host: ondemand.websol.barchart.com
POST
POST https://ondemand.websol.barchart.com/getCropFactors.csv
Host: ondemand.websol.barchart.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length
apikey=YOUR_API_KEY&countyCode=19041%2C17019&stateCode=19%2C17&startDate=20241101&endDate=20241231&fields=ndviCount%2CndwiCount
Response
PHP
<?php
$ondemand = new SoapClient('https://ondemand.websol.barchart.com/service?wsdl');
$params = [
'apikey' => 'YOUR_API_KEY',
'countyCode' => '19041,17019',
'stateCode' => '19,17',
'startDate' => '20241101',
'endDate' => '20241231',
'fields' => 'ndviCount,ndwiCount',
];
$result = $ondemand->getCropFactors($params);
var_dump($result);Classic ASP
Dim ondemand
Dim result
Set ondemand = Server.CreateObject("MSSOAP.SoapClient30")
ondemand.ClientProperty("ServerHTTPRequest") = True
ondemand.MSSoapInit("https://ondemand.websol.barchart.com/service?wsdl")
Set result = ondemand.getCropFactors("YOUR_API_KEY", "19041,17019", "19,17", "20241101", "20241231", "ndviCount,ndwiCount")Perl
use SOAP::Lite;
use SOAP::WSDL;
my $ondemand = SOAP::Lite
-> service('https://ondemand.websol.barchart.com/service?wsdl');
my $result = $ondemand->getCropFactors('YOUR_API_KEY', '19041,17019', '19,17', '20241101', '20241231', 'ndviCount,ndwiCount');
print $result;Python
from suds.client import Client
ondemand = Client('https://ondemand.websol.barchart.com/service?wsdl')
result = ondemand.service.getCropFactors('YOUR_API_KEY', '19041,17019', '19,17', '20241101', '20241231', 'ndviCount,ndwiCount')
print(result)Ruby
require 'savon'
ondemand = Savon.client(wsdl: 'https://ondemand.websol.barchart.com/service?wsdl')
response = ondemand.call(
:getCropFactors,
message: {
apikey: 'YOUR_API_KEY',
countyCode: '19041,17019',
stateCode: '19,17',
startDate: '20241101',
endDate: '20241231',
fields: 'ndviCount,ndwiCount',
}
)
response.body