{ "openapi": "3.0.1", "info": { "title": "Cropland Data Layers V2", "description": "Crop Land Data Layers, also known as CDLs, are published by USDA and provide estimates of\nhistorical crops cover.", "version": "1.0" }, "servers": [ { "url": "https://ag-analytics.azure-api.net/cdl-range-read" } ], "paths": { "/": { "get": { "summary": "Get Request Cropland Data Layers V2", "description": "\n\n\n\n\n\n\n
Parameter | \nDescription | \nExample | \nRequest | \n
---|---|---|---|
filename | \nFile name to download. From POST request. Only request a single file at a time. | \n result_raster_cdl_CultivatedLayer_ epsg_4326_resolution_None_10270.tif | \n https://ag-analytics.azure-api.net/cdl-range-read? filename=result_raster_cdl_CultivatedLayer_ epsg_4326_resolution_None_10270.tif | \n
Parameter | \nData Type | \nRequired? | \nDefault | \nOptions | \nDescription | \n
---|---|---|---|---|---|
file | \nGeoTiff or Shapfile in Zip | \nYes (otherwise pass aoi) | \n -- | \n-- | \nA 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) | \n
aoi | \nGeoJSON String, .shp file, GeoTIFF | \n Yes (otherwise pass file) | \n -- | \n-- | \nArea of interest to return. | \n
Projection | \nString | \nNo | \nSee Request Handling Table | \n EPSG code (\"EPSG:4326\") WKT | \n Output projection of result GeoTIFF. | \n
Resolution | \nFloat | \nNo | \nSee Request Handling Table | \n -- | \nOutput resolution of result GeoTIFF. | \n
years | \nList of integers as String | \nYes | \n-- | \n\"['2015','2016']\" | \nCall will return CDL GeoTiffs from the given years. | \n
product | \nList of string as String | \nNo | \n'CDL' | \n\"['CultivatedLayer','CDL']\" | \nGet 'CultivatedLayer','CDL', or both in the response | \n
AOI Type | \nProjection Specified? | \n Resolution Specified? | \n Ouput Projection | \nOutput Resolution | \n
---|---|---|---|---|
Any | \nYes | \nYes | \nRequest projection | \nRequest resolution | \n
GeoTIFF | \nYes | \nNo | \nRequest projection | \nGeoTIFF resolution | \n
GeoTIFF | \nNo | \nYes | \nGeoTIFF projection | \nRequest resolution | \n
GeoTIFF | \nNo | \nNo | \nGeoTIFF projection | \nGeoTIFF resolution | \n
Shapefile | \nYes | \nNo | \nRequest projection | \nNative tile resolution | \n
Shapefile | \nNo | \nYes | \nShapefile projection | \nRequest resolution | \n
Shapefile | \nNo | \nNo | \nShapefile projection | \nNative tile resolution | \n
GeoJSON | \nYes | \nNo | \nRequest projection | \nNative tile resolution | \n
GeoJSON | \nNo | \nYes | \nGeoJSON projection | \nRequest resolution | \n
GeoJSON | \nNo | \nNo | \nGeoJSON projection | \nNative tile resolution | \n
Parameter | \nData Type | \nDescription | \n
---|---|---|
year | \nKey | \nRequest year of CDL layer | \n
file | \nString | \nResult raster name. Can be used as request parameter for GET request | \n
attributes. extent | \n -- | \nExtents of the result raster. Specifies the bottom left and top right corners of the field raster in degrees. | \n
attributes. pngb64 | \n Link | \nBase64png image of the result raster with legend entries. | \n
attributes. legend | \n List | \nLegend gives the following details for each range of values: 1. color: Hex color used for the crop type 2. Area: Area of certain crop(see CropCode) covered in percentage 3. Count: Number of pixels from the result raster of certain crop(see Value) 4. CountAllPixels: Total number of pixels in the result raster 5. CropCode: CDL code, ex: CDL code for corn is 1 6. CropName: Crop name based on NASS in string 7. Acres: Area of the crop in acres | \n