Skip to content
getgeolens.com
GeoLens Docs

Stac Search

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

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

Authorizations

Section titled “Authorizations ”

Request Body required

Section titled “Request Body required ”
Media type application/json
StacSearchRequest
object
url
required
Url

STAC API root URL.

string
>= 1 characters <= 2048 characters
collections
Any of:
Array<string>
bbox
Any of:
Array<number>
>= 4 items <= 4 items
datetime_range
Any of:
string
limit
Limit

Maximum items to return.

integer
default: 20 >= 1 <= 100

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

Media type application/json
StacSearchResponse
object
items
required
Items

Matching items.

Array<object>
StacItemSummary
object
id
required
Id

Item identifier.

string
collection
Any of:
string
title
required
Title

Item title (falls back to ID).

string
bbox
Any of:
Array<number>
datetime
Any of:
string
datetime_start
Any of:
string
datetime_end
Any of:
string
epsg
Any of:
integer
gsd
Any of:
number
cloud_cover
Any of:
number
data_asset_href
Any of:
string
data_asset_type
Any of:
string
thumbnail_href
Any of:
string
asset_count
required
Asset Count

Number of assets on this item.

integer
matched
Any of:
integer
returned
required
Returned

Number of items in this response.

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

422

Section titled “422 ”

Validation Error

Media type application/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Example generated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}