BoundaryAI v2

GET Request Common Land Unit Boundary

Please note, you need to purchase a subscription key to call the API.
Please use the trial version to try now for a limited amount of uses before purchase.


It is not uncommon for more than one crop to be grown on a CLU. These CLU boundaries are derived from the last publicly available distribution from 2008. A single CLU is approximately interpreted as a “field”. A Common Land Unit (CLU) is the smallest unit of land that has a permanent, contiguous boundary, a common land cover and land management, a common owner and a common producer in agricultural land associated with USDA farm programs.

The Ag-Analytics Common Land Unit Boundary API provides a service for which a user can pass a point (x, y coordinates pair), a line, an envelope (bounding box), or a polygon in geojson. The service will send back boundaries in geojson. To retrieve the desired level of boundary, user will need to pass a level parameter in the GET request.


CLU Boundaries in Ag-Analytics FarmScope.



Click the Jupyter Notebook Static Sample to view a static rendition of this APIs Jupyter Notebook.
Click the Jupyter Notebook Github Repo to access the Jupyter Notebook .ipynb files and
instructions needed in order to run this APIs Jupyter Notebook.

Level Descriptions


Parameter Source Description
Common Land Unit (CLU)
USDA

Boundaries from this source are derived from the last publicly
made 2008 Common Land Unit (CLU) boundaries distribution by the USDA.
1 SQMI Grid
Ag-Analytics
One square mile grids created by Ag-Analytics
Public Land Survey System (PLSS)
USGS
The Public Land Survey System (PLSS) is the surveying method developed and used
in the United States to plat, or divide, real property for sale and settling.
Public Land Survey
System (PLSS) - First Division

USGS
This source provides the boundaries of first division when PLSS is not available.
County
United States Census
County level US boundaries
State
United States Census
State level US boundaries

Request Parameters


Parameter Type Required? Default Option Description
Geometry GeoJSON/JSON Yes 'envelope' GeoJSON, JSON, envelope, point The AOI used for searching boundaries. It can be a point (x,y coordinate pairs),
a line or polygon in GeoJSON, or an envelope (bounding box with xmin, xmax, ymin, ymax).
Geometry_type String Yes - 'envelope', 'point', 'line', 'polygon' The geometry type of the geometry passed in the request.
Level String No 'CLU' 'CLU', 'County', 'State', 'PLSS',
'PLSS_FIRSTDIVISION',
'1SQMI_GRID'
Boundary searching level. See description above.

Response Parameters


Parameter Data Type Description
status String Status of the API call
1. SUCCEED: API call was successful.
2. FAILURE: API call was failed, see msg for error message.
3. NoFound: No boundaries found for current geometry
msg String Messages from the API call
results GeoJSON If the API call was successful, all boundaries will be returned
in GeoJSON as a feature collection



Call API

Request

Request URL

Request parameters

  • json, geojson

    The geometry to apply as the spatial filter.

  • String

    The geometry type of the geometry passed in the request.

Request headers

  • string

Request body

Responses

200 OK

Code samples

@ECHO OFF

curl -v -X GET "https://ag-analytics.azure-api.net/CommonLandUnitBoundary-v2/?Geometry={"geometryType": "esriGeometryPolygon", "features": [{"geometry": {"rings": [[[-91.53900737389114, 34.55980772414722], [-91.53894861128936, 34.560481053757655], [-91.53892673258258, 34.56192576336332], [-91.53889249809026, 34.56325987524309], [-91.5388720178293, 34.564625711607334], [-91.53882557593954, 34.566462376337654], [-91.53913423046032, 34.566538207172584], [-91.53917447152463, 34.566730301462314], [-91.53962869840569, 34.566740245266146], [-91.54305890694297, 34.56681730907161], [-91.54305614512498, 34.566585087032195], [-91.54304565183531, 34.56613185570063], [-91.54306887772651, 34.56417543544802], [-91.54310131717199, 34.562940478320456], [-91.54309762365637, 34.56170736210515], [-91.54308258968973, 34.561319449433086], [-91.54285584362225, 34.56111836821816], [-91.54218857094577, 34.56094358497853], [-91.54135688960872, 34.560665392294084], [-91.54036096688509, 34.56031309277506], [-91.53965887605625, 34.560065743239534], [-91.53900737389114, 34.55980772414722]]], "spatialReference": {"wkid": 4326}}}]}&Geometry_type=polygon"
-H "Ocp-Apim-Subscription-Key: {subscription key}"

--data-ascii "{body}" 
using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;

namespace CSHttpClientSample
{
    static class Program
    {
        static void Main()
        {
            MakeRequest();
            Console.WriteLine("Hit ENTER to exit...");
            Console.ReadLine();
        }
        
        static async void MakeRequest()
        {
            var client = new HttpClient();
            var queryString = HttpUtility.ParseQueryString(string.Empty);

            // Request headers
            client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");

            // Request parameters
            queryString["Geometry"] = "{"geometryType": "esriGeometryPolygon", "features": [{"geometry": {"rings": [[[-91.53900737389114, 34.55980772414722], [-91.53894861128936, 34.560481053757655], [-91.53892673258258, 34.56192576336332], [-91.53889249809026, 34.56325987524309], [-91.5388720178293, 34.564625711607334], [-91.53882557593954, 34.566462376337654], [-91.53913423046032, 34.566538207172584], [-91.53917447152463, 34.566730301462314], [-91.53962869840569, 34.566740245266146], [-91.54305890694297, 34.56681730907161], [-91.54305614512498, 34.566585087032195], [-91.54304565183531, 34.56613185570063], [-91.54306887772651, 34.56417543544802], [-91.54310131717199, 34.562940478320456], [-91.54309762365637, 34.56170736210515], [-91.54308258968973, 34.561319449433086], [-91.54285584362225, 34.56111836821816], [-91.54218857094577, 34.56094358497853], [-91.54135688960872, 34.560665392294084], [-91.54036096688509, 34.56031309277506], [-91.53965887605625, 34.560065743239534], [-91.53900737389114, 34.55980772414722]]], "spatialReference": {"wkid": 4326}}}]}";
            queryString["Geometry_type"] = "polygon";
            var uri = "https://ag-analytics.azure-api.net/CommonLandUnitBoundary-v2/?" + queryString;

            var response = await client.GetAsync(uri);
        }
    }
}	
// // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

public class JavaSample 
{
    public static void main(String[] args) 
    {
        HttpClient httpclient = HttpClients.createDefault();

        try
        {
            URIBuilder builder = new URIBuilder("https://ag-analytics.azure-api.net/CommonLandUnitBoundary-v2/");

            builder.setParameter("Geometry", "{"geometryType": "esriGeometryPolygon", "features": [{"geometry": {"rings": [[[-91.53900737389114, 34.55980772414722], [-91.53894861128936, 34.560481053757655], [-91.53892673258258, 34.56192576336332], [-91.53889249809026, 34.56325987524309], [-91.5388720178293, 34.564625711607334], [-91.53882557593954, 34.566462376337654], [-91.53913423046032, 34.566538207172584], [-91.53917447152463, 34.566730301462314], [-91.53962869840569, 34.566740245266146], [-91.54305890694297, 34.56681730907161], [-91.54305614512498, 34.566585087032195], [-91.54304565183531, 34.56613185570063], [-91.54306887772651, 34.56417543544802], [-91.54310131717199, 34.562940478320456], [-91.54309762365637, 34.56170736210515], [-91.54308258968973, 34.561319449433086], [-91.54285584362225, 34.56111836821816], [-91.54218857094577, 34.56094358497853], [-91.54135688960872, 34.560665392294084], [-91.54036096688509, 34.56031309277506], [-91.53965887605625, 34.560065743239534], [-91.53900737389114, 34.55980772414722]]], "spatialReference": {"wkid": 4326}}}]}");
            builder.setParameter("Geometry_type", "polygon");

            URI uri = builder.build();
            HttpGet request = new HttpGet(uri);
            request.setHeader("Ocp-Apim-Subscription-Key", "{subscription key}");


            // Request body
            StringEntity reqEntity = new StringEntity("{body}");
            request.setEntity(reqEntity);

            HttpResponse response = httpclient.execute(request);
            HttpEntity entity = response.getEntity();

            if (entity != null) 
            {
                System.out.println(EntityUtils.toString(entity));
            }
        }
        catch (Exception e)
        {
            System.out.println(e.getMessage());
        }
    }
}

<!DOCTYPE html>
<html>
<head>
    <title>JSSample</title>
    <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>

<script type="text/javascript">
    $(function() {
        var params = {
            // Request parameters
            "Geometry": "{"geometryType": "esriGeometryPolygon", "features": [{"geometry": {"rings": [[[-91.53900737389114, 34.55980772414722], [-91.53894861128936, 34.560481053757655], [-91.53892673258258, 34.56192576336332], [-91.53889249809026, 34.56325987524309], [-91.5388720178293, 34.564625711607334], [-91.53882557593954, 34.566462376337654], [-91.53913423046032, 34.566538207172584], [-91.53917447152463, 34.566730301462314], [-91.53962869840569, 34.566740245266146], [-91.54305890694297, 34.56681730907161], [-91.54305614512498, 34.566585087032195], [-91.54304565183531, 34.56613185570063], [-91.54306887772651, 34.56417543544802], [-91.54310131717199, 34.562940478320456], [-91.54309762365637, 34.56170736210515], [-91.54308258968973, 34.561319449433086], [-91.54285584362225, 34.56111836821816], [-91.54218857094577, 34.56094358497853], [-91.54135688960872, 34.560665392294084], [-91.54036096688509, 34.56031309277506], [-91.53965887605625, 34.560065743239534], [-91.53900737389114, 34.55980772414722]]], "spatialReference": {"wkid": 4326}}}]}",
            "Geometry_type": "polygon",
        };
      
        $.ajax({
            url: "https://ag-analytics.azure-api.net/CommonLandUnitBoundary-v2/?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
            },
            type: "GET",
            // Request body
            data: "{body}",
        })
        .done(function(data) {
            alert("success");
        })
        .fail(function() {
            alert("error");
        });
    });
</script>
</body>
</html>
#import <Foundation/Foundation.h>

int main(int argc, const char * argv[])
{
    NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
    
    NSString* path = @"https://ag-analytics.azure-api.net/CommonLandUnitBoundary-v2/";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"Geometry={"geometryType": "esriGeometryPolygon", "features": [{"geometry": {"rings": [[[-91.53900737389114, 34.55980772414722], [-91.53894861128936, 34.560481053757655], [-91.53892673258258, 34.56192576336332], [-91.53889249809026, 34.56325987524309], [-91.5388720178293, 34.564625711607334], [-91.53882557593954, 34.566462376337654], [-91.53913423046032, 34.566538207172584], [-91.53917447152463, 34.566730301462314], [-91.53962869840569, 34.566740245266146], [-91.54305890694297, 34.56681730907161], [-91.54305614512498, 34.566585087032195], [-91.54304565183531, 34.56613185570063], [-91.54306887772651, 34.56417543544802], [-91.54310131717199, 34.562940478320456], [-91.54309762365637, 34.56170736210515], [-91.54308258968973, 34.561319449433086], [-91.54285584362225, 34.56111836821816], [-91.54218857094577, 34.56094358497853], [-91.54135688960872, 34.560665392294084], [-91.54036096688509, 34.56031309277506], [-91.53965887605625, 34.560065743239534], [-91.53900737389114, 34.55980772414722]]], "spatialReference": {"wkid": 4326}}}]}",
                         @"Geometry_type=polygon",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"GET"];
    // Request headers
    [_request setValue:@"{subscription key}" forHTTPHeaderField:@"Ocp-Apim-Subscription-Key"];
    // Request body
    [_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
    
    NSURLResponse *response = nil;
    NSError *error = nil;
    NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];

    if (nil != error)
    {
        NSLog(@"Error: %@", error);
    }
    else
    {
        NSError* error = nil;
        NSMutableDictionary* json = nil;
        NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
        NSLog(@"%@", dataString);
        
        if (nil != _connectionData)
        {
            json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
        }
        
        if (error || !json)
        {
            NSLog(@"Could not parse loaded json with error:%@", error);
        }
        
        NSLog(@"%@", json);
        _connectionData = nil;
    }
    
    [pool drain];

    return 0;
}
<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';

$request = new Http_Request2('https://ag-analytics.azure-api.net/CommonLandUnitBoundary-v2/');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'Ocp-Apim-Subscription-Key' => '{subscription key}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'Geometry' => '{"geometryType": "esriGeometryPolygon", "features": [{"geometry": {"rings": [[[-91.53900737389114, 34.55980772414722], [-91.53894861128936, 34.560481053757655], [-91.53892673258258, 34.56192576336332], [-91.53889249809026, 34.56325987524309], [-91.5388720178293, 34.564625711607334], [-91.53882557593954, 34.566462376337654], [-91.53913423046032, 34.566538207172584], [-91.53917447152463, 34.566730301462314], [-91.53962869840569, 34.566740245266146], [-91.54305890694297, 34.56681730907161], [-91.54305614512498, 34.566585087032195], [-91.54304565183531, 34.56613185570063], [-91.54306887772651, 34.56417543544802], [-91.54310131717199, 34.562940478320456], [-91.54309762365637, 34.56170736210515], [-91.54308258968973, 34.561319449433086], [-91.54285584362225, 34.56111836821816], [-91.54218857094577, 34.56094358497853], [-91.54135688960872, 34.560665392294084], [-91.54036096688509, 34.56031309277506], [-91.53965887605625, 34.560065743239534], [-91.53900737389114, 34.55980772414722]]], "spatialReference": {"wkid": 4326}}}]}',
    'Geometry_type' => 'polygon',
);

$url->setQueryVariables($parameters);

$request->setMethod(HTTP_Request2::METHOD_GET);

// Request body
$request->setBody("{body}");

try
{
    $response = $request->send();
    echo $response->getBody();
}
catch (HttpException $ex)
{
    echo $ex;
}

?>
########### Python 2.7 #############
import httplib, urllib, base64

headers = {
    # Request headers
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.urlencode({
    # Request parameters
    'Geometry': '{"geometryType": "esriGeometryPolygon", "features": [{"geometry": {"rings": [[[-91.53900737389114, 34.55980772414722], [-91.53894861128936, 34.560481053757655], [-91.53892673258258, 34.56192576336332], [-91.53889249809026, 34.56325987524309], [-91.5388720178293, 34.564625711607334], [-91.53882557593954, 34.566462376337654], [-91.53913423046032, 34.566538207172584], [-91.53917447152463, 34.566730301462314], [-91.53962869840569, 34.566740245266146], [-91.54305890694297, 34.56681730907161], [-91.54305614512498, 34.566585087032195], [-91.54304565183531, 34.56613185570063], [-91.54306887772651, 34.56417543544802], [-91.54310131717199, 34.562940478320456], [-91.54309762365637, 34.56170736210515], [-91.54308258968973, 34.561319449433086], [-91.54285584362225, 34.56111836821816], [-91.54218857094577, 34.56094358497853], [-91.54135688960872, 34.560665392294084], [-91.54036096688509, 34.56031309277506], [-91.53965887605625, 34.560065743239534], [-91.53900737389114, 34.55980772414722]]], "spatialReference": {"wkid": 4326}}}]}',
    'Geometry_type': 'polygon',
})

try:
    conn = httplib.HTTPSConnection('ag-analytics.azure-api.net')
    conn.request("GET", "/CommonLandUnitBoundary-v2/?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################

########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64

headers = {
    # Request headers
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.parse.urlencode({
    # Request parameters
    'Geometry': '{"geometryType": "esriGeometryPolygon", "features": [{"geometry": {"rings": [[[-91.53900737389114, 34.55980772414722], [-91.53894861128936, 34.560481053757655], [-91.53892673258258, 34.56192576336332], [-91.53889249809026, 34.56325987524309], [-91.5388720178293, 34.564625711607334], [-91.53882557593954, 34.566462376337654], [-91.53913423046032, 34.566538207172584], [-91.53917447152463, 34.566730301462314], [-91.53962869840569, 34.566740245266146], [-91.54305890694297, 34.56681730907161], [-91.54305614512498, 34.566585087032195], [-91.54304565183531, 34.56613185570063], [-91.54306887772651, 34.56417543544802], [-91.54310131717199, 34.562940478320456], [-91.54309762365637, 34.56170736210515], [-91.54308258968973, 34.561319449433086], [-91.54285584362225, 34.56111836821816], [-91.54218857094577, 34.56094358497853], [-91.54135688960872, 34.560665392294084], [-91.54036096688509, 34.56031309277506], [-91.53965887605625, 34.560065743239534], [-91.53900737389114, 34.55980772414722]]], "spatialReference": {"wkid": 4326}}}]}',
    'Geometry_type': 'polygon',
})

try:
    conn = http.client.HTTPSConnection('ag-analytics.azure-api.net')
    conn.request("GET", "/CommonLandUnitBoundary-v2/?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################
require 'net/http'

uri = URI('https://ag-analytics.azure-api.net/CommonLandUnitBoundary-v2/')

query = URI.encode_www_form({
    # Request parameters
    'Geometry' => '{"geometryType": "esriGeometryPolygon", "features": [{"geometry": {"rings": [[[-91.53900737389114, 34.55980772414722], [-91.53894861128936, 34.560481053757655], [-91.53892673258258, 34.56192576336332], [-91.53889249809026, 34.56325987524309], [-91.5388720178293, 34.564625711607334], [-91.53882557593954, 34.566462376337654], [-91.53913423046032, 34.566538207172584], [-91.53917447152463, 34.566730301462314], [-91.53962869840569, 34.566740245266146], [-91.54305890694297, 34.56681730907161], [-91.54305614512498, 34.566585087032195], [-91.54304565183531, 34.56613185570063], [-91.54306887772651, 34.56417543544802], [-91.54310131717199, 34.562940478320456], [-91.54309762365637, 34.56170736210515], [-91.54308258968973, 34.561319449433086], [-91.54285584362225, 34.56111836821816], [-91.54218857094577, 34.56094358497853], [-91.54135688960872, 34.560665392294084], [-91.54036096688509, 34.56031309277506], [-91.53965887605625, 34.560065743239534], [-91.53900737389114, 34.55980772414722]]], "spatialReference": {"wkid": 4326}}}]}',
    'Geometry_type' => 'polygon'
})
if query.length > 0
  if uri.query && uri.query.length > 0
    uri.query += '&' + query
  else
    uri.query = query
  end
end

request = Net::HTTP::Get.new(uri.request_uri)
# Request headers
request['Ocp-Apim-Subscription-Key'] = '{subscription key}'
# Request body
request.body = "{body}"

response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
    http.request(request)
end

puts response.body