The SpatioTemporal Asset Catalog API (1.0.0-beta.1)

Download OpenAPI specification:Download

URL: http://stacspec.org License: Apache License 2.0

This is an OpenAPI definition of the core SpatioTemporal Asset Catalog API specification. Any service that implements this endpoint to allow search of spatiotemporal assets can be considered a STAC API. The endpoint is also available as an OpenAPI fragment that can be integrated with other OpenAPI definitions, and is designed to slot seamlessly into a WFS 3 API definition.

Capabilities

essential characteristics of this API

landing page

The root landing page displays all available provider catalogs in CMR-STAC.

Responses

Response samples

200
500

Content type


{"title": "Buildings in Bonn",
"description": "Access to data about buildings in the city of Bonn via a Web API that conforms to the OGC API Features specification.",
"links": 
[
{"href": "http://data.example.org/",
"rel": "self",
"type": "application/json",
"title": "this document"
},
{"href": "http://data.example.org/api",
"rel": "service-desc",
"type": "application/vnd.oai.openapi+json;version=3.0",
"title": "the API definition"
},
{"href": "http://data.example.org/api.html",
"rel": "service-doc",
"type": "text/html",
"title": "the API documentation"
},
{"href": "http://data.example.org/conformance",
"rel": "conformance",
"type": "application/json",
"title": "OGC API conformance classes implemented by this server"
},
{"href": "http://data.example.org/collections",
"rel": "data",
"type": "application/json",
"title": "Information about the feature collections"
}
]
}

information about specifications that this API conforms to

A list of all conformance classes specified in a standard that the server conforms to.

Responses

Response samples

200
500

Content type


{"conformsTo": 
["http://www.opengis.net/spec/ogcapi-features-1/1.0/conf/core",
"http://www.opengis.net/spec/ogcapi-features-1/1.0/conf/oas30",
"http://www.opengis.net/spec/ogcapi-features-1/1.0/conf/html",
"http://www.opengis.net/spec/ogcapi-features-1/1.0/conf/geojson"
]
}

A provider catalog that contains a STAC search endpoint as well as a collections endpoint for crawling through collections and items in the browser

Responses

Response samples

200
500

Content type


{"id": "buildings",
"title": "Buildings",
"description": "Buildings in the city of Bonn.",
"extent": 
{"spatial": 
{"bbox": 
[
[7.01,
50.63,
7.22,
50.78
]
]
},
"temporal": 
{"interval": 
[
["2010-02-15T12:34:56Z",
null
]
]
}
},
"links": 
[
{"href": "http://data.example.org/collections/buildings/items",
"rel": "items",
"type": "application/geo+json",
"title": "Buildings"
},
{"href": "http://data.example.org/collections/buildings/items.html",
"rel": "items",
"type": "text/html",
"title": "Buildings"
},
{"href": "https://creativecommons.org/publicdomain/zero/1.0/",
"rel": "license",
"type": "text/html",
"title": "CC0-1.0"
},
{"href": "https://creativecommons.org/publicdomain/zero/1.0/rdf",
"rel": "license",
"type": "application/rdf+xml",
"title": "CC0-1.0"
}
]
}

Display all feature collections under provider `providerId`

path Parameters

providerId

required

string

local identifier of a provider

query Parameters

collections

Array of strings non-empty

The collections search parameter is a list of of collection IDs for Items to match. Only items that are included in one of these collections will be returned, otherwise all collections will be searched.

Responses

Response samples

200
500

Content type


{"links": 
[
{"href": "http://data.example.org/collections.json",
"rel": "self",
"type": "application/json",
"title": "this document"
},
{"href": "http://data.example.org/collections.html",
"rel": "alternate",
"type": "text/html",
"title": "this document as HTML"
},
{"href": "http://schemas.example.org/1.0/buildings.xsd",
"rel": "describedBy",
"type": "application/xml",
"title": "GML application schema for Acme Corporation building data"
},
{"href": "http://download.example.org/buildings.gpkg",
"rel": "enclosure",
"type": "application/geopackage+sqlite3",
"title": "Bulk download (GeoPackage)",
"length": 472546
}
],
"collections": 
[
{"id": "buildings",
"title": "Buildings",
"description": "Buildings in the city of Bonn.",
"extent": 
{"spatial": 
{"bbox": 
[
[7.01,
50.63,
7.22,
50.78
]
]
},
"temporal": 
{"interval": 
[
["2010-02-15T12:34:56Z",
null
]
]
}
},
"links": 
[
{"href": "http://data.example.org/collections/buildings/items",
"rel": "items",
"type": "application/geo+json",
"title": "Buildings"
},
{"href": "http://data.example.org/collections/buildings/items.html",
"rel": "items",
"type": "text/html",
"title": "Buildings"
},
{"href": "https://creativecommons.org/publicdomain/zero/1.0/",
"rel": "license",
"type": "text/html",
"title": "CC0-1.0"
},
{"href": "https://creativecommons.org/publicdomain/zero/1.0/rdf",
"rel": "license",
"type": "application/rdf+xml",
"title": "CC0-1.0"
}
]
}
]
}

describe the feature collection with id `collectionId`

path Parameters

providerId required	string local identifier of a provider
collectionId required	string local identifier of a collection

Responses

Response samples

200
500

Content type


{"id": "buildings",
"title": "Buildings",
"description": "Buildings in the city of Bonn.",
"extent": 
{"spatial": 
{"bbox": 
[
[7.01,
50.63,
7.22,
50.78
]
]
},
"temporal": 
{"interval": 
[
["2010-02-15T12:34:56Z",
null
]
]