API docs by Redocly

SlideRule Asset Metadata Service API (v5.4.2)

Download OpenAPI specification:

License: BSD 3-Clause

Web services for querying earth science dataset resources.

Query ATL13 granules

Query ATL13 granule metadata by lake reference ID, lake name, coordinate, and/or spatial/temporal filters. Single lake queries (refid, name, coord) are attempted in order; if a lake is found, its granules are intersected with any general query results.

Request Body schema: application/json
required
Array of objects (Coordinate)

Polygon vertices for spatial filtering

t0
string

Start time filter (ISO 8601 format)

t1
string

End time filter (ISO 8601 format)

name_filter
string

Granule name filter pattern

rgt
integer

Reference ground track number

cycle
integer

Orbital cycle number

region
integer

Region number

refid
integer

ATL13 lake reference ID

name
string

Lake name

object (Coordinate)

Responses

Request samples

Content type
application/json
{
  • "poly": [
    ],
  • "t0": "2020-01-01T00:00:00Z",
  • "t1": "2023-12-31T23:59:59Z",
  • "name_filter": "string",
  • "rgt": 0,
  • "cycle": 0,
  • "region": 0,
  • "refid": 0,
  • "name": "string",
  • "coord": {
    }
}

Response samples

Content type
application/json
{
  • "hits": 0,
  • "refid": 0,
  • "granules": [
    ]
}

Query ATL24 granules

Query ATL24 bathymetry granule metadata with spatial, temporal, and attribute-based filters.

Request Body schema: application/json
required
Array of objects (Coordinate)

Polygon vertices for spatial filtering

t0
string

Start time filter (ISO 8601 format)

t1
string

End time filter (ISO 8601 format)

name_filter
string

Granule name filter pattern

rgt
integer

Reference ground track number

cycle
integer

Orbital cycle number

region
integer

Region number

season
integer

Season value to match

photons0
integer

Minimum bathy_photons range

photons1
integer

Maximum bathy_photons range

meandepth0
number

Minimum bathy_mean_depth range

meandepth1
number

Maximum bathy_mean_depth range

mindepth0
number

Minimum bathy_min_depth range

mindepth1
number

Maximum bathy_min_depth range

maxdepth0
number

Minimum bathy_max_depth range

maxdepth1
number

Maximum bathy_max_depth range

Responses

Request samples

Content type
application/json
{
  • "poly": [
    ],
  • "t0": "2020-01-01T00:00:00Z",
  • "t1": "2023-12-31T23:59:59Z",
  • "name_filter": "string",
  • "rgt": 0,
  • "cycle": 0,
  • "region": 0,
  • "season": 0,
  • "photons0": 0,
  • "photons1": 0,
  • "meandepth0": 0,
  • "meandepth1": 0,
  • "mindepth0": 0,
  • "mindepth1": 0,
  • "maxdepth0": 0,
  • "maxdepth1": 0
}

Response samples

Content type
application/json
{
  • "hits": 0,
  • "granules": [
    ]
}

Get ATL24 granule details

Retrieve per-beam metadata for a specific ATL24 granule.

path Parameters
name
required
string

The granule name

Responses

Response samples

Content type
application/json
{
  • "property1": {
    },
  • "property2": {
    }
}

Query CASALS 1B granules

Query CASALS 1B granule metadata with spatial and temporal filters.

Request Body schema: application/json
required
Array of objects (Coordinate)

Polygon vertices for spatial filtering

t0
string

Start time filter (ISO 8601 format)

t1
string

End time filter (ISO 8601 format)

Responses

Request samples

Content type
application/json
{
  • "poly": [
    ],
  • "t0": "2020-01-01T00:00:00Z",
  • "t1": "2023-12-31T23:59:59Z"
}

Response samples

Content type
application/json
{
  • "hits": 0,
  • "granules": [
    ]
}

Get CASALS 1B search mask

Returns the search mask file contents for CASALS 1B.

Responses

Response samples

Content type
application/json
"string"

Query 3DEP 1m granules

Query USGS 3DEP 1-meter elevation granule metadata with spatial and temporal filters. Returns a GeoJSON FeatureCollection.

Request Body schema: application/json
required
Array of objects (Coordinate)

Polygon vertices for spatial filtering

t0
string

Start time filter (ISO 8601 format)

t1
string

End time filter (ISO 8601 format)

Responses

Request samples

Content type
application/json
{
  • "poly": [
    ],
  • "t0": "2020-01-01T00:00:00Z",
  • "t1": "2023-12-31T23:59:59Z"
}

Response samples

Content type
application/json
{
  • "type": "FeatureCollection",
  • "hits": 0,
  • "features": [
    ]
}

Get 3DEP 1m granule by ID

Retrieve full metadata for a specific 3DEP granule by its ID.

path Parameters
id
required
string

The granule ID

Responses

Response samples

Content type
application/json
{ }