Skip to content
getgeolens.com

Stac Search

POST
/services/stac/search
curl --request POST \
--url https://example.com/services/stac/search \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "bbox": [ 1 ], "collections": [ "example" ], "datetime_range": "example", "limit": 20, "url": "example" }'

Search items in a STAC API with spatial/temporal filters.

Media type application/json
StacSearchRequest
object
bbox
Any of:
Array<number>
>= 4 items <= 4 items
collections
Any of:
Array<string>
datetime_range
Any of:
string
limit
Limit

Maximum items to return.

integer
default: 20 >= 1 <= 100
url
required
Url

STAC API root URL.

string
>= 1 characters <= 2048 characters

Successful Response

Media type application/json
StacSearchResponse
object
items
required
Items

Matching items.

Array<object>
StacItemSummary
object
asset_count
required
Asset Count

Number of assets on this item.

integer
bbox
Any of:
Array<number>
cloud_cover
Any of:
number
collection
Any of:
string
data_asset_href
Any of:
string
data_asset_size_bytes
Any of:
integer
data_asset_type
Any of:
string
datetime
Any of:
string
datetime_end
Any of:
string
datetime_start
Any of:
string
epsg
Any of:
integer
gsd
Any of:
number
id
required
Id

Item identifier.

string
thumbnail_href
Any of:
string
title
required
Title

Item title (falls back to ID).

string
matched
Any of:
integer
returned
required
Returned

Number of items in this response.

integer
Example generated
{
"items": [
{
"asset_count": 1,
"bbox": [
1
],
"cloud_cover": 1,
"collection": "example",
"data_asset_href": "example",
"data_asset_size_bytes": 1,
"data_asset_type": "example",
"datetime": "example",
"datetime_end": "example",
"datetime_start": "example",
"epsg": 1,
"gsd": 1,
"id": "example",
"thumbnail_href": "example",
"title": "example"
}
],
"matched": 1,
"returned": 1
}

Bad request — invalid payload

ProblemDetail
object
detail
required
Detail
string
status
required
Status
integer
title
required
Title
string
type
Type
string
default: about:blank
Example
{
"type": "about:blank"
}

Unauthorized — missing or invalid credentials

ProblemDetail
object
detail
required
Detail
string
status
required
Status
integer
title
required
Title
string
type
Type
string
default: about:blank
Example
{
"type": "about:blank"
}

Forbidden — caller lacks write access

ProblemDetail
object
detail
required
Detail
string
status
required
Status
integer
title
required
Title
string
type
Type
string
default: about:blank
Example
{
"type": "about:blank"
}

Not found

ProblemDetail
object
detail
required
Detail
string
status
required
Status
integer
title
required
Title
string
type
Type
string
default: about:blank
Example
{
"type": "about:blank"
}

Conflict — resource state prevents the operation

ProblemDetail
object
detail
required
Detail
string
status
required
Status
integer
title
required
Title
string
type
Type
string
default: about:blank
Example
{
"type": "about:blank"
}

Validation error

ProblemDetail
object
detail
required
Detail
string
status
required
Status
integer
title
required
Title
string
type
Type
string
default: about:blank
Example
{
"type": "about:blank"
}

Internal server error

ProblemDetail
object
detail
required
Detail
string
status
required
Status
integer
title
required
Title
string
type
Type
string
default: about:blank
Example
{
"type": "about:blank"
}