{"__v":4,"_id":"5661fdce55e4450d00e62c8e","category":{"__v":1,"_id":"5661fdcb55e4450d00e62c75","pages":["5661fdce55e4450d00e62c8e"],"project":"5511df3be2990b0d00fb071d","version":"5661fdca55e4450d00e62c73","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-03-24T22:22:56.073Z","from_sync":false,"order":5,"slug":"search","title":"Search"},"editedParams":true,"editedParams2":true,"parentDoc":null,"project":"5511df3be2990b0d00fb071d","user":"551d6846a7e98017009e3e3b","version":{"__v":2,"_id":"5661fdca55e4450d00e62c73","project":"5511df3be2990b0d00fb071d","createdAt":"2015-12-04T20:55:38.639Z","releaseDate":"2015-12-04T20:55:38.639Z","categories":["5661fdcb55e4450d00e62c74","5661fdcb55e4450d00e62c75","5661fdcb55e4450d00e62c76","5661fdcb55e4450d00e62c77","5661fdcb55e4450d00e62c78","5661fdcb55e4450d00e62c79","567c42b13241c20d00b7312e"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"2.0.0","version":"2.0"},"updates":["553ee7bdd15bf20d0051c4b0"],"next":{"pages":[],"description":""},"createdAt":"2015-04-02T16:14:58.701Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"code":"","language":"text"}]},"method":"get","results":{"codes":[{"name":"Full Result","code":"{\n  \"meta\": {\n    \"name\": \"landsat-api\",\n    \"license\": \"CC0-1.0\",\n    \"website\": \"https://api.astrodigital.com/v1\",\n    \"page\": 1,\n    \"limit\": 1,\n    \"found\": 547102\n  },\n  \"results\": [\n    {\n      \"_id\": \"55e5c86908ff57057697b65c\",\n      \"scene_id\": \"LC81450532015244LGN00\",\n      \"sensor\": \"OLI_TIRS\",\n      \"acquisitionDate\": \"2015-09-01\",\n      \"dateUpdated\": \"2015-09-01\",\n      \"browseAvailable\": \"Y\",\n      \"browseURL\": \"http://earthexplorer.usgs.gov/browse/landsat_8/2015/145/053/LC81450532015244LGN00.jpg\",\n      \"path\": 145,\n      \"row\": 53,\n      \"upperLeftCornerLatitude\": 11.16935,\n      \"upperLeftCornerLongitude\": 74.45177,\n      \"upperRightCornerLatitude\": 10.80856,\n      \"upperRightCornerLongitude\": 76.15251,\n      \"lowerLeftCornerLatitude\": 9.42958,\n      \"lowerLeftCornerLongitude\": 74.07835,\n      \"lowerRightCornerLatitude\": 9.06616,\n      \"lowerRightCornerLongitude\": 75.76969,\n      \"sceneCenterLatitude\": 10.12225,\n      \"sceneCenterLongitude\": 75.11378,\n      \"cloudCover\": 0,\n      \"cloudCoverFull\": 7.85,\n      \"FULL_UL_QUAD_CCA\": \"\",\n      \"FULL_UR_QUAD_CCA\": \"\",\n      \"FULL_LL_QUAD_CCA\": \"\",\n      \"FULL_LR_QUAD_CCA\": \"\",\n      \"dayOrNight\": \"DAY\",\n      \"flightPath\": \"\",\n      \"sunElevation\": 64.76539995,\n      \"sunAzimuth\": 91.77952116,\n      \"receivingStation\": \"LGN\",\n      \"sceneStartTime\": \"2015-09-01T05:17:00-04:00\",\n      \"sceneStopTime\": \"2015-09-01T05:17:00-04:00\",\n      \"lookAngle\": \"\",\n      \"imageQuality1\": 9,\n      \"imageQuality2\": \"\",\n      \"gainBand1\": \"\",\n      \"gainBand2\": \"\",\n      \"gainBand3\": \"\",\n      \"gainBand4\": \"\",\n      \"gainBand5\": \"\",\n      \"gainBand6H\": \"\",\n      \"gainBand6L\": \"\",\n      \"gainBand7\": \"\",\n      \"gainBand8\": \"\",\n      \"gainChangeBand1\": \"\",\n      \"gainChangeBand2\": \"\",\n      \"gainChangeBand3\": \"\",\n      \"gainChangeBand4\": \"\",\n      \"gainChangeBand5\": \"\",\n      \"gainChangeBand6H\": \"\",\n      \"gainChangeBand6L\": \"\",\n      \"gainChangeBand7\": \"\",\n      \"gainChangeBand8\": \"\",\n      \"satelliteNumber\": \"\",\n      \"DATA_TYPE_L1\": \"L1T\",\n      \"cartURL\": \"http://earthexplorer.usgs.gov/order/process?dataset_name=LANDSAT_8&ordered=LC81450532015244LGN00\",\n      \"DATE_ACQUIRED_GAP_FILL\": \"\",\n      \"DATA_TYPE_L0RP\": \"\",\n      \"DATUM\": \"\",\n      \"ELEVATION_SOURCE\": \"\",\n      \"ELLIPSOID\": \"\",\n      \"EPHEMERIS_TYPE\": \"\",\n      \"FALSE_EASTING\": \"\",\n      \"FALSE_NORTHING\": \"\",\n      \"GAP_FILL\": \"\",\n      \"GROUND_CONTROL_POINTS_MODEL\": 17,\n      \"GROUND_CONTROL_POINTS_VERIFY\": \"\",\n      \"GEOMETRIC_RMSE_MODEL\": \"\",\n      \"GEOMETRIC_RMSE_MODEL_X\": 11.34,\n      \"GEOMETRIC_RMSE_MODEL_Y\": 9.629,\n      \"GEOMETRIC_RMSE_VERIFY\": \"\",\n      \"GRID_CELL_SIZE_PANCHROMATIC\": \"\",\n      \"GRID_CELL_SIZE_REFLECTIVE\": \"\",\n      \"GRID_CELL_SIZE_THERMAL\": \"\",\n      \"MAP_PROJECTION_L1\": \"\",\n      \"MAP_PROJECTION_L0RA\": \"\",\n      \"ORIENTATION\": \"\",\n      \"OUTPUT_FORMAT\": \"\",\n      \"PANCHROMATIC_LINES\": \"\",\n      \"PANCHROMATIC_SAMPLES\": \"\",\n      \"L1_AVAILABLE\": \"\",\n      \"REFLECTIVE_LINES\": \"\",\n      \"REFLECTIVE_SAMPLES\": \"\",\n      \"RESAMPLING_OPTION\": \"\",\n      \"SCAN_GAP_INTERPOLATION\": \"\",\n      \"THERMAL_LINES\": \"\",\n      \"THERMAL_SAMPLES\": \"\",\n      \"TRUE_SCALE_LAT\": \"\",\n      \"UTM_ZONE\": \"\",\n      \"VERTICAL_LON_FROM_POLE\": \"\",\n      \"PRESENT_BAND_1\": \"\",\n      \"PRESENT_BAND_2\": \"\",\n      \"PRESENT_BAND_3\": \"\",\n      \"PRESENT_BAND_4\": \"\",\n      \"PRESENT_BAND_5\": \"\",\n      \"PRESENT_BAND_6\": \"\",\n      \"PRESENT_BAND_7\": \"\",\n      \"PRESENT_BAND_8\": \"\",\n      \"NADIR_OFFNADIR\": \"NADIR\",\n      \"countries\": [\n        {\n          \"name\": \"India\",\n          \"alpha-2\": \"IN\",\n          \"alpha-3\": \"IND\",\n          \"country-code\": \"356\",\n          \"iso_3166-2\": \"ISO 3166-2:IN\",\n          \"region-code\": \"142\",\n          \"sub-region-code\": \"034\"\n        }\n      ],\n      \"boundingBox\": {\n        \"type\": \"Polygon\",\n        \"coordinates\": [\n          [\n            [\n            76.15251,\n            10.80856\n            ],\n            [\n            74.45177,\n            11.16935\n            ],\n            [\n            74.07835,\n            9.42958\n            ],\n            [\n            75.76969,\n            9.06616\n            ],\n            [\n            76.15251,\n            10.80856\n            ]\n          ]\n        ]\n      }\n    }\n  ]\n}","language":"json","status":200},{"status":200,"name":"Summary Result","language":"text","code":"{\n  \"meta\": {\n    \"name\": \"landsat-api\",\n    \"license\": \"CC0-1.0\",\n    \"website\": \"https://api.astrodigital.com/v1\",\n    \"page\": 1,\n    \"limit\": 1,\n    \"found\": 547102\n  },\n  \"results\": [\n  {\n    \"_id\": \"55e5c86908ff57057697b65c\",\n    \"sceneID\": \"LC81450532015244LGN00\",\n    \"acquisitionDate\": \"2015-09-01\",\n    \"browseAvailable\": \"Y\",\n    \"browseURL\": \"http://earthexplorer.usgs.gov/browse/landsat_8/2015/145/053/LC81450532015244LGN00.jpg\",\n    \"path\": 145,\n    \"row\": 53,\n    \"sceneCenterLatitude\": 10.12225,\n    \"sceneCenterLongitude\": 75.11378,\n    \"cloudCover\": 0,\n    \"cloudCoverFull\": 7.85,\n    \"sunAzimuth\": 91.77952116,\n    \"sceneStartTime\": \"2015-09-01T05:17:00-04:00\",\n    \"sceneStopTime\": \"2015-09-01T05:17:00-04:00\",\n    \"boundingBox\": {\n      \"type\": \"Polygon\",\n      \"coordinates\": [\n        [\n          [\n          76.15251,\n          10.80856\n          ],\n          [\n          74.45177,\n          11.16935\n          ],\n          [\n          74.07835,\n          9.42958\n          ],\n          [\n          75.76969,\n          9.06616\n          ],\n          [\n          76.15251,\n          10.80856\n          ]\n          ]\n        ]\n      }\n    }\n  ]\n}"}]},"settings":"56a8d993c0e02f0d007fa916","auth":"required","params":[{"_id":"552d2765a86ee20d00780bae","ref":"","in":"query","required":false,"desc":"Limit of results to return","default":"1","type":"int","name":"limit"},{"_id":"552d2765a86ee20d00780bad","ref":"","in":"query","required":false,"desc":"Results to skip in return","default":"0","type":"int","name":"skip"},{"_id":"55e72d7a2d0d3021000db037","ref":"","in":"query","required":false,"desc":"Return a condensed view of the data","default":"false","type":"boolean","name":"summary"},{"_id":"55e72d7a2d0d3021000db036","ref":"","in":"query","required":false,"desc":"Results page to view","default":"1","type":"int","name":"page"},{"_id":"55e72d7a2d0d3021000db035","ref":"","in":"query","required":false,"desc":"Returns results if the point (lon, lat) is within the bounding box of an image, must be of form `contains=40.23,70.76`","default":"","type":"string","name":"contains"},{"_id":"55e72d7a2d0d3021000db034","ref":"","in":"query","required":false,"desc":"Must be valid GeoJSON, returns results that touch any point of the feature","default":"","type":"string","name":"intersects"},{"_id":"55e8988d34516037002e93b8","ref":"","in":"query","required":false,"desc":"Performs exact search on `sceneID` field","default":"","type":"string","name":"scene_id"},{"_id":"55e8988d34516037002e93b7","ref":"","in":"query","required":false,"desc":"Performs exact search on `row` field","default":"","type":"int","name":"row"},{"_id":"55e8988d34516037002e93b6","ref":"","in":"query","required":false,"desc":"Performs exact search on `path` field","default":"","type":"int","name":"path"},{"_id":"55e8988d34516037002e93b5","ref":"","in":"query","required":false,"desc":"Performs exact search on `sensor` field","default":"","type":"string","name":"sensor"},{"_id":"55e8988d34516037002e93b4","ref":"","in":"query","required":false,"desc":"Performs exact search on `dayOrNight` field","default":"","type":"string","name":"day"},{"_id":"55e8988d34516037002e93af","ref":"","in":"query","required":false,"desc":"The lower limit for `cloudCoverFull` field","default":"","type":"int","name":"cloud_from"},{"_id":"55e8988d34516037002e93ae","ref":"","in":"query","required":false,"desc":"The upper limit for `cloudCoverFull` field","default":"","type":"int","name":"cloud_to"},{"_id":"55e8988d34516037002e93ad","ref":"","in":"query","required":false,"desc":"The lower limit for `sunAzimuth` field","default":"","type":"int","name":"sun_azimuth_from"},{"_id":"55e8988d34516037002e93ac","ref":"","in":"query","required":false,"desc":"The upper limit for `sunAzimuth` field","default":"","type":"int","name":"sun_azimuth_to"},{"_id":"55e8988d34516037002e93ab","ref":"","in":"query","required":false,"desc":"The lower limit for `sunElevation` field","default":"","type":"int","name":"sun_elevation_from"},{"_id":"55e8988d34516037002e93aa","ref":"","in":"query","required":false,"desc":"The upper limit for `sunElevation`","default":"","type":"int","name":"sun_elevation_to"},{"_id":"57884426e91bba190095897b","ref":"","in":"query","required":false,"desc":"How many % aoi is overlapped with a scene","default":"20","type":"int","name":"aoi_coverage_percentage"}],"url":"/search/"},"isReference":false,"order":0,"body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Search Syntax\",\n  \"body\": \"https://search.astrodigital.com/landsat\"\n}\n[/block]\nThe search endpoint exposes a powerful API that can be used to find imagery supported on the platform.\n\nUsing a variety of search parameters, you can create very complex search queries. \n\nFields more frequently used for searching are: `scene_id`, `cloud_from`, `cloud_to`, `dayOrNight`, `row`, `path`, `acquisition_date_from` and `acquisition_date_to`.\n\nTo learn more about the search syntax and help you create powerful searches, you can experiment with the [Query Builder Tool](https://astrodigital.com/querybuilder).\n\nHere are a few examples:\n\n- Search for a specific scene:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl https://api.astrodigital.com/v2.0/search/?scene_id=LC80110442014358LGN00\",\n      \"language\": \"curl\"\n    }\n  ]\n}\n[/block]\n\n- Search for a cloud range of 0 to 20 percent:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl https://api.astrodigital.com/v2.0/search/?cloud_from=0&cloud_to=20\",\n      \"language\": \"curl\"\n    }\n  ]\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Cloud coverage calculation\",\n  \"body\": \"For every result the system calculates cloud coverage per Area Of Interest (AOI) specified using this formula:\\n\\ncloud_coverage= number of pixels in AOI containing clouds / total number of pixels in AOI\\n\\nCalculated cloud_coverage is compared with with cloud_from and cloud_to search parameters.\\nSee more about using cloudy images [here](doc:understanding-cloud-coverag)\"\n}\n[/block]\n- Search for a row and path:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl https://api.astrodigital.com/v2.0/search/?row=011&path=013\",\n      \"language\": \"curl\"\n    }\n  ]\n}\n[/block]\n- Search for specific row and path with a particular cloud range:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl https://api.astrodigital.com/v2.0/search/?row=011&path=013&cloud_from=0&cloud_to=20\",\n      \"language\": \"curl\"\n    }\n  ]\n}\n[/block]\n- Search for point with latitude 38.90 and longitude -77.03\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl https://api.astrodigital.com/v2.0/search/?contains=38.90,-77.03\",\n      \"language\": \"curl\"\n    }\n  ]\n}\n[/block]\n- Search for polygon in GeoJSON format\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl https://api.astrodigital.com/v2.0/search/?cloud_to=0&intersects={\\\"type\\\":\\\"Feature\\\",\\\"geometry\\\":{\\\"type\\\":\\\"Polygon\\\",\\\"coordinates\\\": [[[2.875671,49.123882],[2.880477,49.123208],[2.878589,49.119388],[2.874469,49.119837],[2.875671,49.123882]]]},\\\"properties\\\":{}}\",\n      \"language\": \"curl\"\n    }\n  ]\n}\n[/block]","excerpt":"Search the archive of satellite imagery","slug":"search","type":"endpoint","title":"search"}

getsearch

Search the archive of satellite imagery

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

limit:
integer1
Limit of results to return
skip:
integer0
Results to skip in return
summary:
booleanfalse
Return a condensed view of the data
page:
integer1
Results page to view
contains:
string
Returns results if the point (lon, lat) is within the bounding box of an image, must be of form `contains=40.23,70.76`
intersects:
string
Must be valid GeoJSON, returns results that touch any point of the feature
scene_id:
string
Performs exact search on `sceneID` field
row:
integer
Performs exact search on `row` field
path:
integer
Performs exact search on `path` field
sensor:
string
Performs exact search on `sensor` field
day:
string
Performs exact search on `dayOrNight` field
cloud_from:
integer
The lower limit for `cloudCoverFull` field
cloud_to:
integer
The upper limit for `cloudCoverFull` field
sun_azimuth_from:
integer
The lower limit for `sunAzimuth` field
sun_azimuth_to:
integer
The upper limit for `sunAzimuth` field
sun_elevation_from:
integer
The lower limit for `sunElevation` field
sun_elevation_to:
integer
The upper limit for `sunElevation`
aoi_coverage_percentage:
integer20
How many % aoi is overlapped with a scene

Result Format


Documentation

[block:api-header] { "type": "basic", "title": "Search Syntax", "body": "https://search.astrodigital.com/landsat" } [/block] The search endpoint exposes a powerful API that can be used to find imagery supported on the platform. Using a variety of search parameters, you can create very complex search queries. Fields more frequently used for searching are: `scene_id`, `cloud_from`, `cloud_to`, `dayOrNight`, `row`, `path`, `acquisition_date_from` and `acquisition_date_to`. To learn more about the search syntax and help you create powerful searches, you can experiment with the [Query Builder Tool](https://astrodigital.com/querybuilder). Here are a few examples: - Search for a specific scene: [block:code] { "codes": [ { "code": "curl https://api.astrodigital.com/v2.0/search/?scene_id=LC80110442014358LGN00", "language": "curl" } ] } [/block] - Search for a cloud range of 0 to 20 percent: [block:code] { "codes": [ { "code": "curl https://api.astrodigital.com/v2.0/search/?cloud_from=0&cloud_to=20", "language": "curl" } ] } [/block] [block:callout] { "type": "info", "title": "Cloud coverage calculation", "body": "For every result the system calculates cloud coverage per Area Of Interest (AOI) specified using this formula:\n\ncloud_coverage= number of pixels in AOI containing clouds / total number of pixels in AOI\n\nCalculated cloud_coverage is compared with with cloud_from and cloud_to search parameters.\nSee more about using cloudy images [here](doc:understanding-cloud-coverag)" } [/block] - Search for a row and path: [block:code] { "codes": [ { "code": "curl https://api.astrodigital.com/v2.0/search/?row=011&path=013", "language": "curl" } ] } [/block] - Search for specific row and path with a particular cloud range: [block:code] { "codes": [ { "code": "curl https://api.astrodigital.com/v2.0/search/?row=011&path=013&cloud_from=0&cloud_to=20", "language": "curl" } ] } [/block] - Search for point with latitude 38.90 and longitude -77.03 [block:code] { "codes": [ { "code": "curl https://api.astrodigital.com/v2.0/search/?contains=38.90,-77.03", "language": "curl" } ] } [/block] - Search for polygon in GeoJSON format [block:code] { "codes": [ { "code": "curl https://api.astrodigital.com/v2.0/search/?cloud_to=0&intersects={\"type\":\"Feature\",\"geometry\":{\"type\":\"Polygon\",\"coordinates\": [[[2.875671,49.123882],[2.880477,49.123208],[2.878589,49.119388],[2.874469,49.119837],[2.875671,49.123882]]]},\"properties\":{}}", "language": "curl" } ] } [/block]

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}