Magidoc

GranulesInput
Input Object

Fields

#

attribute

[ String ]

Find granules by additional attribute. For full syntax reference see CMR documentation. https://cmr.earthdata.nasa.gov/search/site/docs/search/api.html#g-additional-attribute

boundingBox

[ String ]

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.

browseOnly

Boolean

Search by the browse only flag of the granule.

circle

[ String ]

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.

cloudCover

JSON

Search granules by cloud cover min and max.

collectionConceptId

String

The unique concept id assigned to the parent collection.

collectionConceptIds

[ String ]

A list of unique concept ids assigned to the parent collection.

conceptId

[ String ]

The unique concept id assigned to the granule.

createdAt

[ String ]

Find granules which were created within the ranges of datetimes. The datetime has to be in yyyy-MM-ddTHH:mm:ssZ format. The default is inclusive on the range boundaries.

cursor

String

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

cycle

Int

Search by cycle which is part of the track information of a granule.

dayNightFlag

String

Search by the day/night flag of the granule.

entryId

[ String ]

Search by entry id of the parent collection.

equatorCrossingDate

JSON

Search by the equator crossing date of the granule.

equatorCrossingLongitude

JSON

Search by the equator crossing longitude of the granule.

exclude

JSON

Exclude granules from results by echo_granule_id and/or concept_id.

limit

Int

The number of granules requested by the user.

line

[ String ]

Search for granules that intersect with provided lines.

linkTypes

[ String ]

Filter the links based on these types.

offset

Int

Zero based offset of individual results.

onlineOnly

Boolean

Search by the online only flag of the granule.

options

JSON

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

orbitNumber

JSON

Search for granules by orbit number min and max

passes

JSON

Search by passes which is part of the track information of a granule.

point

[ String ]

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

[ String ]

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.

productionDate

[ String ]

Find granules which have production date within the ranges of datetimes. The datetime has to be in yyyy-MM-ddTHH:mm:ssZ format. The default is inclusive on the range boundaries.

provider

[ String ]

Search for granules using the provider parameter.

readableGranuleName

[ String ]

Search for granules using the readable_granule_name parameter.

revisionDate

[ String ]

Find granules which have revision date within the ranges of datetimes. The datetime has to be in yyyy-MM-ddTHH:mm:ssZ format. The default is inclusive on the range boundaries.

shortName

[ String ]

Find granules matching any of the 'short_name' param values. The 'short_name' here refers to the short name of the collections corresponding to the granules being searched for.

sortKey

[ String ]

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.

temporal

String

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

twoDCoordinateSystem

JSON

The 2D coordinate system associated with the collection

updatedSince

String

Find granules which have revision date starting at or after 'updated_since' param value.

Usages

#

References

#

  • Argument params of field granules from type Query
  • Argument params of field granules from type Collection