Skip to main content

Data API Reference

API docs by Redocly

Planet Data API (1.0.0)

Download OpenAPI specification:Download

The Planet Data API serves all Planet Labs imagery to public clients. This is the general spec that governs the common API objects and operations.

Items and Assets

List Asset Types

List all asset types available to the authenticated user.

An asset describes a product that can be derived from an item's source data, and can be used for various analytic, visual or other purposes. These are referred to as asset_types.

Learn more about asset types

Authorizations:
basic

Responses

Response samples

Content type
application/json
{
  • "_links": {
    },
  • "asset_types": [
    ]
}

Get Asset Type

Get an asset type by id. An asset describes a product that can be derived from an item's source data, and can be used for various analytic, visual or other purposes. These are referred to as asset_types.

Learn more about asset types

Authorizations:
basic
path Parameters
asset_type_id
required
string

Asset type identifier.

Responses

Response samples

Content type
application/json
{
  • "_links": {
    },
  • "display_description": "string",
  • "display_name": "string",
  • "id": "string",
  • "md5_digest": "string"
}

List Item Types

List all item types available to the authenticated user.

An item_type represents the class of spacecraft and/or processing level of an item. All items have an associated item_type. Each item_type has a set of supported asset_types which may be produced for a given item.

Learn more about item types

Authorizations:
basic

Responses

Response samples

Content type
application/json
{
  • "_links": {
    },
  • "item_types": [
    ]
}

Get Item Type

Get an item type by id.

An item_type represents the class of spacecraft and/or processing level of an item. All items have an associated item_type. Each item_type has a set of supported asset_types which may be produced for a given item.

Learn more about item types

Authorizations:
basic
path Parameters
item_type_id
required
string

Item type identifier.

Responses

Response samples

Content type
application/json
{
  • "_links": {
    },
  • "display_description": "string",
  • "display_name": "string",
  • "id": "string",
  • "supported_asset_types": [
    ]
}

Get Item

Get an item by id and item type.

In the Planet API, an item is an entry in our catalog, and generally represents a single logical observation (or scene) captured by a satellite. Each item is defined by an item_type, which represents the class of spacecraft and/or processing level of the item. Assets (or products, such as visual or analytic) can be derived from the item's source data.

Learn more about items

Authorizations:
basic
path Parameters
item_type_id
required
string

Item type identifier.

item_id
required
string

Item identifier.

Responses

Response samples

Content type
application/json
{
  • "_links": {
    },
  • "_permissions": null,
  • "assets": null,
  • "geometry": {
    },
  • "id": "string",
  • "properties": {
    }
}

List Item Assets

List all assets available for an item. An asset describes a product that can be derived from an item's source data, and can be used for various analytic, visual or other purposes. These are referred to as asset_types.

Learn more about asset types

Authorizations:
basic
path Parameters
item_type_id
required
string

Item type identifier.

item_id
required
string

Item identifier.

Responses

Response samples

Content type
application/json
{
  • "_links": {
    },
  • "_permissions": [
    ],
  • "expires_at": "2019-08-24T14:15:22Z",
  • "location": "string",
  • "status": "inactive",
  • "type": "string"
}

cloud coverage estimate

gets coverage estimate

Authorizations:
basic
path Parameters
item_type_id
required
string

Item type identifier.

item_id
required
string

Item identifier.

query Parameters
mode
string
Enum: "UDM2" "estimate"

The mode to calculate coverage. - UDM2 -> Activate the ortho_udm2 asset and compute clear coverage over the provided AOI. Activation may take several minutes. This option supports polling. (default) - estimate -> Will not activate the asset. Provides a rough estimate based on browse imagery. Will return results more quickly.

band
string
Enum: "clear" "snow_ice" "cloud_shadow" "light_haze" "heavy_haze" "cloud" "cirrus"

The UDM2 band used to calculate coverage.

Request Body schema: application/json
required

The area of the cloud coverage request.

Responses

Request samples

Content type
application/json
No sample

Response samples

Content type
application/json
{
  • "clear_percent": 0,
  • "status": "string"
}

Quick Search

Executes a structured item search.

The search APIs allow for both simple and complex item searches. Complex searches support boolean conditions, multiple values, geometries using GeoJSON and others. You can also save, retrieve and execute searches that you use frequently for easy use later.

Learn more about searching

Authorizations:
basic
query Parameters
_page_size
integer <int64> [ 0 .. 250 ]
Default: 250

Number of results to return per page. This may only be used at the start of pagination. This may not be provided with the "_page" parameter.

_sort
string
Default: "published desc"
Enum: "acquired asc" "acquired desc" "published asc" "published desc"

Field and direction to order results by. This may not be provided with the "_page" parameter.

Request Body schema: application/json
required

The structured search criteria.

asset_types
Array of strings

The asset types to include in the search.

object (Filter)

Structured search criteria.

object (GeoJSONGeometry)

A GeoJSON geometry.

item_types
required
Array of strings

The item types to include in the search.

name
string^.{1,64}$

The name of the saved search.

Responses

Request samples

Content type
application/json
{
  • "asset_types": [
    ],
  • "filter": {
    },
  • "geometry": {
    },
  • "item_types": [
    ],
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "_links": {
    },
  • "features": [
    ]
}

List Saved Searches

List all saved searches available to the authenticated user.

Authorizations:
basic
query Parameters
_page
string

Token representing a specific page of results. This should never be constructed manually.

_page_size
integer <int64> [ 0 .. 250 ]
Default: 250

Number of results to return per page. This may only be used at the start of pagination. This may not be provided with the "_page" parameter.

_sort
string
Default: "created desc"
Enum: "created desc" "created asc"

Field and direction to order results by. This may not be provided with the "_page" parameter.

search_type
string
Default: "any"
Enum: "any" "saved" "quick"

Search type filter.

Responses

Response samples

Content type
application/json
{
  • "_links": {
    },
  • "searches": [
    ]
}

Create Saved Search

Create a new saved search.

Authorizations:
basic
Request Body schema: application/json
required

The structured search criteria.

__daily_email_enabled
boolean

Send a daily email when new results are added.

asset_types
Array of strings

The asset types to include in the search.

required
object (Filter)

Structured search criteria.

item_types
required
Array of strings

The item types to include in the search.

name
required
string^.{1,64}$

The name of this saved search.

Responses

Request samples

Content type
application/json
{
  • "__daily_email_enabled": true,
  • "asset_types": [
    ],
  • "filter": {
    },
  • "item_types": [
    ],
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "__daily_email_enabled": false,
  • "_links": {
    },
  • "created": "2019-08-24T14:15:22Z",
  • "filter": {
    },
  • "id": "string",
  • "last_executed": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "updated": "2019-08-24T14:15:22Z"
}

Delete Saved Search

Delete an existing saved search.

Authorizations:
basic
path Parameters
search_id
required
string

Saved search identifier.

Responses

Response samples

Content type
application/json
{
  • "field": {
    },
  • "general": [
    ]
}

Get Saved Search

Get a saved search by id.

Authorizations:
basic
path Parameters
search_id
required
string

Saved search identifier.

Responses

Response samples

Content type
application/json
{
  • "__daily_email_enabled": false,
  • "_links": {
    },
  • "created": "2019-08-24T14:15:22Z",
  • "filter": {
    },
  • "id": "string",
  • "last_executed": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "updated": "2019-08-24T14:15:22Z"
}

Update Saved Search

Update an existing saved search.

Authorizations:
basic
path Parameters
search_id
required
string

Saved search identifier.

Request Body schema: application/json
required

The structured search criteria.

__daily_email_enabled
boolean

Send a daily email when new results are added.

asset_types
Array of strings

The asset types to include in the search.

required
object (Filter)

Structured search criteria.

item_types
required
Array of strings

The item types to include in the search.

name
required
string^.{1,64}$

The name of this saved search.

Responses

Request samples

Content type
application/json
{
  • "__daily_email_enabled": true,
  • "asset_types": [
    ],
  • "filter": {
    },
  • "item_types": [
    ],
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "__daily_email_enabled": false,
  • "_links": {
    },
  • "created": "2019-08-24T14:15:22Z",
  • "filter": {
    },
  • "id": "string",
  • "last_executed": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "updated": "2019-08-24T14:15:22Z"
}

Run Saved Search

Executes a saved search.

Authorizations:
basic
path Parameters
search_id
required
string

Saved search identifier.

query Parameters
_page
string

Token representing a specific page of results. This should never be constructed manually.

_page_size
integer <int64> [ 0 .. 250 ]
Default: 250

Number of results to return per page. This may only be used at the start of pagination. This may not be provided with the "_page" parameter.

_sort
string
Default: "published desc"
Enum: "acquired asc" "acquired desc" "published asc" "published desc"

Field and direction to order results by. This may not be provided with the "_page" parameter.

Responses

Response samples

Content type
application/json
{
  • "_links": {
    },
  • "features": [
    ]
}

Item Stats

Search Stats

Returns a date bucketed histogram of items matching a filter

Authorizations:
basic
Request Body schema: application/json
required

The structured search criteria.

asset_types
Array of strings

The asset types to include in the stats.

required
object (Filter)

Structured search criteria.

interval
required
string
Enum: "hour" "day" "week" "month" "year"

The size of the histogram date buckets.

item_types
required
Array of strings

The item types to include in the stats.

utc_offset
string

A "ISO 8601 UTC offset" (e.g. +01:00 or -08:00) that can be used to adjust the buckets to a users time zone. It is optional.

Responses

Request samples

Content type
application/json
{
  • "asset_types": [
    ],
  • "filter": {
    },
  • "interval": "hour",
  • "item_types": [
    ],
  • "utc_offset": "string"
}

Response samples

Content type
application/json
{
  • "buckets": [
    ],
  • "interval": "hour",
  • "utc_offset": "string"
}
Last updated on