Quick & Saved Search

The Data API supports two main types of search: Quick Search and Saved Search

  • Quick Search is recommended for one-off, ad-hoc searches of the Planet catalog.
  • Saved Search is recommended for searches you use frequently. Saved searches are persisted for the duration of your access period and can be easily retrieved and executed for repeat use. You can also enable Saved Search email notifications to receive daily updates with newly published imagery which meets your search criteria.

Quick Search

Quick search is the easiest way to search the Planet catalog for ad-hoc, everyday use. Quick searches will remain available via the API for repeat use for 30 days.

Query Parameters

Quick search supports several query parameters to format your results.

  • _page_size: limits the number of results to returned per page. It may only be used at the start of pagination.
  • _sort: allows you to sort search results by ascending or descending acquired time or published time. Supported values are acquired asc, acquired desc, published asc, and published desc. When unspecified, published desc is the default value.

Example Query Parameters

https://api.planet.com/data/v1/quick-search?_sort=acquired asc&_page_size=50

Request Body

The body of a quick-search must include item type(s) and a filter.

Example Request Body

{
    "item_types": [
        "PSOrthoTile"
    ],
    "filter": {  
       "type":"AndFilter",
       "config":[  
           {  
            "type":"DateRangeFilter",
            "field_name":"acquired",
             "config":{  
                "gte":"2020-01-01T00:00:00Z",
                "lte":"2020-01-31T00:00:00Z"
             }
          },
          {
             "type": "AssetFilter",
             "config": [
                "analytic_sr"
             ]
          }
       ]
    }
}

Response Schema

A Quick Search response includes metadata and links for items matching your search criteria. The number of results included is based on the page size and additional links are provided to enable pagination.

Page links reference different pages of the returned search results.

  • _self: references the current page of search results
  • _first: references the first page of the search results
  • _next: references the next page of the search results

Features include additional detail on each item returned in the search results.

  • _links:
    • _self: is an endpoint for this specific item result
    • assets: references a set of asset activation links for each published asset of the item
    • thumbnail: is a Tile Service API endpoint, which hosts a thumbnail of the item
  • _permissions: lists all of your asset download permissions which apply to this particular item
  • geometry: is the footprint geometry for this particular item
  • id: is the item id for this particular item
  • properties: lists all metadata fields and values for a particular item; properties may vary by item type

Example Response

{
    "_links": {
        "_first": "https://api.planet.com/data/v1/searches/164c17e9ebd147daba4858224ef741ff/results?_page=eyJwYWdlX3NpemUiOiAyNTAsICJzb3J0X2J5IjogInB1Ymxpc2hlZCIsICJzb3J0X2Rlc2MiOiB0cnVlLCAic29ydF9zdGFydCI6IG51bGwsICJzb3J0X2xhc3RfaWQiOiBudWxsLCAic29ydF9wcmV2IjogZmFsc2UsICJxdWVyeV9wYXJhbXMiOiB7fX0%3D",
        "_next": "https://api.planet.com/data/v1/searches/164c17e9ebd147daba4858224ef741ff/results?_page=eyJwYWdlX3NpemUiOiAyNTAsICJzb3J0X2J5IjogInB1Ymxpc2hlZCIsICJzb3J0X2Rlc2MiOiB0cnVlLCAic29ydF9zdGFydCI6ICIyMDIwLTAyLTI3VDA2OjUwOjUwLjAwMDAwMFoiLCAic29ydF9sYXN0X2lkIjogIjMwODgzNjBfNTA1MjgxN18yMDIwLTAxLTMwXzEwMTgiLCAic29ydF9wcmV2IjogZmFsc2UsICJxdWVyeV9wYXJhbXMiOiB7fX0%3D",
        "_self": "https://api.planet.com/data/v1/searches/164c17e9ebd147daba4858224ef741ff/results?_page=eyJwYWdlX3NpemUiOiAyNTAsICJzb3J0X2J5IjogInB1Ymxpc2hlZCIsICJzb3J0X2Rlc2MiOiB0cnVlLCAic29ydF9zdGFydCI6IG51bGwsICJzb3J0X2xhc3RfaWQiOiBudWxsLCAic29ydF9wcmV2IjogZmFsc2UsICJxdWVyeV9wYXJhbXMiOiB7fX0%3D"
    },
    "features": [
        {
            "_links": {
                "_self": "https://api.planet.com/data/v1/item-types/PSOrthoTile/items/3179348_3932207_2020-01-28_1018",
                "assets": "https://api.planet.com/data/v1/item-types/PSOrthoTile/items/3179348_3932207_2020-01-28_1018/assets/",
                "thumbnail": "https://tiles.planet.com/data/v1/item-types/PSOrthoTile/items/3179348_3932207_2020-01-28_1018/thumb"
            },
            "_permissions": [
                "assets.analytic:download",
                "assets.analytic_dn:download",
                "assets.analytic_sr:download",
                "assets.analytic_xml:download",
                "assets.analytic_dn_xml:download",
                "assets.udm:download",
                "assets.udm2:download",
                "assets.visual:download",
                "assets.visual_xml:download"
            ],
            "geometry": {
                "coordinates": [
                    [
                        [
                            49.40728709742158,
                            -14.828963105116351
                        ],
                        [
                            49.21142146634527,
                            -14.791083064438928
                        ],
                        [
                            49.2117218737549,
                            -14.750623363752473
                        ],
                        [
                            49.42316577478755,
                            -14.7520758935714
                        ],
                        [
                            49.40728709742158,
                            -14.828963105116351
                        ]
                    ]
                ],
                "type": "Polygon"
            },
            "id": "3179348_3932207_2020-01-28_1018",
            "properties": {
                "acquired": "2020-01-28T06:39:19.320539Z",
                "anomalous_pixels": 0.21,
                "black_fill": 0.77,
                "clear_confidence_percent": 76,
                "clear_percent": 50,
                "cloud_cover": 0.214,
                "cloud_percent": 45,
                "columns": 8000,
                "epsg_code": 32739,
                "grid_cell": "3932207",
                "ground_control": true,
                "gsd": 3.9,
                "heavy_haze_percent": 0,
                "instrument": "PS2",
                "item_type": "PSOrthoTile",
                "light_haze_percent": 0,
                "origin_x": 307500,
                "origin_y": 8368500,
                "pixel_resolution": 3.125,
                "provider": "planetscope",
                "published": "2020-02-27T15:37:10Z",
                "quality_category": "standard",
                "rows": 8000,
                "satellite_id": "1018",
                "shadow_percent": 4,
                "snow_ice_percent": 0,
                "strip_id": "3179348",
                "sun_azimuth": 101,
                "sun_elevation": 57.3,
                "updated": "2020-02-27T15:37:10Z",
                "usable_data": 0.01,
                "view_angle": 1,
                "visible_confidence_percent": 66,
                "visible_percent": 54
            },
            "type": "Feature"
        }
    ]
}

Saved Search

Saved Search is a helpful option for managing searches that you use frequently. Saved Searches can be easily retrieved and executed for repeated use and optionally support daily email notifications for newly published imagery which meets your search criteria.

Request Body

In addition to item types and filters required in a quick-search, the body of a saved search requires a name. There is also an option to enable daily email notifications for new imagery updates.

  • name: name of the Saved Search
  • __daily_email_enabled: if set to true, an email will be delivered daily between 00:00:00 and 00:02:00 UTC with an Explorer link to all imagery that meets your search criteria published within the last 24 hours. By default, this value will be set to false.

Example Request Body

{
    "name": "Saved Search Example",
    "__daily_email_enabled": true,
    "item_types": [
        "PSOrthoTile"
    ],
    "filter": {  
       "type":"AndFilter",
       "config":[  
           {  
            "type":"DateRangeFilter",
            "field_name":"acquired",
             "config":{  
                "gte":"2020-01-01T00:00:00Z",
                "lte":"2020-01-31T00:00:00Z"
             }
          },
          {
             "type": "AssetFilter",
             "config": [
                "analytic_sr"
             ]
          }
       ]
    }
}

Response Schema

The Saved Search response includes all details of the saved search:

  • __daily_email_enabled: true if emails are enabled, and false if not enabled
  • _self: is an endpoint for the specific search
  • _results: is an endpoint to execute the saved search and see results
  • created: is the timestamp when the saved search was created
  • filter: lists the structured search criteria
  • id: is the saved search identifier
  • last_executed: is the timestamp when the saved search was last executed
  • name: is the name of the saved search
  • updated: is the timestamp when the saved search was last updated

Example Response

{
    "__daily_email_enabled": true,
    "_links": {
        "_self": "https://api.planet.com/data/v1/searches/3b5cc5df661b4ff89ca70dfdeede238f",
        "results": "https://api.planet.com/data/v1/searches/3b5cc5df661b4ff89ca70dfdeede238f/results"
    },
    "created": "2020-03-03T20:40:36.825325Z",
    "filter": {
        "config": [
            {
                "config": {
                    "gte": "2020-01-01T00:00:00Z",
                    "lte": "2020-01-31T00:00:00Z"
                },
                "field_name": "acquired",
                "type": "DateRangeFilter"
            },
            {
                "config": [
                    "analytic_sr"
                ],
                "type": "AssetFilter"
            }
        ],
        "type": "AndFilter"
    },
    "id": "3b5cc5df661b4ff89ca70dfdeede238f",
    "item_types": [
        "PSOrthoTile"
    ],
    "last_executed": null,
    "name": "Saved Search Example",
    "search_type": "saved",
    "updated": "2020-03-03T20:40:36.825325Z"
}

To get the results of a saved search, you can call the endpoint below, with the saved search id:

https://api.planet.com/data/v1/searches/{search_id}/results

This endpoint accepts the same query parameters (_page_size, sort) and returns the same response schema as the quick-search endpoint.

List Searches

To get a list of historical searches, you can call the endpoint below:

https://api.planet.com/data/v1/searches

This endpoint supports the _page and _page_size query parameters, in addition to:

  • _sort: allows you to sort searches by ascending or descending created time. Supported values are created asc and created desc. When unspecified, created desc is the default value. This parameter may not be used with the _page parameter.
  • search_type: allows you to filter searches by search type. Supported values are any, quick, and saved. When unspecified, any is the default value, returning all searches.

Example Query Parameters

https://api.planet.com/data/v1/searches?_page_size=50&_sort=created asc&search_type=saved

Other Supported Search Operations

See our API Reference documentation for more detail and examples of other operations you can run for Saved Searches.