openapi: 3.1.0 info: title: API Reference version: 1.0.0 contact: name: Sentinel Hub servers: - url: https://services.sentinel-hub.com tags: - name: dataimport_search x-displayName: Search description: > TPDI Service for Planet data is deprecated and will be sunset on November 11th, 2026. Please use [Planet Item Search](https://docs.planet.com/develop/apis/data/reference/#tag/Item-Search) instead. - name: dataimport_product x-displayName: Product description: > TPDI Service for Planet data is deprecated and will be sunset on November 11th, 2026. Please use [Planet Data API](https://docs.planet.com/develop/apis/data/reference/) instead. - name: dataimport_order x-displayName: Order description: > TPDI Service for Planet data is deprecated and will be sunset on November 11th, 2026. Please use [Planet Orders API](https://docs.planet.com/develop/apis/orders/reference/) instead. - name: dataimport_delivery x-displayName: Order delivery description: > TPDI Service for Planet data is deprecated and will be sunset on November 11th, 2026. Please use [Planet Orders API](https://docs.planet.com/develop/apis/orders/reference/) instead. - name: dataimport_tile_delivery x-displayName: Order delivery tile description: > TPDI Service for Planet data is deprecated and will be sunset on November 11th, 2026. Please use the [BYOC API](https://docs.planet.com/develop/apis/byoc/reference/#tag/byoc_tile) instead to work with tiles. - name: dataimport_subscription x-displayName: Subscription description: > TPDI Service for Planet data is deprecated and will be sunset on November 11th, 2026. Please use [Planet Subscriptions API](https://docs.planet.com/develop/apis/subscriptions/reference/) instead. - name: dataimport_subscription_delivery x-displayName: Subscription delivery description: > TPDI Service for Planet data is deprecated and will be sunset on November 11th, 2026. Please use [Planet Subscriptions API](https://docs.planet.com/develop/apis/subscriptions/reference/) instead. - name: dataimport_subscription_tile_delivery x-displayName: Subscription delivery tile description: > TPDI Service for Planet data is deprecated and will be sunset on November 11th, 2026. Please use the [BYOC API](https://docs.planet.com/develop/apis/byoc/reference/#tag/byoc_tile) instead to work with tiles. - name: dataimport_quota x-displayName: Quota paths: /api/v1/dataimport/search: post: summary: Search data description: Search data with Process API-like interface. operationId: dataImport_searchData tags: - dataimport_search parameters: - name: count description: | Number of items to retrieve. Maximum value is provider dependent. in: query schema: type: integer format: int32 minimum: 1 - $ref: '#/components/parameters/SearchBeanViewtoken' requestBody: content: application/json: schema: $ref: '#/components/schemas/SearchQuery' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/SearchResults' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' security: - OAuth2: [] /api/v1/dataimport/nativesearch: post: summary: Native search description: > Proxy search. All the fields not listed as required are passed verbatim to the data provider's search API, and the result from the latter is returned verbatim. operationId: dataImport_nativeSearch tags: - dataimport_search requestBody: content: application/json: schema: $ref: '#/components/schemas/NativeSearchQuery' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/SearchResults' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' security: - OAuth2: [] /api/v1/dataimport/collections/{collectionId}/products/{productId}/thumbnail: get: summary: Get thumbnail of data product description: Get a scaled-down, non-geolocated, non-clipped image of the data product operationId: dataImport_getProductThumbnail tags: - dataimport_product parameters: - $ref: '#/components/parameters/TpdiCollectionId' - name: productId description: >- ID of the product to get thumbnail of, typically returned by a previous search in: path required: true schema: type: string - name: planetApiKey deprecated: true description: | Your Planet API key. Get one from Planet https://www.planet.com. It is required in order to get thumbnails of Planet data products unless you purchased your Planet data plan through Sentinel Hub. in: query schema: type: string responses: '200': description: Successful response (image) security: - OAuth2: [] /api/v1/dataimport/orders: post: summary: Create an order description: > Create a non-confirmed data order object, equivalent to a quote. After creation you can review the contents of the order and its quota requirements, and then choose to confirm it or not. Data can be ordered by specifying a query (all items matching the query will be ordered) or item IDs (the specified items will be ordered). operationId: dataImport_createOrder tags: - dataimport_order requestBody: content: application/json: schema: $ref: '#/components/schemas/OrderRequest' responses: '200': description: Order created content: application/json: schema: $ref: '#/components/schemas/Order' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' security: - OAuth2: [] get: summary: Query orders operationId: dataImport_getOrders tags: - dataimport_order parameters: - $ref: '#/components/parameters/OrderStatus' - name: collectionId description: Filter orders by collectionId. Omit to get all orders. in: query schema: type: string format: uuid - $ref: '#/components/parameters/SearchBeanCount' - $ref: '#/components/parameters/SearchBeanViewtoken' - $ref: '#/components/parameters/SearchBeanSearch' - name: deleted description: >- If set to `true` the response will only return those orders that had been deleted by the user. in: query schema: default: false type: boolean responses: '200': description: Successful response content: application/json: schema: type: object properties: data: type: array items: $ref: '#/components/schemas/Order' links: $ref: '#/components/schemas/View' '401': $ref: '#/components/responses/401' security: - OAuth2: [] /api/v1/dataimport/orders/{orderId}: get: summary: Get an order operationId: dataImport_getOrder tags: - dataimport_order parameters: - $ref: '#/components/parameters/OrderId' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Order' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' security: - OAuth2: [] delete: summary: Delete an order operationId: dataImport_deleteOrder description: |- `CREATED` orders will be permanently deleted. `CANCELLED` , `DONE` or `FAILED` ones will be deleted for normal querying but will still be available. `PARTIAL` or `RUNNING` orders cannot be deleted. tags: - dataimport_order parameters: - $ref: '#/components/parameters/OrderId' responses: '204': description: Successful response - order deleted '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '409': description: >- Conflict - order cannot be deleted because it is currently being processed. security: - OAuth2: [] /api/v1/dataimport/orders/{orderId}/confirm: post: summary: Confirm an order description: > Confirm the order and start executing it. Requires sufficient quota for the order. Only orders with status CREATED can be confirmed. operationId: dataImport_confirmOrder tags: - dataimport_order parameters: - $ref: '#/components/parameters/OrderId' responses: '200': description: Successful response - order confirmed content: application/json: schema: $ref: '#/components/schemas/Order' '401': $ref: '#/components/responses/401' '403': description: Insufficient quota for the order content: application/json: schema: $ref: '#/components/schemas/QuotaExceededError' '409': description: >- Conflict - order cannot be confirmed because its status is not CREATED. security: - OAuth2: [] /api/v1/dataimport/orders/{orderId}/deliveries: get: summary: Get order deliveries operationId: dataImport_getOrderDeliveries tags: - dataimport_delivery parameters: - $ref: '#/components/parameters/OrderId' - $ref: '#/components/parameters/DeliveryStatus' - $ref: '#/components/parameters/SearchBeanCount' - $ref: '#/components/parameters/SearchBeanViewtoken' responses: '200': description: Successful response content: application/json: schema: type: object properties: data: type: array items: $ref: '#/components/schemas/OrderDelivery' links: $ref: '#/components/schemas/View' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' security: - OAuth2: [] /api/v1/dataimport/orders/{orderId}/deliveries/{deliveryId}: get: summary: Get an order delivery operationId: dataImport_getOrderDelivery tags: - dataimport_delivery parameters: - $ref: '#/components/parameters/OrderId' - $ref: '#/components/parameters/DeliveryId' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/OrderDelivery' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' security: - OAuth2: [] /api/v1/dataimport/orders/{orderId}/deliveries/{deliveryId}/files: get: summary: List files of an order delivery description: > Lists all files delivered by the data provider. The file list and contents is provider-specific. operationId: dataImport_getOrderDeliveryFiles tags: - dataimport_delivery parameters: - $ref: '#/components/parameters/OrderId' - $ref: '#/components/parameters/DeliveryId' responses: '200': description: Successful response content: application/json: schema: items: type: string format: filename with path example: - VOL_PHR.XML - INDEX.HTM - >- IMG_PHR1A_P_001/IMG_PHR1A_P_202102240924289_ORT_15c5eeb9-53a1-4cdd-cca6-d265fb1bf0c6-001_R1C1.J2W - ... '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '409': description: Delivery status is not `DONE` security: - OAuth2: [] /api/v1/dataimport/orders/{orderId}/deliveries/{deliveryId}/files/{file}: get: summary: Retrieve a delivery file description: Download a single file delivered by the data provider. operationId: dataImport_getOrderDeliveryFile tags: - dataimport_delivery parameters: - $ref: '#/components/parameters/OrderId' - $ref: '#/components/parameters/DeliveryId' - $ref: '#/components/parameters/DeliveryFile' - in: header name: Range schema: type: string format: RFC 7223 description: > Optional byte range to retrieve part of a file according to [RFC 7233](https://datatracker.ietf.org/doc/html/rfc7233#section-3.1). Typically used with large files to resume interrupted downloads. example: bytes=16384-23473 responses: '200': description: Successful response content: application/octet-stream: schema: title: file contents as delivered by data provider type: string format: binary '206': description: >- Partial response in case partial retrieval was requested with the `Range` request header content: application/octet-stream: schema: title: partial file contents as delivered by data provider type: string format: binary headers: Content-Range: schema: type: string format: RFC 7223 description: > Byte range of the returned part of the file according to [RFC 7233](https://datatracker.ietf.org/doc/html/rfc7233#section-4.2). example: bytes 16384-23473/23474 '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '409': description: Delivery status is not `DONE` security: - OAuth2: [] head: summary: Get delivery file size operationId: dataImport_headOrderDeliveryFile tags: - dataimport_delivery parameters: - $ref: '#/components/parameters/OrderId' - $ref: '#/components/parameters/DeliveryId' - $ref: '#/components/parameters/DeliveryFile' responses: '200': description: Successful response headers: Content-Length: schema: type: integer description: File length in bytes '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '409': description: Delivery status is not `DONE` security: - OAuth2: [] /api/v1/dataimport/orders/{orderId}/deliveries/{deliveryId}/archive/create: post: summary: Request creation of delivery archive operationId: dataImport_postOrderDeliveryArchiveCreate tags: - dataimport_delivery parameters: - $ref: '#/components/parameters/OrderId' - $ref: '#/components/parameters/DeliveryId' - $ref: '#/components/parameters/DeliveryArchiveFormat' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/DeliveryArchive' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '409': description: > Delivery status is not `DONE` or archival of the same delivery in the same format has already been requested security: - OAuth2: [] /api/v1/dataimport/orders/{orderId}/deliveries/{deliveryId}/archive: get: summary: Retrieve delivery archive operationId: dataImport_getOrderDeliveryArchive tags: - dataimport_delivery parameters: - $ref: '#/components/parameters/OrderId' - $ref: '#/components/parameters/DeliveryId' - $ref: '#/components/parameters/DeliveryArchiveFormat' - in: header name: Range schema: type: string format: RFC 7223 description: > Optional byte range to retrieve part of the archive according to [RFC 7233](https://datatracker.ietf.org/doc/html/rfc7233#section-3.1). Typically used to resume interrupted downloads. example: bytes=16384-23473 responses: '200': description: Successful response content: application/octet-stream: schema: title: archive contents type: string format: binary '206': description: >- Partial response in case partial retrieval was requested with the `Range` request header content: application/octet-stream: schema: title: partial archive contents type: string format: binary headers: Content-Range: schema: type: string format: RFC 7223 description: > Byte range of the returned part of the archive according to [RFC 7233](https://datatracker.ietf.org/doc/html/rfc7233#section-4.2). example: bytes 16384-23473/23474 '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' security: - OAuth2: [] head: summary: Get size of delivery archive operationId: dataImport_headOrderDeliveryArchive tags: - dataimport_delivery parameters: - $ref: '#/components/parameters/OrderId' - $ref: '#/components/parameters/DeliveryId' - $ref: '#/components/parameters/DeliveryArchiveFormat' responses: '200': description: Successful response headers: Content-Length: schema: type: integer description: Archive length in bytes '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' security: - OAuth2: [] /api/v1/dataimport/orders/{orderId}/deliveries/{deliveryId}/archive/status: get: summary: Get status of delivery archive creation operationId: dataImport_getOrderDeliveryArchiveStatus tags: - dataimport_delivery parameters: - $ref: '#/components/parameters/OrderId' - $ref: '#/components/parameters/DeliveryId' - $ref: '#/components/parameters/DeliveryArchiveFormat' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/DeliveryArchive' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' security: - OAuth2: [] /api/v1/dataimport/orders/{orderId}/deliveries/{deliveryId}/tiles: get: summary: Get the tiles of an order delivery description: >- The delivery tiles correspond to BYOC tiles that were created during the ingestion of this delivery. Thus their corresponding IDs will match. While for most deliveries just one tile is created, for the largest ones there can be tens of tiles. Only tiles from last 3 months can be retrieved. operationId: dataImport_getTileDeliveries tags: - dataimport_tile_delivery parameters: - $ref: '#/components/parameters/OrderId' - $ref: '#/components/parameters/DeliveryId' responses: '200': description: Successful response content: application/json: schema: type: object properties: data: type: array items: $ref: '#/components/schemas/DeliveryTile' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' security: - OAuth2: [] /api/v1/dataimport/orders/{orderId}/deliveries/{deliveryId}/tiles/{tileId}: get: summary: Get an order delivery tile. description: Only tiles from last 3 months can be retrieved. operationId: dataImport_getTileDelivery tags: - dataimport_tile_delivery parameters: - $ref: '#/components/parameters/OrderId' - $ref: '#/components/parameters/DeliveryId' - $ref: '#/components/parameters/TileId' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/DeliveryTile' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' security: - OAuth2: [] /api/v1/dataimport/subscriptions: post: deprecated: true summary: Create a subscription description: > Create a non-confirmed data subscription object. After creation you can review the parameters of the subscription and then choose to confirm it or not. operationId: dataImport_createSubscription tags: - dataimport_subscription requestBody: content: application/json: schema: $ref: '#/components/schemas/SubscriptionRequest' responses: '200': description: Subscription created content: application/json: schema: $ref: '#/components/schemas/Subscription' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' security: - OAuth2: [] get: deprecated: true summary: Query subscriptions operationId: dataImport_getSubscriptions tags: - dataimport_subscription parameters: - $ref: '#/components/parameters/SubscriptionStatus' - name: collectionId description: Filter subscriptions by collectionId. Omit to get all subscriptions. in: query schema: type: string format: uuid - $ref: '#/components/parameters/SearchBeanCount' - $ref: '#/components/parameters/SearchBeanViewtoken' - $ref: '#/components/parameters/SearchBeanSearch' - name: deleted description: >- If set to `true` the response will only return those subscriptions that had been deleted by the user. in: query schema: default: false type: boolean responses: '200': description: Successful response content: application/json: schema: type: object properties: data: type: array items: $ref: '#/components/schemas/Subscription' links: $ref: '#/components/schemas/View' '401': $ref: '#/components/responses/401' security: - OAuth2: [] /api/v1/dataimport/subscriptions/{subscriptionId}: get: deprecated: true summary: Get a subscription operationId: dataImport_getSubscription tags: - dataimport_subscription parameters: - $ref: '#/components/parameters/SubscriptionId' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Subscription' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' security: - OAuth2: [] delete: deprecated: true summary: Delete a non-running subscription operationId: dataImport_deleteSubscription description: |- `CREATED` subscriptions will be permanently deleted. `CANCELLED` , `COMPLETED` or `FAILED` ones will be deleted for normal querying but will still be available. `RUNNING` subscriptions cannot be deleted. tags: - dataimport_subscription parameters: - $ref: '#/components/parameters/SubscriptionId' responses: '204': description: Successful response - subscription deleted '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '409': description: >- Conflict - subscription cannot be deleted because it is currently being processed. security: - OAuth2: [] /api/v1/dataimport/subscriptions/{subscriptionId}/confirm: post: deprecated: true summary: Confirm a subscription description: > Confirm the subscription and start executing it. Only subscription with status CREATED can be confirmed. operationId: dataImport_confirmSubscription tags: - dataimport_subscription parameters: - $ref: '#/components/parameters/SubscriptionId' responses: '200': description: Successful response - subscription confirmed content: application/json: schema: $ref: '#/components/schemas/Subscription' '401': $ref: '#/components/responses/401' '403': description: Insufficient quota for the order content: application/json: schema: $ref: '#/components/schemas/QuotaExceededError' '409': description: >- Conflict - subscription cannot be confirmed because its status is not CREATED. security: - OAuth2: [] /api/v1/dataimport/subscriptions/{subscriptionId}/cancel: post: deprecated: true summary: Cancel a subscription description: > Cancel a RUNNING subscription so that it will stop executing. Already imported data will be kept. Only subscription with status RUNNING can be cancelled. operationId: dataImport_cancelSubscription tags: - dataimport_subscription parameters: - $ref: '#/components/parameters/SubscriptionId' responses: '200': description: Successful response - subscription cancelled content: application/json: schema: $ref: '#/components/schemas/Subscription' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '409': description: >- Conflict - subscription cannot be cancelled because its status is not RUNNING. security: - OAuth2: [] /api/v1/dataimport/subscriptions/{subscriptionId}/deliveries: get: deprecated: true summary: Get subscription deliveries operationId: dataImport_getSubscriptionDeliveries tags: - dataimport_subscription_delivery parameters: - $ref: '#/components/parameters/SubscriptionId' - $ref: '#/components/parameters/DeliveryStatus' - $ref: '#/components/parameters/SearchBeanCount' - $ref: '#/components/parameters/SearchBeanViewtoken' responses: '200': description: Successful response content: application/json: schema: type: object properties: data: type: array items: $ref: '#/components/schemas/SubscriptionDelivery' links: $ref: '#/components/schemas/View' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' security: - OAuth2: [] /api/v1/dataimport/subscriptions/{subscriptionId}/deliveries/{deliveryId}: get: deprecated: true summary: Get a subscription delivery operationId: dataImport_getSubscriptionDelivery tags: - dataimport_subscription_delivery parameters: - $ref: '#/components/parameters/SubscriptionId' - $ref: '#/components/parameters/DeliveryId' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/SubscriptionDelivery' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' security: - OAuth2: [] /api/v1/dataimport/subscriptions/{subscriptionId}/deliveries/{deliveryId}/files: get: deprecated: true summary: List files of a subscription delivery description: > Lists all files delivered by the data provider. The file list and contents is provider-specific. operationId: dataImport_getSubscriptionDeliveryFiles tags: - dataimport_subscription_delivery parameters: - $ref: '#/components/parameters/SubscriptionId' - $ref: '#/components/parameters/DeliveryId' responses: '200': description: Successful response content: application/json: schema: items: type: string format: filename with path example: - 20211208_095127_54_2416_3B_AnalyticMS_SR_clip.tif - 20211208_095127_54_2416_metadata.json - 20211208_095127_54_2416_3B_AnalyticMS_metadata_clip.xml - 20211208_095127_54_2416_3B_udm2_clip.tif '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '409': description: Delivery status is not `DONE` security: - OAuth2: [] /api/v1/dataimport/subscriptions/{subscriptionId}/deliveries/{deliveryId}/files/{file}: get: deprecated: true summary: Retrieve a delivery file description: Download a single file delivered by the data provider. operationId: dataImport_getSubscriptionDeliveryFile tags: - dataimport_subscription_delivery parameters: - $ref: '#/components/parameters/SubscriptionId' - $ref: '#/components/parameters/DeliveryId' - $ref: '#/components/parameters/DeliveryFile' - in: header name: Range schema: type: string format: RFC 7223 description: > Optional byte range to retrieve part of a file according to [RFC 7233](https://datatracker.ietf.org/doc/html/rfc7233#section-3.1). Typically used with large files to resume interrupted downloads. example: bytes=16384-23473 responses: '200': description: Successful response content: application/octet-stream: schema: title: file contents as delivered by data provider type: string format: binary '206': description: >- Partial response in case partial retrieval was requested with the `Range` request header content: application/octet-stream: schema: title: partial file contents as delivered by data provider type: string format: binary headers: Content-Range: schema: type: string format: RFC 7223 description: > Byte range of the returned part of the file according to [RFC 7233](https://datatracker.ietf.org/doc/html/rfc7233#section-4.2). example: bytes 16384-23473/23474 '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '409': description: Delivery status is not `DONE` security: - OAuth2: [] head: deprecated: true summary: Get delivery file size operationId: dataImport_headSubscriptionDeliveryFile tags: - dataimport_subscription_delivery parameters: - $ref: '#/components/parameters/SubscriptionId' - $ref: '#/components/parameters/DeliveryId' - $ref: '#/components/parameters/DeliveryFile' responses: '200': description: Successful response headers: Content-Length: schema: type: integer description: File length in bytes '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '409': description: Delivery status is not `DONE` security: - OAuth2: [] /api/v1/dataimport/subscriptions/{subscriptionId}/deliveries/{deliveryId}/archive/create: post: deprecated: true summary: Request creation of delivery archive operationId: dataImport_postSubscriptionDeliveryArchiveCreate tags: - dataimport_subscription_delivery parameters: - $ref: '#/components/parameters/SubscriptionId' - $ref: '#/components/parameters/DeliveryId' - $ref: '#/components/parameters/DeliveryArchiveFormat' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/DeliveryArchive' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '409': description: > Delivery status is not `DONE` or archival of the same delivery in the same format has already been requested security: - OAuth2: [] /api/v1/dataimport/subscriptions/{subscriptionId}/deliveries/{deliveryId}/archive: get: deprecated: true summary: Retrieve delivery archive operationId: dataImport_getSubscriptionDeliveryArchive tags: - dataimport_subscription_delivery parameters: - $ref: '#/components/parameters/SubscriptionId' - $ref: '#/components/parameters/DeliveryId' - $ref: '#/components/parameters/DeliveryArchiveFormat' - in: header name: Range schema: type: string format: RFC 7223 description: > Optional byte range to retrieve part of the archive according to [RFC 7233](https://datatracker.ietf.org/doc/html/rfc7233#section-3.1). Typically used to resume interrupted downloads. example: bytes=16384-23473 responses: '200': description: Successful response content: application/octet-stream: schema: title: archive contents type: string format: binary '206': description: >- Partial response in case partial retrieval was requested with the `Range` request header content: application/octet-stream: schema: title: partial archive contents type: string format: binary headers: Content-Range: schema: type: string format: RFC 7223 description: > Byte range of the returned part of the archive according to [RFC 7233](https://datatracker.ietf.org/doc/html/rfc7233#section-4.2). example: bytes 16384-23473/23474 '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' security: - OAuth2: [] head: deprecated: true summary: Get size of delivery archive operationId: dataImport_headSubscriptionDeliveryArchive tags: - dataimport_subscription_delivery parameters: - $ref: '#/components/parameters/SubscriptionId' - $ref: '#/components/parameters/DeliveryId' - $ref: '#/components/parameters/DeliveryArchiveFormat' responses: '200': description: Successful response headers: Content-Length: schema: type: integer description: Archive length in bytes '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' security: - OAuth2: [] /api/v1/dataimport/subscriptions/{subscriptionId}/deliveries/{deliveryId}/archive/status: get: deprecated: true summary: Get status of delivery archive creation operationId: dataImport_getSubscriptionDeliveryArchiveStatus tags: - dataimport_subscription_delivery parameters: - $ref: '#/components/parameters/SubscriptionId' - $ref: '#/components/parameters/DeliveryId' - $ref: '#/components/parameters/DeliveryArchiveFormat' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/DeliveryArchive' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' security: - OAuth2: [] /api/v1/dataimport/subscriptions/{subscriptionId}/deliveries/{deliveryId}/tiles: get: deprecated: true summary: Get the tiles of a subscription delivery description: >- The delivery tiles correspond to BYOC tiles that were created during the ingestion of this delivery. Thus their corresponding IDs will match. While for most deliveries just one tile is created, for the largest ones there can be tens of tiles. Only tiles from last 3 months can be retrieved. operationId: dataImport_getSubscriptionTileDeliveries tags: - dataimport_subscription_tile_delivery parameters: - $ref: '#/components/parameters/SubscriptionId' - $ref: '#/components/parameters/DeliveryId' responses: '200': description: Successful response content: application/json: schema: type: object properties: data: type: array items: $ref: '#/components/schemas/DeliveryTile' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' security: - OAuth2: [] /api/v1/dataimport/subscriptions/{subscriptionId}/deliveries/{deliveryId}/tiles/{tileId}: get: deprecated: true summary: Get a subscription delivery tile. description: Only tiles from last 3 months can be retrieved. operationId: dataImport_getSubscriptionTileDelivery tags: - dataimport_subscription_tile_delivery parameters: - $ref: '#/components/parameters/SubscriptionId' - $ref: '#/components/parameters/DeliveryId' - $ref: '#/components/parameters/TileId' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/DeliveryTile' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' security: - OAuth2: [] /api/v1/dataimport/accountquotas: get: summary: Get import quotas description: Get the list of your import quotas for all providers and collections operationId: dataImport_getQuotas tags: - dataimport_quota responses: '200': description: Successful response content: application/json: schema: type: object properties: data: type: array items: $ref: '#/components/schemas/Quota' '401': $ref: '#/components/responses/401' security: - OAuth2: [] /api/v1/dataimport/accountquotas/{collectionId}: get: summary: Get import quota description: Get the import quota for the specified collection operationId: dataImport_getQuota tags: - dataimport_quota parameters: - $ref: '#/components/parameters/QuotaTpdiCollectionId' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Quota' '401': $ref: '#/components/responses/401' '404': $ref: '#/components/responses/404' security: - OAuth2: [] components: securitySchemes: OAuth2: type: oauth2 description: > ### Authentication More about the authentication here. To get an access token using curl: ``` curl --request POST \ --url https://services.sentinel-hub.com/auth/realms/main/protocol/openid-connect/token \ --header "content-type: application/x-www-form-urlencoded" \ --data "grant_type=client_credentials&client_id=&client_secret=" ``` flows: clientCredentials: tokenUrl: >- https://services.sentinel-hub.com/auth/realms/main/protocol/openid-connect/token scopes: SH: Sentinel Hub parameters: SearchBeanSearch: name: search description: >- Optional search query. Either a single word to search for or multiple words separated by the `|` (or) and `&` (and) operators. If omitted, all items are returned. in: query schema: type: string SearchBeanCount: name: count description: >- Upper limit to the number of items to retrieve. It cannot be larger than the endpoint-specific limit. If omitted, the endpoint-specific limit is used. For more records, use *viewtoken* to page through. in: query schema: type: integer format: int32 SearchBeanViewtoken: name: viewtoken description: > When the total number of items is larger than *count*, the response contains *viewtoken*. This *viewtoken* can be used in the next request to retrieve the next page of items. The next page can be retrieved by repeating the query. However, replace your URL with the next URL in the returned links object. in: query schema: type: string SearchBeanSort: name: sort description: sort in: query schema: type: string ByocCollectionId: name: collectionId in: path required: true schema: type: string format: uuid BatchRequestId: name: requestId description: Request ID in: path required: true schema: type: string format: uuid OrderId: name: orderId description: Order ID in: path required: true schema: type: string format: uuid OrderStatus: name: status description: Filter orders by status. Omit to get all orders. in: query schema: $ref: '#/components/schemas/OrderStatus' SubscriptionId: name: subscriptionId description: Subscription ID in: path required: true schema: type: string format: uuid SubscriptionStatus: name: status description: Filter subscriptions by status. Omit to get all subscriptions. in: query schema: $ref: '#/components/schemas/SubscriptionStatus' DeliveryId: name: deliveryId description: Delivery ID in: path required: true schema: type: string format: uuid TileId: name: tileId description: Tile ID in: path required: true schema: type: string format: uuid TpdiCollectionId: name: collectionId description: Collection ID in: path required: true schema: type: string enum: - PLANET_SCOPE - PLANET_SKYSAT - MAXAR_WORLDVIEW QuotaTpdiCollectionId: name: collectionId description: Collection ID in: path required: true schema: type: string enum: - MAXAR_WORLDVIEW DeliveryStatus: name: status description: Filter deliveries by status. Omit to get all deliveries. in: query schema: $ref: '#/components/schemas/DeliveryStatus' DeliveryFile: name: file description: File with full path as returned by the "List delivery files" endpoint. in: path required: true schema: type: string DeliveryArchiveFormat: name: format description: One of supported archive formats. Currently only `zip` is supported. in: query schema: $ref: '#/components/schemas/DeliveryArchiveFormat' responses: '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/RestErrorWrapper' '401': description: Unauthorized '403': description: Insufficient permissions '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/RestErrorWrapper' '409': description: Conflict in the request content: application/json: schema: $ref: '#/components/schemas/RestErrorWrapper' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/RestErrorWrapper' schemas: Boom: type: object properties: status: description: HTTP status code type: integer format: int32 reason: description: Reason for the error type: string message: description: Friendly error message type: string code: description: Code that uniquely identifies the error type: string enum: - COMMON_BAD_PAYLOAD - COMMON_NOT_FOUND - COMMON_DATABASE_ERROR - COMMON_UNIQUE_KEY_VIOLATION - COMMON_INSUFFICIENT_PERMISSIONS - COMMON_SENTINEL_ACCOUNT_EXPIRED - COMMON_METHOD_NOT_ALLOWED - COMMON_UNSUPPORTED_MEDIA_TYPE - COMMON_ELASTICSEARCH_ERROR - COMMON_UNAUTHORIZED - COMMON_EXCEPTION - RATE_LIMIT_STORAGE_TIMEOUT - RATE_LIMIT_OVERLAPPING_POLICIES - RATE_LIMIT_EXCEEDED - RATE_LIMIT_TOKEN_COUNT_EXCEEDS_CAPACITY - DASHBOARD_PAYPAL_SALE_ERROR - DASHBOARD_PAYPAL_SUBSCRIPTION_ERROR - DASHBOARD_INVALID_PAYPAL_RESPONSE - DASHBOARD_EXECUTE_SALE_ERROR - DASHBOARD_EXECUTE_AGREEMENT_ERROR - DASHBOARD_IPN_ERROR - DASHBOARD_ADYEN_SALE_ERROR - DASHBOARD_ADYEN_PAYMENT_CANCELLED - RENDERER_EXCEPTION - OAUTH_ERROR - EMAIL_OCTOPUS_ERROR errors: description: Additional information about the error (Optional) type: object RestErrorWrapper: type: object properties: error: $ref: '#/components/schemas/Boom' DatasetType: type: string enum: - sentinel-2-l1c - sentinel-2-l2a - landsat-8-l1c - landsat-ot-l1 - landsat-ot-l2 - landsat-tm-l1 - landsat-tm-l2 - dem - modis - sentinel-1-grd - s2gm - sentinel-3-olci - sentinel-3-slstr - sentinel-5p-l2 - custom Interpolator: type: string enum: - BILINEAR - BICUBIC - LANCZOS - BOX - NEAREST BaseDataset: type: object properties: type: description: Datasource abbreviation type: string id: description: Identifier type: string S2L1CDataset: title: sentinel-2-l1c type: object allOf: - $ref: '#/components/schemas/BaseDataset' - type: object properties: dataFilter: $ref: '#/components/schemas/S2L1CFiltering' processing: $ref: '#/components/schemas/S2Processing' type: type: string enum: - sentinel-2-l1c S2L2ADataset: title: sentinel-2-l2a type: object allOf: - $ref: '#/components/schemas/BaseDataset' - type: object properties: dataFilter: $ref: '#/components/schemas/S2L2AFiltering' processing: $ref: '#/components/schemas/S2Processing' type: type: string enum: - sentinel-2-l2a LandsatDataset: type: object allOf: - $ref: '#/components/schemas/BaseDataset' - type: object properties: dataFilter: $ref: '#/components/schemas/LandsatFiltering' processing: $ref: '#/components/schemas/BaseDatasetProcessing' Ls8Dataset: title: landsat-8-l1c type: object allOf: - $ref: '#/components/schemas/LandsatDataset' - type: object properties: type: type: string enum: - landsat-8-l1c dataFilter: allOf: - $ref: '#/components/schemas/LandsatFiltering' - $ref: '#/components/schemas/LandsatTierFilteringWithRt' L8L1Dataset: title: landsat-ot-l1 type: object allOf: - $ref: '#/components/schemas/LandsatDataset' - type: object properties: type: type: string enum: - landsat-ot-l1 dataFilter: allOf: - $ref: '#/components/schemas/LandsatFiltering' - $ref: '#/components/schemas/LandsatTierFilteringWithRt' L8L2Dataset: title: landsat-ot-l2 type: object allOf: - $ref: '#/components/schemas/LandsatDataset' - type: object properties: type: type: string enum: - landsat-ot-l2 dataFilter: allOf: - $ref: '#/components/schemas/LandsatFiltering' - $ref: '#/components/schemas/LandsatTierFilteringWithoutRt' LTML1Dataset: title: landsat-tm-l1 type: object allOf: - $ref: '#/components/schemas/LandsatDataset' - type: object properties: type: type: string enum: - landsat-tm-l1 dataFilter: allOf: - $ref: '#/components/schemas/LandsatFiltering' - $ref: '#/components/schemas/LandsatTierFilteringWithoutRt' LTML2Dataset: title: landsat-tm-l2 type: object allOf: - $ref: '#/components/schemas/LandsatDataset' - type: object properties: type: type: string enum: - landsat-tm-l2 dataFilter: allOf: - $ref: '#/components/schemas/LandsatFiltering' - $ref: '#/components/schemas/LandsatTierFilteringWithoutRt' LETML1Dataset: title: landsat-etm-l1 type: object allOf: - $ref: '#/components/schemas/LandsatDataset' - type: object properties: type: type: string enum: - landsat-etm-l1 dataFilter: allOf: - $ref: '#/components/schemas/LandsatFiltering' - $ref: '#/components/schemas/LandsatTierFilteringWithRt' LETML2Dataset: title: landsat-etm-l2 type: object allOf: - $ref: '#/components/schemas/LandsatDataset' - type: object properties: type: type: string enum: - landsat-etm-l2 dataFilter: allOf: - $ref: '#/components/schemas/LandsatFiltering' - $ref: '#/components/schemas/LandsatTierFilteringWithoutRt' LMSSL1Dataset: title: landsat-mss-l1 type: object allOf: - $ref: '#/components/schemas/LandsatDataset' - type: object properties: type: type: string enum: - landsat-mss-l1 dataFilter: allOf: - $ref: '#/components/schemas/LandsatFiltering' - $ref: '#/components/schemas/LandsatTierFilteringWithoutRt' ModisDataset: title: modis type: object allOf: - $ref: '#/components/schemas/BaseDataset' - type: object properties: dataFilter: $ref: '#/components/schemas/ModisFiltering' processing: $ref: '#/components/schemas/BaseDatasetProcessing' type: type: string enum: - modis DEMDataset: title: dem type: object allOf: - $ref: '#/components/schemas/BaseDataset' - type: object properties: dataFilter: $ref: '#/components/schemas/DEMFiltering' processing: $ref: '#/components/schemas/DEMProcessing' type: type: string enum: - dem S1Dataset: title: sentinel-1-grd type: object allOf: - $ref: '#/components/schemas/BaseDataset' - type: object properties: dataFilter: $ref: '#/components/schemas/S1Filtering' processing: $ref: '#/components/schemas/S1Processing' type: type: string enum: - sentinel-1-grd HLSDataset: title: hls type: object allOf: - $ref: '#/components/schemas/BaseDataset' - type: object properties: type: type: string enum: - hls dataFilter: $ref: '#/components/schemas/HLSFiltering' processing: $ref: '#/components/schemas/BaseDatasetProcessing' BYOCDataset: title: BYOC / BATCH / ZARR type: object allOf: - type: object properties: dataFilter: $ref: '#/components/schemas/BYOCFiltering' processing: $ref: '#/components/schemas/BaseDatasetProcessing' type: type: string description: > For a BYOC collection, set to "byoc-\", for example "byoc-017aa0ae-33a6-45d3-8548-0f7d1041b40c". For a BATCH collection, set to "batch-\", for example "batch-9688cd56-6c70-4221-add8-a5821d0256a9". For a ZARR collection, set to "zarr-\", for example "zarr-e2c7baec-3dfa-4523-b125-e242bdb5dd7c". - $ref: '#/components/schemas/BaseDataset' DateTimeInterval: type: object properties: from: type: string description: >- ISO-8601 time representing start of search interval, e.g. 2019-01-31T14:00:00+01:00 format: date-time to: type: string description: >- ISO-8601 time representing end of search interval, e.g. 2019-02-05T15:00:00+01:00. format: date-time Geometry: description: >- The request area of interest geometry. This and/or BBOX must be specified. Coordinates need to be in easting,northing or longitude,latitude, in that order in the CRS defined in the "bounds.properties.crs" parameter. A GeoJsonObject. type: object oneOf: - $ref: '#/components/schemas/Polygon' - $ref: '#/components/schemas/MultiPolygon' example: type: Polygon coordinates: - - - 14.000701904296873 - 46.23685258143992 - - 13.822174072265625 - 46.09037664604301 - - 14.113311767578125 - 45.85080395917834 - - 14.55963134765625 - 46.038922598236 - - 14.441528320312498 - 46.28717293114449 - - 14.17236328125 - 46.29191774991382 - - 14.000701904296873 - 46.23685258143992 Polygon: type: object properties: type: type: string enum: - Polygon coordinates: type: array items: type: array items: maxItems: 2 minItems: 2 type: array items: type: number format: double MultiPolygon: type: object properties: type: type: string enum: - MultiPolygon coordinates: type: array items: type: array items: type: array items: maxItems: 2 minItems: 2 type: array items: type: number format: double View: description: Links to paginate the resource type: object properties: currentToken: type: string nextToken: type: string previousToken: type: string '@id': type: string format: uri next: type: string format: uri previous: type: string format: uri ResourceReference: type: object properties: '@id': description: Resource URL reference type: string ObjectStorageInfo: type: object required: - s3 properties: s3: $ref: '#/components/schemas/S3BucketInfo' S3BucketInfo: type: object required: - url properties: url: type: string description: >- A URL pointing to an S3 bucket or an object in an S3 bucket. It can contain prefixes, e.g. `s3://my-personal-bucket/some-folder` or `s3://my-personal-bucket/some-folder/some-file.gpkg`. iamRoleARN: type: string description: >- IAM role ARN, which allows programmatic access to the S3 bucket specified in the `url` field using the recommended assume IAM role flow. accessKey: type: string description: >- AWS access key, which allows programmatic access to the S3 bucket specified in the `url` field. secretAccessKey: type: string description: AWS secret access key which must correspond to the AWS access key. region: type: string description: >- The region where the S3 bucket is located. If omitted, the region of the deployment that the request is submitted to is assumed. GSBucketInfo: title: GSBucketInfo type: object required: - url - credentials properties: url: type: string description: >- A URL pointing to a Google Cloud Storage bucket or an object in a GCS bucket, e.g. `gs://my-bucket/some-folder` or `gs://my-bucket/some-folder/some-file.gpkg`. credentials: type: string description: Base64-encoded service account credentials in JSON format. ObjectStorageInfoV2: type: object oneOf: - title: S3BucketInfo required: - s3 properties: s3: $ref: '#/components/schemas/S3BucketInfo' - title: GSBucketInfo x-cdse-exclude: true required: - gs properties: gs: $ref: '#/components/schemas/GSBucketInfo' BYOCFormat: type: object required: - bitDepth - sampleFormat properties: source: description: >- The string that must appear in `(BAND)` placeholder. If unset, defaults to the band name. type: string bandIndex: description: The index of band in 1-based numbering. type: integer format: int32 default: 1 bitDepth: type: integer format: int32 enum: - 8 - 16 - 32 sampleFormat: type: string enum: - UINT - INT - FLOAT noData: type: number description: >- You can define noData either per band or per collection, but not both. aliases: description: > An optional list of alias names that can be used instead of the band name in the evalscript. Only used in certain specific collections and not settable by the user. type: array items: type: string readOnly: true BYOCCollectionAdditionalData: type: object properties: bands: type: object description: Limited to 100 bands. additionalProperties: x-additionalPropertiesName: band $ref: '#/components/schemas/BYOCFormat' maxMetersPerPixel: type: number readOnly: true description: > How much meters per pixel can you request with Process/OGC/Batch requests for this collection. The limit is internally increased to 500, if it's less than that. extent: description: The collection extent in WGS84. $ref: '#/components/schemas/Polygon' readOnly: true hasSensingTimes: type: string enum: - 'YES' - PARTIALLY - 'NO' description: Information if tiles have sensing time. readOnly: true fromSensingTime: type: string format: date-time description: The sensing time in ISO 8601 of the least recent tile. readOnly: true toSensingTime: type: string format: date-time description: The sensing time in ISO 8601 of the most recent tile. readOnly: true BatchProcessRequest: required: - processRequest type: object properties: id: description: Identifier type: string format: uuid readOnly: true accountId: description: Account that submitted the request type: string format: uuid readOnly: true created: description: Creation time of the request in ISO 8601 type: string format: date-time readOnly: true processRequest: $ref: '#/components/schemas/ProcessRequestForBatch' tilingGridId: description: This parameter was moved to tilingGrid type: integer format: int64 deprecated: true tilingGrid: $ref: '#/components/schemas/TilingGridSettings' resolution: description: This parameter was moved to tilingGrid. type: number format: double deprecated: true output: $ref: '#/components/schemas/BatchProcessOutput' bucketName: description: > Simplified alternative for specifying where the results shall be written, where only the bucket name is specified. Specifying `some-bucket` as `bucketName` is equivalent to specifying `s3://some-bucket` as the `defaultTilePath` in `output`. type: string zarrOutput: $ref: '#/components/schemas/BatchZarrParameters' description: description: Optional description that can be used to keep track of requests type: string valueEstimate: description: > Estimated processing value (cost) of the request in [processing units](https://docs.planet.com/platform/processing-units/). The accuracy of the estimate depends on your request, as described in the [documentation](https://docs.sentinel-hub.com/api/latest/api/batch/#cost-estimate). type: number format: double readOnly: true tileCount: description: Number of output tiles type: integer format: int32 readOnly: true tileWidthPx: description: Tile width in pixels type: integer format: int32 readOnly: true tileHeightPx: description: Tile height in pixels type: integer format: int32 readOnly: true userAction: description: Last user action on the request type: string enum: - NONE - ANALYSE - START - CANCEL readOnly: true userActionUpdated: description: Time of last user action update in ISO 8601 type: string format: date-time readOnly: true status: description: Current processing status of the request type: string enum: - CREATED - ANALYSING - ANALYSIS_DONE - PROCESSING - DONE - PARTIAL - FAILED - CANCELED readOnly: true error: description: >- Error description for requests that were submitted but failed during analysis or processing type: string readOnly: true MultiPartBatchRequest: type: object properties: request: $ref: '#/components/schemas/BatchProcessRequest' evalscript: description: Block of JavaScript code. type: string ProcessRequestOutputBatchResponse: type: object required: - format properties: identifier: type: string description: > Response's identifier is used to connect the results of an evalscript with the output file. Each response identifier value must either match one of the values in `setup()` -> `output.id` in the evalscript (see example) or be `userdata` (see example). enum: - - userdata format: description: | Format object type: object oneOf: - $ref: '#/components/schemas/ProcessRequestOutputFormatTiff' - $ref: '#/components/schemas/ProcessRequestOutputFormatJson' - $ref: '#/components/schemas/ProcessRequestOutputFormatZarr' TilingGridSettings: required: - id - resolution description: | Tiling grid settings. type: object properties: id: description: Id of one of the supported tiling grids type: integer format: int64 resolution: description: Output resolution in units of the tiling grid type: number format: double bufferX: description: > Will expand each output tile horizontally (on the left and the right) by number of pixels specified by this value.

Example:
If bufferX is 5, the output tile will be wider by 10 pixels. Coordinates of the tile are also moved accordingly by the number of pixels multiplied by resolution in each direction. However, the `tileWidthX` property returned by the API will **not** include the buffer. type: integer format: int16 bufferY: description: > Will expand each output tile vertically (on the top and the bottom) by number of pixels specified by this value. See `bufferX` above for an example. type: integer format: int16 BatchProcessOutput: description: > Specifies the tile output paths where the results shall be written. Required unless `bucketName` or `zarrOutput` is specified. type: object properties: defaultTilePath: description: > Path or path template specifying where batch processing results shall be stored. Supported formats:
  • a valid Amazon S3 URL, e.g. `s3://some-bucket/some/folder`.
    A subdirectory will be created for this batch request, named after the request ID, and will contain further subdirectories with the output tiles. This is equivalent to the template `s3://some-bucket/some/folder///.`.
  • a templated Amazon S3 URL, e.g. `s3://some-bucket/some/folder/.tif`. Templating allows custom organization of the output files. Templates can contain the following placeholders, which are replaced by respective actual values when writing results:
    • `` - the ID of your batch request,
    • `` - the name (string ID) of the tile within the used tiling grid,
    • `` - the numerical ID of the tile within the used tiling grid,
    • `` - the output (raster) identifier (e.g. `default`),
    • `` - the filename extension of the output's format (e.g. `tiff`).
    The template must contain `` or `` in order to ensure unique output files. In case of multiple outputs, the template must also contain ``.
The request will fail if files already exist. type: string overwrite: description: > If `true`, the request will **never** fail if files already exist. Instead, any existing files will be overwritten, except if `skipExisting` is `true` and **all** outputs for a tile exist. *Note:* checking for existing files can only be done if the task is estimated to output fewer than 5000 files, e.g. a task that produces 5 outputs per tile and is estimated to span over 1000 grid tiles is too big to check. Such big tasks must either:
  • ensure that the output path is unique to the task by including `` in `defaultTilePath` and all `tilePath`s,
  • ensure that the output path is unique by using a simple, non-templated `defaultTilePath`, or
  • suppress overwrite checks by setting `overwrite` to `true` and `skipExisting` to `false`.
      • default: false type: boolean skipExisting: description: > If `true`, any tiles for which **all** outputs already exist will be skipped. Tiles for which only **some** of the outputs exist will either be *fully overwritten* (if `overwrite` is `true`) or will cause the whole request to fail. default: false type: boolean cogOutput: description: >- If `true`, the results will be written as COG (cloud optimized GeoTIFFs). All outputs must use the TIFF format and **cannot** use `sampleType` INT8. We also suggest setting the evalscript output object `nodataValue` (more details) for correct overview generation. default: false type: boolean cogParameters: $ref: '#/components/schemas/BatchCogParameters' createCollection: description: > If `true`, the results will be written as COG (cloud optimized GeoTIFFs) and a collection will be automatically created. All outputs must be single-band and use the TIFF format. Only one of *createCollection* and *collectinId* may be specified. Requires `"cogOutput"=true`. type: boolean default: false collectionId: description: > If provided, the results will be written as COG (cloud optimized GeoTIFFs) and added to the existing collection with the specified identifier. All outputs must be single-band and use the TIFF format. The collection must exist and be compatible -- that is, must contain bands equivalent to the batch request's outputs with the same bit depths. Only one of *createCollection* and *collectinId* may be specified. Requires `"cogOutput"=true`. type: - string - 'null' default: null BatchCogParameters: description: > Allows to specify COG creation parameters. When the output is a batch collection (that is, either *createCollection* is true or *collectionId* is provided), COG customization is limited: only the *resamplingAlgorithm* parameter can be specified in *cogParameters*, all others must **not** be provided. type: object properties: overviewLevels: description: >- Corresponds to the *levels* parameter of [gdaladdo](https://gdal.org/programs/gdaladdo.html). type: array items: type: integer overviewMinSize: description: > Corresponds to the *minsize* parameter of [gdaladdo](https://gdal.org/programs/gdaladdo.html). Default value minimum of blockxsize and blockysize type: integer resamplingAlgorithm: type: string enum: - nearest - average - gauss - cubic - cubicspline - lanczos - average_magphase - mode description: >- Corresponds to the value of the *-r* parameter of [gdaladdo](https://gdal.org/programs/gdaladdo.html). default: average blockxsize: description: >- Corresponds to the *BLOCKXSIZE* parameter of [GDAL GTiff raster driver](https://gdal.org/drivers/raster/gtiff.html). type: integer default: 1024 blockysize: description: >- Corresponds to the *BLOCKYSIZE* parameter of [GDAL GTiff raster driver](https://gdal.org/drivers/raster/gtiff.html). type: integer default: 1024 usePredictor: description: > Whether predictor should be used for TIFF compression. If true, the predictor "2" will be passed to [GDAL GTiff raster driver](https://gdal.org/drivers/raster/gtiff.html) in case of integer output and "3" for FLOAT32 output. If false, the value "1" (no predictor) will be used. type: boolean default: true BatchZarrParameters: description: > Specifies Zarr creation parameters. If this parameter is specified, all outputs in processRequest **must** be of the type zarr/array and neither `bucketName` nor `output` can be specified. With Zarr output **only** WGS84 and LAEA grids **are supported**. type: object required: - path - group properties: path: description: > Path or path template specifying where batch processing results shall be stored. Supported formats:
      • a valid Amazon S3 URL, e.g. `s3://some-bucket/some/folder`.
        The output Zarr will be stored to this folder (prefix). The request will fail if any files already exist in the folder.
      • a templated Amazon S3 URL, e.g. `s3://some-bucket/some/folder/`. The placeholder `` will be replaced by the ID of your batch request and the output Zarr will be stored there.
      The specified path must not contain any subfolders or Zarr files such as .zattrs, .zgroup, .zmetadata. type: string group: $ref: '#/components/schemas/Group' arrayParameters: description: > Parameters that will be used for all output arrays, except where overridden with `arrayOverrides`. Required unless `arrayOverrides` includes all required fields for all output arrays. All fields are standard Zarr fields. Further information can be found on the link below. externalDocs: description: Zarr metadata specification version 2, Attributes url: https://zarr-specs.readthedocs.io/en/latest/v2/v2.0.html#metadata allOf: - $ref: '#/components/schemas/ArrayParameters' arrayOverrides: $ref: '#/components/schemas/ArrayOverrides' Group: required: - zarr_format description: Zarr group level parameters properties: zarr_format: description: Zarr format version. Currently only version 2 is supported. example: 2 type: integer coordinates: description: Allows customization of certain output coordinate system parameters properties: origin: type: string description: | Defines the origin of the output raster/sign of resolution: * `topLeft` (default): negative resolution along the Zarr y-axis, same as for TIFF output * `bottomLeft`: positive resolution along the Zarr y-axis The resolution along the Zarr x-axis is always positive. default: topLeft enum: - topLeft - bottomLeft customAttributes: description: > User-defined metadata to store into the group's `.zattrs` file. For example, to include a copyright notice in the ouptut Zarr, you could set this field to `{"copyright": "My Company Ltd, 2023"}`. **Note**: multiple fields are added to the group attributes by default, such as "date_modified" and the geospatial extent. Listing any such field in `customAttributes` will override its default value. type: object ArrayParameters: required: - dtype - chunks - order - fill_value properties: dtype: description: > Data type/encoding. Allowed values depend on the `sampleType` defined in `evalscript`: * `|u1`: 8-bit unsigned integer, recommended for `sampleType` UINT8 and AUTO, * `|i1`: 8-bit signed integer, recommended for `sampleType` INT8, * `u2`: 16-bit unsigned integer (little and big endian, respectively), recommended for `sampleType` UINT16, allowed for UINT8 and AUTO, * `i2`: 16-bit signed integer (little and big endian, respectively), recommended for `sampleType` INT16, allowed for UINT8, INT8 and AUTO, * `f4`, `f8`: float (little/big endian single precision, little/big endian double precision, respectively), recommended for `sampleType` FLOAT32, allowed for any `sampleType`. *Recommended* values encode the chosen `sampleType` losslessly, while other allowed values encode the same values in a wider data type but do not add any more precision. example: - https://zarr-specs.readthedocs.io/en/latest/v2/v2.0.html#data-type-encoding order: description: >- Layout of values within each chunk of the array. Currently only "C" is supported, which means row-major order. type: string default: C chunks: description: > A list of integers defining the length of each dimension of a chunk of the array, e.g. `[1, 1000, 1000]`. The first element (time dimension chunking) must be 1. The second and third (latidude/y and longitude/x-dimension chunking, respectively) must evenly divide the batch output tile raster size. For example, when using the [LAEA 100km grid](https://docs.planet.com/develop/apis/batch-processing/#1-tiling-grid) with an output resolution of 50 m, each batch tile will be 2000 x 2000 pixels, thus valid chunking sizes are 2000, 1000, 500, 400 etc. example: - 1 - 1000 - 1000 type: array minItems: 3 maxItems: 3 items: type: number format: integer fill_value: type: number description: > A scalar value providing the default value for portions of the array corresponding to non-existing chunks: * any chunks consisting solely of this value will **not** be written, * the value will be included in the output Zarr metadata. **Note**: `fill_value` must be representable by the array's `dtype`. **Note**: any grid tiles that are within Zarr envelope but outside of `processRequest.input.bounds.geometry` will not be processed by batch at all. No chunks will thus be written for those tiles, thus `fill_value` is required to ensure a valid Zarr is created. compressor: description: > Compressor type and parameters, which will be used to compress the data chunks. default: id: blosc cname: lz4 clevel: 5 shuffle: 1 blocksize: 0 type: object ArrayOverrides: description: Overrides the values of `arrayParameters` for individual arrays. type: object additionalProperties: x-additionalPropertiesName: array name $ref: '#/components/schemas/ArrayOverride' ArrayOverride: type: object description: > Values for the particular output Zarr array. The array names are equal to the identifiers of the outputs/responses of the `processRequest`. allOf: - $ref: '#/components/schemas/ArrayParameters' - type: object properties: customAttributes: description: > User-defined metadata to append to the array's `.zattrs` file. For example, to include information on array's content and units, you could set this field to `{"long_name": "Chlorophyll-a concentration", "units": "milligram m-3"}` **Note**: the field "_ARRAY_DIMENSIONS" is added to the array attributes by default. Listing this field in `customAttributes` will override its default value. type: object BatchTileOrigin: description: Coordinates of the tile origin (lower left corner) in the tile's CRS. type: object properties: type: type: string enum: - Point coordinates: type: array minItems: 2 maxItems: 2 items: type: number format: double crs: type: object properties: type: type: string enum: - name properties: type: object properties: name: type: string description: CRS used by the tile, e.g. `urn:ogc:def:crs:EPSG::4326` example: urn:ogc:def:crs:EPSG::4326 TilingGridDescriptor: type: object properties: id: description: Identifier type: integer format: int64 name: type: string properties: $ref: '#/components/schemas/TilingGridDescriptorProperties' TilingGridDescriptorProperties: type: object properties: tileWidth: description: Width of each output tile, in units used by the grid type: number format: double tileHeight: description: Height of each output tile, in units used by the grid type: number format: double resolutions: description: List of supported resolutions, in units used by the grid type: array uniqueItems: true items: type: number description: List of supported resolutions, in units used by the grid format: double unit: description: Units used by the grid type: string enum: - METRE - DEGREE ProcessRequestForBatch: type: object description: >- Batch processing equivalent of the Process request. required: - evalscript - input properties: input: $ref: '#/components/schemas/ProcessRequestInput' output: $ref: '#/components/schemas/ProcessRequestOutputForBatch' evalscript: description: > Your evalscript. For details, click here. type: string ProcessRequestOutputForBatch: type: object properties: responses: type: array description: Response object. items: $ref: '#/components/schemas/ProcessRequestOutputBatchResponse' ProcessRequestInput: title: Input type: object required: - bounds - data properties: bounds: $ref: '#/components/schemas/ProcessRequestInputBounds' data: $ref: '#/components/schemas/ProcessRequestInputData' ProcessRequestInputData: description: > The collections you wish to request, along with certain processing and filtering parameters. To learn how to request and work with multiple collection, check the "Data Fusion" page in our documentation https://docs.sentinel-hub.com/api/latest/data/data-fusion/. type: array minItems: 1 items: oneOf: - $ref: '#/components/schemas/S2L1CDataset' - $ref: '#/components/schemas/S2L2ADataset' - $ref: '#/components/schemas/Ls8Dataset' - $ref: '#/components/schemas/L8L1Dataset' - $ref: '#/components/schemas/L8L2Dataset' - $ref: '#/components/schemas/LETML1Dataset' - $ref: '#/components/schemas/LETML2Dataset' - $ref: '#/components/schemas/LTML1Dataset' - $ref: '#/components/schemas/LTML2Dataset' - $ref: '#/components/schemas/LMSSL1Dataset' - $ref: '#/components/schemas/ModisDataset' - $ref: '#/components/schemas/DEMDataset' - $ref: '#/components/schemas/S1Dataset' - $ref: '#/components/schemas/HLSDataset' - $ref: '#/components/schemas/BYOCDataset' ProcessRequestInputBounds: title: Bounds description: > Defines the request bounds by specifying the bounding box and/or geometry for the request. If both are specified it will generate an image for the bounding box and render data contained within the geometry. type: object properties: bbox: description: > The request bounding box. This and/or GEOMETRY must be specified. Specify with a coordinate pair on two (opposite) vertices of the bounding box rectangle. Coordinates need to be in easting,northing or longitude, latitude, in that order in the CRS defined in the "bounds.properties.crs" parameter. type: array minItems: 4 maxItems: 4 items: type: number format: double example: - 13.822174072265625 - 45.85080395917834 - 14.55963134765625 - 46.29191774991382 geometry: $ref: '#/components/schemas/Geometry' properties: $ref: '#/components/schemas/ProcessRequestInputBoundsProperties' ProcessRequestInputBoundsProperties: title: BoundsProperties type: object properties: crs: description: > The coordinate reference system of the coordinates. Must be one of the values listed at https://docs.planet.com/develop/apis/processing/#crs-support. Default CRS is WGS84, http://www.opengis.net/def/crs/OGC/1.3/CRS84. type: string default: http://www.opengis.net/def/crs/OGC/1.3/CRS84 ProcessRequestOutput: type: object properties: width: description: > The request image width. Must be an integer between 1 and 2500.
      *Only one pair of parameters "width"/"height" or "resx"/"resy" must be set at the same time.* type: integer format: int32 minimum: 1 maximum: 2500 default: 256 example: 512 height: description: > The request image height. Must be an integer between 1 and 2500.
      *Only one pair of parameters "width"/"height" or "resx"/"resy" must be set at the same time.* type: integer format: int32 minimum: 1 maximum: 2500 default: 256 example: 512 resx: description: > Spatial resolution of the request image in a horizontal direction. Its units are defined by the CRS given in "input.bounds.properties.crs" parameter.
      *Only one pair of parameters "width"/"height" or "resx"/"resy" must be set at the same time.* type: number format: double resy: description: > Spatial resolution of the request image in a vertical direction. Its units are defined by the CRS given in "input.bounds.properties.crs" parameter.
      *Only one pair of parameters "width"/"height" or "resx"/"resy" must be set at the same time.* type: number format: double responses: type: array description: | Response object(s).
      If you request multiple responses, set the `Accept` header to `application/tar`, `application/x-tar` or `multipart/mixed`. items: $ref: '#/components/schemas/ProcessRequestOutputResponse' ProcessRequestOutputResponse: type: object properties: identifier: type: string description: > Response's identifier is used to connect the results of an evalscript with the output file. Each response identifier value must either match one of the values in `setup()` -> `output.id` in the evalscript (see example) or be `userdata` (see example). enum: - - userdata format: description: Format object (default is `image/png`). type: object oneOf: - $ref: '#/components/schemas/ProcessRequestOutputFormatPng' - $ref: '#/components/schemas/ProcessRequestOutputFormatJpeg' - $ref: '#/components/schemas/ProcessRequestOutputFormatTiff' - $ref: '#/components/schemas/ProcessRequestOutputFormatJson' ProcessRequestOutputFormat: type: object properties: type: type: string description: Output format mime-type ProcessRequestOutputFormatJpeg: title: image/jpeg type: object allOf: - $ref: '#/components/schemas/ProcessRequestOutputFormat' - type: object properties: quality: description: Quality level of JPEG compression. type: integer format: int32 minimum: 0 maximum: 100 default: 90 type: type: string enum: - image/jpeg ProcessRequestOutputFormatPng: title: image/png type: object allOf: - $ref: '#/components/schemas/ProcessRequestOutputFormat' - type: object properties: type: type: string enum: - image/png ProcessRequestOutputFormatTiff: title: image/tiff type: object allOf: - $ref: '#/components/schemas/ProcessRequestOutputFormat' - type: object properties: type: type: string enum: - image/tiff ProcessRequestOutputFormatJson: title: application/json type: object allOf: - $ref: '#/components/schemas/ProcessRequestOutputFormat' - type: object properties: type: type: string enum: - application/json ProcessRequestOutputFormatZarr: title: zarr/array type: object allOf: - $ref: '#/components/schemas/ProcessRequestOutputFormat' - type: object properties: type: type: string enum: - zarr/array BaseDatasetProcessing: type: object properties: upsampling: description: | The interpolation used when the requested resolution is higher than the source resolution. type: string enum: - NEAREST - BILINEAR - BICUBIC default: NEAREST downsampling: description: | The interpolation used when the requested resolution is lower than the source resolution. type: string enum: - NEAREST - BILINEAR - BICUBIC default: NEAREST S2Processing: type: object allOf: - $ref: '#/components/schemas/BaseDatasetProcessing' - type: object properties: harmonizeValues: description: > Harmonizes data values to be comparable with old processing baselines. See here for details. type: boolean default: true DEMProcessing: type: object allOf: - $ref: '#/components/schemas/BaseDatasetProcessing' - type: object properties: clampNegative: type: boolean default: false description: >- Mapzen DEM specific option. It replaces negative orthometric heights with 0. Useful for removing ocean bathymetry, for example. egm: type: boolean default: false description: >- It replaces orthometric heights with ellipsoidal heights relative to the WGS84 ellipsoid. S1Processing: type: object allOf: - $ref: '#/components/schemas/BaseDatasetProcessing' - type: object properties: speckleFilter: type: object oneOf: - $ref: '#/components/schemas/S1ProcessingSpeckleFilterLEE' - $ref: '#/components/schemas/S1ProcessingSpeckleFilterNONE' discriminator: propertyName: type mapping: LEE: '#/components/schemas/S1ProcessingSpeckleFilterLEE' NONE: '#/components/schemas/S1ProcessingSpeckleFilterNONE' backCoeff: type: string enum: - BETA0 - SIGMA0_ELLIPSOID - GAMMA0_ELLIPSOID - GAMMA0_TERRAIN default: GAMMA0_ELLIPSOID orthorectify: type: boolean default: false demInstance: type: string enum: - MAPZEN - COPERNICUS - COPERNICUS_30 - COPERNICUS_90 default: MAPZEN radiometricTerrainOversampling: type: number format: double minimum: 1 maximum: 4 default: 2 S1ProcessingSpeckleFilterLEE: type: object description: >- The Lee speckle filter. Note that processing time rapidly increases as window size increases. required: - type - windowSizeX - windowSizeY properties: type: type: string windowSizeX: type: integer minimum: 1 maximum: 7 description: >- The window size in the X direction of the source data. Odd values recommended. windowSizeY: type: integer minimum: 1 maximum: 7 description: >- The window size in the Y direction of the source data. Odd values recommended. S1ProcessingSpeckleFilterNONE: type: object description: >- Does NO speckle filtering. Equivalent to not having speckleFilter defined. required: - type properties: type: type: string S3SlstrProcessing: type: object allOf: - $ref: '#/components/schemas/BaseDatasetProcessing' - type: object properties: view: description: The satellite view. type: string enum: - NADIR - OBLIQUE default: NADIR S5PProcessing: type: object allOf: - $ref: '#/components/schemas/BaseDatasetProcessing' - type: object properties: minQa: description: | The minimum (inclusive) pixel quality to be displayed. For NO2, default is 75. type: integer format: int32 minimum: 0 maximum: 100 default: 50 S2L2AFiltering: type: object properties: timeRange: $ref: '#/components/schemas/TimeRange' mosaickingOrder: description: >- The order in which tiles are overlapped from which the output result is mosaicked. type: string enum: - mostRecent - leastRecent - leastCC default: mostRecent maxCloudCoverage: allOf: - $ref: '#/components/schemas/MaxCloudCoverage' - default: 100 S2L1CFiltering: allOf: - $ref: '#/components/schemas/S2L2AFiltering' LandsatFiltering: type: object properties: timeRange: $ref: '#/components/schemas/TimeRange' mosaickingOrder: description: >- The order in which tiles are overlapped from which the output result is mosaicked. type: string enum: - mostRecent - leastRecent - leastCC default: mostRecent maxCloudCoverage: allOf: - $ref: '#/components/schemas/MaxCloudCoverage' - default: 100 LandsatTierFilteringWithRt: type: object properties: tiers: type: string default: ALL_TIERS enum: - TIER_1 - TIER_1_AND_RT - ALL_TIERS LandsatTierFilteringWithoutRt: type: object properties: tiers: type: string default: ALL_TIERS enum: - TIER_1 - ALL_TIERS HLSFiltering: type: object properties: timeRange: $ref: '#/components/schemas/TimeRange' mosaickingOrder: description: >- The order in which tiles are overlapped from which the output result is mosaicked. type: string enum: - mostRecent - leastRecent - leastCC default: mostRecent maxCloudCoverage: allOf: - $ref: '#/components/schemas/MaxCloudCoverage' - default: 100 constellation: type: string description: > The selected constellation. "SENTINEL" selects only Sentinel products, while "LANDSAT" selects only Landsat products. By default, products of both constellations are selected. enum: - SENTINEL - LANDSAT ModisFiltering: type: object properties: timeRange: $ref: '#/components/schemas/TimeRange' mosaickingOrder: description: >- The order in which tiles are overlapped from which the output result is mosaicked. type: string enum: - mostRecent - leastRecent default: mostRecent S1Filtering: type: object properties: timeRange: $ref: '#/components/schemas/TimeRange' mosaickingOrder: description: >- The order in which tiles are overlapped from which the output result is mosaicked. type: string enum: - mostRecent - leastRecent default: mostRecent resolution: type: string enum: - HIGH - MEDIUM - FULL acquisitionMode: type: string enum: - SM - IW - EW - WV - EN - AN - IM polarization: type: string enum: - SH - SV - DH - DV - HH - HV - VV - VH orbitDirection: type: string enum: - ASCENDING - DESCENDING timeliness: type: string enum: - NRT10m - NRT1h - NRT3h - Fast24h - Offline - Reprocessing - ArchNormal BYOCFiltering: type: object properties: timeRange: $ref: '#/components/schemas/TimeRange' mosaickingOrder: description: >- The order in which tiles are overlapped from which the output result is mosaicked. type: string enum: - mostRecent - leastRecent default: mostRecent DEMFiltering: type: object properties: demInstance: description: Selects DEM instance. type: string enum: - MAPZEN - COPERNICUS_30 - COPERNICUS_90 default: MAPZEN TimeRange: type: object description: >- A time interval to filter data by acquisition date. It is defined by a start and end date and time, e.g. 2019-01-31T14:00:00+01:00. A date representation without time (e.g. 2019-01-31) will not work. Both the start and end of a time interval are inclusive and can be equal. properties: from: description: The start of a search interval. type: string format: date-time to: description: The end of a search interval. type: string format: date-time example: from: '2018-10-01T00:00:00.000Z' to: '2018-11-01T00:00:00.000Z' MaxCloudCoverage: description: The maximum allowable cloud coverage in percent. type: number format: double minimum: 0 maximum: 100 default: 100 StatisticalRequest: required: - input - aggregation type: object properties: input: $ref: '#/components/schemas/ProcessRequestInput' aggregation: $ref: '#/components/schemas/StatisticalRequestAggregation' calculations: $ref: '#/components/schemas/StatisticalRequestCalculations' MultiPartStatisticalRequest: type: object properties: request: $ref: '#/components/schemas/StatisticalRequest' evalscript: description: > Block of JavaScript code that will replace the evalscript property of the statistics request. type: string Aggregation: required: - of description: | Specifies how given time range is split into time intervals. type: object properties: of: description: > Duration in ISO 8601 duration format, check [here](https://docs.planet.com/develop/apis/statistical/#split-the-requested-timerange-into-multiple-time-intervals) for more details. type: string lastIntervalBehavior: description: > This parameter specifies the behavior of the last interval if the given time range isn't divisible by the provided aggregation interval. * SKIP - skip the last interval (default behavior) * SHORTEN - shortens the last interval so that it ends at the end of provided time range. * EXTEND - extends the last interval over the end of the provided time range so that all intervals are of equal duration type: string enum: - SKIP - SHORTEN - EXTEND CalculationDefinition: description: >- The name of the output (as key) for which a calculation of statistics and histogram are defined below. Each key must match with one of the `output.id` specified in a `setup()` function in an evalscript or be "default". If it is "default", the specified statistics and histogram will be calculated for all outputs for which calculation of statistics is not explicitly defined. type: object properties: histograms: description: > Histogram definitions. They can be specified differently for each band in this output. type: object additionalProperties: x-additionalPropertiesName: band name $ref: '#/components/schemas/HistogramDefinition' statistics: description: > Statistics definitions. It can be specified differently for each band in this output. type: object additionalProperties: x-additionalPropertiesName: band name $ref: '#/components/schemas/StatisticsDefinition' HistogramDefinition: description: > The name of the band (as key) for which a histogram is defined below. Each key must match with one of the band names `output.bands` specified in a `setup()` function in an evalscript (for this output) or be "default". If it is "default", the histogram specified below will be returned for all bands of this output for which histogram is not explicitly defined. Each band's histogram may be defined by providing one of the following properties: * `binWidth` * `nBins` * exact bins provided by `bins` array [This example](https://docs.planet.com/develop/apis/statistical/examples/#multiple-outputs-with-different-datamasks-multi-band-output-with-custom-bands-names-and-different-histogram-types) shows how to specify histograms using different parameters. Histograms can be calculated using float or integer math. Providing `lowEdge` and `highEdge` or `binWidth` or elements of the `bins` array as integer numbers will select integer math, otherwise float will be used. Output type of the band's output (specified in `output.sampleType` in the `setup()` function in the evalscript) must match the respective histogram math. If `lowEdge` and `highEdge` are not explicitly provided, min and max values are used, respectively. type: object properties: nBins: description: | Number of bins in the histogram. type: number binWidth: description: | Bin width. type: number lowEdge: description: > Values lower to this will not be included in any of the histogram's bins. type: number highEdge: description: > Values higher to this will not be included in any of the histogram's bins. type: number bins: description: | Explicitly defined bins. Array [v1,v2,v3,v4] will define the following bins: [v1,v2), [v2,v3), [v3,v4] type: array items: type: number minItems: 2 StatisticsDefinition: description: >- Single band statistics definition. The name of the band (as key) for which a calculation of statistic is defined below. Each key must match with one of the band names `output.bands` specified in a `setup()` function in an evalscript (for this output) or be "default". If it is "default", the statistics specified below will be calculated for all bands of this output for which calculation of statistics is not explicitly defined. type: object properties: percentiles: description: Calculate percentiles. type: object properties: k: description: > Percentiles definition as array of values between [0,1], [see this example](https://docs.planet.com/develop/apis/statistical/examples/#statistics-histogram-and-percentiles-for-one-single-band-output). type: array items: type: number format: double minimum: 0 maximum: 1 StatisticalRequestAggregationWithoutEvalscript: required: - timeRange - aggregationInterval description: > Specifies how data is aggregated and processed before statistics is calculated. `timeRange` and `aggregationInterval` combined define sampling intervals in time dimension. Width/height or resx/resy combined with `input.bounds` define a sample matrix (i.e. "image") in spatial dimension. type: object properties: timeRange: $ref: '#/components/schemas/StatisticalDateTimeInterval' aggregationInterval: $ref: '#/components/schemas/Aggregation' width: description: > Width of the sample matrix. _Only one pair of parameters "width"/"height" or "resx"/"resy" must be set at the same time._ type: integer format: int32 minimum: 1 maximum: 2500 default: 256 example: 512 height: description: > Height of the sample matrix. _Only one pair of parameters "width"/"height" or "resx"/"resy" must be set at the same time._ type: integer format: int32 minimum: 1 maximum: 2500 default: 256 example: 512 resx: description: > Spatial resolution used to calculate the width of the sample matrix from the `input.bounds`. Its units are defined by the CRS given in `input.bounds.properties.crs` parameter. _Only one pair of parameters "width"/"height" or "resx"/"resy" must be set at the same time._ type: number format: double resy: description: > Spatial resolution used to calculate the height of the sample matrix from the `input.bounds`. Its units are defined by the CRS given in `input.bounds.properties.crs` parameter. _Only one pair of parameters "width"/"height" or "resx"/"resy" must be set at the same time._ type: number format: double StatisticalDateTimeInterval: type: object required: - from - to properties: from: type: string description: >- ISO-8601 time representing start of search interval, e.g. 2019-01-31T14:00:00+01:00 format: date-time to: type: string description: >- ISO-8601 time representing end of search interval, e.g. 2019-02-05T15:00:00+01:00. format: date-time StatisticalRequestAggregation: type: object allOf: - $ref: '#/components/schemas/StatisticalRequestAggregationWithoutEvalscript' - type: object required: - evalscript properties: evalscript: description: > Your evalscript. For details, click here. The evalscript will be executed once for each time interval defined by `timeRange` and `aggregationInterval`. type: string StatisticalRequestCalculations: description: > Define which statistics and histogram to calculate. It can be specified differently for each evalscript output. If omitted only the basic statistic (min, max, mean, stDev) will be calculated. type: object additionalProperties: x-additionalPropertiesName: output name $ref: '#/components/schemas/CalculationDefinition' StatisticalResponse: description: | Statistics type: object properties: status: description: | Overall status of the request. type: string enum: - OK - PARTIAL - FAILED geometryPixelCount: description: | Number of pixels intersecting the request geometry. type: integer data: description: | Statistics for intervals, where data is available. type: array items: type: object properties: interval: description: | Interval on which, there's actual data $ref: '#/components/schemas/DateTimeInterval' outputs: description: | Per output statistics. Output names are defined in evalscript. type: object additionalProperties: x-additionalPropertiesName: output name type: object properties: bands: description: | Per band statistics and histograms. type: object additionalProperties: x-additionalPropertiesName: band name $ref: '#/components/schemas/BandStatistics' error: description: > If an error occurs when calculating statistics for a given interval it is reported here. type: object properties: type: type: string enum: - BAD_REQUEST - EXECUTION_ERROR - TIMEOUT BandStatistics: type: object description: | Per band statistics and histograms properties: histogram: description: Histogram type: object properties: overflow: description: | Number of samples above `highEdge` value type: number format: integer underflow: description: | Number of samples below `lowEdge` value type: number format: integer bins: description: | Histogram bins type: array items: type: object properties: lowEdge: description: Bin's low edge (inclusive) type: number highEdge: description: Bin's high edge (not inclusive unless last bin) type: number count: description: number of samples that fall into the bin type: number format: integer stats: type: object description: Statistics properties: min: description: minimum value type: number max: description: maximum value type: number mean: description: mean value type: number stDev: description: standard deviation type: number sampleCount: description: total number of samples type: number format: integer noDataCount: description: total number of samples without value type: number format: integer percentiles: description: | Percentile to percentile value map. type: object additionalProperties: x-additionalPropertiesName: percentile [0,1] type: number format: double QuotaTpdiCollectionId: description: Collection ID type: string readOnly: true enum: - MAXAR_WORLDVIEW NativeSearchQuery: oneOf: - $ref: '#/components/schemas/PlanetNativeSearchQuery' - $ref: '#/components/schemas/MaxarNativeSearchQuery' SearchQuery: oneOf: - $ref: '#/components/schemas/PlanetSearchQuery' - $ref: '#/components/schemas/MaxarSearchQuery' SearchResults: oneOf: - $ref: '#/components/schemas/PlanetSearchResults' - $ref: '#/components/schemas/MaxarSearchResults' SearchQueryBase: required: - provider - bounds - data properties: provider: type: string bounds: description: > Defines the request bounds by specifying the bounding box and/or geometry for the request. If both are given, a request is made for a geometry and bbox is ignored. $ref: '#/components/schemas/ProcessRequestInputBounds' data: type: array minItems: 1 maxItems: 1 items: type: object properties: dataFilter: type: object properties: timeRange: $ref: '#/components/schemas/TimeRange' maxCloudCoverage: $ref: '#/components/schemas/MaxCloudCoverage' SearchResultBase: properties: links: $ref: '#/components/schemas/View' OrderRequest: oneOf: - $ref: '#/components/schemas/PlanetOrderRequest' - $ref: '#/components/schemas/MaxarOrderRequest' Order: type: object properties: id: description: Order ID type: string format: uuid readOnly: true name: description: >- Order name. It's also used as a name for a new BYOC collection, if no collection is given in collectionId field. type: string accountId: description: Account ID type: string format: uuid readOnly: true collectionId: description: > BYOC collection ID. If given at order creation, requested data is imported into referenced collection, which must be compatible with the data being ordered - that is, must either be empty or contain the same bands as the data being ordered. If not given at order creation, a new BYOC collection is created when the order is confirmed and its ID is returned in the response from the `confirm` endpoint. type: string format: uuid status: $ref: '#/components/schemas/OrderStatus' sqkm: description: >- Total size of the order in km2 or minimum order area, whichever is greater type: number readOnly: true input: type: object description: Specification of the ordered data OrderStatus: description: Order status type: string readOnly: true enum: - CREATED - CANCELLED - RUNNING - DONE - PARTIAL - FAILED SubscriptionRequest: oneOf: - $ref: '#/components/schemas/PlanetSubscriptionRequest' Subscription: type: object properties: id: description: Subscription ID type: string format: uuid readOnly: true name: description: >- Subscription name. It's also used as a name for a new BYOC collection, if no collection is given in collectionId field. type: string accountId: description: Account ID type: string format: uuid readOnly: true collectionId: description: > BYOC collection ID. If given at subscription creation, the data is imported into referenced collection, which must be compatible with the data being subscribed - that is, must either be empty or contain the same bands as the data being subscribed. If not given at subscription creation, a new BYOC collection is created when the subscription is confirmed and its ID is returned in the response from the `confirm` endpoint. type: string format: uuid status: $ref: '#/components/schemas/SubscriptionStatus' sqkm: description: Area of the subscriptions's `input.bounds` in km2 type: number readOnly: true input: type: object description: Specification of the subscribed data SubscriptionStatus: description: Subscription status type: string readOnly: true enum: - CREATED - RUNNING - CANCELLED - COMPLETED - FAILED OrderDelivery: oneOf: - $ref: '#/components/schemas/OrderPlanetDelivery' - $ref: '#/components/schemas/OrderMaxarDelivery' SubscriptionDelivery: oneOf: - $ref: '#/components/schemas/SubscriptionPlanetDelivery' OrderDeliveryBase: type: object properties: id: description: Delivery ID type: string format: uuid sqkm: description: Size of the delivery in km2. type: number status: $ref: '#/components/schemas/DeliveryStatus' errorMessage: description: >- Error message if status = "DELIVERY_FAILED", "NON_INGESTIBLE" or "IMPORT_FAILED". type: string SubscriptionDeliveryBase: type: object properties: id: description: Delivery ID type: string format: uuid status: $ref: '#/components/schemas/DeliveryStatus' errorMessage: description: >- Error message if status = "DELIVERY_FAILED", "NON_INGESTIBLE" or "IMPORT_FAILED". type: string DeliveryStatus: description: Delivery status type: string readOnly: true enum: - WAITING - DELIVERED - DELIVERY_FAILED - PREPARING - INGESTING - DONE - IMPORT_FAILED - NON_INGESTIBLE DeliveryTile: type: object properties: id: description: Tile ID type: string format: uuid deliveryId: description: Tile ID type: string format: uuid status: $ref: '#/components/schemas/TileStatus' TileStatus: description: The status of the tile. type: string enum: - WAITING - QUEUED - INGESTING - INGESTED - FAILED readOnly: true Quota: type: object properties: collectionId: $ref: '#/components/schemas/QuotaTpdiCollectionId' quotaSqkm: type: number description: >- This is total purchased quota. Available quota is quotaSqkm - quotaUsed. readOnly: true quotaUsed: type: number description: Quota used in square kilometers. readOnly: true QuotaExceededError: allOf: - $ref: '#/components/schemas/Boom' - type: object properties: errors: type: object properties: availableQuota: type: number description: Currently available quota for the provider of the order requiredQuota: type: number description: >- Quota that would be required for successful confirmation of the order DeliveryArchiveFormat: description: One of supported archive formats. Currently only `zip` is supported. type: string default: zip enum: - zip DeliveryArchiveStatus: description: >- Status of archive creation. Only archives with status `DONE` can be downloaded. type: string enum: - WAITING - PREPARING - DONE - FAILED DeliveryArchive: type: object properties: deliveryId: type: string format: uuid format: $ref: '#/components/schemas/DeliveryArchiveFormat' requested: type: string format: date-time description: Time of archiving request in ISO 8601 status: $ref: '#/components/schemas/DeliveryArchiveStatus' size: type: integer description: >- Size of archive in bytes. Only provided for archives with status `DONE`. PlanetSearchRequestBase: deprecated: true type: object required: - provider properties: provider: description: Specify this value to use data provider Planet. type: string enum: - PLANET planetApiKey: description: > Your Planet API key. Get one from Planet https://www.planet.com. It is required unless you purchased your Planet data plan through Sentinel Hub, in which case it is optional and will filter search results based on the permissions of the key. type: string PlanetOrderRequestBase: deprecated: true type: object required: - provider - planetApiKey properties: provider: description: Specify this value to use data provider Planet. type: string enum: - PLANET planetApiKey: description: Your Planet API key. Get one from Planet https://www.planet.com. type: string PlanetNativeSearchQuery: deprecated: true allOf: - $ref: '#/components/schemas/PlanetSearchRequestBase' - type: object example: provider: PLANET item_types: - PSScene filter: type: AndFilter config: - type: GeometryFilter field_name: geometry config: type: Polygon coordinates: - - - 15.786 - 46.7008 - - 15.786 - 46.7234 - - 15.8473 - 46.7234 - - 15.8473 - 46.7008 - - 15.786 - 46.7008 - type: DateRangeFilter field_name: acquired config: gte: '2019-04-27T00:00:00.000Z' lte: '2019-04-30T00:00:00.000Z' - type: RangeFilter field_name: cloud_cover config: lte: 0.3 additionalProperties: externalDocs: description: Fields from Request body of Planet Quick search. url: >- https://developers.planet.com/docs/apis/data/reference/#tag/Item-Search/operation/QuickSearch PlanetSearchQuery: deprecated: true allOf: - $ref: '#/components/schemas/PlanetSearchRequestBase' - $ref: '#/components/schemas/SearchQueryBase' - type: object properties: data: type: array minItems: 1 maxItems: 1 items: type: object required: - itemType - productBundle properties: type: type: string enum: - catalog default: catalog description: | Use `catalog` for PlanetScope and SkySat data. itemType: type: string enum: - PSScene - SkySatCollect description: > The item type of data to search for or order: * Use [PSScene](https://developers.planet.com/docs/data/psscene/) to order PlanetScope data. [PSScene4Band](https://developers.planet.com/docs/data/psscene4band/) is deprecated and cannot be ordered since November 1st 2022. * Use [SkySatCollect](https://developers.planet.com/docs/data/skysatcollect/) to order SkySat archive data. externalDocs: description: Item Types Documentation url: >- https://developers.planet.com/docs/apis/data/items-assets/#item-types productBundle: type: string enum: - analytic_udm2 - analytic_sr_udm2 - analytic_8b_udm2 - analytic_8b_sr_udm2 - analytic - analytic_sr - panchromatic description: > When ordering, selects the product bundle (that is, the group of assets) to order. When searching, limits search to products available as the specified product bundle. Supported values depend on item type: * for `PSScene`, the product bundles containing "*udm2*" are supported, * for `SkySatCollect`, `analytic_udm2`, `analytic_sr_udm2` and `panchromatic` are supported. Other values used by Planet but not listed here are not supported. externalDocs: description: Product Bundles Reference url: >- https://developers.planet.com/apis/orders/product-bundles-reference/ dataFilter: type: object properties: nativeFilter: type: object description: Planet Data API search filters externalDocs: description: >- Link to the Planet documentation page about search filters. url: >- https://developers.planet.com/docs/data/searches-filtering/#search-filters example: type: RangeFilter field_name: snow_ice_percent config: gte: 10 PlanetSearchResults: deprecated: true allOf: - $ref: '#/components/schemas/SearchResultBase' - type: object properties: features: type: array externalDocs: description: Search results as returned by Planet Quick search url: >- https://developers.planet.com/docs/apis/data/reference/#tag/Item-Search/operation/QuickSearch : description: >- Other fields returned by Planet Quick search may be included in the response. PlanetOrderRequest: deprecated: true allOf: - $ref: '#/components/schemas/Order' - type: object required: - input properties: input: allOf: - $ref: '#/components/schemas/PlanetOrderRequestBase' - $ref: '#/components/schemas/PlanetSearchQuery' - type: object properties: data: type: array description: > To order specific Planet items, list their IDs in itemIds field. Otherwise, provide search criteria in the dataFilter field to order all items matching the criteria. Omitting both will order all items within the specified bounds. In both cases, at most 500 items can be ordered at once, i.e. orders listing too many item IDs will fail, as will search-based orders that match too many items. Instead of larger search-based orders we recommend to use subscriptions. items: type: object required: - harmonizeTo properties: harmonizeTo: type: string enum: - NONE - Sentinel-2 description: > Sensing instrument whose values the data should be harmonized to. Supported values: * `NONE` to disable harmonization, * `Sentinel-2` only for *PSScene* item type and surface reflectance product bundles, externalDocs: description: Details on PlanetScope instruments url: https://developers.planet.com/docs/data/sensors/ itemIds: type: array minItems: 1 maxItems: 250 description: > List of itemIds to order, if dataFilter is not provided. The itemId list is typically obtained from a previous search request. items: type: string PlanetSubscriptionRequest: deprecated: true allOf: - $ref: '#/components/schemas/Subscription' - type: object required: - input properties: input: type: object required: - provider - bounds - data - planetApiKey properties: provider: description: Specify this value to use data provider Planet. type: string enum: - PLANET planetApiKey: description: >- Your Planet API key. Get one from Planet https://www.planet.com. type: string bounds: description: > Defines the bounds of the subscribed area by specifying a bounding box and/or a geometry. If both are given, the subscription will use the geometry and the bbox is ignored. $ref: '#/components/schemas/ProcessRequestInputBounds' data: type: array minItems: 1 maxItems: 1 description: | Specification of the data to subscribe to. items: $ref: '#/components/schemas/PlanetSubscriptionDataSpec' PlanetSubscriptionDataSpec: deprecated: true oneOf: - $ref: '#/components/schemas/PSSceneDataSpec' - $ref: '#/components/schemas/PlanetaryVariableDataSpec' - $ref: '#/components/schemas/AnalysisReadyPlanetScopeDataSpec' PlanetSubscriptionDataFilterBase: deprecated: true type: object required: - timeRange description: > Selection criteria for the data the subscription should cover. At the minimum, `timeRange.from` must be included because subscriptions must have a start time. properties: timeRange: allOf: - $ref: '#/components/schemas/TimeRange' - required: - from - description: > A time interval to filter data by the **publish** date (in contrast to orders, where the data is filtered by the acquisition date). It is defined by a start and end date and time, e.g. 2019-01-31T14:00:00+01:00. A date representation without time (e.g. 2019-01-31) will not work. Both the start and end of a time interval are inclusive and can be equal. PSSceneDataSpec: deprecated: true type: object required: - dataFilter - itemType - productBundle - harmonizeTo properties: dataFilter: allOf: - $ref: '#/components/schemas/PlanetSubscriptionDataFilterBase' - type: object properties: maxCloudCoverage: $ref: '#/components/schemas/MaxCloudCoverage' nativeFilter: type: object description: | Planet Data API search filters externalDocs: description: >- Link to the Planet documentation page about search filters. url: >- https://developers.planet.com/docs/data/searches-filtering/#search-filters example: type: RangeFilter field_name: snow_ice_percent config: gte: 10 type: type: string enum: - catalog default: catalog description: | Use `catalog` to subscribe to PlanetScope data. itemType: type: string enum: - PSScene description: > The item type to subscribe to. Only [PSScene](https://developers.planet.com/docs/data/psscene/) is supported. Subscribing to [PSScene4Band](https://developers.planet.com/docs/data/psscene4band/) data is not possible since November 1st 2022. externalDocs: description: Item Types Documentation url: >- https://developers.planet.com/docs/apis/data/items-assets/#item-types productBundle: type: string enum: - analytic_udm2 - analytic_sr_udm2 - analytic_8b_udm2 - analytic_8b_sr_udm2 description: | The product bundle to subscribe to. externalDocs: description: Product Bundles Reference url: >- https://developers.planet.com/docs/orders/product-bundles-reference/ harmonizeTo: type: string enum: - NONE - Sentinel-2 description: > Sensing instrument whose values the data should be harmonized to, or `NONE` to disable harmonization. externalDocs: description: Details on PlanetScope instruments url: https://developers.planet.com/docs/data/sensors/ PlanetaryVariableDataSpec: deprecated: true type: object required: - dataFilter - type - id properties: dataFilter: allOf: - $ref: '#/components/schemas/PlanetSubscriptionDataFilterBase' type: type: string enum: - soil_water_content - biomass_proxy - land_surface_temperature - forest_carbon_diligence_30m - forest_carbon_monitoring_3m description: The Planetary Variable Type to subscribe to. externalDocs: description: Plantery Variables types and IDs url: >- https://developers.planet.com/docs/subscriptions/pvs-subs/#planetary-variables-types-and-ids id: type: string enum: - SWC-AMSR2-C_V1.0_100 - SWC-AMSR2-X_V1.0_100 - SWC-SMAP-L_V1.0_100 - SWC-AMSR2-C_V2.0_100 - SWC-AMSR2-X_V2.0_100 - SWC-SMAP-L_V2.0_100 - SWC-AMSRE-C_V4.0_1000 - SWC-AMSRE-X_V4.0_1000 - SWC-AMSR2-C_V4.0_1000 - SWC-AMSR2-X_V4.0_1000 - SWC-SMAP-L_V4.0_1000 - SWC-AMSRE-C_V5.0_1000 - SWC-AMSRE-X_V5.0_1000 - SWC-AMSR2-C_V5.0_1000 - SWC-AMSR2-X_V5.0_1000 - SWC-SMAP-L_V5.0_1000 - BIOMASS-PROXY_V3.0_10 - BIOMASS-PROXY_V4.0_10 - LST-AMSR2_V1.0_100 - LST-AMSRE_V1.0_1000 - LST-AMSR2_V1.0_1000 - CANOPY_HEIGHT_v1.1.0_30 - CANOPY_COVER_v1.1.0_30 - ABOVEGROUND_CARBON_DENSITY_v1.1.0_30 - CANOPY_HEIGHT_v1.2.0_30 - CANOPY_COVER_v1.2.0_30 - ABOVEGROUND_CARBON_DENSITY_v1.2.0_30 - CANOPY_HEIGHT_v1.0.0_3 - CANOPY_COVER_v1.0.0_3 - ABOVEGROUND_CARBON_DENSITY_v1.0.0_3 description: > The ID of the Planetary Variable to subscribe to. Note that each `id` value is only allowed with one corresponding `type` value. externalDocs: description: Allowed type/id combinations url: >- https://developers.planet.com/docs/subscriptions/pvs-subs/#planetary-variables-types-and-ids AnalysisReadyPlanetScopeDataSpec: deprecated: true type: object required: - dataFilter - type - id properties: dataFilter: allOf: - $ref: '#/components/schemas/PlanetSubscriptionDataFilterBase' type: type: string enum: - analysis_ready_ps description: The Analysis Ready Type to subscribe to. id: type: string enum: - PS_ARD_SR_DAILY description: | The ID of the Analysis Ready type to subscribe to. externalDocs: description: Analysis Ready IDs url: >- https://developers.planet.com/docs/data/analysis-ready-ps/#available-ids PlanetDeliveryProvider: deprecated: true type: object properties: provider: description: Provider of the delivery type: string enum: - PLANET OrderPlanetDelivery: allOf: - $ref: '#/components/schemas/PlanetDeliveryProvider' - $ref: '#/components/schemas/OrderDeliveryBase' - type: object properties: itemId: description: Planet's Item ID for PlanetScope and SkySat deliveries. type: string SubscriptionPlanetDelivery: allOf: - $ref: '#/components/schemas/PlanetDeliveryProvider' - $ref: '#/components/schemas/SubscriptionDeliveryBase' - type: object properties: itemId: description: Planet's item ID for PlanetScope and SkySat deliveries. type: string MaxarRequestBase: type: object required: - provider properties: provider: description: Specify this value to use data provider Maxar. type: string enum: - MAXAR MaxarDeliveryProvider: type: object properties: provider: description: Provider of the delivery type: string enum: - MAXAR MaxarNativeSearchQuery: allOf: - $ref: '#/components/schemas/MaxarRequestBase' - type: object example: provider: MAXAR startDate: '2020-11-06T00:00:00.0Z' endDate: '2020-11-06T23:59:59.0Z' sensor: WV03 aoiInGeoJson: type: Polygon coordinates: - - - 15.81 - 46.7 - - 15.84 - 46.7 - - 15.84 - 46.72 - - 15.81 - 46.72 - - 15.81 - 46.7 crs: type: name properties: name: EPSG:4326 additionalProperties: description: Fields from request body of MAXAR search. MaxarSearchQuery: allOf: - $ref: '#/components/schemas/MaxarRequestBase' - $ref: '#/components/schemas/SearchQueryBase' - type: object properties: data: type: array minItems: 1 maxItems: 1 items: type: object required: - productBands properties: productBands: type: string description: | Band Bundle enum: - 4BB dataFilter: type: object properties: minOffNadir: $ref: '#/components/schemas/MaxarMinOffNadir' maxOffNadir: $ref: '#/components/schemas/MaxarMaxOffNadir' minSunElevation: $ref: '#/components/schemas/MaxarMinSunElevation' maxSunElevation: $ref: '#/components/schemas/MaxarMaxSunElevation' sensor: $ref: '#/components/schemas/MaxarSensor' MaxarMinOffNadir: type: number format: int minimum: 0 maximum: 45 default: 0 MaxarMaxOffNadir: type: number format: int minimum: 0 maximum: 45 default: 45 MaxarMinSunElevation: description: The minimum allowable sun elevation in degrees type: number format: int minimum: 0 maximum: 90 default: 0 MaxarMaxSunElevation: description: The maximum allowable sun elevation in degrees type: number format: int minimum: 0 maximum: 90 default: 90 MaxarSensor: description: > If specified, limits search results to a single sensor (satellite). Results are also filtered to include only sensors that support the requested `productBands`. Thus, if a sensor that does not support all bands is specified, no results will be returned. type: string enum: - WV01 - WV02 - WV03 - WV04 - GE01 MaxarSearchResults: properties: features: type: array description: > Search results as returned by MAXAR search. Note thate MAXAR search does not support paging. Thus, the `count` and `viewtoken` query parameters are ignored and a plain list of results is returned. MaxarOrderRequest: allOf: - $ref: '#/components/schemas/Order' - type: object required: - input properties: input: allOf: - $ref: '#/components/schemas/MaxarSearchQuery' - type: object properties: data: type: array description: > To order specific MAXAR products, list them in the `selectedImages` field. Otherwise, provide search criteria in the dataFilter field to order all items matching the criteria. In both cases, at most 10 products can be ordered at once, i.e. orders listing too many product IDs will fail, as will search-based orders that match too many products. Minimum order of 5 km^2 applies to each product, i.e. if the intersection of order's bounds and products's bounds is smaller, the order will fail. items: type: object properties: productKernel: type: string default: CC enum: - CC - NN - MTF description: > Selects the resampling kernel to use: 4x4 cubic convolution (CC), nearest neighbour (NN), or the proprietary MTF kernel (MTF). selectedImages: type: array minItems: 1 maxItems: 10 description: > Only provide this field when ordering specific MAXAR products -- leave out when ordering via search criteria. items: type: string description: The ID of product (strip) to order OrderMaxarDelivery: allOf: - $ref: '#/components/schemas/MaxarDeliveryProvider' - $ref: '#/components/schemas/OrderDeliveryBase' - type: object properties: selectedImages: description: MAXAR product IDs. type: array minItems: 1 items: type: string x-tagGroups: - name: TPDI tags: - dataimport_search - dataimport_product - dataimport_order - dataimport_delivery - dataimport_tile_delivery - dataimport_subscription - dataimport_subscription_delivery - dataimport_subscription_tile_delivery - dataimport_quota