Table of Key-Value-Pair (KVP) Operands for Subsetting, Reformatting, and Reprojection Services

Required field.  short name ID of the
data set.

The following tables list an overview of services provided for each collection:

1. SMAP
2. MODIS
3. ICESat-2
4. ICESat/GLAS
5. AMSR-E
6. VIIRS

short_name=MOD10A1

Request email associated with Earthdata Login account:
email=yes
OR
email=true

Request specified email:
email=name@domain.com

Data set version number. If not specified,
all available versions will be returned.
To determine the verion number, query CMR
collection metadata.
For example:

curl "https://cmr.earthdata.nasa.gov/search/
collections.json?short_name=SPL3SMP&pretty=true"
| grep version_id

version=005

Temporal range filter (start_time,end_time). Valid entries include:

time=yyyy-MM-dd,yyyy-MM-dd
time=yyyy-MM-ddTHH:mm:ssZ,yyyy-MM-ddTHH:mm:ssZ
time=yyyy-MM-ddTHH:mm:ss,yyyy-MM-ddTHH:mm:ss

If no time is specified, the day
defaults to T00:00:00. This parameter is the WCS
compatible equivalent of the CMR temporal
parameter.

time=2018-06-06,2018-06-07

Sort order of returned files from the CMR
search. If a temporal range search is performed, the
search results will be sorted by temporal overlap
percentage over all ranges provided by default.
Otherwise, results are sorted by ascending entry title by
default. See Sorting Collection Results in the CMR
documentation for more info.

Sort files by descending start date (most recent data first):

sort_key=-start_date

Required if you request bounding box subsetting, below. Specifies a search filter to find files with a spatial extent
that overlaps this bounding box, specified in decimal
degrees of latitude and longitude in WSEN format:

bounding_box=lower_left_long,lower_left_lat,
upper_right_long,upper_right_lat

Unlike bounding_box above, bbox specifies a bounding box to
be used for spatial subsetting. The coordinates must match the coordinates entered in the bounding_box parameter, above. Output files will be cropped to
the specified bounding box extent.

bbox=lower_left_long,lower_left_lat,
upper_right_long,upper_right_lat

Required when spatially subsetting by boundingshape or uploading a Shapefile or KML (currently only available for ICESat-2 and some SMAP data). This filters for (i.e., returns only) files with a spatial extent that overlaps the polygon
boundary. The polygon should be defined by longitude, latitude coordinate pairs in decimal degrees, e.g., lon1,lat1,
lon2,lat2,lon3,lat3,...,lon1,lat1, in counter-clockwise order and containing a minimum of four coordinate pairs.

*The last point must match the first point to close the polygon.

Spatial subsetting applied using either a GeoJSON content string or a listing of coordinate pairs. The coordinates must be
equal or nearly equal to the coordinates entered in the polygon parameter, above. Output files will be cropped to the boundingshape extent as defined by the GeoJSON or the coordinate pairs.

GeoJSON example format: boundingshape={"type":"Polygon","coordinates": [[[lon_1, lat_1],[lon_2, lat_2],[lon_3, lat_3],...,[lon_1, lat_1]]]}

Coordinate pairs example format: boundingshape=lon_1,lat_1,lon_2,lat_2,lon_3,lat_3,...,lon_1,lat_1

*The last point must match the first point to close the boundingshape.

GeoJSON example:
boundingshape={"type":"Polygon","coordinates": [[[-25.41,66.67][-14.73,67.02],[-12.71,64.28],[-23.3,62.14],[-25.41,66.67] ]]}

Coordinate pairs list example:
boundingshape=-25.41,66.67,-14.73,67.02,-12.71,64.28,
-23.3,62.14,-25.41,66.67
 

Esri Shapefile or KML/KMZ is uploaded to the request. Shapefile must be uploaded as a .zip including .shp, .dbf, and .shx files. This parameter must be included separately as an HTTP POST request.

shapefile=@FILE-NAME-OF-SHAPEFILE

Reformats the output. Supported options
are data set-specific (see Step 1 to determine valid format
options). Options include:

[GeoTIFF, HDF-EOS5, NetCDF4-CF, NetCDF-3, ASCII, TABULAR_ASCII, HDF-EOS, KML, Shapefile]

This parameter is optional; native file format will be returned
if format is not specified.

format=GeoTIFF

Subsets the data set parameter (i.e. variable, layer) or group
of parameters. Also signifies WCS coverage
to be processed. If only a group or subgroup is specified, all
lower level datasets are included in the processing. 

coverage=/group/sub-group/sub-sub-group/parameter

[MOD10A1 example]
coverage=
/MOD_Grid_Snow_500m/NDSI

Supported projections are dataset-specific (see Step 1 to determine valid projection
options). Options include:

[geographic, universal+transverse+mercator,
utm+northern+hemisphere,utm+southern+hemisphere,
north+polar+stereographic, south+polar+stereographic,
polar+stereographic, state+plane, lambert+conformal+conic,
transverse+mercator, lambert+azimuthal, sinusoidal]

Note that some projection options are unavailable if bbox is specified.
KVP Operand: projection_parameters

Resample dimension, in percent. Valid range=1 to 200

resample=percent:NNN

resample=percent:50

Interpolation option used in reprojection. Options include:

• NN (Nearest Neighbor)
• BI (Bilinear)
• CC (Cubic Convolution)

interpolation=NN