Protocol Documentation

min x value

min y value

max x value

max y value

spatial reference of envelope

Azimuth from the first to the second point

Azimuth from the second to the first point

Geodesic distance

geometry id as an integer

feature id as a string (for guids and other ids that aren't numeric)

well known text format for geometry encoding, https://en.wikipedia.org/wiki/Well-known_text_representation_of_geometry

geojson format for geometry encoding, https://en.wikipedia.org/wiki/GeoJSON

well known binary format for geometry encoding, https://en.wikipedia.org/wiki/Well-known_text_representation_of_geometry#Well-known_binary

ESRI shape binary format for geometry encoding (fastest decoding and encoding for geometry service) https://www.esri.com/library/whitepapers/pdfs/shapefile.pdf

extended well known binary format

spatial reference of geometry

envelope or bounding box of geometry

state of the geometry topological correctness. at geometry creation, it is unknown if it is simple

geometry to be operated on

if there are two geometries to operate on, then this is the first geometry

the result of the geometry request is to be operated on by this request

if there are two geometries, the left geometry request is to be operated on by this request

if there are two geometries to operate on, then this is the second geometry

if there are two geometries, the right geometry request is to be operated on by this request

(default is PROJECT) geometry operation to perform on input geometries

(default is wkb) encoding, wkt, wkb, esri_shape, etc

(optional) the spatial reference the geometric operation should take place in. If both inputs are in different spatial references, you can use this to define a common reference system for the geometric operation.

(optional) after the operation has been completed, project the results to a new spatial reference.

if geometry result, then this field holds the geometry data

if a topo spatial relationship request, then this field holds the true or false result

a measure result will be a float for area and length requests

oneof https://github.com/golang/protobuf/issues/283 }

oneof https://github.com/golang/protobuf/issues/283 oneof method {

oneof https://github.com/golang/protobuf/issues/283 }

epsg wkid (well know id), or srid (spatial reference id) of the projected or geographic coordinate system

proj string describing a projection or geographic coordinate system https://proj4.org/usage/projections.html

custom projection

well-known text string of spatial reference esri wkid (if not yet approved by epsg)

longitude of center of projection (central meridian)

latitude of center of projection (latitude of origin)

enum defining the type of projection

relationship type of the query. EQ, LTE, GTE, LT, GT, NEQ for `value` BETWEEN or NOT_BETWEEN for `start` with `end` IN or NOT_IN for use with `set`

Singular double value that, combined with rel_type, allows you to search for floats that relate to this `value`. `value` field cannot be combined with BETWEEN or the NOT_BETWEEN FilterRelationship `rel_type`. That means you can use the EQ, LTE, GTE, LT, GT, NEQ FilterRelationship `rel_type`

For searching by a range. `start` with BETWEEN searches for everything in the range from `start` to `end` `start` with NOT_BETWEEN searches for everything not in the range from `start` and `end`. must be accompanied by a `end` value

For searching by a range. `end` with BETWEEN searches for everything in the range from `start` to `end` `end` with NOT_BETWEEN searches for everything not in the range from `start` and `end`. must be accompanied by a `start` value

sort direction for the return values

'IN' or 'NOT IN' sql operations

relationship type of the query. EQ, LTE, GTE, LT, GT, NEQ for `value` BETWEEN or NOT_BETWEEN for `start` with `end` IN or NOT_IN for use with `set`

Singular float value that, combined with rel_type, allows you to search for floats that relate to this `value`. `value` field cannot be combined with BETWEEN or the NOT_BETWEEN FilterRelationship `rel_type`. That means you can use the EQ, LTE, GTE, LT, GT, NEQ FilterRelationship `rel_type`

For searching by a range. `start` with BETWEEN searches for everything in the range from `start` to `end` `start` with NOT_BETWEEN searches for everything not in the range from `start` and `end`. must be accompanied by a `end` value

For searching by a range. `end` with BETWEEN searches for everything in the range from `start` to `end` `end` with NOT_BETWEEN searches for everything not in the range from `start` and `end`. must be accompanied by a `start` value

sort direction for the return values

'IN' or 'NOT IN' sql operations

for use with EQ, NEQ, LIKE and NOT_LIKE

relationship type of the query. EQ, NEQ for `value` IN or NOT_IN for use with `set` LIKE or NOT_LIKE test if the string in `value` matches or does not match the supplied pattern

For use with 'IN' or 'NOT IN' sql operations

relationship type of the query. EQ, LTE, GTE, LT, GT, NEQ for `value` BETWEEN or NOT_BETWEEN for `start` with `end`

Singular Timestamp value that, combined with rel_type, allows you to search for floats that relate to this `value`. `value` field cannot be combined with BETWEEN or the NOT_BETWEEN FilterRelationship `rel_type`. That means you can use the EQ, LTE, GTE, LT, GT, NEQ FilterRelationship `rel_type`

For searching by a range. `start` with BETWEEN searches for everything in the range from `start` to `end` `start` with NOT_BETWEEN searches for everything not in the range from `start` and `end`. must be accompanied by a `end` value

For searching by a range. `end` with BETWEEN searches for everything in the range from `start` to `end` `end` with NOT_BETWEEN searches for everything not in the range from `start` and `end`. must be accompanied by a `start` value

sort direction for the return values

relationship type of the query. EQ, LTE, GTE, LT, GT, NEQ for `value` BETWEEN or NOT_BETWEEN for `start` with `end` IN or NOT_IN for use with `set`

Singular unint32 value that, combined with rel_type, allows you to search for floats that relate to this `value`. `value` field cannot be combined with BETWEEN or the NOT_BETWEEN FilterRelationship `rel_type`. That means you can use the EQ, LTE, GTE, LT, GT, NEQ FilterRelationship `rel_type`

For searching by a range. `start` with BETWEEN searches for everything in the range from `start` to `end` `start` with NOT_BETWEEN searches for everything not in the range from `start` and `end`. must be accompanied by a `end` value

For searching by a range. `end` with BETWEEN searches for everything in the range from `start` to `end` `end` with NOT_BETWEEN searches for everything not in the range from `start` and `end`. must be accompanied by a `start` value

sort direction for the return values

'IN' or 'NOT IN' sql operations

href for downloading item

asset type

band(s) of data in asset. https://github.com/radiantearth/stac-spec/blob/612ee4fb4f979c049d2416e7f5374a5301b8a277/extensions/eo/README.md

enum for asset type

cloud platform enum (Google cloud, Azure, etc)

manager of the bucket

bucket region. useful when concerned about egress

bucket name

path to the object in the bucket

requester_pays pertains to egress cost. Some buckets are hosted with the egress costs assigned to the requester. some hosts pay the regress costs for the requester.

REQUIRED. The STAC version the Collection implements. STAC versions can be mixed, but please keep the recommended best practices in mind.

REQUIRED. Identifier for the collection that is unique across the provider.

A short descriptive one-line title for the collection.

REQUIRED. Detailed multi-line description to fully explain the collection. CommonMark 0.29 syntax MAY be used for rich text representation.

List of keywords describing the collection.

REQUIRED. Collection's license(s), either a SPDX License identifier, various if multiple licenses apply or proprietary for all other cases.

A list of providers, which may include all organizations capturing or processing the data or the hosting provider. Providers should be listed in chronological order with the most recent provider being the last element of the list.

REQUIRED. Spatial and temporal extents.

A map of property summaries, either a set of values or statistics such as a range.

Flag denoting that this collection is static (i.e. it's footprint will not change).

percent cloud cover. 0 no clouds, 100 completely covered

band or bands represented in data. If multiple bands, then use a bitwise operator

data with a cloud_cover equal to or in the range specified in cloud_cover

data that possesses the bands specified in bands

REQUIRED. Potential spatial extent covered by the collection.

REQUIRED. Potential temporal extent covered by the collection.

REQUIRED. Current footprint.

id of scene should be id of STAC item, but there may be a use case where someone does not want that

experimental name of the mosaic this item is a member of

experimental the quad_key of this specific item

experimental an array of the zooms contained within the asset(s)

deprecated

experimental scene provenance. ordered list of STAC item ids that contribute to the mosaic. The 0th STAC item in provenance_ids is the front-most contributor to the mosaic, the last STAC item in bottom contributor and is likely to be partially covered by other contributing scenes

experimental mosaic to search for

experimental quad_key to search by

REQUIRED. The name of the organization or the individual.

Multi-line description to add further provider information such as processing details for processors and producers, hosting details for hosts or basic contact information. CommonMark 0.29 syntax MAY be used for rich text representation.

Roles of the provider. Any of licensor, producer, processor or host.

Homepage on which the provider describes the dataset and publishes contact information.

The relative orbit number at the time of acquisition.

The state of the orbit. Either ascending or descending for polar orbiting satellites, or geostationary for geosynchronous satellites

The relative orbit number at the time of acquisition.

The state of the orbit. Either ascending or descending for polar orbiting satellites, or geostationary for geosynchronous satellites

Provider identifier. As most geospatial assets are already defined by some identification scheme by the data provider it is recommended to simply use that ID. Data providers are advised to include sufficient information to make their IDs globally unique, including things like unique satellite IDs.

(optional) A human readable title describing the item.

(optional) The id of the STAC Collection this Item references to (see collection relation type below). This field is required if such a relation type is present. This field provides an easy way for a user to search for any Items that belong in a specified Collection.

the properties of an item that are not defined within the STAC specification. Requires marshalling and un-marshalling https://developers.google.com/protocol-buffers/docs/proto3#any

Dictionary of asset objects that can be downloaded, each with a unique key. Some pre-defined keys are listed in the chapter 'Asset types'.

the spatial shape of the item. must have a spatial reference defined.

the bounding box of the spatial shape of the item. must have a spatial reference defined.

deprecated

deprecated

timestamp at which data was observed (optional if datetime set)

start timestamp for a period of observation

deprecated

end timestamp for a period of observation

timestamp when it was created (according to STAC spec this applies to metadata only, but in our case we haven't implemented the asset level created date yet, so we don't have a differentiation yet between metadata creation and asset creation. used to be `processed`)

last timestamp when STAC metadata itself was updated

spatial reference of the assets (if assets have different projections, those can be assigned on the assets and any not defined default to this projection)

platform from which the data was collected

platform from which the data was collected

instrument which collected the data

instrument which collected the data

constellation of data collectors

ground sampling distance

version of JSON STAC that this protobuf attempts to match

version of protobuf STAC

STAC

electro-optical data message

view of the asset, includes all relevant angular information

Landsat Message

limit the number of results returned

the offset from which the query should start

if id matches, return the one matching STAC item

more complex id search. allows for searching by pattern or by IN or NOT_IN sets

search by properties specified by user using a request object known by user and the Any marshalling pattern

search by the spatial extent as defined by geometry

search by the spatial extent as defined by the envelope bounds

search by a geometry request. this sends a geometry operator to a geometry service, and the returned geometry is in turn used as the spatial extent

search for the datetime that matched by bounds defined by the exact timestamp or a range of timestamp

search for the moment the data was observed by bounds defined by the exact timestamp or a range of timestamp

search for the moment the asset data was created by bounds defined by the exact timestamp or a range of timestamp

search for the moment the STAC item metadata was updated by bounds defined by the exact timestamp or a range of timestamp

spatial reference. (currently only supports epsg field)

only data from the platform specified

only data from the instrument specified

only data from the constellation specified

data with a gsd equal to or in the range specified in gsd

use certain electro-optical search parameters in your query

Viewing angle. The angle from the sensor between nadir (straight down) and the scene center. Measured in degrees (0-90).

The incidence angle is the angle between the vertical (normal) to the intercepting surface and the line of sight back to the satellite at the scene center. Measured in degrees (0-90).

The angle measured from the sub-sensor point (point on the ground below the platform) between the scene center and true north. Measured clockwise from north in degrees (0-360).

Sun azimuth angle. From the scene center point on the ground, this is the angle between truth north and the sun. Measured clockwise in degrees (0-360).

Sun elevation angle. The angle from the tangent of the scene center point to the sun. Measured from the horizon in degrees (0-90).

data with a off_nadir equal to or in the range specified in off_nadir

data with a incidence equal to or in the range specified in incidence

data with a azimuth equal to or in the range specified in azimuth

data with a sun_azimuth equal to or in the range specified in sun_azimuth

data with a sun_elevation equal to or in the range specified in sun_elevation