API docs by Redocly

Planet Mosaics API (1.0)

Download OpenAPI specification:Download

An API to interact with Mosaics generated on Planet's platform.

Basemaps and Mosaics

List Mosaics

List all accessible mosaics.

query Parameters
_page
integer

Integer representing a specific page of results.

_page_size
integer

Number of results to return per page.

name__is
string

If provided, returns up to one result that exactly matches the provided value.

name__contains
string

If provided, returns only results that contain the fragment, case-insensitive.

Responses

Response Schema: application/json
object (MosaicListLinks)
Array of objects (Mosaic)

Response samples

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

Get Mosaic

Get a mosaic by id.

path Parameters
mosaic_id
required
string

Mosaic identifier.

Responses

Response Schema: application/json
object (MosaicLinks)
bands
integer

The number of bands in this mosaic.

bbox
required
Array of numbers <float64> [ items <float64 > ]

The bounding box representing the extent of the mosaic.

coordinate_system
required
string

The coordinate system of this mosaic.

datatype
string

The type of data (byte, uint16, float32, etc).

first_acquired
required
string <date-time>

The acquisition date of the oldest scene that contributed to this mosaic.

object (GridContext)

The grid context.

id
string <uuid>

Mosaic identifier.

interval
string

The interval of the mosaic.

item_types
Array of strings

The item types in this mosaic.

last_acquired
required
string <date-time>

The acquisition date of the newest scene that contributed to this mosaic.

level
integer

The maximum zoom level in XYZ scheme.

name
required
string

A unique name for this mosaic.

product_type
required
string

The product type of this mosaics, currently supported is "timelapse", "basemap".

quad_download
boolean

Your quad download permission for this mosaic.

Response samples

Content type
application/json
{
  • "_links": {
    },
  • "bands": 0,
  • "bbox": [
    ],
  • "coordinate_system": "string",
  • "datatype": "string",
  • "first_acquired": "2019-08-24T14:15:22Z",
  • "grid": {
    },
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "interval": "string",
  • "item_types": [
    ],
  • "last_acquired": "2019-08-24T14:15:22Z",
  • "level": 0,
  • "name": "string",
  • "product_type": "string",
  • "quad_download": true
}

Get Mosaic Grid

Get extended mosaic metadata by id.

path Parameters
mosaic_id
required
string

Mosaic identifier.

Responses

Response Schema: application/json
quad_size
integer

The size of the square quad in pixels.

resolution
number

The resolution of the maximum zoom level in meters.

Response samples

Content type
application/json
{
  • "quad_size": 0,
  • "resolution": 0
}

Create a Mosaic Quad search

List of quad download links for a mosaic.

path Parameters
mosaic_id
required
string

Mosaic identifier.

query Parameters
minimal
boolean

If true, only return quad download links.

_page_size
integer

Number of results to return per page.

Request Body schema: application/json

Search request

object (Search)

Search is a valid GeoJSON Polygon or MultiPolygon with 1500 or fewer vertices.

Responses

Request samples

Content type
application/json
{
  • "coordinates": [
    ],
  • "type": "Polygon"
}

Response samples

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

Get Mosaic Quad

Get mosaic quad by id.

path Parameters
mosaic_id
required
string

Mosaic identifier.

quad_id
required
string

Quad identifier.

Responses

Response Schema: application/json
required
object
bbox
required
Array of numbers <float64> [ items <float64 > ]

The bounding box representing the extent of the quad.

id
required
string

Quad identifier.

percent_covered
required
number <float>

The percentage of the GeoTIFF pixels that are not no-data values.

Response samples

Content type
application/json
{
  • "_links": {
    },
  • "bbox": [
    ],
  • "id": "string",
  • "percent_covered": 0
}

Get Mosaic Quad URL

Get a full quad download URL quad id.

path Parameters
mosaic_id
required
string

Mosaic identifier.

quad_id
required
string

Quad identifier.

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

List Mosaic Quad Items

List items that contributed to a quad.

path Parameters
mosaic_id
required
string

Mosaic identifier.

quad_id
required
string

Quad identifier.

Responses

Response Schema: application/json
Array of objects (QuadItem)

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Get Mosaic TileJSON

Get TileJSON for Mosaic. See https://github.com/mapbox/tilejson-spec

path Parameters
mosaic_id
required
string

Mosaic identifier.

Responses

Response Schema: application/json
object

Response samples

Content type
application/json
{ }

List Mosaic Series

List all mosaic series available to the authenticated user.

query Parameters
_page
integer

Integer representing a specific page of results.

_page_size
integer

Number of results to return per page.

name__is
string

If provided, returns up to one result that exactly matches the provided value.

name__contains
string

If provided, returns only results that contain the fragment, case-insensitive.

acquired__between
string

Acquired between comma separated dates or date-times

acquired__gt
string

Acquired greater than date or date-time

acquired__lt
string

Acquired less than date or date-time

Responses

Response Schema: application/json
object (MosaicSeriesListLinks)
Array of objects (MosaicSeries)

Response samples

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

Get Mosaic Series

Get a mosaic series by id.

path Parameters
series_id
required
string

Series identifier.

Responses

Response Schema: application/json
object (MosaicSeriesLinks)
first_acquired
string <date-time>

The acquisition date of the oldest scene that contributed to this series.

id
string <uuid>

Mosaic series identifier.

interval
required
string

The interval for the mosaics in the series.

last_acquired
string <date-time>

The acquisition date of the newest scene that contributed to this series.

name
required
string

A human readable name for this series.

product_type
required
string
Enum: "basemap" "timelapse" "l3m"

The type of product this mosaic is.

selector
string

Response samples

Content type
application/json
{
  • "_links": {
    },
  • "first_acquired": "2019-08-24T14:15:22Z",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "interval": "string",
  • "last_acquired": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "product_type": "basemap",
  • "selector": "string"
}

List Series' Mosaics

List mosaics in this series.

path Parameters
series_id
required
string

Series identifier.

query Parameters
acquired__between
string

Acquired between comma separated dates or date-times

acquired__gt
string

Acquired greater than date or date-time

acquired__lt
string

Acquired less than date or date-time

Responses

Response Schema: application/json
object (MosaicSeriesMosaicsLinks)
Array of objects (Mosaic)

Response samples

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