Searching
Last updated: February 27, 2025
eAPI's searching capability allows users to discover imagery in Maxar's vast catalog. eAPI leverages Maxar's Discovery REST API to facilitate searches. In fact, the eAPI endpoints mirror those found in the Catalog REST API. View more information on the available endpoints by visiting their API documentation.
The search API is small — just a few methods for requesting collections, items, and performing searches. For most users the search method will be the one most often used.
Note: For more detailed information on collections visit the Maxar Catalog documentation for collections.
All requests to the API require a HTTP Authentication header with an OAuth bearer token. See the Getting an access token for more details.
Search Endpoints¶
The search endpoints provide query parameters for searching the catalog in a variety of ways including area of interest, time, and by arbitrary STAC item properties.
For more detailed information on the search endpoints visit the Maxar Catalog documentation for searching.
Note: To try out the Search API from your browser, view the eAPI's Collections Rapidoc webpage section.
You will need to log in using your username and password.
Tip: Including a 'datetime' filter of 3 years to your queries improves response time by ~70% (and 1 year filter cuts it down to about 2 seconds).
Adding 'datetime' examples:
https://eapi.maxar.com/e1so/search?collections=wv02&datetime=2020-01-01/2023-01-01
https://eapi.maxar.com/e1so/search?collections=wv02&datetime=2022-01-01/2023-01-01
List of Search Endpoints¶
GET
/e1so/search
https://eapi.maxar.com/e1so/search?collections=wv02&limit=1
POST
/e1so/search
https://eapi.maxar.com/e1so/search
POST body example:
{
"intersects": {
"type": "Polygon",
"coordinates": [
[
[
107.617495259223,
40.0426463031601
],
[
107.617496194991,
40.0544377615091
],
[
107.617491635855,
40.1032134785852
],
[
107.617389666588,
40.1519549239564
],
[
107.617533957255,
40.1848559558601
],
[
107.363370894321,
40.2019172682146
],
[
107.363077728329,
40.1707858513638
],
[
107.363055534282,
40.1680799661769
],
[
107.362754888628,
40.1207872605681
],
[
107.362540954214,
40.0723363603672
],
[
107.362445954865,
40.0605529735541
],
[
107.617495259223,
40.0426463031601
]
]
]
},
"collections": ["wv01", "wv02"],
"where": "eo:cloud_cover < 20",
"orderby": "id",
"limit": 10,
"page": 2
}
Collections Endpoints¶
Catalog items are organized into collections. See the STAC Specification for a description of collections and their properties. If you want to search through our available collections, we support pagination through the endpoints with the orderby, limit, and page parameters.
The value of orderby is a SQL-style ordering clause. However, only two properties are supported for ordering: datetime and id. Each may have an optional ASC or DESC modifier, where ASC is the default and may be omitted.
The value of the limit parameter supports a maximum value of 100 currently.
Note: To try out the Collections API from your browser, view the eAPI's Collections Rapidoc webpage section.
You will need a valid web token to make requests.
List of Collections Endpoints¶
Collections (all)¶
GET
/e1so/collections
Collections by collectionId¶
GET
/e1so/collections/{collectionId}
Collections by collectionId audit¶
Note: Due to the nature of third-party imagery, this endpoint is not available for the following collections: blacksky, skysat, capella, iceye, umbra.
GET
/e1so/collections/{collectionId}/audit
Collections by collectionId items¶
GET
/e1so/collections/{collectionId}/items
Collections with (browse image, cloud cover, and sample points)¶
Returns an asset given its collectionId, itemId, and type. This endpoint allows users to view a browse.tif (for previewing the image before ordering), cloud-cover geojson and sample-point-set geojson for a given image.
View RapidDocs page for this endpoint.
Note: Due to the nature of third-party imagery, we do not have these assets available for the following collections: blacksky, skysat, capella, iceye, umbra.
GET
/e1so/collections/{collectionId}/items/{itemId}/assets/{assetType}
| Parameter | Description |
|---|---|
| collectionId | [Required] Values: (wv01, wv02, wv03-vnir, wv03-swir) |
| itemId | [Required] A valid Maxar catalog inventory Id. |
| assetType | [Required] Values (browse.tif, cloud-cover.json, sample-point-set.json) |
Note: Failure to provide one of these will result in an error.
browse.tif¶
Example for browse.tif:
The following curl will request a browse.tif image from eAPI for the specified WorldView 2 image. It will output the file as foo.tif. This file can be used to view cloud cover before placing an order.
curl -X GET "https://eapi.maxar.com/e1so/collections/wv02/items/10300100AC19AC00/assets/browse.tif" \
-H "accept: application/json"\
-H "authorization: Bearer <ADD_YOUR_ACCESS_TOKEN>" --output foo.tif \
cloud-cover.json¶
Example for cloud-cover.json:
The following curl will request the cloud coverage for an image in GeoJSON format for the specified WorldView 2 image. This data can also be used to view cloud cover (in vector format) before placing an order.
curl -X GET "https://eapi.maxar.com/e1so/collections/wv02/items/10300100C937A300/assets/cloud-cover.json" \
-H "accept: application/json"\
-H "authorization: Bearer <ADD_YOUR_ACCESS_TOKEN>" \
Response GeoJSON:
{
"type": "Feature",
"properties": {
"item_id": "10300100C937A300",
"generation_date": "2023-02-27T19:21:16Z",
"method": "auto",
"cover_percentage": 0.019370446929039144
},
"geometry": {
"type": "MultiPolygon",
"coordinates": [
[
-26.071089,
17.073588
],
[
-26.071089,
17.073452
],
[
-26.070948,
17.073452
],
[
-26.070948,
17.073587
]
...truncated for the sake of brevity
]
}
}
sample-point-set.json¶
Example for sample-point-set.json:
curl -X GET "https://eapi.maxar.com/e1so/collections/wv02/items/10300100C937A300/assets/sample-point-set.json" \
-H "accept: application/json"\
-H "authorization: Bearer <ADD_YOUR_ACCESS_TOKEN>"
Response GeoJSON:
{
"type": "FeatureCollection",
"features": [
{
"type": "Feature",
"geometry": {
"type": "Point",
"coordinates": [
-25.989245972708222,
16.885525862904043
],
"crs": {
"type": "name",
"properties": {
"name": "EPSG:4326"
}
}
},
"properties": {
"sample_line": 0,
"sample_pixel": 18300,
"sample_datetime": "2023-02-27T12:33:19.738150Z",
"off_nadir": 17.3751,
"spacecraft_to_target_azimuth": 139.6465,
"sun_azimuth": 139.04034,
"sun_elevation": 57.517097,
"target_to_spacecraft_azimuth": 319.8941382528698,
"target_to_spacecraft_elevation": 70.53261386448001,
"gsd": 0.50150424
}
},
{
"type": "Feature",
"geometry": {
"type": "Point",
"coordinates": [
-25.989249676239606,
16.987219042622456
],
"crs": {
"type": "name",
"properties": {
"name": "EPSG:4326"
}
}
},
"properties": {
"sample_line": 23039,
"sample_pixel": 18300,
"sample_datetime": "2023-02-27T12:33:20.890100Z",
"off_nadir": 16.508635,
"spacecraft_to_target_azimuth": 136.28207,
"sun_azimuth": 139.15103,
"sun_elevation": 57.443676,
"target_to_spacecraft_azimuth": 316.50840060359315,
"target_to_spacecraft_elevation": 71.51134836136247,
"gsd": 0.49737236
}
},
{
"type": "Feature",
"geometry": {
"type": "Point",
"coordinates": [
-25.989251174809702,
17.02680348018399
],
"crs": {
"type": "name",
"properties": {
"name": "EPSG:4326"
}
}
},
"properties": {
"sample_line": 32007,
"sample_pixel": 18300,
"sample_datetime": "2023-02-27T12:33:21.338500Z",
"off_nadir": 16.18435,
"spacecraft_to_target_azimuth": 134.86981,
"sun_azimuth": 139.19397,
"sun_elevation": 57.415062,
"target_to_spacecraft_azimuth": 315.0869987422436,
"target_to_spacecraft_elevation": 71.87704341186937,
"gsd": 0.4958954
}
},
{
"type": "Feature",
"geometry": {
"type": "Point",
"coordinates": [
-25.989253411412815,
17.08891756758818
],
"crs": {
"type": "name",
"properties": {
"name": "EPSG:4326"
}
}
},
"properties": {
"sample_line": 46079,
"sample_pixel": 18300,
"sample_datetime": "2023-02-27T12:33:22.042101Z",
"off_nadir": 15.692617,
"spacecraft_to_target_azimuth": 132.53056,
"sun_azimuth": 139.2612,
"sun_elevation": 57.370113,
"target_to_spacecraft_azimuth": 312.7325122233805,
"target_to_spacecraft_elevation": 72.43086783698018,
"gsd": 0.49372637
}
},
{
"type": "Feature",
"geometry": {
"type": "Point",
"coordinates": [
-25.989553288438874,
16.874580528511554
],
"crs": {
"type": "name",
"properties": {
"name": "EPSG:4326"
}
}
},
"properties": {
"sample_line": 0,
"sample_pixel": 4620,
"sample_datetime": "2023-02-27T12:33:19.737950Z",
"off_nadir": 17.43578,
"spacecraft_to_target_azimuth": 139.83598,
"sun_azimuth": 139.02869,
"sun_elevation": 57.525124,
"target_to_spacecraft_azimuth": 320.0850317843498,
"target_to_spacecraft_elevation": 70.46393864821371,
"gsd": 2.0125017
}
},
{
"type": "Feature",
"geometry": {
"type": "Point",
"coordinates": [
-25.989555782728868,
16.97638546393921
],
"crs": {
"type": "name",
"properties": {
"name": "EPSG:4326"
}
}
},
"properties": {
"sample_line": 5759,
"sample_pixel": 4620,
"sample_datetime": "2023-02-27T12:33:20.889750Z",
"off_nadir": 16.56617,
"spacecraft_to_target_azimuth": 136.49326,
"sun_azimuth": 139.13956,
"sun_elevation": 57.451633,
"target_to_spacecraft_azimuth": 316.72118367449343,
"target_to_spacecraft_elevation": 71.4463750999186,
"gsd": 2.0081272
}
},
{
"type": "Feature",
"geometry": {
"type": "Point",
"coordinates": [
-25.989556803516827,
17.0149010381658
],
"crs": {
"type": "name",
"properties": {
"name": "EPSG:4326"
}
}
},
"properties": {
"sample_line": 7938,
"sample_pixel": 4620,
"sample_datetime": "2023-02-27T12:33:21.325550Z",
"off_nadir": 16.249502,
"spacecraft_to_target_azimuth": 135.13014,
"sun_azimuth": 139.18135,
"sun_elevation": 57.423794,
"target_to_spacecraft_azimuth": 315.3492690697502,
"target_to_spacecraft_elevation": 71.80354222055598,
"gsd": 2.0065024
}
},
{
"type": "Feature",
"geometry": {
"type": "Point",
"coordinates": [
-25.989558476177287,
17.078194496768365
],
"crs": {
"type": "name",
"properties": {
"name": "EPSG:4326"
}
}
},
"properties": {
"sample_line": 11519,
"sample_pixel": 4620,
"sample_datetime": "2023-02-27T12:33:22.041751Z",
"off_nadir": 15.746293,
"spacecraft_to_target_azimuth": 132.76526,
"sun_azimuth": 139.2499,
"sun_elevation": 57.378002,
"target_to_spacecraft_azimuth": 312.96900821894775,
"target_to_spacecraft_elevation": 72.37039766884668,
"gsd": 2.0038722
}
}
]
}
Searching Over the Antimeridian¶
The antimeridian is the 180 degrees longitude line that the International Date Line (IDL) is based upon. There are only a handful of places on Earth where land areas cross the antimeridian such as Fiji, Eastern Russia, and Antarctica. Some images acquired by Maxar satellites cross the antimeridian, and their STAC item footprint geometries will likewise cross the antimeridian. While searching for imagery near the antimeridian will not cause issues, searching for imagery that crosses the antimeridian will require some extra knowledge.
The coordinate order of a search should be in WGS84 format (lower left longitude, lower left latitude, upper right longitude, upper right latitude). All latitudes must be bound between [-90, 90]. In traditional GeoJSON specification, such as RFC 7946, longitudes must be bound between [-180, 180]; however, eAPI allows for values over 180 for the upper right longitude. This avoids cutting the geometry and maintains continuity in longitude values. Put simply, if a geometry crosses the antimeridian, its vertices with longitudes in the Western hemisphere will have values greater than 180.
For example, searching for the image with the inventory id 10200100DC6C7200 will return a bbox of 179.887928, -17.021566, 180.084226, -15.977491, and geometry coordinates with longitudes over 180 in the response such as [180.083839, -16.041542]. This same image can also be found by searching for the following bbox: 179.887928, -17.021566, -179.915774, -15.977491. This occurs because the upper right longitudes are equivalent (180.084226 == -179.915774; the second value is the converted negative value of the first). Regardless of which version is used to search, eAPI will always return the positive version over 180 when crossing the antimeridian.
Another example BBOX that crosses the antimeridian near Fiji is: 177.0, -20.0, -178.0, -16.0. This search covers 5 degrees of longitude OVER the antimeridian. Simply swapping the longitude values is a search for 355 degress of longitude that does NOT cross the antimeridian: -178.0, -20.0, 177.0, -16.0. When crossing the antimeridian the longitude value will go from a positive value near 180 to a negative value near -180.
Example Valid BBOX Near or Crossing Antimeridian¶
179.99, -16.16, 180.01, -16.15 (equal to 179.99, -16.16, -179.99, -16.15)
179.887928, -17.021566, 180.084226, -15.977491 (equal to 179.887928, -17.021566, -179.915774, -15.977491)
177.0, -20.0, 182.0, -16.0 (equal to 177.0, -20.0, -178.0, -16.0)
-178.0, -20.0, 177.0, -16.0
🆕 Searching Over Israel¶
The Kyl-Bingaman amendment (KBA) and the Maxar NOAA license have been updated to allow for a pixel restriction adjustment over Israel from 2m to 0.4m. Currently, Global Daily Take (GDT) content over Israel is resampled to .4m. This change, which applies to the country of Israel + a 500m buffer, allows for the production of imagery with an Effective Resolution of no less than 0.4m.
- Automatic resampling applied to images with a native resolution <0.4m.
- No resampling applied to images with a native resolution ≥ 0.4m.
- Resampling to ≥ 0.4m for orthomosaics, such as FG.
For ordering imagery that intersects over Israel, first establish a BBOX. Here is an example of a
BBOX that will return imagery over Israel: [34.22, 31.38, 35.46, 31.69]. The geometry of the BBOX
requires at a minimum a lower left and upper right.
In this example, the sample BBOX [34.22, 31.38, 35.46, 31.69] returned results which contained a
Worldview-1 image with the inventoryID of 102001010B9F7600. In the example json below from
the results, identify the GSD ("gsd": 0.618125945) and confirm that the value is greater than .4m
resolution. Now you are ready to place an order for this collection over Israel. Reference Ordering
Imagery Over Israel
Example Valid BBOX Over Israel¶
{
"id": "102001010B9F7600",
"bbox": [
34.116409,
31.168912,
34.363755,
31.610371
],
"type": "Feature",
"links": [
{
"rel": "collection",
"href": "https://api.content.satcloud.us/catalog/collections/wv01"
},
{
"rel": "self",
"href": "https://api.content.satcloud.us/catalog/collections/wv01/items/102001010B9F7600"
},
{
"rel": "root",
"href": "https://api.content.satcloud.us/catalog/"
},
{
"rel": "order-map-ready",
"href": "https://api.maxar.com/ordering/v1/pipelines/imagery/map-ready/order",
"type": "application/json"
},
{
"rel": "order-system-ready",
"href": "https://api.maxar.com/ordering/v1/pipelines/imagery/system-ready/order",
"type": "application/json"
},
{
"rel": "order-view-ready",
"href": "https://api.maxar.com/ordering/v1/pipelines/imagery/view-ready/order",
"type": "application/json"
},
{
"rel": "order-view-ready-ortho",
"href": "https://api.maxar.com/ordering/v1/pipelines/imagery/view-ready-ortho/order",
"type": "application/json"
}
],
"assets": {
"browse": {
"href": "https://e1so.eapi.maxar.com/e1so/collections/wv01/items/102001010B9F7600/assets/browse.
tif
",
"type": "image/tiff; application=geotiff",
"title": "Browse Image"
},
"cloud-cover": {
"href": "https://e1so.eapi.maxar.com/e1so/collections/wv01/items/102001010B9F7600/assets/cloud-
cover.json
",
"type": "application/geo+json",
"title": "Cloud Cover"
},
"sample-point-set": {
"href": "https://e1so.eapi.maxar.com/e1so/collections/wv01/items/102001010B9F7600/assets/sample-
point-set.json
",
"type": "application/geo+json",
"title": "Sample Point Set"
}
},
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
34.363755,
31.188358
],
[
34.363041,
31.239875
],
[
34.362451,
31.291159
],
[
34.362209,
31.342293
],
[
34.361665,
31.393166
],
[
34.361207,
31.443882
],
[
34.360899,
31.494423
],
[
34.360747,
31.544829
],
[
34.36066,
31.595105
],
[
34.360638,
31.610371
],
[
34.118045,
31.606216
],
[
34.117979,
31.590415
],
[
34.117744,
31.538369
],
[
34.117512,
31.486182
],
[
34.117312,
31.433833
],
[
34.117075,
31.38126
],
[
34.116775,
31.328481
],
[
34.116512,
31.275511
],
[
34.116409,
31.222335
],
[
34.11641,
31.168912
],
[
34.363755,
31.188358
]
]
]
},
"collection": "wv01",
"properties": {
"gsd": 0.618125945,
"title": "Maxar WV01 Image 102001010B9F7600",
"datetime": "2025-01-18T11:20:53.389271Z",
"eo:bands": [
{
"name": "pan",
"center_wavelength": 650
}
],
"platform": "worldview-01",
"utc_hour": 11,
"local_hour": 13,
"instruments": [
"VNIR"
],
"associations": [],
"view:azimuth": 259.43039833333336,
"constellation": "maxar",
"off_nadir_avg": 27.88351116666667,
"off_nadir_end": 27.19671,
"off_nadir_max": 28.968847,
"off_nadir_min": 27.19671,
"rda_available": false,
"utc_month_day": "01-18",
"eo:cloud_cover": 0.008521315608996867,
"scan_direction": "reverse",
"view:off_nadir": 27.88351116666667,
"local_month_day": "01-18",
"off_nadir_start": 28.968847,
"timezone_offset": 2,
"utc_time_of_day": "11:20:53",
"collect_time_end": "2025-01-18T11:20:56.856000Z",
"view:sun_azimuth": 204.95207666666667,
"local_time_of_day": "13:20:53",
"raw_archive_state": "offline",
"collect_time_start": "2025-01-18T11:20:53.389271Z",
"pan_resolution_avg": 0.618125945,
"pan_resolution_end": 0.6112152,
"pan_resolution_max": 0.6292048,
"pan_resolution_min": 0.6112152,
"view:sun_elevation": 34.22567516666667,
"multi_resolution_avg": null,
"multi_resolution_end": null,
"multi_resolution_max": null,
"multi_resolution_min": null,
"pan_resolution_start": 0.6292048,
"acquisition_rev_number": 96460,
"multi_resolution_start": null,
"view:sun_elevation_max": 34.446377,
"view:sun_elevation_min": 34.05231,
"geolocation_uncertainty": 6.123336,
"stereo_pair_identifiers": [],
"local_time_of_day_with_timezone": "13:20:53+0200",
"spacecraft_to_target_azimuth_avg": 259.43039833333336,
"spacecraft_to_target_azimuth_end": 266.0802,
"spacecraft_to_target_azimuth_max": 266.0802,
"spacecraft_to_target_azimuth_min": 251.29826,
"target_to_spacecraft_azimuth_avg": 79.43039957682292,
"target_to_spacecraft_azimuth_end": 86.0802001953125,
"target_to_spacecraft_azimuth_max": 86.0802001953125,
"target_to_spacecraft_azimuth_min": 71.29826354980469,
"spacecraft_to_target_azimuth_start": 251.29826,
"target_to_spacecraft_azimuth_start": 71.29826354980469,
"target_to_spacecraft_elevation_avg": 59.73164283493792,
"target_to_spacecraft_elevation_end": 60.48908129308199,
"target_to_spacecraft_elevation_max": 60.48908129308199,
"target_to_spacecraft_elevation_min": 58.53359377357897,
"target_to_spacecraft_elevation_start": 58.53359377357897
},
"stac_version": "1.0.0",
"stac_extensions": [
"https://stac-extensions.github.io/eo/v1.0.0/schema.json",
"https://stac-extensions.github.io/view/v1.0.0/schema.json"
]
}