Knowledge Base

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

The following table lists important KVPs associated with the Common Metadata Repository (CMR) file search, as well as all KVPs available for subsetting, reformatting, and reprojection services. Please see the CMR Search API Documentation page for additional information on CMR parameters.

Key-value-pair (KVP) operand Description Example

short_name

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

token Required field. token required to access
data using Earthdata Login credentials.
token=75E5CEBE-6BBB-2FB5-A613-0368A361D0B6
email Required field. email to report if error is returned with request

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

Request specified email:
email=name@domain.com

version

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

agent Returns data files without customization (no subsetting, reformatting, or reprojection services) agent=NO

time

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_key

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

bounding_box

Required field 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

bounding_box=
-109,35,-105,38
bbox

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

bbox=-109,35,-105,38
polygon

Required field if you request subsetting by bounding_shape or uploaded Shapefile or KML (currently only available for ICESat-2 data). Find files with a spatial extent
that overlaps the polygon points, written in decimal
degrees in longitude latitude order, i.e. lon1, lat1, lon2, lat2, lon3, lat3, etc. in counter-clockwise order.

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

polygon=-74.886,69.408,-71.681,
69.408,-71.681,70.62,-74.886,
70.62,-74.886,69.408
boundingshape

Spatial subsetting with GeoJSON. The coordinates must be equal
or near-equal to the coordinates entered in the polygon parameter, above.
 
Output files will be cropped to the specified GeoJSON extent.

boundingshape={"type":"Polygon","coordinates": [[[longitude, latitude], 
[longitude, latitude],[longitude, latitude],[longitude, latitude],
[longitude, latitude]]]}
boundingshape={"type": "Polygon","coordinates": [[ [100.0, 0.0],[101.0, 0.0], 101.0, 1.0],[100.0, 1.0],[100.0, 0.0] ]]}
shapefile

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

shapefile=@glacier_shapefile.zip

format

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

coverage

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

projection

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

Projection_
Parameters

Applicable
projection

Description

NZone:NN 

universal+
transverse+
mercator

UTM zone number.
Valid range=
-60 to 60;
<0 signifies southern hemisphere. Example:

NZone:-5

LonZ:lon,
LatZ:lat

universal+
transverse+
mercator

Latitude and longitude
of any point in UTM
Zone in decimal degrees. Example:

LonZ:-110,
LatZ:45

NZone:NN

utm+northern+
hemisphere

utm+southern+
hemisphere

Required. UTM zone number. Valid range=1 to 60. Example:

NZone:30

NZone:NNNN

state+plane

State Plane zone code. Example:

NZone:0502

OriginLat:NN

lambert+
conformal+
conic

transverse+
mercator

Latitude of false/natural
origin; Angular values.

CentMer:NN

lambert+
conformal+
conic

transverse+
mercator

Longitude of false origin / central meridian

Longitude of natural/false origin; Angular values.

STDPR1:NN

lambert+
conformal+
conic

Latitude of first standard parallel; Angular values.

STDPR2:NN

lambert+
conformal+
conic

Latitude of second
standard parallel;
Angular values.

FE:NN

lambert+
conformal+
conic

polar+
stereographic

transverse+
mercator

lambert+
azimuthal

sinusoidal

False Easting;
Linear values.

FN:NN

lambert+
conformal+
conic

polar+
stereographic

transverse+
mercator

lambert+
azimuthal

sinusoidal

False Northing;
Linear values.

SMajor:NN

lambert+
conformal+
conic

polar+
stereographic

transverse+
mercator

Semimajor radius of
the ellipsoid axis; Linear values.

SMinor:NN

lambert+
conformal+
conic

polar+
stereographic

transverse+
mercator

Semiminor radius of
the ellipsoid axis; Linear values.

LongPol:NN

polar+
stereographic

Longitude of natural
origin; Angular values.

TrueScale:NN

polar+
stereographic

Latitude of natural
origin; Angular values.

Factor:N

transverse+
mercator

Scale factor at natural
origin; Unitless.

Sphere:NN

lambert+
azimuthal

Radius of reference
Sphere; Linear values.

CenterLat:NN

lambert+
azimuthal

Latitude of projection
center / origin;
Angular values.

CentLon:NN

lambert+
azimuthal

sinusoidal

Longitude of projection
center; Angular values.

resample

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

resample=percent:NNN

resample=percent:50

interpolation

Interpolation option used in reprojection. Options include:

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

interpolation=NN

Updated June 2019