# paths./.post.description
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.

BUY

TRIAL

This API is utilized to drive the Ag-Analytics SSURGO soil panel below, for illustration. Area calculations from the API are provided in square meters and can be easily converted to acres on the front-end. The API Response contains shapes/features in ESRI JSON format, as well as the calculated metric (e.g., National Commodity Crop Productivity Index) and areas of each shape, the soil type name, the area for the sums of each soil type across all features for display in the table, metadata related to projection and other information. This API can be easily called and mapped using any standard front-end JavaScript mapping library (e.g., Leaflet).

Please note, this SSURGO Soil v2 API features changes in the response. Changes will be reflected in the Documentation and Jupyter Notebook.

SSURGO Soils in Ag-Analytics DataLayers.

Documentation

Notebook

Github Repo

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.

Request Parameters ▼

Request Parameters

Parameter

Data Type

Required?

Default

Options

Description

AOI

String

Yes (otherwise
pass file)

--

Geojson or
esriGeometryType

If no spatial specification was provided, the result raster
will use the Ag-Analytics default spatial reference:
WGS 84, resolution at 0.0001 degree

File

GeoTIFF or
ShapeFile in a zip

Yes (otherwise
pass AOI)

-

-

A GeoTiff (.TIFF,.Tif, .etc) or a Shapefile in Zip
(must include shp, shx, dbf, but others files such as .prj, .xml,
.cpg are recommended for better processing)

Projection

String

No

"EPSG:4326"

ex:"EPSG:4326"

Output projection of result GeoTIFF.

Resolution

String

No

"nccpi2all"

Full NRCS List

The soil metric to return, see the
NRCS variables PDF for full list with descriptions

Request Handling - Default Projections and Resolutions

AOI Type

Projection
Specified?

Resolution
Specified?

Ouput Projection

Output Resolution

Any

Yes

Yes

Request projection

Request resolution

GeoTIFF

Yes

No

Request projection

GeoTIFF resolution

GeoTIFF

No

Yes

GeoTIFF projection

Request resolution

GeoTIFF

No

No

GeoTIFF projection

GeoTIFF resolution

Shapefile

Yes

No

Request projection

Default resolution

Shapefile

No

Yes

Shapefile projection

Request resolution

Shapefile

No

No

Shapefile projection

Default resolution

GeoJSON

Yes

No

Request projection

Default resolution

GeoJSON

No

Yes

GeoJSON projection

Request resolution

GeoJSON

No

No

GeoJSON projection

Default resolution

Response Parameters ▼

Raster Response Parameters

Parameter

Type

Description

CellSize

List

Cell size/ Resolution of result raster

CoordinateSystem

String

Coordinate System of result raster

Extent

String

Corner coordinates of result raster

Soil_Parameter

String

Soil metric/parameter

Weighted_Average

Float

Weighted average soil matrix value

pngb64

String

Base 64 png string.

Legend

List

Legend gives the following details for each range of values:

1. color: Hex color used for the crop type
2. Area: area of the Soil Type (see Soil_Type) covered in percentage
3. Count: Number of pixels from the result raster of a certain Soil_Type
4. CountAllPixels: Total number of pixels in the result raster
5. Soil_Type: Soil type in String
6. Value: Soil type in index, mukey value
7. Soil_Value: Value of requested soil matrix on current soil type

GeoJSON Response Parameters

Parameter

Type

Description

GeoJSON

GeoJSON

Return the results as a FeatureCollection.
The properties are also attached to each GeoJSON object.

Soil_Parameter

String

Request soil matrix/parameter

Weighted_Average

Float

Weighted average soil matrix/parameter by area

Properties.SoilType

String

Soil type name in string

Properties.area

Float

Area in acreage of current soil type

Properties.mukey

Integer

Soil type key as integer

Properties.Request
SoilParameter

Float

RequestSoilParameter will be based on the parameter in request.
This parameter gives back the soil matrix/parameter value of current soil type.
ex: Properties.nccpi2all

# paths./.get.description
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.

BUY

TRIAL

This API is utilized to drive the Ag-Analytics SSURGO soil panel below, for illustration. Area calculations from the API are provided in square meters and can be easily converted to acres on the front-end. The API Response contains shapes/features in ESRI JSON format, as well as the calculated metric (e.g., National Commodity Crop Productivity Index) and areas of each shape, the soil type name, the area for the sums of each soil type across all features for display in the table, metadata related to projection and other information. This API can be easily called and mapped using any standard front-end JavaScript mapping library (e.g., Leaflet).

Please note, this SSURGO Soil v2 API features changes in the response. Changes will be reflected in the Documentation and Jupyter Notebook.

SSURGO Soils in Ag-Analytics DataLayers.

Documentation

Notebook

Github Repo

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.

GET Request

Parameter

Description

Example

Request

filename

File name to download. From POST request.

result_ssurgo_raster_proj_
4326_res_0.0001_202007091
92551017948.tif

https://ag-analytics.azure-api.net/ssurgo-v2?
filename=result_ssurgo_raster_proj_ 4326_
res_0.0001_20200709192551017948.tif

# paths./.get.parameters[].description
SSURGO raster file name from POST response