Basemaps API Reference

• Basemaps and Mosaics
  • getList Mosaics
  • getGet Mosaic
  • getGet Mosaic Grid
  • getList Mosaic Quads
  • postCreate a Mosaic Quad search
  • getQuad Search Results
  • getGet Mosaic Quad
  • getGet Mosaic Quad URL
  • getList Mosaic Quad Items
  • getGet Mosaic TileJSON
  • getList Mosaic Series
  • getGet Mosaic Series
  • getList Series' Mosaics

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

https://api.planet.com/basemaps/v1/mosaics

Response samples

• 200
• 401
• default

Content type

application/json

{

• "_links": {

  • "_next": "string",
  • "_self": "string"

  },
• "mosaics": [

  • {

    • "_links": {

      • "_self": "string",
      • "quads": "string",
      • "tiles": "string"

      },
    • "bands": 0,
    • "bbox": [

      • 0

      ],
    • "coordinate_system": "string",
    • "datatype": "string",
    • "first_acquired": "2019-08-24T14:15:22Z",
    • "grid": {

      • "quad_size": 0,
      • "resolution": 0

      },
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "interval": "string",
    • "item_types": [

      • "string"

      ],
    • "last_acquired": "2019-08-24T14:15:22Z",
    • "level": 0,
    • "name": "string",
    • "product_type": "string",
    • "quad_download": true

    }

  ]

}

Get Mosaic

Get a mosaic by id.

path Parameters

mosaic_id required

string Mosaic identifier.

Responses

https://api.planet.com/basemaps/v1/mosaics/{mosaic_id}

Response samples

• 200
• 401
• 404
• default

Content type

application/json

{

• "_links": {

  • "_self": "string",
  • "quads": "string",
  • "tiles": "string"

  },
• "bands": 0,
• "bbox": [

  • 0

  ],
• "coordinate_system": "string",
• "datatype": "string",
• "first_acquired": "2019-08-24T14:15:22Z",
• "grid": {

  • "quad_size": 0,
  • "resolution": 0

  },
• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "interval": "string",
• "item_types": [

  • "string"

  ],
• "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

https://api.planet.com/basemaps/v1/mosaics/{mosaic_id}/grid

Response samples

• 200
• 401
• 404
• default

Content type

application/json

{

• "quad_size": 0,
• "resolution": 0

}

List Mosaic Quads

List of quad download links for a mosaic.

path Parameters

mosaic_id required

string Mosaic identifier.

query Parameters

bbox required	string Comma separated bounding box in degrees as lx,ly,ux,uy.
minimal	boolean If true, only return quad download links.
_page	string Integer representing a specific page of results.
_page_size	integer Number of results to return per page.

Responses

https://api.planet.com/basemaps/v1/mosaics/{mosaic_id}/quads

Response samples

• 200
• 401
• 404
• default

Content type

application/json

{

• "_links": {

  • "_next": "string",
  • "_self": "string"

  },
• "items": [

  • {

    • "_links": {

      • "_self": "string",
      • "download": "string",
      • "items": "string",
      • "thumbnail": "string"

      },
    • "bbox": [

      • 0

      ],
    • "id": "string",
    • "percent_covered": 0.1

    }

  ]

}

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

required

Search request

object (Search)

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

Responses

https://api.planet.com/basemaps/v1/mosaics/{mosaic_id}/quads/search

Request samples

• Payload

Content type

application/json

{

• "coordinates": {

  • "0": {

    • "0": {

      • "0": -122.430755,
      • "1": 37.830635

      },
    • "1": {

      • "0": -122.430755,
      • "1": 37.822746

      },
    • "2": {

      • "0": -122.415158,
      • "1": 37.822746

      },
    • "3": {

      • "0": -122.415158,
      • "1": 37.830635

      },
    • "4": {

      • "0": -122.430755,
      • "1": 37.830635

      }

    }

  },
• "type": "Polygon"

}

Response samples

• 400
• 401
• 404
• default

Content type

application/json

{

• "field": {

  • "property1": [

    • {

      • "message": "string"

      }

    ],
  • "property2": [

    • {

      • "message": "string"

      }

    ]

  },
• "general": [

  • {

    • "message": "string"

    }

  ]

}

Quad Search Results

List of quad download links for a mosaic.

path Parameters

mosaic_id required	string Mosaic identifier.
search_id required	string search id.

query Parameters

minimal	boolean If true, return only download link.
_page	string Integer representing a specific page of results.
_page_size	integer Number of results to return per page.

Responses

https://api.planet.com/basemaps/v1/mosaics/{mosaic_id}/quads/search/{search_id}

Response samples

• 200
• 401
• 404
• default

Content type

application/json

{

• "_links": {

  • "_next": "string",
  • "_self": "string"

  },
• "items": [

  • {

    • "_links": {

      • "_self": "string",
      • "download": "string",
      • "items": "string",
      • "thumbnail": "string"

      },
    • "bbox": [

      • 0

      ],
    • "id": "string",
    • "percent_covered": 0.1

    }

  ]

}

Get Mosaic Quad

Get mosaic quad by id.

path Parameters

mosaic_id required	string Mosaic identifier.
quad_id required	string Quad identifier.

Responses

https://api.planet.com/basemaps/v1/mosaics/{mosaic_id}/quads/{quad_id}

Response samples

• 200
• 401
• 404
• default

Content type

application/json

{

• "_links": {

  • "_self": "string",
  • "download": "string",
  • "items": "string",
  • "thumbnail": "string"

  },
• "bbox": [

  • 0

  ],
• "id": "string",
• "percent_covered": 0.1

}

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

https://api.planet.com/basemaps/v1/mosaics/{mosaic_id}/quads/{quad_id}/full

Response samples

• 401
• 404
• default

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

https://api.planet.com/basemaps/v1/mosaics/{mosaic_id}/quads/{quad_id}/items

Response samples

• 200
• 401
• 404
• default

Content type

application/json

{

• "items": [

  • {

    • "item_id": "string",
    • "item_type": "string",
    • "link": "string"

    }

  ]

}

Get Mosaic TileJSON

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

path Parameters

mosaic_id required

string Mosaic identifier.

Responses

https://api.planet.com/basemaps/v1/mosaics/{mosaic_id}/tiles

Response samples

• 200
• 401
• 404
• default

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

https://api.planet.com/basemaps/v1/series

Response samples

• 200
• 401
• 404
• default

Content type

application/json

{

• "_links": {

  • "_next": "string",
  • "_self": "string"

  },
• "series": [

  • {

    • "_links": {

      • "_self": "string",
      • "mosaics": "string"

      },
    • "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"

    }

  ]

}

Get Mosaic Series

Get a mosaic series by id.

path Parameters

series_id required

string Series identifier.

Responses

https://api.planet.com/basemaps/v1/series/{series_id}

Response samples

• 200
• 401
• 404
• default

Content type

application/json

{

• "_links": {

  • "_self": "string",
  • "mosaics": "string"

  },
• "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

https://api.planet.com/basemaps/v1/series/{series_id}/mosaics

Response samples

• 200
• 401
• 404
• default

Content type

application/json

{

• "_links": {

  • "_self": "string"

  },
• "mosaics": [

  • {

    • "_links": {

      • "_self": "string",
      • "quads": "string",
      • "tiles": "string"

      },
    • "bands": 0,
    • "bbox": [

      • 0

      ],
    • "coordinate_system": "string",
    • "datatype": "string",
    • "first_acquired": "2019-08-24T14:15:22Z",
    • "grid": {

      • "quad_size": 0,
      • "resolution": 0

      },
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "interval": "string",
    • "item_types": [

      • "string"

      ],
    • "last_acquired": "2019-08-24T14:15:22Z",
    • "level": 0,
    • "name": "string",
    • "product_type": "string",
    • "quad_download": true

    }

  ]

}