CollectionsInput

Input Object

boundingBox

Bounding boxes define an area on the earth aligned with longitude and latitude. The Bounding box parameters must be 4 comma-separated numbers: lower left longitude, lower left latitude, upper right longitude, upper right latitude.

circle

Circle defines a circle area on the earth with a center point and a radius. The center parameters must be 3 comma-separated numbers: longitude of the center point, latitude of the center point, radius of the circle in meters. The circle center cannot be on North or South pole. The radius of the circle must be between 10 and 6,000,000.

cloudHosted

The cloud_hosted parameter can be set to 'true' or 'false'. When true, the results will be restricted to collections that have a DirectDistributionInformation element or have been tagged with gov.nasa.earthdatacloud.s3.

collectionDataType

Type of the collection.

collectionProgress

The production status of the data set (collection).

collectionProgresses

The production statuses of the data sets (collections).

conceptId

The unique concept id assigned to the collection.

consortium

The consortium value of the collection.

cursor

Cursor that points to the/a specific position in a list of requested records.

dataCenter

Data center assigned to the collection.

dataCenterH

Data center assigned to the collection, in facet form.

dataCenters

Data centers assigned to the collection.

doi

The DOI Value of the collection.

entryId

Entry ID of the collection.

entryTitle

The Entry Title of collection

facetsSize

The number of facets to return in each category.

granuleDataFormat

The data format of the granules belonging to the collection.

granuleDataFormatH

The data format of the granules belonging to the collection, in facet form.

hasGranules

When has_granules is set to 'true' or 'false', results will be restricted to collections with or without granules, respectively.

hasGranulesOrCwic

When true, the results will be restricted to collections with granules or with the configured CWIC tag. When false, results will be restricted to collections without granules.

hasOpendapUrl

When has_opendap_url is set to 'true' or 'false', results will be restricted to collections with or without OPeNDAP service RelatedURLs, respectively.

horizontalDataResolutionRange

The horizontal data resolution of the data belonging to the collection.

includeFacets

If this parameter is set (e.g. includeFacets=v2), the results will include a new top level key facets that contains the facets related to the collection results. NOTE: This only requests the facets be returned by CMR, you will need to include facets in your query to have the results returned in the query.

includeHasGranules

If this parameter is set to 'true' this will include a flag indicating true or false if the collection has any granules at all.

includeTags

If this parameter is set (e.g. includeTags=gov.nasa.earthdata.search.,gov.nasa.echo.), the collection results will contain an additional field 'tags' within each collection. The value of the tags field is a list of tag_keys that are associated with the collection. Only the tags with tag_key matching the values of include_tags parameter (with wildcard support) are included. NOTE: This only requests the tags be returned by CMR, you will need to include tags in your query to have the results returned in the query.

instrument

Instrument associated with the collection.

instrumentH

Instrument associated with the collection, in facet form.

keyword

Keyword search value.

latency

The latency facet value of the collection.

limit

The number of collections requested by the user.

line

Search for collections that intersect with provided lines.

offset

Zero based offset of individual results.

options

Options to provide to CMR pertaining to and, or, and wildcard searching.

pageSize

Which page to request from the current collection results.

platform

Platform associated with the collection.

platformsH

Platform associated with the collection, in facet form.

point

Search using a point involves using a pair of values representing the point coordinates as parameters. The first value is the longitude and second value is the latitude.

polygon

Polygon points are provided in counter-clockwise order. The last point should match the first point to close the polygon. The values are listed comma separated in longitude latitude order, i.e. lon1, lat1, lon2, lat2, lon3, lat3, and so on.

processingLevelId

An identifier indicating the level at which the data in the collection are processed, ranging from Level0 (raw instrument data at full resolution) to Level4 (model output or analysis results). The value of Processing Level Id is chosen from a controlled vocabulary.

processingLevelIdH

An identifier indicating the level at which the data in the collection are processed, ranging from Level0 (raw instrument data at full resolution) to Level4 (model output or analysis results), in facet form. The value of Processing Level Id is chosen from a controlled vocabulary.

project

The project associated with the collection.

projectH

The project associated with the collection, in facet form.

provider

The name of the provider associated with the collection.

providers

The name of the providers associated with the collections.

revisionDate

The revision date of the collection

scienceKeywords

Science Keywords for searching term at all levels of the science keyword hierarchy.

scienceKeywordsH

Science Keywords associated with the collection, in facet form.

serviceConceptId

UMM Service concept id.

serviceType

UMM Service type.

shortName

The short name associated with the collection.

shortNames

An array of 'shortName' param values.

sortKey

One or more sort keys can be specified to impact searching. Fields can be prepended with a '-' to sort in descending order. Ascending order is the default but + can be used to explicitly request ascending.

spatialKeyword

Keywords relating to spatial aspects of the collection.

standardProduct

Boolean to query for collections in the Standard Product portal

tagKey

Tags associated with the collection.

temporal

The temporal datetime has to be in yyyy-MM-ddTHH:mm:ssZ format.

twoDCoordinateSystemName

The 2D coordinate system associated with the collection.

updatedSince

Find collections which have a revision date starting at or after the provided datetime string in yyyy-MM-ddTHH:mm:ssZ format.

variableConceptId

UMM Variable concept id.

version

version of the collection.