Download Visual

Download 8-bit image in EPSG:3857.

POST /api?api_key=<API_KEY>
JSON Parameters:
 
  • type – (required) Operation name. Value is ‘jpeg’.
  • params – (required) Request parameters.
  • params.view_id – (required) View id of the scene returned by the Search API, see Search API. Example values: “L8/LC80110312016028LGN00”, “S2/19/T/CG/2017/7/9/0”, “MODIS/12/04/2017204/2017213034223” etc
  • params.bbox – (required to crop by AOI: either bbox, geometry or cropper_ref must be set) Bounding box in EPSG:4326; order: westing, southing, easting, northing (i.e. minx, miny, maxx, maxy). If null process full scene.
  • params.geometry – (required to crop by AOI: either bbox, geometry or cropper_ref must be set) A GeoJSON representation of a geometry describing the AOI. Supported geometry types: “Polygon”, “MultiPolygon”. If neither geometry nor bbox were provided, then process a full scene
  • params.cropper_ref – (required to crop by AOI: either bbox, geometry or cropper_ref must be set) A resourse id of a GeoJSON representation of a geometry saved into data base using Cropper API
  • params.bm_type – (required) Band combination to visualize. Example: “(B5-B4)/(B5+B4),(B3-B5)/(B3+B5),(B3-B6)/(B3+B6)”, “B5-1” etc. For available band combinations please refer to Name Aliases and Supported Datasets
  • params.name_alias – (optional) User name of the band combination to be used in output file name.
  • params.resample – (optional) Interpolation type to use with WMS. Valid values: “near”, “bilinear”, “cubic”, “cubicspline”, “lanczos”, “average”, “mode”, “max”, “min”, “med”, “q1”, “q3”. Default is “cubic”.
  • params.colormap – (optional) Colorize bandmath result with the specified colormap. For avaliable palettes see Colorization
  • params.levels – (optional) An option to use with COLORMAP; rescale bandmath levels to the specified values. Default: -0.5,0.5
  • params.colors_limit – (optional) An option to use with COLORMAP, used for colormap discretization.
  • params.calibrate – (optional) Convert DN to ToA reflectance if 1. Valid values: 0, 1. Default: 0 (calibration disabled).
  • params.size – (optional) Output image dimensions setting from LV. Used for logging purpose only. Valid values: “S”, “M”, “L”, “XL”. Default: null.
  • params.georeference – (optional) Return georeferenced image if provided. Valid values: “world”, “kmz”, “tiff”. If “world”: return an image (.jpeg) and a world file (.jpegw) in a zip archive; if “kmz” return “kmz”; if “tiff” return geotiff; else return an image (.jpeg). Default: null.
  • params.format – (optional) Image format. Valid values: “jpeg”, “tiff”, “png”. Default: “jpeg”
  • params.pansharpening – (optional) Apply pansharpening if True.
  • params.reference – (required) Unique id to assign to the request
  • params.colors – (optional) List of colors to use with range colorization. Thresholds are set in params.thresholds. For more info on range colorization see range colorization
  • params.thresholds

    (optional) List of thresholds to use with range colorization. Colors are set in params.colors.For more info on range colorization see range colorization

Query Parameters:
 
  • api_key – (required) user’s API key

Examples

RGB Landsat 8

http

POST /api?api_key=XXX HTTP/1.1
Host: gdw.eos.com
Content-Type: application/json

{
    "type": "jpeg",
    "params": {
        "view_id": "L8/LC08_L1TP_025039_20180628_20180704_01_T1",
        "size": "S",
        "px_size": 480,
        "georeference": "jpeg",
        "name_alias": "RGB",
        "bm_type": "B4,B3,B2",
        "reference": "ref_1543313721"
    }
}

curl

curl -i -X POST 'https://gdw.eos.com/api?api_key=XXX' -H 'Content-Type: application/json' --data-raw '{"params": {"bm_type": "B4,B3,B2", "georeference": "jpeg", "name_alias": "RGB", "px_size": 480, "reference": "ref_1543313721", "size": "S", "view_id": "L8/LC08_L1TP_025039_20180628_20180704_01_T1"}, "type": "jpeg"}'

Output file name shall be: L8-LC08_L1TP_025039_20180628_20180704_01_T1_RGB.jpeg

NDVI Landsat 8

http

POST /api?api_key=XXX HTTP/1.1
Host: gdw.eos.com
Content-Type: application/json

{
    "type": "jpeg",
    "params": {
        "view_id": "L8/LC08_L1TP_025039_20180628_20180704_01_T1",
        "size": "S",
        "px_size": 480,
        "georeference": "tiff",
        "bm_type": "NDVI",
        "reference": "ref_1543315137"
    }
}

curl

curl -i -X POST 'https://gdw.eos.com/api?api_key=XXX' -H 'Content-Type: application/json' --data-raw '{"params": {"bm_type": "NDVI", "georeference": "tiff", "px_size": 480, "reference": "ref_1543315137", "size": "S", "view_id": "L8/LC08_L1TP_025039_20180628_20180704_01_T1"}, "type": "jpeg"}'

Output file name shall be: L8-LC08_L1TP_025039_20180628_20180704_01_T1_NDVI.tiff

Example Custom Index for CBERS-4. Crop by geometry

http

POST /api?api_key=XXX HTTP/1.1
Host: gdw.eos.com
Content-Type: application/json

{
   "type":"jpeg",
   "params":{
       "view_id":"CBERS4MUX/CBERS_4_MUX_20170111_153_119_L2",
       "bm_type":"(BAND8-BAND7)/(BAND8+BAND7)",
       "geometry":{"type":"Polygon","coordinates":[[[-43.42226,-16.667275],[-43.452301,-16.712494],[-43.414364,-16.742907],[-43.389301,-16.70493],[-43.42226,-16.667275]]]},
       "px_size":60,
       "resample":"cubic",
       "colormap": "RdYlGn",
       "levels": "-1,1",
       "calibrate": 1,
       "name_alias":"ndvi as custom index",
       "size": "S",
       "reference": "ref_1543315137"
   }
}

curl

curl -i -X POST 'https://gdw.eos.com/api?api_key=XXX' -H 'Content-Type: application/json' --data-raw '{"params": {"bm_type": "(BAND8-BAND7)/(BAND8+BAND7)", "calibrate": 1, "colormap": "RdYlGn", "geometry": {"coordinates": [[[-43.42226, -16.667275], [-43.452301, -16.712494], [-43.414364, -16.742907], [-43.389301, -16.70493], [-43.42226, -16.667275]]], "type": "Polygon"}, "levels": "-1,1", "name_alias": "ndvi as custom index", "px_size": 60, "reference": "ref_1543315137", "resample": "cubic", "size": "S", "view_id": "CBERS4MUX/CBERS_4_MUX_20170111_153_119_L2"}, "type": "jpeg"}'

Output file name shall be: CBERS4MUX-CBERS_4_MUX_20170111_153_119_L2_ndvi_as_custom_index.jpeg

Example Sentinel-2 NDVI. Crop by saved geometry

  1. Save the geometry using Cropper API.

http

POST /api/render/cropper/?api_key=XXX HTTP/1.1
Host: gate.eos.com
Content-Type: application/json

{
    "type": "Feature",
    "properties": {},
    "geometry": {
            "type": "Polygon",
            "coordinates": [
                    [
                            [-101.949692, 39.422403],
                            [-102.036896, 39.351821],
                            [-101.978531, 39.260436],
                            [-101.848068, 39.247676],
                            [-101.770477, 39.310394],
                            [-101.757431, 39.388979],
                            [-101.852188, 39.434602],
                            [-101.949692, 39.422403]
                    ]
            ]
    }
}

curl

curl -i -X POST 'https://gate.eos.com/api/render/cropper/?api_key=XXX' -H 'Content-Type: application/json' --data-raw '{"geometry": {"coordinates": [[[-101.949692, 39.422403], [-102.036896, 39.351821], [-101.978531, 39.260436], [-101.848068, 39.247676], [-101.770477, 39.310394], [-101.757431, 39.388979], [-101.852188, 39.434602], [-101.949692, 39.422403]]], "type": "Polygon"}, "properties": {}, "type": "Feature"}'

If a resource has been created successfully, the server responds with 200 OK:

HTTP/1.1 200 OK
Access-Control-Allow-Origin: *
Content-Type: application/json; charset=UTF-8

{"cropper_ref": "c230d39994ab5f7a664c52d28eff1130"}
  1. Request download setting the AOI with a cropper_ref:

http

POST /api?api_key=XXX HTTP/1.1
Host: gdw.eos.com
Content-Type: application/json

{
   "type":"jpeg",
   "params":{
       "view_id":"S2/14/S/KJ/2018/11/22/0",
       "cropper_ref": "c230d39994ab5f7a664c52d28eff1130",
       "bm_type":"(B8A-B04)/(B8A+B04)",
       "px_size":60,
       "resample":"cubic",
       "colormap": "RdYlGn",
       "levels": "-1,1",
       "calibrate": 1,
       "name_alias":"ndvi",
       "size": "S",
       "reference": "ref_1543315137"
   }
}

curl

curl -i -X POST 'https://gdw.eos.com/api?api_key=XXX' -H 'Content-Type: application/json' --data-raw '{"params": {"bm_type": "(B8A-B04)/(B8A+B04)", "calibrate": 1, "colormap": "RdYlGn", "cropper_ref": "c230d39994ab5f7a664c52d28eff1130", "levels": "-1,1", "name_alias": "ndvi", "px_size": 60, "reference": "ref_1543315137", "resample": "cubic", "size": "S", "view_id": "S2/14/S/KJ/2018/11/22/0"}, "type": "jpeg"}'