STAC search API
Introduction
This section describes how to search products from REGARDS meta catalog with STAC API.
caution
This API requires the stac plugin to be installed and configured on your REGARDS instance.
REST API
How to
The Regards REST API concept describes how REST interfaces must be handled to submit requests.
Endpoints
| description | url | verb | documentation |
|---|---|---|---|
| Entry point to browse with STAC browser | /api/v1/rs-catalog/stac | GET | see REST documentation |
| Get the feature collections | /api/v1/rs-catalog/stac/collections | GET | see REST documentation |
| Get a collection by its ID | /api/v1/rs-catalog/stac/collections/{collectionId} | GET | see REST documentation |
| Get the features of a collection | /api/v1/rs-catalog/stac/collections/{collectionId}/items | GET | see REST documentation |
| Get a feature by its ID | /api/v1/rs-catalog/stac/collections/{collectionId}/items/{itemId} | GET | see REST documentation |
| Search feature with simple filtering | /api/v1/rs-catalog/stac/search | GET | see REST documentation |
| Search feature with complex filtering | /api/v1/rs-catalog/stac/search | POST | see REST documentation |
| Search collection with simple filtering | /api/v1/rs-catalog/stac/collections/search | GET | see REST documentation |
| Search collection with complex filtering | /api/v1/rs-catalog/stac/collections/search | POST | see REST documentation |
Request body for STAC Item search
Example :
{
"bbox": {
"maxX": 0.1,
"maxY": 0.1,
"minX": 0.1,
"minY": 0.1
},
"collections": {
"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": "string",
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
},
"datetime": {
"from": "2019-08-24T14:15:22Z",
"singleDate": true,
"to": "2019-08-24T14:15:22Z"
},
"fields": {
"excludes": {
"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": "string",
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
},
"includes": {
"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": "string",
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
}
},
"ids": {
"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": "string",
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
},
"intersects": {
"crs": "string",
"type": "string"
},
"limit": 0,
"page": 0,
"query": {
"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": {
"_1": "string",
"_2": {}
},
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
},
"sortBy": {
"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": {
"direction": "ASC",
"field": "string"
},
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
}
}
Request body for STAC Collection search
Example:
{
"bbox": {
"maxX": 0.1,
"maxY": 0.1,
"minX": 0.1,
"minY": 0.1
},
"collections": {
"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": "string",
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
},
"datetime": {
"from": "2019-08-24T14:15:22Z",
"singleDate": true,
"to": "2019-08-24T14:15:22Z"
},
"fields": {
"excludes": {
"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": "string",
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
},
"includes": {
"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": "string",
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
}
},
"ids": {
"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": "string",
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
},
"intersects": {
"crs": "string",
"type": "string"
},
"item": {
"bbox": {
"maxX": 0.1,
"maxY": 0.1,
"minX": 0.1,
"minY": 0.1
},
"collections": {
"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": "string",
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
},
"datetime": {
"from": "2019-08-24T14:15:22Z",
"singleDate": true,
"to": "2019-08-24T14:15:22Z"
},
"ids": {
"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": "string",
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
},
"intersects": {
"crs": "string",
"type": "string"
},
"query": {
"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": {
"_1": "string",
"_2": {}
},
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
}
},
"limit": 0,
"page": 0,
"query": {
"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": {
"_1": "string",
"_2": {}
},
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
},
"sortBy": {
"async": true,
"distinct": true,
"empty": true,
"lazy": true,
"memoized": true,
"orNull": {
"direction": "ASC",
"field": "string"
},
"ordered": true,
"sequential": true,
"singleValued": true,
"traversableAgain": true
}
}