basePath: /data/v1 consumes: - application/json definitions: APIError: description: >- An APIError communicates both general and field-specific errors. General errors include issues with core API usage as well as conflicts that involve more than one field. Field-specific errors correspond to an individual query parameter or request body attribute. Errors referencing nested fields will be dot-delimited (e.g. user.groups.0.name). properties: field: additionalProperties: $ref: '#/definitions/Errors' type: object general: $ref: '#/definitions/Errors' required: - general - field type: object AndFilter: allOf: - $ref: '#/definitions/Filter' - properties: config: items: $ref: '#/definitions/Filter' type: array required: - config type: object Asset: description: Item asset metadata. properties: _links: allOf: - $ref: '#/definitions/SelfLink' - properties: activate: description: >- If present, RFC 3986 URI indicating where an authenticated user may trigger activation of this asset via a POST request. A 202 response indicates the activation request has been accepted. A 204 response indicates the asset is already active. After successful activation, this asset will have a non-empty location. type: string type: description: The RFC 3986 URI describing the asset type. type: string type: object description: Links to related endpoints. type: object _permissions: description: An array of permissons the authenticated user has to the item. items: enum: - download type: string type: array uniqueItems: true expires_at: description: >- If present, RFC 3339 timestamp indicating when this asset will become inactive and will require reactivation. format: date-time type: string location: description: >- If present, RFC 3986 URI that indicates a location that will yield image data. Consult the documentation of the asset type to understand how to use this URI. type: string status: description: >- Current status of the asset. Inactive - Asset is not currently available for download, but may be after activation. Activating - Asset is currently undergoing activation, and may be available for download shortly. Active - Asset has been activated, and may currently be available for download if the authentication context permits. enum: - inactive - activating - active type: string type: description: Type identifier of the asset. type: string required: - status - type - _links - _permissions type: object AssetFilter: allOf: - $ref: '#/definitions/Filter' - properties: config: items: $ref: '#/definitions/AssetNameEnum' type: array required: - config type: object AssetNameEnum: enum: - analytic - analytic_sr - analytic_xml - basic_analytic - basic_analytic_4b - basic_analytic_4b_rpc - basic_analytic_4b_xml - basic_analytic_8b - basic_analytic_8b_xml - basic_analytic_b1 - basic_analytic_b1_nitf - basic_analytic_b2 - basic_analytic_b2_nitf - basic_analytic_b3 - basic_analytic_b3_nitf - basic_analytic_b4 - basic_analytic_b4_nitf - basic_analytic_b5 - basic_analytic_b5_nitf - basic_analytic_dn - basic_analytic_dn_rpc - basic_analytic_rpc - basic_analytic_sci - basic_analytic_udm - basic_analytic_udm2 - basic_analytic_xml - basic_analytic_xml_nitf - basic_beta_udm - basic_l1a_all_frames - basic_l1a_panchromatic - basic_l1a_panchromatic_dn - basic_l1a_panchromatic_dn_rpc - basic_l1a_panchromatic_rpc - basic_panchromatic - basic_panchromatic_dn - basic_panchromatic_dn_rpc - basic_panchromatic_rpc - basic_panchromatic_udm2 - basic_radiance_hdf5 - basic_sr_hdf5 - basic_udm - basic_udm2 - browse - geolocation_array - ortho_analytic - ortho_analytic_3b - ortho_analytic_3b_xml - ortho_analytic_4b - ortho_analytic_4b_sr - ortho_analytic_4b_xml - ortho_analytic_8b - ortho_analytic_8b_sr - ortho_analytic_8b_xml - ortho_analytic_dn - ortho_analytic_sr - ortho_analytic_udm - ortho_analytic_udm2 - ortho_beta_udm - ortho_panchromatic - ortho_panchromatic_dn - ortho_panchromatic_udm - ortho_panchromatic_udm2 - ortho_pansharpened - ortho_pansharpened_udm - ortho_pansharpened_udm2 - ortho_ql_ch4 - ortho_radiance_hdf5 - ortho_sr_hdf5 - ortho_udm2 - ortho_visual - ql_ch4_json - recent_monthly_mosaic - udm - video_file - video_frames - video_metadata - visual - visual_xml type: string AssetType: properties: _links: allOf: - $ref: '#/definitions/SelfLink' description: Links to related endpoints. type: object display_description: description: Human-readable description of the asset type. type: string display_name: description: Human-readable name of the asset type. type: string id: description: Asset type identifier. type: string md5_digest: description: >- md5 digest of the asset type used to determine if the asset has changed. type: string AssetTypePage: properties: _links: allOf: - $ref: '#/definitions/SelfLink' description: Links to related endpoints. type: object asset_types: items: $ref: '#/definitions/AssetType' type: array type: object AssetsLink: properties: assets: description: >- RFC 3986 URI representing the canonical location of the assets subcollection. type: string required: - assets Band: properties: name: $ref: '#/definitions/BandName' type: object BandName: description: Name of the spectral band. enum: - coastal - blue - green - green_i - yellow - red - rededge - nir - pan type: string CloudCoverage: description: Cloud coverage estimate and status properties: clear_percent: description: Average percentage of cloud coverage throughout the supplied geometry. format: int type: number status: description: complete or activating type: string type: object DateRangeFilter: allOf: - $ref: '#/definitions/FieldFilter' - properties: config: properties: gt: format: date-time type: string gte: format: date-time type: string lt: format: date-time type: string lte: format: date-time type: string type: object required: - config type: object Error: properties: message: description: A descriptive error message. type: string type: object Errors: items: $ref: '#/definitions/Error' type: array FieldFilter: allOf: - $ref: '#/definitions/Filter' - properties: field_name: type: string required: - field_name type: object Filter: description: Structured search criteria. discriminator: type properties: type: description: Logical filter type. type: string required: - type type: object FirstLink: properties: _first: description: RFC 3986 URI representing the location of the first page of results. type: string required: - _first type: object GeoJSONFeature: description: GeoJSON feature object. properties: geometry: $ref: '#/definitions/GeoJSONGeometry' properties: type: object required: - properties - geometry title: Feature GeoJSONFeatureCollection: description: A GeoJSON feature collection. properties: features: items: $ref: '#/definitions/GeoJSONFeature' type: array required: - features title: FeatureCollection GeoJSONGeometry: description: A GeoJSON geometry. discriminator: type properties: relation: default: intersects description: | spatial relation between Planet Imagery and Search AOI enum: - intersects - contains - within - disjoint type: string type: description: GeoJSON geometery type. All types are supported. enum: - Polygon - MultiPoint - LineString - MultiLineString - Point - MultiPolygon - ref type: string required: - type type: object GeometryFilter: allOf: - $ref: '#/definitions/Filter' - properties: config: $ref: '#/definitions/GeoJSONGeometry' field_name: enum: - geometry type: string required: - config - field_name type: object Item: properties: _links: allOf: - $ref: '#/definitions/SelfLink' - $ref: '#/definitions/AssetsLink' - $ref: '#/definitions/ThumbLink' description: Links to related endpoints. type: object _permissions: description: An array of permissons the authenticated user has to the item. assets: description: Lists all the assets that have been published for the item. geometry: $ref: '#/definitions/GeoJSONGeometry' id: description: Item identifier. type: string properties: description: >- Item metadata. [Varies by item_type.](https://docs.planet.com/develop/apis/data/items/#item-types) properties: acquired: description: Timestamp that the item was captured. format: date-time type: string anomalous_pixels: description: The percentage of pixels that may have errors. format: float type: number black_fill: description: The percentage of the item containing black fill. format: float type: number cloud_cover: description: Average percentage of cloud coverage throughout the item. format: float type: number columns: description: The number of columns in the item. type: integer epsg_code: description: >- The unique code that identifies the spatial reference system for the item. type: integer gsd: description: >- Ground sample distance - the distance between pixel centers as measured on the ground. format: float type: number item_type: description: The planet item type. type: string origin_x: description: >- ULX coordinate of the extent of the data. The coordinate references the top left corner of the top left pixel. type: integer origin_y: description: >- ULY coordinate of the extent of the data. The coordinate references the top left corner of the top left pixel. type: integer pixel_resolution: description: Pixel resolution of the item in meters. type: integer provider: description: Name of the item provider. type: string published: description: Timestamp that the item was published to the Planet API. format: date-time type: string rows: description: The number of rows in the item type: integer satellite_id: description: >- Globally unique identifier of the satellite that acquired the item. type: string sun_azimuth: description: >- The angle of the sun, as seen by the observer, measured clockwise from the north. format: float type: number sun_elevation: description: The angle of the sun above the horizon. format: float type: number updated: description: Timestamp that the item record was last updated. format: date-time type: string usable_data: description: The percentage of pixels that are usable. format: float type: number view_angle: description: >- The satellite's across-track, off-nadir viewing angle. Positive numbers denote east, negitive numbers denote west. format: float type: number type: object required: - id - properties - _links type: object ItemPage: properties: _links: allOf: - $ref: '#/definitions/SelfLink' - $ref: '#/definitions/FirstLink' - $ref: '#/definitions/NextLink' description: Links to related endpoints. type: object features: description: Array of items matching the search. items: $ref: '#/definitions/Item' type: array required: - features - _links type: object ItemType: properties: _links: allOf: - $ref: '#/definitions/SelfLink' description: Links to related endpoints. type: object display_description: description: Human-readable description of the item type. type: string display_name: description: Human-readable name of the item type. type: string id: description: Item type identifier. type: string supported_asset_types: description: Human-readable array of supported asset types for the item type. items: $ref: '#/definitions/AssetNameEnum' type: array type: object ItemTypeAssetType: allOf: - $ref: '#/definitions/AssetType' - properties: bands: description: Spectral band information for this asset type, if available. items: $ref: '#/definitions/Band' type: array type: object ItemTypeAssetTypePage: properties: _links: allOf: - $ref: '#/definitions/SelfLink' description: Links to related endpoints. type: object asset_types: items: $ref: '#/definitions/ItemTypeAssetType' type: array type: object ItemTypePage: properties: _links: allOf: - $ref: '#/definitions/SelfLink' description: Links to related endpoints. type: object item_types: items: $ref: '#/definitions/ItemType' type: array type: object LineString: properties: coordinates: allOf: - $ref: '#/definitions/PositionArray' - minItems: 2 required: - coordinates LinearRing: allOf: - $ref: '#/definitions/PositionArray' - minItems: 4 description: An array of four positions where the first equals the last MultiLineString: properties: coordinates: items: allOf: - $ref: '#/definitions/PositionArray' - minItems: 2 type: array required: - coordinates MultiPoint: properties: coordinates: $ref: '#/definitions/PositionArray' required: - coordinates MultiPolygon: properties: coordinates: items: items: $ref: '#/definitions/LinearRing' type: array type: array required: - coordinates NextLink: properties: _next: description: >- RFC 3986 URI representing the location of the next page of results. Omitted when there are no results, or the current page is the last. type: string required: - _next type: object NotFilter: allOf: - $ref: '#/definitions/Filter' - properties: config: $ref: '#/definitions/Filter' required: - config type: object NumberInFilter: allOf: - $ref: '#/definitions/FieldFilter' - properties: config: items: format: int64 type: number type: array required: - config type: object OrFilter: allOf: - $ref: '#/definitions/Filter' - properties: config: items: $ref: '#/definitions/Filter' type: array required: - config type: object PermissionFilter: allOf: - $ref: '#/definitions/Filter' - properties: config: items: enum: - assets:download - assets.analytic:download - assets.analytic_5b:download - assets.analytic_5b_xml:download - assets.analytic_b1:download - assets.analytic_b10:download - assets.analytic_b11:download - assets.analytic_b12:download - assets.analytic_b2:download - assets.analytic_b3:download - assets.analytic_b4:download - assets.analytic_b5:download - assets.analytic_b6:download - assets.analytic_b7:download - assets.analytic_b8:download - assets.analytic_b8a:download - assets.analytic_b9:download - assets.analytic_bqa:download - assets.analytic_dn:download - assets.analytic_dn_xml:download - assets.analytic_gflags:download - assets.analytic_granule_pnt:download - assets.analytic_iobs_res:download - assets.analytic_num_observations:download - assets.analytic_num_observations_1km:download - assets.analytic_num_observations_500m:download - assets.analytic_obscov:download - assets.analytic_obscov_500m:download - assets.analytic_orbit_pnt:download - assets.analytic_q_scan:download - assets.analytic_qc_250m:download - assets.analytic_qc_500m:download - assets.analytic_range:download - assets.analytic_sensor_azimuth:download - assets.analytic_sensor_zenith:download - assets.analytic_solar_azimuth:download - assets.analytic_solar_zenith:download - assets.analytic_sr:download - assets.analytic_state_1km:download - assets.analytic_sur_refl_b01:download - assets.analytic_sur_refl_b02:download - assets.analytic_sur_refl_b03:download - assets.analytic_sur_refl_b04:download - assets.analytic_sur_refl_b05:download - assets.analytic_sur_refl_b06:download - assets.analytic_sur_refl_b07:download - assets.analytic_xml:download - assets.basic_analytic:download - assets.basic_analytic_4b:download - assets.basic_analytic_4b_rpc:download - assets.basic_analytic_4b_xml:download - assets.basic_analytic_8b:download - assets.basic_analytic_8b_xml:download - assets.basic_analytic_b1:download - assets.basic_analytic_b1_nitf:download - assets.basic_analytic_b2:download - assets.basic_analytic_b2_nitf:download - assets.basic_analytic_b3:download - assets.basic_analytic_b3_nitf:download - assets.basic_analytic_b4:download - assets.basic_analytic_b4_nitf:download - assets.basic_analytic_b5:download - assets.basic_analytic_b5_nitf:download - assets.basic_analytic_dn:download - assets.basic_analytic_dn_nitf:download - assets.basic_analytic_dn_rpc:download - assets.basic_analytic_dn_rpc_nitf:download - assets.basic_analytic_dn_xml:download - assets.basic_analytic_dn_xml_nitf:download - assets.basic_analytic_nitf:download - assets.basic_analytic_rpc:download - assets.basic_analytic_rpc_nitf:download - assets.basic_analytic_sci:download - assets.basic_analytic_udm:download - assets.basic_analytic_udm2:download - assets.basic_analytic_xml:download - assets.basic_analytic_xml_nitf:download - assets.basic_beta_udm:download - assets.basic_l1a_all_frames:download - assets.basic_l1a_panchromatic:download - assets.basic_l1a_panchromatic_dn:download - assets.basic_l1a_panchromatic_dn_rpc:download - assets.basic_l1a_panchromatic_rpc:download - assets.basic_panchromatic:download - assets.basic_panchromatic_dn:download - assets.basic_panchromatic_dn_rpc:download - assets.basic_panchromatic_rpc:download - assets.basic_panchromatic_udm2:download - assets.basic_radiance_hdf5:download - assets.basic_sr_hdf5:download - assets.basic_udm:download - assets.basic_udm2:download - assets.browse:download - assets.ch4_plume_json:download - assets.geolocation_array:download - assets.metadata_aux:download - assets.metadata_txt:download - assets.ortho_analytic:download - assets.ortho_analytic_3b:download - assets.ortho_analytic_3b_xml:download - assets.ortho_analytic_4b:download - assets.ortho_analytic_4b_sr:download - assets.ortho_analytic_4b_xml:download - assets.ortho_analytic_8b:download - assets.ortho_analytic_8b_sr:download - assets.ortho_analytic_8b_xml:download - assets.ortho_analytic_dn:download - assets.ortho_analytic_hh:download - assets.ortho_analytic_hv:download - assets.ortho_analytic_sr:download - assets.ortho_analytic_udm:download - assets.ortho_analytic_udm2:download - assets.ortho_analytic_vh:download - assets.ortho_analytic_vv:download - assets.ortho_beta_udm:download - assets.ortho_ch4_plume:download - assets.ortho_panchromatic:download - assets.ortho_panchromatic_dn:download - assets.ortho_panchromatic_udm:download - assets.ortho_panchromatic_udm2:download - assets.ortho_pansharpened:download - assets.ortho_pansharpened_udm:download - assets.ortho_pansharpened_udm2:download - assets.ortho_radiance_hdf5:download - assets.ortho_sr_hdf5:download - assets.ortho_udm2:download - assets.ortho_visual:download - assets.recent_monthly_mosaic:download - assets.udm:download - assets.udm2:download - assets.video_file:download - assets.video_frames:download - assets.video_metadata:download - assets.visual:download - assets.visual_xml:download - webtiles:stream type: string type: array required: - config type: object Point: properties: coordinates: $ref: '#/definitions/Position' required: - coordinates Polygon: properties: coordinates: items: $ref: '#/definitions/LinearRing' type: array required: - coordinates Position: description: A single position items: type: number maxItems: 2 minItems: 2 type: array PositionArray: description: An array of two or more positions items: $ref: '#/definitions/Position' type: array PrevLink: properties: _prev: description: >- RFC 3986 URI representing the location of the previous page of results. Omitted from first page of results. type: string required: - _prev type: object QuickSearch: properties: asset_types: description: The asset types to include in the search. items: type: string type: array filter: $ref: '#/definitions/Filter' geometry: $ref: '#/definitions/GeoJSONGeometry' description: >- A GeoJSON geometry. This can be used instead of a GeometryFilter. Feature references are also supported. item_types: description: The item types to include in the search. items: type: string type: array name: description: The name of the saved search. pattern: ^.{1,64}$ type: string required: - item_types type: object RangeFilter: allOf: - $ref: '#/definitions/FieldFilter' - properties: config: properties: gt: format: double type: number gte: format: double type: number lt: format: double type: number lte: format: double type: number type: object required: - config type: object ResultsLink: properties: thumbnail: description: >- RFC 3986 URI representing the canonical location to get saved search results. type: string required: - thumbnail SavedSearch: properties: __daily_email_enabled: description: Send a daily email when new results are added. type: boolean asset_types: description: The asset types to include in the search. items: type: string type: array filter: $ref: '#/definitions/Filter' item_types: description: The item types to include in the search. items: type: string type: array name: description: The name of this saved search. pattern: ^.{1,64}$ type: string required: - name - filter - item_types type: object Search: properties: __daily_email_enabled: default: false description: Send a daily email when new results are added. type: boolean _links: allOf: - $ref: '#/definitions/SelfLink' - $ref: '#/definitions/ResultsLink' description: Links to related endpoints. type: object created: description: The date the record was created. format: date-time type: string filter: $ref: '#/definitions/Filter' id: description: Saved search identifier. pattern: ^.{32}$ type: string last_executed: description: The date the search was last executed. format: date-time type: string name: description: The name of the saved search. pattern: ^.{1,64}$ type: string updated: description: The date the record was updated. format: date-time type: string required: - filter - name - created - updated - last_executed - id type: object SearchPage: properties: _links: allOf: - $ref: '#/definitions/SelfLink' - $ref: '#/definitions/FirstLink' - $ref: '#/definitions/NextLink' - $ref: '#/definitions/PrevLink' description: Links to related endpoints. type: object searches: description: A list of saved searches. items: $ref: '#/definitions/Search' type: array required: - _links - searches type: object SelfLink: properties: _self: description: RFC 3986 URI representing the canonical location of this object. type: string required: - _self type: object Stats: properties: asset_types: description: The asset types to include in the stats. items: type: string type: array filter: $ref: '#/definitions/Filter' interval: description: The size of the histogram date buckets. enum: - hour - day - week - month - year type: string item_types: description: The item types to include in the stats. items: type: string type: array utc_offset: description: >- 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. type: string required: - filter - interval - item_types type: object StatsBucketResults: properties: count: description: Count of items in the bucket. type: number start_time: description: Start time of the aggregated bucket. format: date-time type: string required: - count - start_time type: object StatsResults: properties: buckets: description: List of buckets for agregration. items: $ref: '#/definitions/StatsBucketResults' type: array interval: description: The size of the histogram date buckets. enum: - hour - day - week - month - year type: string utc_offset: description: >- 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. type: string required: - utc_offset - interval - buckets type: object StringInFilter: allOf: - $ref: '#/definitions/FieldFilter' - properties: config: items: type: string type: array required: - config type: object ThumbLink: properties: thumbnail: description: >- RFC 3986 URI representing the canonical location of the item thumbnail image. type: string required: - thumbnail UpdateFilter: allOf: - $ref: '#/definitions/FieldFilter' - properties: config: properties: gt: format: date-time type: string gte: format: date-time type: string type: object required: - config type: object ref: properties: content: type: string required: - content host: api.planet.com info: description: >- 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. title: Planet Data API version: 1.0.0 x-revision: d9c8fc20854b52645b6b1b3ec32a84d7c67e0703 parameters: pAssetTypeID: description: Asset type identifier. in: path name: asset_type_id required: true type: string pItemID: description: Item identifier. in: path name: item_id required: true type: string pItemTypeID: description: Item type identifier. in: path name: item_type_id required: true type: string pSearchID: description: Saved search identifier. in: path name: search_id required: true type: string qPage: description: >- Token representing a specific page of results. This should never be constructed manually. in: query name: _page type: string qPageSize: default: 250 description: >- 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. format: int64 in: query maximum: 250 minimum: 0 name: _page_size type: integer qSearchResultSort: default: published desc description: >- Field and direction to order results by. This may not be provided with the "_page" parameter. enum: - acquired asc - acquired desc - published asc - published desc in: query name: _sort type: string qSearchSort: default: created desc description: >- Field and direction to order results by. This may not be provided with the "_page" parameter. enum: - created desc - created asc in: query name: _sort type: string qSearchType: default: any description: Search type filter. enum: - any - saved - quick in: query name: search_type type: string paths: /asset-types: get: description: > 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](https://docs.planet.com/develop/apis/data/items/#assets) operationId: ListAssetTypes responses: '200': description: List of asset types. schema: $ref: '#/definitions/AssetTypePage' summary: List Asset Types tags: - Items and Assets /asset-types/{asset_type_id}: get: description: > 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](https://docs.planet.com/develop/apis/data/items/#assets) operationId: GetAssetType parameters: - $ref: '#/parameters/pAssetTypeID' responses: '200': description: Asset type details. schema: $ref: '#/definitions/AssetType' '404': description: The requested asset type does not exist. schema: $ref: '#/definitions/APIError' summary: Get Asset Type tags: - Items and Assets /item-types: get: description: > 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](https://docs.planet.com/develop/apis/data/items/#item-types) operationId: ListItemTypes responses: '200': description: List of item types. schema: $ref: '#/definitions/ItemTypePage' summary: List Item Types tags: - Items and Assets /item-types/{item_type_id}: get: description: > 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](https://docs.planet.com/develop/apis/data/items/#item-types) operationId: GetItemType parameters: - $ref: '#/parameters/pItemTypeID' responses: '200': description: Item type details. schema: $ref: '#/definitions/ItemType' '404': description: The requested item type does not exist. schema: $ref: '#/definitions/APIError' summary: Get Item Type tags: - Items and Assets /item-types/{item_type_id}/items/{item_id}: get: description: > 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](https://docs.planet.com/develop/apis/data/items/#items) operationId: GetItem parameters: - $ref: '#/parameters/pItemTypeID' - $ref: '#/parameters/pItemID' responses: '200': description: Item details. schema: $ref: '#/definitions/Item' '404': description: The requested item does not exist for the given item type. schema: $ref: '#/definitions/APIError' summary: Get Item tags: - Items and Assets /item-types/{item_type_id}/items/{item_id}/assets: get: description: > 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](https://docs.planet.com/develop/apis/data/items/#assets) operationId: ListItemAssets parameters: - $ref: '#/parameters/pItemTypeID' - $ref: '#/parameters/pItemID' responses: '200': description: List of available assets. schema: $ref: '#/definitions/Asset' '404': description: The requested item does not exist for the given item type. schema: $ref: '#/definitions/APIError' summary: List Item Assets tags: - Items and Assets /item-types/{item_type_id}/items/{item_id}/coverage: post: description: | gets coverage estimate operationId: CloudCoverage parameters: - $ref: '#/parameters/pItemTypeID' - $ref: '#/parameters/pItemID' - description: The area of the cloud coverage request. in: body name: geometry required: true schema: $ref: '#/definitions/GeoJSONGeometry' - description: > 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. enum: - UDM2 - estimate in: query name: mode required: false type: string - description: | The UDM2 band used to calculate coverage. enum: - clear - snow_ice - cloud_shadow - light_haze - heavy_haze - cloud - cirrus in: query name: band required: false type: string responses: '201': description: Cloud coverage status and clear percentage estimate. schema: $ref: '#/definitions/CloudCoverage' '404': description: The requested item does not exist for the given item type. schema: $ref: '#/definitions/APIError' summary: cloud coverage estimate tags: - Items and Assets /item-types/{item_type_id}/items/{item_id}/versions: get: description: | List all data versions available for an item. operationId: ListItemVersions parameters: - $ref: '#/parameters/pItemTypeID' - $ref: '#/parameters/pItemID' responses: '200': description: List of available data versions as a FeatureCollection. schema: properties: _links: description: Links to related endpoints. properties: _self: description: >- RFC 3986 URI representing the canonical location of this resource. type: string type: object features: description: Array of item versions matching the request. items: $ref: '#/definitions/Item' type: array type: enum: - FeatureCollection type: string type: object '404': description: The requested item does not exist for the given item type. schema: $ref: '#/definitions/APIError' summary: List Item Versions tags: - Items and Assets /item-types/{item_type_id}/items/{item_id}/versions/{data_version}: get: description: | Get a specific data version of an item. operationId: GetItemVersion parameters: - $ref: '#/parameters/pItemTypeID' - $ref: '#/parameters/pItemID' - description: The data version timestamp. in: path name: data_version required: true type: string responses: '200': description: Item details for the specified version. schema: $ref: '#/definitions/Item' '404': description: The requested version does not exist for the given item. schema: $ref: '#/definitions/APIError' summary: Get Item Version tags: - Items and Assets /quick-search: post: description: > 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](https://docs.planet.com/develop/apis/data/item-search/#filters) operationId: QuickSearch parameters: - description: The structured search criteria. in: body name: search required: true schema: $ref: '#/definitions/QuickSearch' - $ref: '#/parameters/qPageSize' - $ref: '#/parameters/qSearchResultSort' responses: '200': description: List of items that match search criteria. schema: $ref: '#/definitions/ItemPage' '400': description: There was an error executing the search. schema: $ref: '#/definitions/APIError' summary: Quick Search tags: - Item Search /searches: get: description: List all saved searches available to the authenticated user. operationId: ListSearches parameters: - $ref: '#/parameters/qPage' - $ref: '#/parameters/qPageSize' - $ref: '#/parameters/qSearchSort' - $ref: '#/parameters/qSearchType' responses: '200': description: List of saved searches. schema: $ref: '#/definitions/SearchPage' summary: List Saved Searches tags: - Item Search post: description: Create a new saved search. operationId: CreateSearch parameters: - description: The structured search criteria. in: body name: search required: true schema: $ref: '#/definitions/SavedSearch' responses: '200': description: Saved search details. headers: Location: description: The URL for the newly created saved search. type: string schema: $ref: '#/definitions/Search' '400': description: There was an error creating your saved search. schema: $ref: '#/definitions/APIError' summary: Create Saved Search tags: - Item Search /searches/{search_id}: delete: description: Delete an existing saved search. operationId: DeleteSearch parameters: - $ref: '#/parameters/pSearchID' responses: '204': description: Saved search successfully deleted. '404': description: The requested saved search does not exist. schema: $ref: '#/definitions/APIError' summary: Delete Saved Search tags: - Item Search get: description: Get a saved search by id. operationId: GetSearch parameters: - $ref: '#/parameters/pSearchID' responses: '200': description: Saved search details. schema: $ref: '#/definitions/Search' '404': description: The requested saved search does not exist. schema: $ref: '#/definitions/APIError' summary: Get Saved Search tags: - Item Search put: description: Update an existing saved search. operationId: UpdateSearch parameters: - $ref: '#/parameters/pSearchID' - description: The structured search criteria. in: body name: search required: true schema: $ref: '#/definitions/SavedSearch' responses: '200': description: Saved search details. schema: $ref: '#/definitions/Search' '400': description: There was an error updating your saved search. schema: $ref: '#/definitions/APIError' summary: Update Saved Search tags: - Item Search /searches/{search_id}/results: get: description: Executes a saved search. operationId: ExecuteSearch parameters: - $ref: '#/parameters/qPage' - $ref: '#/parameters/qPageSize' - $ref: '#/parameters/qSearchResultSort' - $ref: '#/parameters/pSearchID' responses: '200': description: List of items that match search criteria. schema: $ref: '#/definitions/ItemPage' '404': description: The requested saved search does not exist. schema: $ref: '#/definitions/APIError' summary: Run Saved Search tags: - Item Search /stats: post: description: Returns a date bucketed histogram of items matching a filter operationId: Stats parameters: - description: The structured search criteria. in: body name: search required: true schema: $ref: '#/definitions/Stats' responses: '200': description: List of item stats aggregated over the interval given. schema: $ref: '#/definitions/StatsResults' '400': description: There was an error executing the stats. schema: $ref: '#/definitions/APIError' summary: Search Stats tags: - Item Stats produces: - application/json schemes: - https security: - basic: [] securityDefinitions: basic: type: basic swagger: '2.0'