Parameter | Value | Format | Example | CMR Parameter Equivalent | Notes | ||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
ac | "Include collections without granules" checkbox value | Boolean | ac=true | has_granules_or_cwic | |||||||||
as | Autocomplete value selected | Object | as[instrument][0]=MODIS | n/a | as[instrument][0]=MODIS means the first autocomplete selection for the Instrument facet is "MODIS" is selected. Would be accompanied by fi=MODIS . | ||||||||
base | Map base layer | String | base=blueMarble | n/a | Sets the base layer to be displayed on the map.
| ||||||||
cd circle | Concatenate downloadCircle spatial | String |
| n/a | This is a harmony service only parameter that will who's value will only show if the collection supports "Concatenate Download". This will only determine if the checkbox is checked or not in the Combine Data AccessMethod customization option. | ||||||||
circle | Circle spatial | Array | circle[0]=-77.0163%2C38.8831%2C10000 | circle[] | Each parameter must be 3 comma-separated numbers: longitude of the center point, latitude of the center point, radius of the circle in meters. | ||||||||
fdc | Selected Organizations facets | String | fdc=NASA%2FGSFC%2FEOS%2FESDIS!NASA%2FGSFC%2FEOS%2FEO | data_center_h[] | An exclamation point (! ) delimited string of facet values. | ||||||||
Array | circle[0]=-77.0163%2C38.8831%2C10000 | circle[] | Each parameter must be 3 comma-separated numbers: longitude of the center point, latitude of the center point, radius of the circle in meters. | ||||||||||
fdc | Selected Organizations facets | String | fdc=NASA%2FGSFC%2FEOS%2FESDIS!NASA%2FGSFC%2FEOS%2FEO | data_center_h[] | An exclamation point (! ) delimited string of facet values. | ||||||||
ff | Feature facets | n/a | An | ff | Feature facets | n/a | An exclamation point (! ) delimited string of facet values. | ||||||
fi | Selected Instruments facets | String | fi=AIRS!MODIS | instrument_h[] | An exclamation point (! ) delimited string of facet values. | ||||||||
fl | Processing Levels facets | String | fl=1%20-%20Radiance!1A%20-%20Radiance | processing_level_id_h[] | An exclamation point (! ) delimited string of facet values. | ||||||||
fpb# | Platforms facets - Basis | String | fpb0=Space-based%20Platform | platforms_h[#][basis] | The # in the parameter name will match for each level of each applied Platform. Multiple Platforms can be applied by incrementing the index (# ) in the parameter names. | ||||||||
fpc# | Platforms facets - Category | String |
| platforms_h[#][category] | See notes for Will include | ||||||||
fpsc# | Platforms facets - Sub Catagory | String |
| platforms_h[#][sub_category] | See notes for Will include | ||||||||
fps# | Platforms facets - Short Name | String |
| platforms_h[#][short_name] | See notes for Will include | ||||||||
fpj | Projects facets | String | fpj=AQUARIUS%20SAC-D!ABoVE | project_h[] | An exclamation point (! ) delimited string of facet values. | ||||||||
fs1# | Science Keywords facets - Variable Level 1 | String | fs10=Sea%20Surface%20Temperature | science_keywords_h[#][variable_level_1] | See notes for Will include | ||||||||
fs2# | Science Keywords facets- Variable Level 2 | String | fs20=Sea%20Surface%20Skin%20Temperature | science_keywords_h[#][variable_level_2] | See notes for Will include | ||||||||
fs3# | Science Keywords facets- Variable Level 3 | String | fs30=Variable%20Level%203%20Example | science_keywords_h[#][variable_level_3] | See notes for Will include | ||||||||
fsd# | Science Keywords facets - Detailed Variable | String | fsd0=Detailed%20Variable%20Example | science_keywords_h[#][detailed_variable] | See notes for Will include | ||||||||
fsm# | Science Keywords facets - Term | String | fsm0=Ocean%20Temperature | science_keywords_h[#][term] | See notes for Will include | ||||||||
fst# | Science Keywords facets - Topic | String | fst0=Oceans | science_keywords_h[#][topic] | The # in the parameter name will match for each level of each applied Science Keyword. Multiple Science Keywords can be applied by incrementing the index (# ) in the parameter names. | ||||||||
g | Focused Granule | String | g=G2207050726-ASF | n/a | |||||||||
gdf | Data Format facets | String | gdf=CSV!ASCII | granule_data_format_h[] | An exclamation point (! ) delimited string of facet values. | ||||||||
hdr | Horizontal Data Resolution facets | String | hdr=500%20to%201000%20meters!250%20to%20500%20meters | horizontal_data_resolution_range[] | An exclamation point (! ) delimited string of facet values. | ||||||||
line | Line spatial | Array | line[0]=-77.0163%2C38.8831%2C-76.8523%2C38.9949 | line[] | The coordinates are listed in the format lon1, lat1, lon2, lat2, lon3, lat3, and so on. | ||||||||
lat | Center latitude | String | lat=0 | n/a | Sets the center latitude coordinate. | ||||||||
long | Center longitude | String | long=0 | n/a | Sets the center longitude coordinate. | ||||||||
m | Map parameters | String | m=38.44170!-82.21807!5!1!0!0%2C2 |
An exclamation point (
Projections: 0: EPSG:3413 1: EPSG:4326 2: EPSG:3031 Base layers (select one): 0: Blue Marble 1: Corrected Reflectance (True Color) 2: Land / Water Map Overlay layers ( 0: Borders and Roads 1: Coastlines 2: Place Labels | |||||||||
oe | Include only EOSDIS Collections | String | oe=t | consortium=["EOSDIS"] | t value for true , parameter not included for a false value. | ||||||||
ot | Override temporal query | String | ot=2022-01-01T00%3A00%3A00.000Z%2C2022-01-31T23%3A59%3A59.999Z | temporal | Override the qt temporal query. This can happen when the user applies a temporal query and then focuses a range on the timeline to override the original temporal query. | ||||||||
overlays | Map overlay layers | String | overlays=referenceFeatures,coastlines | n/a | Sets the overlay layers to display on the map. Format:
Multiple values should be formatted as a comma ( For more information about the supported overlay layers is available in the NASA Global Imagery Browse Service (GIBS) API Documentation | ||||||||
p | Focused and project collections | String | p=C1711961296-LPCLOUD!C1711961296-LPCLOUD | n/a | Defines the collections used within the application. Format: | ||||||||
projection | Map projection (CRS) | String |
| n/a | Sets the projection (CRS) for the map. Format:
| ||||||||
pg | Focused and project collection options | Object | n/a | The filters associated with each collection within the application. See detailed information about the | |||||||||
polygon | Polygon spatial | Array | polygon[0]=-77.0163%2C38.8831%2C-77.0413%2C38.8060%2C-76.8523%2C38.9949%2C-77.0163%2C38.8831 | polygon[] | Sets a spatial search using a polygon. Format: For example: | ||||||||
q | Free text query | String | q=rainfall | keyword | |||||||||
qt | Temporal query | String | Single date range: Recurring date range: | temporal | Sets the temporal range for the current collection and granules search. Format: Single date range:
Recurring date range:
| ||||||||
s2n | 2D Coordinate System Name facet | String | s2n=CALIPSO!MISR | two_d_coordinate_system_name[] | Sets the 2D coordinate system facet search values Format: | ||||||||
sb | Bounding Box spatial | Array | sb[0]=-77.12519%2C38.78277%2C-76.9113%2C38.98505 | n/a | Sets a spatial search using a bounding box. Format: | ||||||||
sf | Shapefile ID | String | sf=1219430596 | n/a | Sets a spatial search using a saved shapefile. Format: | ||||||||
sfs | Shapefile selected features | Array | sfs[0]=27 | n/a | Sets a selected feature in a multi-shape shapefile. Format: | ||||||||
sp | Point spatial | Array | sp[0]=-77.0163%2C38.8831 | point[] | The first value is the longitude and second value is the latitude. | ||||||||
sr | Advanced Search - Selected Region | Object | n/a | See available sr options below. | |||||||||
tag_key | CMR Tag Key | String | tag_key=gov.nasa.eosdis | tag_key[] | |||||||||
tl | Timeline parameters | String | tl=1642537265.587!3!1638316800!1640995199.999 | n/a | An exclamation point (
| ||||||||
zoom | Map zoom level | String |
| n/a | Sets the zoom level for the map. Possible values are numbers 0 (min) through 7 (max) |
...
The pg
parameter and its options represent the current settings for the collections within the application. The index pg[0]
will set the options for the active collection. Any additional entries (pg[0],pg[1],...
) represent the options for any collections in the current collection.
Parameter Name | Value | Format | Example | Notes |
---|---|---|---|---|
a | Added Granules | String | pg[1][a]=2204031126!LPDAAC_ECS | Format: Takes the numeric portion of the granule concept IDs and adds them to an exclamation point ( ! ) delimited string, with the provider ID (found in the Granule Concept ID) at the end of the string. |
bo | Browse Only | Boolean | pg[1][bo]=true | Shows only granules that have associated browse imagery. |
ca | Open Search Added Granules | String | pg[1][ca]=AWou9qxVI2P1I4ujHWv- | Open Search Added Granules are defined with an exclamation point (! ) delimited string of the granule IDs. |
cc | Cloud Cover | Object | pg[1][cc][min]=15&pg[1][cc][max]=20 | Object with min and max keys. |
cd | Concatenate download | t / f | pg[1][cd]=t | This is a harmony service only parameter that will who's value will only show if the collection supports "Concatenate Download". This will only determine if the checkbox is checked or not in the Combine Data AccessMethod customization option. |
cr | Open Search Removed Granules | String | pg[1][cr]=AWou9qxVI2P1I4ujHWv- | Open Search Removed Granules are an exclamation point (! ) delimited string of the granule IDs. |
cx | Open Search Filtered Granules | String | pg[1][cx]=AWou9qxVI2P1I4ujHWv- | Open Search Filtered Granules are an exclamation point (! ) delimited string of the granule IDs. |
dnf | Day/Night Flag | String | pg[1][dnf]=DAY | Values will be DAY , NIGHT or BOTH . |
ecd | Equator Crossing Date | Object | pg[1][ecd]=2021-09-15T00%3A00%3A00.000Z%2C2021-10-01T23%3A59%3A59.999Z | A comma (, ) delimited string of start and end dates. |
ecl | Equator Crossing Longitude | Object | pg[1][ecl][min]=-10&pg[1][ecl][max]=10 | Object with min and max keys. |
ets | Enable Temporal Subsetting | t / f | pg[1][ets]=t | Will have a pg[#][qt] parameter. |
ess | Enable Spatial Subsetting | t / f | pg[1][ess]=t | Will have a polygon[#], circle[#], line[#], point[#] or sb[#] parameter. |
gc | Grid Coordinates | String | pg[1][gc]=2-2%3A3-3%2C5-5%3A7-7 | |
gsk | Granule Sort Key | String | pg[1][gsk]=-start_date | |
id | Granule ID search | String | pg[1][id]=MOD13Q1.A2022001.h08v08.061.2022018162818.hdf | Supports * and ? wildcards. |
m | Selected Access Method | String | pg[1][m]=download | |
of | Output Format | String | pg[1][of]=application/x-netcdf4 | |
on | Orbit Number | Object | pg[1][on][min]=30000&pg[1][on][max]=30005 | Object with min and max keys. |
oo | Online Only | Boolean | pg[1][oo]=true | |
op | Output Projection | String | pg[1][op]=EPSG%3A4326 | |
qt | Temporal | String | Single date range: Recurring date range: | See top level qt notes. |
r | Removed Granules | String | pg[1][r]=2204031126!LPDAAC_ECS | Removed Granules takes the numeric portion of the Granule Concept IDs and adds them to an exclamation point (! ) delimited string, with the Provider ID (found in the Granule Concept ID) at the end of the string. |
ts | Tiling System | String | pg[1][ts]=MODIS%20Tile%20SIN | |
uv | Selected Variables | String | pg[1][uv]=V2144683811-GES_DISC!V2144680005-GES_DISC | An exclamation point (! ) delimited string of Variable Concept IDs. |
v | Collection Visible on EDSC map | t / f | pg[1][v]=t | Sets the visibility of a collections granules on the map. By default, a focused collection will always be visible. This parameter only has effect when viewing a project. |
x | Filtered Granules | String | pg[1][x]=2204031126!LPDAAC_ECS | Filtered Granules takes the numeric portion of the Granule Concept IDs and adds them to an exclamation point ( |
Parameter Name | Value | Example | Notes |
---|---|---|---|
id | ID of Region | sr[id]=150702011403 | |
name | Name of Region | sr[name]=Colorado%20Mine | |
spatial | Region Spatial | sr[spatial]=-114.11801549580633%2C33.01441329146337%2C<...complete list of points...> | |
type | Region Type | sr[type]=huc | Available values: huc and reach |