Stac Search Operations - Create

Service:: Planetary Computer

API Version:: 2025-04-30-preview

Search
Endpoint.

POST https://contoso-catalog.gwhqfdeddydpareu.uksouth.geocatalog.spatio.azure.com/stac/search?api-version=2025-04-30-preview

URI Parameters

Name	In	Required	Type	Description
api-version	query	True	string minLength: 1	The API version to use for this operation.

Request Body

Name	Type	Description
bbox	number[] (double)	Bounding box for spatial filtering in format [west, south, east, north].
collections	string[]	List of collection IDs to search within.
conf	object	Conf
datetime	string	Temporal filter in RFC 3339 format, can be a single time or range.
duration	integer (int32)	URL signature duration in seconds.
fields	SearchPostRequestFields[]	https://github.com/stac-api-extensions/fields Specifies which fields to include or exclude in the response.
filter	object	https://github.com/stac-api-extensions/filter Filter
filter-crs	string	Coordinate reference system for the filter.
filter-lang	FilterLang	Filter language to use for the filter expression.
ids	string[]	List of specific item IDs to return.
intersects	GeoJson	GeoJSON geometry for spatial filtering.
limit	integer (int32) minimum: 1 maximum: 1000	Maximum number of results to return.
query	object	https://github.com/stac-api-extensions/query Query
sign	SignType	Whether to sign asset URLs in the response.
sortby	SortExtension[]	https://github.com/stac-api-extensions/sort Sort criteria for the search results.
token	string	Pagination token for fetching the next set of results.

Responses

Name	Type	Description
200 OK	ItemCollection	The request has succeeded.
204 No Content		There is no content to send for this request, but the headers may be useful.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	An unexpected error response. Headers x-ms-error-code: string

Name

Type

Description

200 OK

ItemCollection

The request has succeeded.

204 No Content

There is no content to send for this request, but the headers may be useful.

Other Status Codes

Azure.Core.Foundations.ErrorResponse

An unexpected error response.

Headers

x-ms-error-code: string

Security

OAuth2Auth

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
https://geocatalog.spatio.azure.com/.default

Examples

StacSearchOperations_Create

Sample request

HTTP

POST https://contoso-catalog.gwhqfdeddydpareu.uksouth.geocatalog.spatio.azure.com/stac/search?api-version=2025-04-30-preview

{
  "bbox": [
    -89.940948,
    28.887969,
    -88.938446,
    29.623609
  ],
  "collections": [
    "sentinel-2-l2a-test-collection-0101d529594b"
  ]
}

Sample response

Status code:: 200

{
  "type": "FeatureCollection",
  "features": [
    {
      "id": "S2A_MSIL2A_20240211T163421_R083_T16RCT_20240211T222120",
      "bbox": [
        -89.06959008,
        28.82389372,
        -87.92460396,
        29.82716844
      ],
      "type": "Feature",
      "links": [
        {
          "rel": "collection",
          "type": "application/json",
          "href": "https://sample.cmbtazhseqhgeudd.uksouth.geocatalog.spatio.azure.com/stac/collections/sentinel-2-l2a-test-collection-0101d529594b"
        },
        {
          "rel": "parent",
          "type": "application/json",
          "href": "https://sample.cmbtazhseqhgeudd.uksouth.geocatalog.spatio.azure.com/stac/collections/sentinel-2-l2a-test-collection-0101d529594b"
        },
        {
          "rel": "root",
          "type": "application/json",
          "href": "https://sample.cmbtazhseqhgeudd.uksouth.geocatalog.spatio.azure.com/stac/"
        },
        {
          "rel": "self",
          "type": "application/geo+json",
          "href": "https://sample.cmbtazhseqhgeudd.uksouth.geocatalog.spatio.azure.com/stac/collections/sentinel-2-l2a-test-collection-0101d529594b/items/S2A_MSIL2A_20240211T163421_R083_T16RCT_20240211T222120"
        },
        {
          "rel": "license",
          "href": "https://sentinel.esa.int/documents/247904/690755/Sentinel_Data_Legal_Notice"
        },
        {
          "rel": "preview",
          "href": "https://planetarycomputer.microsoft.com/api/data/v1/item/map?collection=sentinel-2-l2a&item=S2A_MSIL2A_20240211T163421_R083_T16RCT_20240211T222120",
          "type": "text/html",
          "title": "Map of item"
        }
      ],
      "assets": {
        "AOT": {
          "href": "https://ysuxzldatasa.blob.core.windows.net/sentinel-2-l2a-test-collection-0101d529594b-a7a94b80/bdd/S2A_MSIL2A_20240211T163421_R083_T16RCT_20240211T222120/AOT.tif",
          "proj:bbox": [
            300000,
            3190200,
            409800,
            3300000
          ],
          "proj:shape": [
            10980,
            10980
          ],
          "proj:transform": [
            10,
            0,
            300000,
            0,
            -10,
            3300000
          ],
          "gsd": 10,
          "type": "image/tiff; application=geotiff; profile=cloud-optimized",
          "roles": [
            "data"
          ],
          "title": "Aerosol optical thickness (AOT)"
        },
        "B01": {
          "href": "https://ysuxzldatasa.blob.core.windows.net/sentinel-2-l2a-test-collection-0101d529594b-a7a94b80/bdd/S2A_MSIL2A_20240211T163421_R083_T16RCT_20240211T222120/B01.tif",
          "proj:bbox": [
            300000,
            3190200,
            409800,
            3300000
          ],
          "proj:shape": [
            1830,
            1830
          ],
          "proj:transform": [
            60,
            0,
            300000,
            0,
            -60,
            3300000
          ],
          "gsd": 60,
          "type": "image/tiff; application=geotiff; profile=cloud-optimized",
          "roles": [
            "data"
          ],
          "title": "Band 1 - Coastal aerosol - 60m",
          "eo:bands": [
            {
              "name": "B01",
              "common_name": "coastal",
              "description": "Band 1 - Coastal aerosol",
              "center_wavelength": 0.443,
              "full_width_half_max": 0.027
            }
          ]
        },
        "B02": {
          "href": "https://ysuxzldatasa.blob.core.windows.net/sentinel-2-l2a-test-collection-0101d529594b-a7a94b80/bdd/S2A_MSIL2A_20240211T163421_R083_T16RCT_20240211T222120/B02.tif",
          "proj:bbox": [
            300000,
            3190200,
            409800,
            3300000
          ],
          "proj:shape": [
            10980,
            10980
          ],
          "proj:transform": [
            10,
            0,
            300000,
            0,
            -10,
            3300000
          ],
          "gsd": 10,
          "type": "image/tiff; application=geotiff; profile=cloud-optimized",
          "roles": [
            "data"
          ],
          "title": "Band 2 - Blue - 10m",
          "eo:bands": [
            {
              "name": "B02",
              "common_name": "blue",
              "description": "Band 2 - Blue",
              "center_wavelength": 0.49,
              "full_width_half_max": 0.098
            }
          ]
        },
        "B03": {
          "href": "https://ysuxzldatasa.blob.core.windows.net/sentinel-2-l2a-test-collection-0101d529594b-a7a94b80/bdd/S2A_MSIL2A_20240211T163421_R083_T16RCT_20240211T222120/B03.tif",
          "proj:bbox": [
            300000,
            3190200,
            409800,
            3300000
          ],
          "proj:shape": [
            10980,
            10980
          ],
          "proj:transform": [
            10,
            0,
            300000,
            0,
            -10,
            3300000
          ],
          "gsd": 10,
          "type": "image/tiff; application=geotiff; profile=cloud-optimized",
          "roles": [
            "data"
          ],
          "title": "Band 3 - Green - 10m",
          "eo:bands": [
            {
              "name": "B03",
              "common_name": "green",
              "description": "Band 3 - Green",
              "center_wavelength": 0.56,
              "full_width_half_max": 0.045
            }
          ]
        },
        "B04": {
          "href": "https://ysuxzldatasa.blob.core.windows.net/sentinel-2-l2a-test-collection-0101d529594b-a7a94b80/bdd/S2A_MSIL2A_20240211T163421_R083_T16RCT_20240211T222120/B04.tif",
          "proj:bbox": [
            300000,
            3190200,
            409800,
            3300000
          ],
          "proj:shape": [
            10980,
            10980
          ],
          "proj:transform": [
            10,
            0,
            300000,
            0,
            -10,
            3300000
          ],
          "gsd": 10,
          "type": "image/tiff; application=geotiff; profile=cloud-optimized",
          "roles": [
            "data"
          ],
          "title": "Band 4 - Red - 10m",
          "eo:bands": [
            {
              "name": "B04",
              "common_name": "red",
              "description": "Band 4 - Red",
              "center_wavelength": 0.665,
              "full_width_half_max": 0.038
            }
          ]
        },
        "B05": {
          "href": "https://ysuxzldatasa.blob.core.windows.net/sentinel-2-l2a-test-collection-0101d529594b-a7a94b80/bdd/S2A_MSIL2A_20240211T163421_R083_T16RCT_20240211T222120/B05.tif",
          "proj:bbox": [
            300000,
            3190200,
            409800,
            3300000
          ],
          "proj:shape": [
            5490,
            5490
          ],
          "proj:transform": [
            20,
            0,
            300000,
            0,
            -20,
            3300000
          ],
          "gsd": 20,
          "type": "image/tiff; application=geotiff; profile=cloud-optimized",
          "roles": [
            "data"
          ],
          "title": "Band 5 - Vegetation red edge 1 - 20m",
          "eo:bands": [
            {
              "name": "B05",
              "common_name": "rededge",
              "description": "Band 5 - Vegetation red edge 1",
              "center_wavelength": 0.704,
              "full_width_half_max": 0.019
            }
          ]
        },
        "B06": {
          "href": "https://ysuxzldatasa.blob.core.windows.net/sentinel-2-l2a-test-collection-0101d529594b-a7a94b80/bdd/S2A_MSIL2A_20240211T163421_R083_T16RCT_20240211T222120/B06.tif",
          "proj:bbox": [
            300000,
            3190200,
            409800,
            3300000
          ],
          "proj:shape": [
            5490,
            5490
          ],
          "proj:transform": [
            20,
            0,
            300000,
            0,
            -20,
            3300000
          ],
          "gsd": 20,
          "type": "image/tiff; application=geotiff; profile=cloud-optimized",
          "roles": [
            "data"
          ],
          "title": "Band 6 - Vegetation red edge 2 - 20m",
          "eo:bands": [
            {
              "name": "B06",
              "common_name": "rededge",
              "description": "Band 6 - Vegetation red edge 2",
              "center_wavelength": 0.74,
              "full_width_half_max": 0.018
            }
          ]
        },
        "B07": {
          "href": "https://ysuxzldatasa.blob.core.windows.net/sentinel-2-l2a-test-collection-0101d529594b-a7a94b80/bdd/S2A_MSIL2A_20240211T163421_R083_T16RCT_20240211T222120/B07.tif",
          "proj:bbox": [
            300000,
            3190200,
            409800,
            3300000
          ],
          "proj:shape": [
            5490,
            5490
          ],
          "proj:transform": [
            20,
            0,
            300000,
            0,
            -20,
            3300000
          ],
          "gsd": 20,
          "type": "image/tiff; application=geotiff; profile=cloud-optimized",
          "roles": [
            "data"
          ],
          "title": "Band 7 - Vegetation red edge 3 - 20m",
          "eo:bands": [
            {
              "name": "B07",
              "common_name": "rededge",
              "description": "Band 7 - Vegetation red edge 3",
              "center_wavelength": 0.783,
              "full_width_half_max": 0.028
            }
          ]
        },
        "B08": {
          "href": "https://ysuxzldatasa.blob.core.windows.net/sentinel-2-l2a-test-collection-0101d529594b-a7a94b80/bdd/S2A_MSIL2A_20240211T163421_R083_T16RCT_20240211T222120/B08.tif",
          "proj:bbox": [
            300000,
            3190200,
            409800,
            3300000
          ],
          "proj:shape": [
            10980,
            10980
          ],
          "proj:transform": [
            10,
            0,
            300000,
            0,
            -10,
            3300000
          ],
          "gsd": 10,
          "type": "image/tiff; application=geotiff; profile=cloud-optimized",
          "roles": [
            "data"
          ],
          "title": "Band 8 - NIR - 10m",
          "eo:bands": [
            {
              "name": "B08",
              "common_name": "nir",
              "description": "Band 8 - NIR",
              "center_wavelength": 0.842,
              "full_width_half_max": 0.145
            }
          ]
        },
        "B09": {
          "href": "https://ysuxzldatasa.blob.core.windows.net/sentinel-2-l2a-test-collection-0101d529594b-a7a94b80/bdd/S2A_MSIL2A_20240211T163421_R083_T16RCT_20240211T222120/B09.tif",
          "proj:bbox": [
            300000,
            3190200,
            409800,
            3300000
          ],
          "proj:shape": [
            1830,
            1830
          ],
          "proj:transform": [
            60,
            0,
            300000,
            0,
            -60,
            3300000
          ],
          "gsd": 60,
          "type": "image/tiff; application=geotiff; profile=cloud-optimized",
          "roles": [
            "data"
          ],
          "title": "Band 9 - Water vapor - 60m",
          "eo:bands": [
            {
              "name": "B09",
              "description": "Band 9 - Water vapor",
              "center_wavelength": 0.945,
              "full_width_half_max": 0.026
            }
          ]
        },
        "B11": {
          "href": "https://ysuxzldatasa.blob.core.windows.net/sentinel-2-l2a-test-collection-0101d529594b-a7a94b80/bdd/S2A_MSIL2A_20240211T163421_R083_T16RCT_20240211T222120/B11.tif",
          "proj:bbox": [
            300000,
            3190200,
            409800,
            3300000
          ],
          "proj:shape": [
            5490,
            5490
          ],
          "proj:transform": [
            20,
            0,
            300000,
            0,
            -20,
            3300000
          ],
          "gsd": 20,
          "type": "image/tiff; application=geotiff; profile=cloud-optimized",
          "roles": [
            "data"
          ],
          "title": "Band 11 - SWIR (1.6) - 20m",
          "eo:bands": [
            {
              "name": "B11",
              "common_name": "swir16",
              "description": "Band 11 - SWIR (1.6)",
              "center_wavelength": 1.61,
              "full_width_half_max": 0.143
            }
          ]
        },
        "B12": {
          "href": "https://ysuxzldatasa.blob.core.windows.net/sentinel-2-l2a-test-collection-0101d529594b-a7a94b80/bdd/S2A_MSIL2A_20240211T163421_R083_T16RCT_20240211T222120/B12.tif",
          "proj:bbox": [
            300000,
            3190200,
            409800,
            3300000
          ],
          "proj:shape": [
            5490,
            5490
          ],
          "proj:transform": [
            20,
            0,
            300000,
            0,
            -20,
            3300000
          ],
          "gsd": 20,
          "type": "image/tiff; application=geotiff; profile=cloud-optimized",
          "roles": [
            "data"
          ],
          "title": "Band 12 - SWIR (2.2) - 20m",
          "eo:bands": [
            {
              "name": "B12",
              "common_name": "swir22",
              "description": "Band 12 - SWIR (2.2)",
              "center_wavelength": 2.19,
              "full_width_half_max": 0.242
            }
          ]
        },
        "B8A": {
          "href": "https://ysuxzldatasa.blob.core.windows.net/sentinel-2-l2a-test-collection-0101d529594b-a7a94b80/bdd/S2A_MSIL2A_20240211T163421_R083_T16RCT_20240211T222120/B8A.tif",
          "proj:bbox": [
            300000,
            3190200,
            409800,
            3300000
          ],
          "proj:shape": [
            5490,
            5490
          ],
          "proj:transform": [
            20,
            0,
            300000,
            0,
            -20,
            3300000
          ],
          "gsd": 20,
          "type": "image/tiff; application=geotiff; profile=cloud-optimized",
          "roles": [
            "data"
          ],
          "title": "Band 8A - Vegetation red edge 4 - 20m",
          "eo:bands": [
            {
              "name": "B8A",
              "common_name": "rededge",
              "description": "Band 8A - Vegetation red edge 4",
              "center_wavelength": 0.865,
              "full_width_half_max": 0.033
            }
          ]
        },
        "SCL": {
          "href": "https://ysuxzldatasa.blob.core.windows.net/sentinel-2-l2a-test-collection-0101d529594b-a7a94b80/bdd/S2A_MSIL2A_20240211T163421_R083_T16RCT_20240211T222120/SCL.tif",
          "proj:bbox": [
            300000,
            3190200,
            409800,
            3300000
          ],
          "proj:shape": [
            5490,
            5490
          ],
          "proj:transform": [
            20,
            0,
            300000,
            0,
            -20,
            3300000
          ],
          "gsd": 20,
          "type": "image/tiff; application=geotiff; profile=cloud-optimized",
          "roles": [
            "data"
          ],
          "title": "Scene classfication map (SCL)"
        },
        "WVP": {
          "href": "https://ysuxzldatasa.blob.core.windows.net/sentinel-2-l2a-test-collection-0101d529594b-a7a94b80/bdd/S2A_MSIL2A_20240211T163421_R083_T16RCT_20240211T222120/WVP.tif",
          "proj:bbox": [
            300000,
            3190200,
            409800,
            3300000
          ],
          "proj:shape": [
            10980,
            10980
          ],
          "proj:transform": [
            10,
            0,
            300000,
            0,
            -10,
            3300000
          ],
          "gsd": 10,
          "type": "image/tiff; application=geotiff; profile=cloud-optimized",
          "roles": [
            "data"
          ],
          "title": "Water vapour (WVP)"
        },
        "visual": {
          "href": "https://ysuxzldatasa.blob.core.windows.net/sentinel-2-l2a-test-collection-0101d529594b-a7a94b80/bdd/S2A_MSIL2A_20240211T163421_R083_T16RCT_20240211T222120/visual.tif",
          "proj:bbox": [
            300000,
            3190200,
            409800,
            3300000
          ],
          "proj:shape": [
            10980,
            10980
          ],
          "proj:transform": [
            10,
            0,
            300000,
            0,
            -10,
            3300000
          ],
          "gsd": 10,
          "type": "image/tiff; application=geotiff; profile=cloud-optimized",
          "roles": [
            "data"
          ],
          "title": "True color image",
          "eo:bands": [
            {
              "name": "B04",
              "common_name": "red",
              "description": "Band 4 - Red",
              "center_wavelength": 0.665,
              "full_width_half_max": 0.038
            },
            {
              "name": "B03",
              "common_name": "green",
              "description": "Band 3 - Green",
              "center_wavelength": 0.56,
              "full_width_half_max": 0.045
            },
            {
              "name": "B02",
              "common_name": "blue",
              "description": "Band 2 - Blue",
              "center_wavelength": 0.49,
              "full_width_half_max": 0.098
            }
          ]
        },
        "safe-manifest": {
          "href": "https://ysuxzldatasa.blob.core.windows.net/sentinel-2-l2a-test-collection-0101d529594b-a7a94b80/bdd/S2A_MSIL2A_20240211T163421_R083_T16RCT_20240211T222120/safe-manifest.safe",
          "type": "application/xml",
          "roles": [
            "metadata"
          ],
          "title": "SAFE manifest"
        },
        "granule-metadata": {
          "href": "https://ysuxzldatasa.blob.core.windows.net/sentinel-2-l2a-test-collection-0101d529594b-a7a94b80/bdd/S2A_MSIL2A_20240211T163421_R083_T16RCT_20240211T222120/granule-metadata.xml",
          "type": "application/xml",
          "roles": [
            "metadata"
          ],
          "title": "Granule metadata"
        },
        "inspire-metadata": {
          "href": "https://ysuxzldatasa.blob.core.windows.net/sentinel-2-l2a-test-collection-0101d529594b-a7a94b80/bdd/S2A_MSIL2A_20240211T163421_R083_T16RCT_20240211T222120/inspire-metadata.xml",
          "type": "application/xml",
          "roles": [
            "metadata"
          ],
          "title": "INSPIRE metadata"
        },
        "product-metadata": {
          "href": "https://ysuxzldatasa.blob.core.windows.net/sentinel-2-l2a-test-collection-0101d529594b-a7a94b80/bdd/S2A_MSIL2A_20240211T163421_R083_T16RCT_20240211T222120/product-metadata.xml",
          "type": "application/xml",
          "roles": [
            "metadata"
          ],
          "title": "Product metadata"
        },
        "datastrip-metadata": {
          "href": "https://ysuxzldatasa.blob.core.windows.net/sentinel-2-l2a-test-collection-0101d529594b-a7a94b80/bdd/S2A_MSIL2A_20240211T163421_R083_T16RCT_20240211T222120/datastrip-metadata.xml",
          "type": "application/xml",
          "roles": [
            "metadata"
          ],
          "title": "Datastrip metadata"
        }
      },
      "_msft:ts": "2024-11-06T22:48:32.746991Z",
      "geometry": {
        "type": "Polygon",
        "coordinates": [
          [
            [
              -89.0695901,
              29.8142551
            ],
            [
              -87.9335875,
              29.8271684
            ],
            [
              -87.924604,
              28.8362971
            ],
            [
              -89.0496889,
              28.8238937
            ],
            [
              -89.0695901,
              29.8142551
            ]
          ]
        ]
      },
      "_msft:etag": "0faf1c9f-3a1f-4d69-8beb-cc89bec0f76a",
      "collection": "sentinel-2-l2a-test-collection-0101d529594b",
      "properties": {
        "datetime": "2024-02-11T16:34:21.024000Z",
        "platform": "Sentinel-2A",
        "proj:epsg": 32616,
        "instruments": [
          "msi"
        ],
        "s2:mgrs_tile": "16RCT",
        "constellation": "Sentinel 2",
        "s2:granule_id": "S2A_OPER_MSI_L2A_TL_MSFT_20240211T222120_A045125_T16RCT_N05.10",
        "eo:cloud_cover": 100,
        "s2:datatake_id": "GS2A_20240211T163421_045125_N05.10",
        "s2:product_uri": "S2A_MSIL2A_20240211T163421_N0510_R083_T16RCT_20240211T222120.SAFE",
        "s2:datastrip_id": "S2A_OPER_MSI_L2A_DS_MSFT_20240211T222120_S20240211T164431_N05.10",
        "s2:product_type": "S2MSI2A",
        "sat:orbit_state": "descending",
        "s2:datatake_type": "INS-RAW",
        "s2:generation_time": "2024-02-11T22:21:20.341595Z",
        "sat:relative_orbit": 83,
        "s2:water_percentage": 0,
        "s2:mean_solar_zenith": 47.739082267841,
        "s2:mean_solar_azimuth": 152.402799769714,
        "s2:processing_baseline": "05.10",
        "s2:snow_ice_percentage": 0,
        "s2:vegetation_percentage": 0,
        "s2:thin_cirrus_percentage": 0.930425,
        "s2:cloud_shadow_percentage": 0,
        "s2:nodata_pixel_percentage": 0,
        "s2:unclassified_percentage": 0,
        "s2:dark_features_percentage": 0,
        "s2:not_vegetated_percentage": 0,
        "s2:degraded_msi_data_percentage": 0.0189,
        "s2:high_proba_clouds_percentage": 46.895468,
        "s2:reflectance_conversion_factor": 1.02819912068379,
        "s2:medium_proba_clouds_percentage": 52.174109,
        "s2:saturated_defective_pixel_percentage": 0
      },
      "stac_extensions": [
        "https://stac-extensions.github.io/eo/v1.1.0/schema.json",
        "https://stac-extensions.github.io/sat/v1.0.0/schema.json",
        "https://stac-extensions.github.io/projection/v1.1.0/schema.json"
      ],
      "stac_version": "1.0.0"
    }
  ]
}

Status code:: 204

Definitions

Name	Description
Asset	https://github.com/radiantearth/stac-spec/blob/v1.0.0/item-spec/item-spec.md#asset-object Represents a STAC asset, which is a file or resource associated with a STAC item.
Azure.Core.Foundations.Error	The error object.
Azure.Core.Foundations.ErrorResponse	A response containing error details.
Azure.Core.Foundations.InnerError	An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.
ContextExtension	https://github.com/radiantearth/stac-api-spec/tree/master/extensions/context#context-extension-specification Context information for a search response including pagination details.
FeatureType	Type identifier for GeoJSON Feature objects
FilterLang	Choices for filter-lang value in a POST request. Based on https://github.com/stac-api-extensions/filter#queryables Note the addition of cql2-json, which is used by the pgstac backend, but is not included in the spec above. Defines the supported filter languages for STAC API queries.
ItemCollection	https://github.com/radiantearth/stac-spec/blob/v1.0.0/item-spec/itemcollection-spec.md Represents a collection of STAC Items as a GeoJSON FeatureCollection.
ItemCollectionType	Represents the GeoJSON feature collection type for STAC item collections.
ItemProperties	Properties of a STAC Item containing metadata about the asset. https://github.com/radiantearth/stac-spec/blob/v1.0.0/item-spec/item-spec.md#properties-object
Link	Link model. Ref: http://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/schemas/link.yaml Represents a link.
LinkType	MIME types for links.
Provider	https://github.com/radiantearth/stac-spec/blob/v1.0.0/collection-spec/collection-spec.md#provider-object Represents information about a data provider for STAC collections and items.
SearchPostRequest	Search model. Overrides the validation for datetime from the base request model. Defines parameters for a STAC search POST request.
SearchPostRequestFields	FieldsExtension. Attributes: include: set of fields to include. exclude: set of fields to exclude. Controls which fields to include or exclude from the response.
SignType	Represent the signature type for asset URLs.
SortDirections	Defines the sorting directions for query results in STAC API.
SortExtension	https://github.com/radiantearth/stac-api-spec/tree/master/extensions/sort#sort-api-extension Represents a sort specification for STAC API queries.
StacItem	Represents a STAC Item, which is a GeoJSON Feature with additional metadata.

Asset

Object

https://github.com/radiantearth/stac-spec/blob/v1.0.0/item-spec/item-spec.md#asset-object

Represents a STAC asset, which is a file or resource associated with a STAC item.

Name	Type	Description
constellation	string	Constellation of satellites that acquired the data.
created	string (date-time)	Creation timestamp of the data.
description	string	Detailed description of the asset.
gsd	number (float)	Ground sample distance in meters.
href	string minLength: 1	URL to the asset file.
instruments	string[]	Instruments that acquired the data.
mission	string	Mission associated with the data.
platform	string	Platform that acquired the data.
providers	Provider[]	Organizations or individuals who provide the data.
roles	string[]	Roles of the asset within the item.
title	string	Human-readable title for the asset.
type	string	Media type of the asset.
updated	string (date-time)	Last update timestamp of the data.

Azure.Core.Foundations.Error

Object

The error object.

Name	Type	Description
code	string	One of a server-defined set of error codes.
details	Azure.Core.Foundations.Error[]	An array of details about specific errors that led to this reported error.
innererror	Azure.Core.Foundations.InnerError	An object containing more specific information than the current object about the error.
message	string	A human-readable representation of the error.
target	string	The target of the error.

Azure.Core.Foundations.ErrorResponse

Object

A response containing error details.

Name	Type	Description
error	Azure.Core.Foundations.Error	The error object.

Azure.Core.Foundations.InnerError

Object

An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.

Name	Type	Description
code	string	One of a server-defined set of error codes.
innererror	Azure.Core.Foundations.InnerError	Inner error.

ContextExtension

Object

https://github.com/radiantearth/stac-api-spec/tree/master/extensions/context#context-extension-specification

Context information for a search response including pagination details.

Name	Type	Description
limit	integer (int32)	Maximum number of items requested.
matched	integer (int32)	Total number of items matching the query.
returned	integer (int32)	Number of items returned in the response.

FeatureType

Enumeration

Type identifier for GeoJSON Feature objects

Value	Description
Feature	Standard GeoJSON Feature type identifier

FilterLang

Enumeration

Choices for filter-lang value in a POST request.

Based on https://github.com/stac-api-extensions/filter#queryables

Note the addition of cql2-json, which is used by the pgstac backend, but is not included in the spec above.

Defines the supported filter languages for STAC API queries.

Value	Description
cql-json	Common Query Language in JSON format.
cql2-json	Common Query Language 2 in JSON format
cql2-text	Common Query Language 2 in text format.

ItemCollection

Object

https://github.com/radiantearth/stac-spec/blob/v1.0.0/item-spec/itemcollection-spec.md

Represents a collection of STAC Items as a GeoJSON FeatureCollection.

Name	Type	Default value	Description
bbox	number[] (double)		Bounding box of all items in format [west, south, east, north].
context	ContextExtension		Context information for the search response.
features	StacItem[]		Array of STAC Items in the collection.
links	Link[]		Links to related resources and endpoints.
msft:_created	string		MSFT Created
msft:_updated	string		MSFT Updated
msft:short_description	string maxLength: 300		MSFT Short Description
stac_extensions	string[]		URLs to STAC extensions implemented by this STAC resource.
stac_version	string minLength: 1	1.0.0	Stac Version
type	ItemCollectionType		GeoJSON FeatureCollection type.

ItemCollectionType

Enumeration

Represents the GeoJSON feature collection type for STAC item collections.

Value	Description
FeatureCollection	Standard GeoJSON FeatureCollection type.

ItemProperties

Object

Properties of a STAC Item containing metadata about the asset.

https://github.com/radiantearth/stac-spec/blob/v1.0.0/item-spec/item-spec.md#properties-object

Name	Type	Description
constellation	string	Constellation of satellites that acquired the data.
created	string (date-time)	Creation timestamp of the data.
datetime	string	Datetime the asset represents in RFC 3339 format.
description	string	Detailed description of the item.
end_datetime	string (date-time)	End time of the item observation period.
gsd	number (float)	Ground sample distance in meters.
instruments	string[]	Instruments that acquired the data.
mission	string	Mission associated with the data.
platform	string	Platform that acquired the data.
providers	Provider[]	Organizations or individuals who provide the data.
start_datetime	string (date-time)	Start time of the item observation period.
title	string	Human-readable title for the item.
updated	string (date-time)	Last update timestamp of the data.

Link

Object

Link model.

Ref: http://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/schemas/link.yaml

Represents a link.

Name	Type	Default value	Description
body	object		For POST requests, the resource can specify the HTTP body as a JSON object.
headers	object		Object key-value pairs that map to headers. Example: { "Accept": "application/json" }.
href	string		The URL of the link.
hreflang	string		The language of the linked resource.
length	integer (int32)		The length of the linked resource.
merge	boolean	False	Indicates whether the client is expected to merge the body value into the current request body before following the link. This is only valid when the server is responding to a POST request. Default: false.
method	enum: GET POST	GET	Specifies the HTTP method that the resource expects. Default: GET.
rel	string		The relationship type of the link.
title	string		The title of the link.
type	LinkType	application/json	The MIME type of the linked resource.

LinkType

Enumeration

MIME types for links.

Value	Description
image/tiff; application=geotiff	Represents an image/tiff with application=geotiff.
image/jp2	Represents an image/jp2.
image/png	Represents an image/png.
image/jpeg	Represents an image/jpeg.
image/jpg	Represents an image/jpg.
image/webp	Represents an image/webp.
application/x-binary	Represents an application/x-binary.
application/xml	Represents an application/xml.
application/json	Represents an application/json.
application/geo+json	Represents an application/geo+json.
text/html	Represents a text/html.
text/plain	Represents a text/plain.
application/x-protobuf	Represents an application/x-protobuf.

Provider

Object

https://github.com/radiantearth/stac-spec/blob/v1.0.0/collection-spec/collection-spec.md#provider-object

Represents information about a data provider for STAC collections and items.

Name	Type	Description
description	string	Description of the provider.
name	string minLength: 1	Name of the provider organization or individual.
roles	string[]	Roles played by the provider (e.g., producer, processor, host).
url	string	URL to the provider's website.

SearchPostRequest

Object

Search model.

Overrides the validation for datetime from the base request model.

Defines parameters for a STAC search POST request.

Name	Type	Default value	Description
bbox	number[] (double)		Bounding box for spatial filtering in format [west, south, east, north].
collections	string[]		List of collection IDs to search within.
conf	object		Conf
datetime	string		Temporal filter in RFC 3339 format, can be a single time or range.
duration	integer (int32)		URL signature duration in seconds.
fields	SearchPostRequestFields[]		https://github.com/stac-api-extensions/fields Specifies which fields to include or exclude in the response.
filter	object		https://github.com/stac-api-extensions/filter Filter
filter-crs	string		Coordinate reference system for the filter.
filter-lang	FilterLang	cql-json	Filter language to use for the filter expression.
ids	string[]		List of specific item IDs to return.
intersects	GeoJson		GeoJSON geometry for spatial filtering.
limit	integer (int32) minimum: 1 maximum: 1000	250	Maximum number of results to return.
query	object		https://github.com/stac-api-extensions/query Query
sign	SignType		Whether to sign asset URLs in the response.
sortby	SortExtension[]		https://github.com/stac-api-extensions/sort Sort criteria for the search results.
token	string		Pagination token for fetching the next set of results.

SearchPostRequestFields

Object

FieldsExtension.

Attributes: include: set of fields to include. exclude: set of fields to exclude.

Controls which fields to include or exclude from the response.

Name	Type	Default value	Description
exclude	string[]	[]	Array of field names to exclude from the response.
include	string[]	[]	Array of field names to include in the response.

SignType

Enumeration

Represent the signature type for asset URLs.

Value	Description
true	Sign asset URLs in the response.
false	Do not sign asset URLs in the response.

SortDirections

Enumeration

Defines the sorting directions for query results in STAC API.

Value	Description
asc	Sort results in ascending order.
desc	Sort results in descending order.

SortExtension

Object

https://github.com/radiantearth/stac-api-spec/tree/master/extensions/sort#sort-api-extension

Represents a sort specification for STAC API queries.

Name	Type	Description
direction	SortDirections	The sort direction (ascending or descending).
field	string minLength: 1	The field name to sort by.

StacItem

Object

Represents a STAC Item, which is a GeoJSON Feature with additional metadata.

Name	Type	Default value	Description
_msft:etag	string		MSFT ETag
_msft:ts	string		MSFT Timestamp
assets	<string, Asset>		Assets
bbox	number[] (double)		Bounding box coordinates for the feature
collection	string		ID of the STAC collection this item belongs to.
geometry	GeoJson		Geometry object defining the feature's shape
id	string		Unique identifier for the feature
links	Link[]		Links to related resources and endpoints.
msft:_created	string		MSFT Created
msft:_updated	string		MSFT Updated
msft:short_description	string maxLength: 300		MSFT Short Description
properties	ItemProperties		Attributes associated with the feature
stac_extensions	string[]		URLs to STAC extensions implemented by this STAC resource.
stac_version	string minLength: 1	1.0.0	Stac Version
type	FeatureType		GeoJSON type identifier for Feature

Share via

Stac Search Operations - Create

URI Parameters

Request Body

Responses

Security

OAuth2Auth

Scopes

Examples

StacSearchOperations_Create

Sample request

Sample response

Definitions

Asset

Azure.Core.Foundations.Error

Azure.Core.Foundations.ErrorResponse

Azure.Core.Foundations.InnerError

ContextExtension

FeatureType

FilterLang

ItemCollection

ItemCollectionType

ItemProperties

Link

LinkType

Provider

SearchPostRequest

SearchPostRequestFields

SignType

SortDirections

SortExtension

StacItem