Language

Search API documentation

Prerequisites

In order to use the Search API you need first to obtain an API key by requesting it to the customer care support or the Contact Us page.

Usage examples

Search and image and retrieve its identifier

This example demonstrate how to find a SPOT image and extract its identifier to be able to order it through the Order API.

First, define your API key so that the example commands can use it:

export MY_API_KEY=***INSERT YOUR API KEY HERE***

You can now request the desired images using a POST search request. Here we request all images that:

  • are in the bounding box 1.18, 43.52, 1.25, 43.56 expressed in geographic coordinates
  • were acquired with one of the optical satellite of the SPOT constellation (i.e. SPOT 1 to 7)
  • were acquired in July 2016
  • have an incidence angle less or equal to 20 degrees
  • have less than 10 percent of it covered by clouds
curl -X POST -H "Authorization: $MY_API_KEY" -H "Content-Type: application/json" -d '{
  "bbox": [
    1.18,
    43.52,
    1.25,
    43.56
  ],
  "constellation": [
    "SPOT"
  ],
  "acquisitionDate": "[2016-07-01,2016-07-31T23:59:59]",
  "incidenceAngle": "20]",
  "cloudCover": "10]",
  "count": 10,
  "startPage": 1
}' "https://search.geoapi-airbusds.com/api/v1/search"

Each matching image is returned as a GeoJSON feature under the /features[] property. The response should look like:

{
    "startIndex": 1,
    "itemsPerPage": 10,
    "totalResults": 1,
    "query": {
        "count": 10,
        "startPage": 1,
        "constellation": [
            "SPOT"
        ],
        "acquisitionDate": "[2016-07-01,2016-07-31T23:59:59]",
        "incidenceAngle": "20]",
        "cloudCover": "10]",
        "bbox": [
            1.18,
            43.52,
            1.25,
            43.56
        ]
    },
    "type": "FeatureCollection",
    "features": [
        {
            "type": "Feature",
            "properties": {
                "viewingAngleAlongTrack": 17.842472,
                "sourceId": "DS_SPOT7_201607291038129_FR1_FR1_FR1_FR1_E001N44_01140",
                "acquisitionDate": "2016-07-29T10:38:18.749Z",
                "viewingAngleAcrossTrack": 17.909748,
                "cloudCover": 1,
                "illuminationAzimuthAngle": 138.17620223373999,
                "azimuthAngle": 180.02305999992444,
                "creationDate": "2017-06-09T18:34:07.993655Z",
                "resolution": 1.5,
                "productName": "SPOT 1.5-m",
                "incidenceAngle": 19.932425767385716,
                "constellation": "SPOT",
                "provider": "Airbus Defence and Space",
                "satellite": "SPOT7",
                "illuminationElevationAngle": 60.113767096927724,
                "productType": "SPOTArchive1.5Mono"
            },
            "geometry": {
                "type": "Polygon",
                "coordinates": [
                    [
                        [
                            1.004096367945723,
                            43.70465186274181
                        ],
                        [
                            1.839631530291143,
                            43.69153457181614
                        ],
                        [
                            1.840765797911517,
                            43.3869345568225
                        ],
                        [
                            1.002817646184104,
                            43.4014298007982
                        ],
                        [
                            1.004096367945723,
                            43.70465186274181
                        ]
                    ]
                ]
            },
            "id": "ea1575c9-a4e5-4748-9e1b-fbc37d7286e9::fde346d6-4531-4bec-9d35-3d1880382c89",
            "bbox": [
                1.002817646184104,
                43.386934556822496,
                1.840765797911517,
                43.704651862741805
            ],
            "thumbnail": "/api/v1/productTypes/SPOTArchive1.5Mono/products/DS_SPOT7_201607291038129_FR1_FR1_FR1_FR1_E001N44_01140?size=SMALL",
            "quicklooks": [
                {
                    "size": "MEDIUM",
                    "projection": "http://www.opengis.net/def/crs/EPSG/0/3857",
                    "image": "https://search.geoapi-airbusds.com/api/v1/productTypes/SPOTArchive1.5Mono/products/DS_SPOT7_201607291038129_FR1_FR1_FR1_FR1_E001N44_01140?projection=EPSG:3857&size=MEDIUM"
                },
                {
                    "size": "MEDIUM",
                    "projection": "http://www.opengis.net/def/crs/EPSG/0/4326",
                    "image": "https://search.geoapi-airbusds.com/api/v1/productTypes/SPOTArchive1.5Mono/products/DS_SPOT7_201607291038129_FR1_FR1_FR1_FR1_E001N44_01140?projection=EPSG:4326&size=MEDIUM"
                },
                {
                    "size": "LARGE",
                    "projection": null,
                    "image": "https://search.geoapi-airbusds.com/api/v1/productTypes/SPOTArchive1.5Mono/products/DS_SPOT7_201607291038129_FR1_FR1_FR1_FR1_E001N44_01140?size=LARGE"
                },
                {
                    "size": "MEDIUM",
                    "projection": null,
                    "image": "https://search.geoapi-airbusds.com/api/v1/productTypes/SPOTArchive1.5Mono/products/DS_SPOT7_201607291038129_FR1_FR1_FR1_FR1_E001N44_01140?size=MEDIUM"
                },
                {
                    "size": "SMALL",
                    "projection": null,
                    "image": "https://search.geoapi-airbusds.com/api/v1/productTypes/SPOTArchive1.5Mono/products/DS_SPOT7_201607291038129_FR1_FR1_FR1_FR1_E001N44_01140?size=SMALL"
                }
            ]
        }
    ]
}

To verify that the image is of the desired quality, you can request one of the quicklooks of it (under /features[]/quicklooks[]). Here we choose to check the LARGE and unprojected quicklook:

curl -X GET -H "Authorization: $MY_API_KEY" "https://search.geoapi-airbusds.com/api/v1/productTypes/SPOTArchive1.5Mono/products/DS_SPOT7_201607291038129_FR1_FR1_FR1_FR1_E001N44_01140?size=LARGE"

The quicklook should look like the following image:

quicklook