OrdersAPI
Wrapper class for interacting with the Planet Orders API. Provides methods for creating, managing, and downloading orders.
See the Planet Orders API documentation for more details: https://developers.planet.com/docs/apis/orders/
Example usage
from cast_planet import OrdersApi
orders = OrdersApi(api_key='your api key here')
API reference
OrdersApi
- class cast_planet.OrdersApi(api_key, base_url='https://api.planet.com/compute/ops', log_filename=None)
A wrapper for interfacing with the Orders API
- Parameters:
api_key (
str) – The planet API key for your subscription.base_url (
str) – ase_url: The base URL of the Planet Data API (default: ‘https://api.planet.com/data/v1’)logging_filepath – If supplied, class will log to file.
log_level – If supplied, sets the log level for the class. Default logging level is logging.ERROR.
- cancel_order(order_id)
Cancels an existing order.
- Parameters:
order_id (
Union[UUID,str]) – The ID of the order to cancel.- Return type:
- Returns:
The updated order details after cancellation.
- create_order(order_information)
Creates a new order with the provided information.
- Parameters:
order_information (
CreateOrder) – The data required to create the order.- Return type:
- Returns:
Details of the newly created order.
- download_order_results(order, folder=None)
Download the results of an order and save them to the specified folder using the download_file helper.
- Parameters:
order (
Union[UUID,str,OrderDetails]) – The order whose results to download. Can be an ID, UUID, or OrderDetails object.folder (
Optional[str]) – The folder to save the downloaded files.
- Return type:
List[str]- Returns:
A list of file paths to the downloaded results.
- get_order_details_by_id(order_id)
Retrieves the details of a specific order by ID.
- Parameters:
order_id (
Union[UUID,str]) – The unique identifier of the order.- Return type:
- Returns:
Details of the specified order.
- list_all_account_orders(state=None, source_type=None)
Retrieves a list of all orders with optional filters.
- Parameters:
state (
Optional[OrderState]) – Filter by the state of the orders (optional).source_type (
Optional[OrderSource]) – Filter by the source type of the orders (optional).
- Return type:
List[OrderDetails]- Returns:
A list of order details.
- order_stats()
Retrieves statistics about the current orders.
- Return type:
- Returns:
Statistics on queued and running orders.
- view_api_spec()
Retrieves the OpenAPI specification for the Orders API.
- Return type:
Dict[str,Any]- Returns:
A dictionary representing the API spec.
Models
- pydantic model cast_planet.orders.models.ActiveOrderStats
Show JSON schema
{ "title": "ActiveOrderStats", "type": "object", "properties": { "queued_orders": { "title": "Queued Orders", "type": "integer" }, "running_orders": { "title": "Running Orders", "type": "integer" } }, "required": [ "queued_orders", "running_orders" ] }
- Fields:
queued_orders (int)running_orders (int)
-
field queued_orders:
int[Required]
-
field running_orders:
int[Required]
- pydantic model cast_planet.orders.models.Amazons3
Show JSON schema
{ "title": "Amazons3", "type": "object", "properties": { "bucket": { "title": "Bucket", "type": "string" }, "aws_region": { "title": "Aws Region", "type": "string" }, "aws_access_key_id": { "title": "Aws Access Key Id", "type": "string" }, "aws_secret_access_key": { "title": "Aws Secret Access Key", "type": "string" }, "path_prefix": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Path Prefix" } }, "required": [ "bucket", "aws_region", "aws_access_key_id", "aws_secret_access_key" ] }
- Fields:
aws_access_key_id (str)aws_region (str)aws_secret_access_key (str)bucket (str)path_prefix (str | None)
-
field aws_access_key_id:
str[Required]
-
field aws_region:
str[Required]
-
field aws_secret_access_key:
str[Required]
-
field bucket:
str[Required]
-
field path_prefix:
Optional[str] = None
- pydantic model cast_planet.orders.models.AzureBlobStorage
Show JSON schema
{ "title": "AzureBlobStorage", "type": "object", "properties": { "account": { "title": "Account", "type": "string" }, "container": { "title": "Container", "type": "string" }, "sas_token": { "title": "Sas Token", "type": "string" }, "storage_endpoint_suffix": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Storage Endpoint Suffix" }, "path_prefix": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Path Prefix" } }, "required": [ "account", "container", "sas_token" ] }
- Fields:
account (str)container (str)path_prefix (str | None)sas_token (str)storage_endpoint_suffix (str | None)
-
field account:
str[Required]
-
field container:
str[Required]
-
field path_prefix:
Optional[str] = None
-
field sas_token:
str[Required]
-
field storage_endpoint_suffix:
Optional[str] = None
- pydantic model cast_planet.orders.models.BandMathObject
See https://developers.planet.com/apis/orders/tools/#band-math and https://developers.planet.com/apis/orders/bandmath-numpy-routines/ to learn more.
Show JSON schema
{ "title": "BandMathObject", "description": "See https://developers.planet.com/apis/orders/tools/#band-math and\nhttps://developers.planet.com/apis/orders/bandmath-numpy-routines/ to learn more.", "type": "object", "properties": { "b1": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "B1" }, "b2": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "B2" }, "b3": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "B3" }, "b4": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "B4" }, "b5": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "B5" }, "b6": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "B6" }, "b7": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "B7" }, "b8": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "B8" }, "b9": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "B9" }, "b10": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "B10" }, "b11": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "B11" }, "b12": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "B12" }, "b13": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "B13" }, "b14": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "B14" }, "b15": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "B15" }, "expression": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Expression" }, "pixel_type": { "anyOf": [ { "$ref": "#/$defs/PixelType" }, { "type": "null" } ], "default": null } }, "$defs": { "PixelType": { "enum": [ "8U", "16U", "16S", "32R" ], "title": "PixelType", "type": "string" } } }
- Fields:
b1 (str | None)b10 (str | None)b11 (str | None)b12 (str | None)b13 (str | None)b14 (str | None)b15 (str | None)b2 (str | None)b3 (str | None)b4 (str | None)b5 (str | None)b6 (str | None)b7 (str | None)b8 (str | None)b9 (str | None)expression (str | None)pixel_type (cast_planet.orders.models.tools.PixelType | None)
-
field b1:
Optional[str] = None
-
field b10:
Optional[str] = None
-
field b11:
Optional[str] = None
-
field b12:
Optional[str] = None
-
field b13:
Optional[str] = None
-
field b14:
Optional[str] = None
-
field b15:
Optional[str] = None
-
field b2:
Optional[str] = None
-
field b3:
Optional[str] = None
-
field b4:
Optional[str] = None
-
field b5:
Optional[str] = None
-
field b6:
Optional[str] = None
-
field b7:
Optional[str] = None
-
field b8:
Optional[str] = None
-
field b9:
Optional[str] = None
-
field expression:
Optional[str] = None
- pydantic model cast_planet.orders.models.BaseMapsGeometrySource
Show JSON schema
{ "title": "BaseMapsGeometrySource", "type": "object", "properties": { "mosaic_name": { "description": "Name of mosaic", "title": "Mosaic Name", "type": "string" }, "geometry": { "anyOf": [ { "$ref": "#/$defs/PointModel" }, { "$ref": "#/$defs/PolygonModel" }, { "$ref": "#/$defs/MultiPolygonModel" }, { "type": "null" } ], "default": null, "description": "GeoJSON object.", "title": "Geometry" } }, "$defs": { "Coordinates": { "maxItems": 2, "minItems": 2, "prefixItems": [ { "anyOf": [ { "type": "number" }, { "type": "integer" } ], "ge": -180, "le": 180, "title": "Lon" }, { "anyOf": [ { "type": "number" }, { "type": "integer" } ], "ge": -90, "le": 90, "title": "Lat" } ], "type": "array" }, "MultiPolygonModel": { "properties": { "type": { "default": "MultiPolygon", "title": "Multi Polygon", "type": "string" }, "coordinates": { "items": { "items": { "items": { "$ref": "#/$defs/Coordinates" }, "type": "array" }, "type": "array" }, "title": "Coordinates", "type": "array" } }, "required": [ "coordinates" ], "title": "MultiPolygonModel", "type": "object" }, "PointModel": { "properties": { "type": { "default": "Point", "title": "Point", "type": "string" }, "coordinates": { "$ref": "#/$defs/Coordinates" } }, "required": [ "coordinates" ], "title": "PointModel", "type": "object" }, "PolygonModel": { "properties": { "type": { "default": "Polygon", "title": "Polygon", "type": "string" }, "coordinates": { "items": { "items": { "$ref": "#/$defs/Coordinates" }, "type": "array" }, "title": "Coordinates", "type": "array" } }, "required": [ "coordinates" ], "title": "PolygonModel", "type": "object" } }, "required": [ "mosaic_name" ] }
- Fields:
geometry (pydantic_geojson.point.PointModel | pydantic_geojson.polygon.PolygonModel | pydantic_geojson.multi_polygon.MultiPolygonModel | None)mosaic_name (str)
-
field geometry:
Union[PointModel,PolygonModel,MultiPolygonModel,None] = None GeoJSON object.
-
field mosaic_name:
str[Required] Name of mosaic
- pydantic model cast_planet.orders.models.BaseMapsQuadIdSource
Show JSON schema
{ "title": "BaseMapsQuadIdSource", "type": "object", "properties": { "mosaic_name": { "description": "Name of mosaic", "title": "Mosaic Name", "type": "string" }, "quad_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": [], "description": "List of quad ids.", "title": "Quad Ids" } }, "required": [ "mosaic_name" ] }
- Fields:
mosaic_name (str)quad_ids (List[str] | None)
-
field mosaic_name:
str[Required] Name of mosaic
-
field quad_ids:
Optional[List[str]] = [] List of quad ids.
- pydantic model cast_planet.orders.models.BasemapClipObject
Show JSON schema
{ "title": "BasemapClipObject", "type": "object", "properties": { "clip": { "default": {}, "title": "Clip", "type": "object" } } }
- Fields:
clip (Dict)
-
field clip:
Dict= {}
- pydantic model cast_planet.orders.models.CloudFilterObject
Show JSON schema
{ "title": "CloudFilterObject", "type": "object", "properties": { "clear_min": { "title": "Clear Min", "type": "number" }, "cloud_max": { "title": "Cloud Max", "type": "number" } }, "required": [ "clear_min", "cloud_max" ] }
- Fields:
clear_min (float)cloud_max (float)
-
field clear_min:
float[Required]
-
field cloud_max:
float[Required]
- pydantic model cast_planet.orders.models.CoRegisterObject
Show JSON schema
{ "title": "CoRegisterObject", "type": "object", "properties": { "anchor_item": { "title": "Anchor Item", "type": "string" } }, "required": [ "anchor_item" ] }
- Fields:
anchor_item (str)
-
field anchor_item:
str[Required]
- class cast_planet.orders.models.CompositeGroup(value)
An enumeration.
- pydantic model cast_planet.orders.models.CompositeObject
Show JSON schema
{ "title": "CompositeObject", "type": "object", "properties": { "group_by": { "anyOf": [ { "$ref": "#/$defs/CompositeGroup" }, { "type": "null" } ], "default": null } }, "$defs": { "CompositeGroup": { "enum": [ "order", "strip_id" ], "title": "CompositeGroup", "type": "string" } } }
- Fields:
group_by (cast_planet.orders.models.tools.CompositeGroup | None)
-
field group_by:
Optional[CompositeGroup] = None
- pydantic model cast_planet.orders.models.CouldHaveHosting
Show JSON schema
{ "title": "CouldHaveHosting", "type": "object", "properties": { "hosting": { "anyOf": [ { "$ref": "#/$defs/OrderHosting" }, { "type": "null" } ], "default": null } }, "$defs": { "OrderHosting": { "properties": { "sentinel_hub": { "$ref": "#/$defs/SentinelHubHosting" } }, "required": [ "sentinel_hub" ], "title": "OrderHosting", "type": "object" }, "SentinelHubHosting": { "description": "Before using, you must follow the steps in this article: Linking Planet User to Sentinel Hub User.\nhttps://support.planet.com/hc/en-us/articles/16417885928221-Linking-Planet-User-to-Sentinel-Hub-User\n\nCollections can be found on the Sentinel Hub Dashboard.\nhttps://apps.sentinel-hub.com/dashboard/#/collections", "properties": { "collection_id": { "description": "A Sentinel Hub BYOC collection to deliver to. If omitted, a new collection will be created for you and returned in the response", "format": "uuid", "title": "Collection Id", "type": "string" } }, "required": [ "collection_id" ], "title": "SentinelHubHosting", "type": "object" } } }
- Fields:
hosting (cast_planet.orders.models.order_hosting.OrderHosting | None)
-
field hosting:
Optional[OrderHosting] = None
- pydantic model cast_planet.orders.models.CouldHaveOrderProducts
Show JSON schema
{ "title": "CouldHaveOrderProducts", "type": "object", "properties": { "products": { "anyOf": [ { "items": { "anyOf": [ { "$ref": "#/$defs/SceneSource" }, { "$ref": "#/$defs/BaseMapsGeometrySource" }, { "$ref": "#/$defs/BaseMapsQuadIdSource" } ] }, "type": "array" }, { "type": "null" } ], "default": null, "description": "The products from the Data or Basemaps API to order.", "title": "Products" } }, "$defs": { "BaseMapsGeometrySource": { "properties": { "mosaic_name": { "description": "Name of mosaic", "title": "Mosaic Name", "type": "string" }, "geometry": { "anyOf": [ { "$ref": "#/$defs/PointModel" }, { "$ref": "#/$defs/PolygonModel" }, { "$ref": "#/$defs/MultiPolygonModel" }, { "type": "null" } ], "default": null, "description": "GeoJSON object.", "title": "Geometry" } }, "required": [ "mosaic_name" ], "title": "BaseMapsGeometrySource", "type": "object" }, "BaseMapsQuadIdSource": { "properties": { "mosaic_name": { "description": "Name of mosaic", "title": "Mosaic Name", "type": "string" }, "quad_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": [], "description": "List of quad ids.", "title": "Quad Ids" } }, "required": [ "mosaic_name" ], "title": "BaseMapsQuadIdSource", "type": "object" }, "Coordinates": { "maxItems": 2, "minItems": 2, "prefixItems": [ { "anyOf": [ { "type": "number" }, { "type": "integer" } ], "ge": -180, "le": 180, "title": "Lon" }, { "anyOf": [ { "type": "number" }, { "type": "integer" } ], "ge": -90, "le": 90, "title": "Lat" } ], "type": "array" }, "MultiPolygonModel": { "properties": { "type": { "default": "MultiPolygon", "title": "Multi Polygon", "type": "string" }, "coordinates": { "items": { "items": { "items": { "$ref": "#/$defs/Coordinates" }, "type": "array" }, "type": "array" }, "title": "Coordinates", "type": "array" } }, "required": [ "coordinates" ], "title": "MultiPolygonModel", "type": "object" }, "PointModel": { "properties": { "type": { "default": "Point", "title": "Point", "type": "string" }, "coordinates": { "$ref": "#/$defs/Coordinates" } }, "required": [ "coordinates" ], "title": "PointModel", "type": "object" }, "PolygonModel": { "properties": { "type": { "default": "Polygon", "title": "Polygon", "type": "string" }, "coordinates": { "items": { "items": { "$ref": "#/$defs/Coordinates" }, "type": "array" }, "title": "Coordinates", "type": "array" } }, "required": [ "coordinates" ], "title": "PolygonModel", "type": "object" }, "SceneSource": { "properties": { "item_ids": { "description": "Array of item ids.", "items": { "type": "string" }, "title": "Item Ids", "type": "array" }, "item_type": { "description": "item-type for requested item_id.", "title": "Item Type", "type": "string" }, "product_bundle": { "description": "asset-type for the item.", "title": "Product Bundle", "type": "string" } }, "required": [ "item_ids", "item_type", "product_bundle" ], "title": "SceneSource", "type": "object" } } }
- Fields:
products (List[cast_planet.orders.models.order_products.SceneSource | cast_planet.orders.models.order_products.BaseMapsGeometrySource | cast_planet.orders.models.order_products.BaseMapsQuadIdSource] | None)
-
field products:
Optional[List[Union[SceneSource,BaseMapsGeometrySource,BaseMapsQuadIdSource]]] = None The products from the Data or Basemaps API to order.
- pydantic model cast_planet.orders.models.CouldHaveToolsList
Show JSON schema
{ "title": "CouldHaveToolsList", "type": "object", "properties": { "tools": { "anyOf": [ { "items": { "anyOf": [ { "$ref": "#/$defs/HarmonizeObject" }, { "$ref": "#/$defs/CoRegisterObject" }, { "$ref": "#/$defs/ToarObject" }, { "$ref": "#/$defs/SceneClipObject" }, { "$ref": "#/$defs/BasemapClipObject" }, { "$ref": "#/$defs/ReprojectObject" }, { "$ref": "#/$defs/BandMathObject" }, { "$ref": "#/$defs/CompositeObject" }, { "$ref": "#/$defs/TileObject" }, { "$ref": "#/$defs/CloudFilterObject" }, { "$ref": "#/$defs/FileFormatObject" }, { "$ref": "#/$defs/MergeObject" } ] }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Tools" } }, "$defs": { "BandMathObject": { "description": "See https://developers.planet.com/apis/orders/tools/#band-math and\nhttps://developers.planet.com/apis/orders/bandmath-numpy-routines/ to learn more.", "properties": { "b1": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "B1" }, "b2": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "B2" }, "b3": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "B3" }, "b4": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "B4" }, "b5": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "B5" }, "b6": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "B6" }, "b7": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "B7" }, "b8": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "B8" }, "b9": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "B9" }, "b10": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "B10" }, "b11": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "B11" }, "b12": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "B12" }, "b13": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "B13" }, "b14": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "B14" }, "b15": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "B15" }, "expression": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Expression" }, "pixel_type": { "anyOf": [ { "$ref": "#/$defs/PixelType" }, { "type": "null" } ], "default": null } }, "title": "BandMathObject", "type": "object" }, "BasemapClipObject": { "properties": { "clip": { "default": {}, "title": "Clip", "type": "object" } }, "title": "BasemapClipObject", "type": "object" }, "CloudFilterObject": { "properties": { "clear_min": { "title": "Clear Min", "type": "number" }, "cloud_max": { "title": "Cloud Max", "type": "number" } }, "required": [ "clear_min", "cloud_max" ], "title": "CloudFilterObject", "type": "object" }, "CoRegisterObject": { "properties": { "anchor_item": { "title": "Anchor Item", "type": "string" } }, "required": [ "anchor_item" ], "title": "CoRegisterObject", "type": "object" }, "CompositeGroup": { "enum": [ "order", "strip_id" ], "title": "CompositeGroup", "type": "string" }, "CompositeObject": { "properties": { "group_by": { "anyOf": [ { "$ref": "#/$defs/CompositeGroup" }, { "type": "null" } ], "default": null } }, "title": "CompositeObject", "type": "object" }, "Coordinates": { "maxItems": 2, "minItems": 2, "prefixItems": [ { "anyOf": [ { "type": "number" }, { "type": "integer" } ], "ge": -180, "le": 180, "title": "Lon" }, { "anyOf": [ { "type": "number" }, { "type": "integer" } ], "ge": -90, "le": 90, "title": "Lat" } ], "type": "array" }, "FileFormatObject": { "properties": { "format": { "$ref": "#/$defs/Format" } }, "required": [ "format" ], "title": "FileFormatObject", "type": "object" }, "Format": { "enum": [ "COG", "PL_NITF" ], "title": "Format", "type": "string" }, "HarmonizeObject": { "properties": { "target_sensor": { "allOf": [ { "$ref": "#/$defs/TargetSensor" } ], "description": "Sentinel-2 or PS2" } }, "required": [ "target_sensor" ], "title": "HarmonizeObject", "type": "object" }, "MergeObject": { "properties": { "merge": { "default": {}, "title": "Merge", "type": "object" } }, "title": "MergeObject", "type": "object" }, "MultiPolygonModel": { "properties": { "type": { "default": "MultiPolygon", "title": "Multi Polygon", "type": "string" }, "coordinates": { "items": { "items": { "items": { "$ref": "#/$defs/Coordinates" }, "type": "array" }, "type": "array" }, "title": "Coordinates", "type": "array" } }, "required": [ "coordinates" ], "title": "MultiPolygonModel", "type": "object" }, "PixelType": { "enum": [ "8U", "16U", "16S", "32R" ], "title": "PixelType", "type": "string" }, "PolygonModel": { "properties": { "type": { "default": "Polygon", "title": "Polygon", "type": "string" }, "coordinates": { "items": { "items": { "$ref": "#/$defs/Coordinates" }, "type": "array" }, "title": "Coordinates", "type": "array" } }, "required": [ "coordinates" ], "title": "PolygonModel", "type": "object" }, "ReprojectObject": { "properties": { "projection": { "title": "Projection", "type": "string" }, "kernel": { "anyOf": [ { "$ref": "#/$defs/ResamplingMethod" }, { "type": "null" } ], "default": null }, "resolution": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "title": "Resolution" } }, "required": [ "projection" ], "title": "ReprojectObject", "type": "object" }, "ResamplingMethod": { "enum": [ "bilinear", "cubic", "cubicspline", "lanczos", "average", "mode", "min", "max", "med", "q1", "q3" ], "title": "ResamplingMethod", "type": "string" }, "SceneClipObject": { "properties": { "aoi": { "anyOf": [ { "$ref": "#/$defs/PolygonModel" }, { "$ref": "#/$defs/MultiPolygonModel" } ], "title": "Aoi" } }, "required": [ "aoi" ], "title": "SceneClipObject", "type": "object" }, "TargetSensor": { "enum": [ "Sentinel-2", "PS2" ], "title": "TargetSensor", "type": "string" }, "TileObject": { "properties": { "name_template": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Name Template" }, "origin_x": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "title": "Origin X" }, "origin_y": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "title": "Origin Y" }, "pixel_size": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "title": "Pixel Size" }, "tile_size": { "title": "Tile Size", "type": "number" }, "conformal_x_scaling": { "default": false, "title": "Conformal X Scaling", "type": "boolean" } }, "required": [ "tile_size" ], "title": "TileObject", "type": "object" }, "ToarObject": { "properties": { "scale_factor": { "title": "Scale Factor", "type": "number" } }, "required": [ "scale_factor" ], "title": "ToarObject", "type": "object" } } }
- Fields:
tools (List[cast_planet.orders.models.tools.HarmonizeObject | cast_planet.orders.models.tools.CoRegisterObject | cast_planet.orders.models.tools.ToarObject | cast_planet.orders.models.tools.SceneClipObject | cast_planet.orders.models.tools.BasemapClipObject | cast_planet.orders.models.tools.ReprojectObject | cast_planet.orders.models.tools.BandMathObject | cast_planet.orders.models.tools.CompositeObject | cast_planet.orders.models.tools.TileObject | cast_planet.orders.models.tools.CloudFilterObject | cast_planet.orders.models.tools.FileFormatObject | cast_planet.orders.models.tools.MergeObject] | None)
-
field tools:
Optional[List[Union[HarmonizeObject,CoRegisterObject,ToarObject,SceneClipObject,BasemapClipObject,ReprojectObject,BandMathObject,CompositeObject,TileObject,CloudFilterObject,FileFormatObject,MergeObject]]] = None
- pydantic model cast_planet.orders.models.CreateOrder
Show JSON schema
{ "title": "CreateOrder", "type": "object", "properties": { "hosting": { "anyOf": [ { "$ref": "#/$defs/OrderHosting" }, { "type": "null" } ], "default": null }, "products": { "anyOf": [ { "items": { "anyOf": [ { "$ref": "#/$defs/SceneSource" }, { "$ref": "#/$defs/BaseMapsGeometrySource" }, { "$ref": "#/$defs/BaseMapsQuadIdSource" } ] }, "type": "array" }, { "type": "null" } ], "default": null, "description": "The products from the Data or Basemaps API to order.", "title": "Products" }, "tools": { "anyOf": [ { "items": { "anyOf": [ { "$ref": "#/$defs/HarmonizeObject" }, { "$ref": "#/$defs/CoRegisterObject" }, { "$ref": "#/$defs/ToarObject" }, { "$ref": "#/$defs/SceneClipObject" }, { "$ref": "#/$defs/BasemapClipObject" }, { "$ref": "#/$defs/ReprojectObject" }, { "$ref": "#/$defs/BandMathObject" }, { "$ref": "#/$defs/CompositeObject" }, { "$ref": "#/$defs/TileObject" }, { "$ref": "#/$defs/CloudFilterObject" }, { "$ref": "#/$defs/FileFormatObject" }, { "$ref": "#/$defs/MergeObject" } ] }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Tools" }, "name": { "description": "A name given to this Order request.", "title": "Name", "type": "string" }, "subscription_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "apply this orders against this quota subscription", "title": "Subscription Id" }, "delivery": { "anyOf": [ { "$ref": "#/$defs/OrderDelivery" }, { "type": "null" } ], "default": null, "description": "How should ordered products be delivered?" }, "notifications": { "anyOf": [ { "$ref": "#/$defs/OrderNotifications" }, { "type": "null" } ], "default": null, "description": "How would you like to be notified when order is complete?" }, "order_type": { "allOf": [ { "$ref": "#/$defs/OrderType" } ], "default": "partial", "description": "accept order if requested products are not available (partial)?" }, "source_type": { "anyOf": [ { "$ref": "#/$defs/OrderSource" }, { "type": "null" } ], "default": null, "description": "Source imagery type for all products. Default is scenes." } }, "$defs": { "Amazons3": { "properties": { "bucket": { "title": "Bucket", "type": "string" }, "aws_region": { "title": "Aws Region", "type": "string" }, "aws_access_key_id": { "title": "Aws Access Key Id", "type": "string" }, "aws_secret_access_key": { "title": "Aws Secret Access Key", "type": "string" }, "path_prefix": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Path Prefix" } }, "required": [ "bucket", "aws_region", "aws_access_key_id", "aws_secret_access_key" ], "title": "Amazons3", "type": "object" }, "AzureBlobStorage": { "properties": { "account": { "title": "Account", "type": "string" }, "container": { "title": "Container", "type": "string" }, "sas_token": { "title": "Sas Token", "type": "string" }, "storage_endpoint_suffix": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Storage Endpoint Suffix" }, "path_prefix": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Path Prefix" } }, "required": [ "account", "container", "sas_token" ], "title": "AzureBlobStorage", "type": "object" }, "BandMathObject": { "description": "See https://developers.planet.com/apis/orders/tools/#band-math and\nhttps://developers.planet.com/apis/orders/bandmath-numpy-routines/ to learn more.", "properties": { "b1": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "B1" }, "b2": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "B2" }, "b3": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "B3" }, "b4": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "B4" }, "b5": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "B5" }, "b6": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "B6" }, "b7": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "B7" }, "b8": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "B8" }, "b9": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "B9" }, "b10": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "B10" }, "b11": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "B11" }, "b12": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "B12" }, "b13": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "B13" }, "b14": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "B14" }, "b15": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "B15" }, "expression": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Expression" }, "pixel_type": { "anyOf": [ { "$ref": "#/$defs/PixelType" }, { "type": "null" } ], "default": null } }, "title": "BandMathObject", "type": "object" }, "BaseMapsGeometrySource": { "properties": { "mosaic_name": { "description": "Name of mosaic", "title": "Mosaic Name", "type": "string" }, "geometry": { "anyOf": [ { "$ref": "#/$defs/PointModel" }, { "$ref": "#/$defs/PolygonModel" }, { "$ref": "#/$defs/MultiPolygonModel" }, { "type": "null" } ], "default": null, "description": "GeoJSON object.", "title": "Geometry" } }, "required": [ "mosaic_name" ], "title": "BaseMapsGeometrySource", "type": "object" }, "BaseMapsQuadIdSource": { "properties": { "mosaic_name": { "description": "Name of mosaic", "title": "Mosaic Name", "type": "string" }, "quad_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": [], "description": "List of quad ids.", "title": "Quad Ids" } }, "required": [ "mosaic_name" ], "title": "BaseMapsQuadIdSource", "type": "object" }, "BasemapClipObject": { "properties": { "clip": { "default": {}, "title": "Clip", "type": "object" } }, "title": "BasemapClipObject", "type": "object" }, "CloudFilterObject": { "properties": { "clear_min": { "title": "Clear Min", "type": "number" }, "cloud_max": { "title": "Cloud Max", "type": "number" } }, "required": [ "clear_min", "cloud_max" ], "title": "CloudFilterObject", "type": "object" }, "CoRegisterObject": { "properties": { "anchor_item": { "title": "Anchor Item", "type": "string" } }, "required": [ "anchor_item" ], "title": "CoRegisterObject", "type": "object" }, "CompositeGroup": { "enum": [ "order", "strip_id" ], "title": "CompositeGroup", "type": "string" }, "CompositeObject": { "properties": { "group_by": { "anyOf": [ { "$ref": "#/$defs/CompositeGroup" }, { "type": "null" } ], "default": null } }, "title": "CompositeObject", "type": "object" }, "Coordinates": { "maxItems": 2, "minItems": 2, "prefixItems": [ { "anyOf": [ { "type": "number" }, { "type": "integer" } ], "ge": -180, "le": 180, "title": "Lon" }, { "anyOf": [ { "type": "number" }, { "type": "integer" } ], "ge": -90, "le": 90, "title": "Lat" } ], "type": "array" }, "FileFormatObject": { "properties": { "format": { "$ref": "#/$defs/Format" } }, "required": [ "format" ], "title": "FileFormatObject", "type": "object" }, "Format": { "enum": [ "COG", "PL_NITF" ], "title": "Format", "type": "string" }, "GoogleCloudStorage": { "properties": { "bucket": { "title": "Bucket", "type": "string" }, "credentials": { "title": "Credentials", "type": "string" }, "path_prefix": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Path Prefix" } }, "required": [ "bucket", "credentials" ], "title": "GoogleCloudStorage", "type": "object" }, "GoogleEarthEngine": { "properties": { "project": { "title": "Project", "type": "string" }, "collection": { "title": "Collection", "type": "string" }, "credentials": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Credentials" } }, "required": [ "project", "collection" ], "title": "GoogleEarthEngine", "type": "object" }, "HarmonizeObject": { "properties": { "target_sensor": { "allOf": [ { "$ref": "#/$defs/TargetSensor" } ], "description": "Sentinel-2 or PS2" } }, "required": [ "target_sensor" ], "title": "HarmonizeObject", "type": "object" }, "Layout": { "properties": { "format": { "title": "Format", "type": "string" } }, "required": [ "format" ], "title": "Layout", "type": "object" }, "MergeObject": { "properties": { "merge": { "default": {}, "title": "Merge", "type": "object" } }, "title": "MergeObject", "type": "object" }, "MultiPolygonModel": { "properties": { "type": { "default": "MultiPolygon", "title": "Multi Polygon", "type": "string" }, "coordinates": { "items": { "items": { "items": { "$ref": "#/$defs/Coordinates" }, "type": "array" }, "type": "array" }, "title": "Coordinates", "type": "array" } }, "required": [ "coordinates" ], "title": "MultiPolygonModel", "type": "object" }, "NotificationWebhook": { "properties": { "url": { "title": "Url", "type": "string" }, "per_order": { "default": false, "description": "If 'true', webhook will be called when order completes.", "title": "Per Order", "type": "boolean" } }, "required": [ "url" ], "title": "NotificationWebhook", "type": "object" }, "OracleCloudStorage": { "properties": { "bucket": { "title": "Bucket", "type": "string" }, "customer_access_key_id": { "title": "Customer Access Key Id", "type": "string" }, "customer_secret_key": { "title": "Customer Secret Key", "type": "string" }, "region": { "title": "Region", "type": "string" }, "namespace": { "title": "Namespace", "type": "string" }, "path_prefix": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Path Prefix" } }, "required": [ "bucket", "customer_access_key_id", "customer_secret_key", "region", "namespace" ], "title": "OracleCloudStorage", "type": "object" }, "OrderDelivery": { "description": "For more information see https://developers.planet.com/apis/orders/reference/#tag/Orders", "properties": { "single_archive": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Single Archive" }, "archive_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Archive Type" }, "archive_filename": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Archive Filename" }, "layout": { "anyOf": [ { "$ref": "#/$defs/Layout" }, { "type": "null" } ], "default": null }, "amazon_s3": { "anyOf": [ { "$ref": "#/$defs/Amazons3" }, { "type": "null" } ], "default": null }, "azure_blob_storage": { "anyOf": [ { "$ref": "#/$defs/AzureBlobStorage" }, { "type": "null" } ], "default": null }, "google_cloud_storage": { "anyOf": [ { "$ref": "#/$defs/GoogleCloudStorage" }, { "type": "null" } ], "default": null }, "google_earth_engine": { "anyOf": [ { "$ref": "#/$defs/GoogleEarthEngine" }, { "type": "null" } ], "default": null }, "oracle_cloud_storage": { "anyOf": [ { "$ref": "#/$defs/OracleCloudStorage" }, { "type": "null" } ], "default": null } }, "title": "OrderDelivery", "type": "object" }, "OrderHosting": { "properties": { "sentinel_hub": { "$ref": "#/$defs/SentinelHubHosting" } }, "required": [ "sentinel_hub" ], "title": "OrderHosting", "type": "object" }, "OrderNotifications": { "properties": { "webhook": { "anyOf": [ { "$ref": "#/$defs/NotificationWebhook" }, { "type": "null" } ], "default": null, "description": "Details for calling your webhook. An OrderComponent will be POST'ed to endpoint." }, "email": { "default": false, "description": "Send email to address associated with submitter account.", "title": "Email", "type": "boolean" } }, "title": "OrderNotifications", "type": "object" }, "OrderSource": { "enum": [ "scenes", "basemaps" ], "title": "OrderSource", "type": "string" }, "OrderType": { "enum": [ "full", "partial" ], "title": "OrderType", "type": "string" }, "PixelType": { "enum": [ "8U", "16U", "16S", "32R" ], "title": "PixelType", "type": "string" }, "PointModel": { "properties": { "type": { "default": "Point", "title": "Point", "type": "string" }, "coordinates": { "$ref": "#/$defs/Coordinates" } }, "required": [ "coordinates" ], "title": "PointModel", "type": "object" }, "PolygonModel": { "properties": { "type": { "default": "Polygon", "title": "Polygon", "type": "string" }, "coordinates": { "items": { "items": { "$ref": "#/$defs/Coordinates" }, "type": "array" }, "title": "Coordinates", "type": "array" } }, "required": [ "coordinates" ], "title": "PolygonModel", "type": "object" }, "ReprojectObject": { "properties": { "projection": { "title": "Projection", "type": "string" }, "kernel": { "anyOf": [ { "$ref": "#/$defs/ResamplingMethod" }, { "type": "null" } ], "default": null }, "resolution": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "title": "Resolution" } }, "required": [ "projection" ], "title": "ReprojectObject", "type": "object" }, "ResamplingMethod": { "enum": [ "bilinear", "cubic", "cubicspline", "lanczos", "average", "mode", "min", "max", "med", "q1", "q3" ], "title": "ResamplingMethod", "type": "string" }, "SceneClipObject": { "properties": { "aoi": { "anyOf": [ { "$ref": "#/$defs/PolygonModel" }, { "$ref": "#/$defs/MultiPolygonModel" } ], "title": "Aoi" } }, "required": [ "aoi" ], "title": "SceneClipObject", "type": "object" }, "SceneSource": { "properties": { "item_ids": { "description": "Array of item ids.", "items": { "type": "string" }, "title": "Item Ids", "type": "array" }, "item_type": { "description": "item-type for requested item_id.", "title": "Item Type", "type": "string" }, "product_bundle": { "description": "asset-type for the item.", "title": "Product Bundle", "type": "string" } }, "required": [ "item_ids", "item_type", "product_bundle" ], "title": "SceneSource", "type": "object" }, "SentinelHubHosting": { "description": "Before using, you must follow the steps in this article: Linking Planet User to Sentinel Hub User.\nhttps://support.planet.com/hc/en-us/articles/16417885928221-Linking-Planet-User-to-Sentinel-Hub-User\n\nCollections can be found on the Sentinel Hub Dashboard.\nhttps://apps.sentinel-hub.com/dashboard/#/collections", "properties": { "collection_id": { "description": "A Sentinel Hub BYOC collection to deliver to. If omitted, a new collection will be created for you and returned in the response", "format": "uuid", "title": "Collection Id", "type": "string" } }, "required": [ "collection_id" ], "title": "SentinelHubHosting", "type": "object" }, "TargetSensor": { "enum": [ "Sentinel-2", "PS2" ], "title": "TargetSensor", "type": "string" }, "TileObject": { "properties": { "name_template": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Name Template" }, "origin_x": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "title": "Origin X" }, "origin_y": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "title": "Origin Y" }, "pixel_size": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "title": "Pixel Size" }, "tile_size": { "title": "Tile Size", "type": "number" }, "conformal_x_scaling": { "default": false, "title": "Conformal X Scaling", "type": "boolean" } }, "required": [ "tile_size" ], "title": "TileObject", "type": "object" }, "ToarObject": { "properties": { "scale_factor": { "title": "Scale Factor", "type": "number" } }, "required": [ "scale_factor" ], "title": "ToarObject", "type": "object" } }, "required": [ "name" ] }
- Fields:
delivery (cast_planet.orders.models.order_delivery.OrderDelivery | None)hosting (Optional[OrderHosting])name (str)notifications (cast_planet.orders.models.order_notifications.OrderNotifications | None)order_type (cast_planet.orders.models.common.OrderType)products (Optional[List[Union[SceneSource, BaseMapsGeometrySource, BaseMapsQuadIdSource]]])source_type (cast_planet.orders.models.common.OrderSource | None)subscription_id (int | None)tools (Optional[List[Union[HarmonizeObject, CoRegisterObject, ToarObject, SceneClipObject, BasemapClipObject, ReprojectObject, BandMathObject, CompositeObject, TileObject, CloudFilterObject, FileFormatObject, MergeObject]]])
-
field delivery:
Optional[OrderDelivery] = None How should ordered products be delivered?
- field hosting: Optional[OrderHosting] = None
-
field name:
str[Required] A name given to this Order request.
-
field notifications:
Optional[OrderNotifications] = None How would you like to be notified when order is complete?
-
field order_type:
OrderType= OrderType.PARTIAL accept order if requested products are not available (partial)?
- field products: Optional[List[Union[SceneSource, BaseMapsGeometrySource, BaseMapsQuadIdSource]]] = None
The products from the Data or Basemaps API to order.
-
field source_type:
Optional[OrderSource] = None Source imagery type for all products. Default is scenes.
-
field subscription_id:
Optional[int] = None apply this orders against this quota subscription
- field tools: Optional[List[Union[HarmonizeObject, CoRegisterObject, ToarObject, SceneClipObject, BasemapClipObject, ReprojectObject, BandMathObject, CompositeObject, TileObject, CloudFilterObject, FileFormatObject, MergeObject]]] = None
- class cast_planet.orders.models.Enum(value)
Generic enumeration.
Derive from this class to define new enumerations.
- pydantic model cast_planet.orders.models.FileFormatObject
Show JSON schema
{ "title": "FileFormatObject", "type": "object", "properties": { "format": { "$ref": "#/$defs/Format" } }, "$defs": { "Format": { "enum": [ "COG", "PL_NITF" ], "title": "Format", "type": "string" } }, "required": [ "format" ] }
- Fields:
format (cast_planet.orders.models.tools.Format)
- class cast_planet.orders.models.Format(value)
An enumeration.
- pydantic model cast_planet.orders.models.GoogleCloudStorage
Show JSON schema
{ "title": "GoogleCloudStorage", "type": "object", "properties": { "bucket": { "title": "Bucket", "type": "string" }, "credentials": { "title": "Credentials", "type": "string" }, "path_prefix": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Path Prefix" } }, "required": [ "bucket", "credentials" ] }
- Fields:
bucket (str)credentials (str)path_prefix (str | None)
-
field bucket:
str[Required]
-
field credentials:
str[Required]
-
field path_prefix:
Optional[str] = None
- pydantic model cast_planet.orders.models.GoogleEarthEngine
Show JSON schema
{ "title": "GoogleEarthEngine", "type": "object", "properties": { "project": { "title": "Project", "type": "string" }, "collection": { "title": "Collection", "type": "string" }, "credentials": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Credentials" } }, "required": [ "project", "collection" ] }
- Fields:
collection (str)credentials (str | None)project (str)
-
field collection:
str[Required]
-
field credentials:
Optional[str] = None
-
field project:
str[Required]
- pydantic model cast_planet.orders.models.HarmonizeObject
Show JSON schema
{ "title": "HarmonizeObject", "type": "object", "properties": { "target_sensor": { "allOf": [ { "$ref": "#/$defs/TargetSensor" } ], "description": "Sentinel-2 or PS2" } }, "$defs": { "TargetSensor": { "enum": [ "Sentinel-2", "PS2" ], "title": "TargetSensor", "type": "string" } }, "required": [ "target_sensor" ] }
- Fields:
target_sensor (cast_planet.orders.models.tools.TargetSensor)
-
field target_sensor:
TargetSensor[Required] Sentinel-2 or PS2
- pydantic model cast_planet.orders.models.HasToolsList
Show JSON schema
{ "title": "HasToolsList", "type": "object", "properties": { "tools": { "default": [], "items": { "anyOf": [ { "$ref": "#/$defs/HarmonizeObject" }, { "$ref": "#/$defs/CoRegisterObject" }, { "$ref": "#/$defs/ToarObject" }, { "$ref": "#/$defs/SceneClipObject" }, { "$ref": "#/$defs/BasemapClipObject" }, { "$ref": "#/$defs/ReprojectObject" }, { "$ref": "#/$defs/BandMathObject" }, { "$ref": "#/$defs/CompositeObject" }, { "$ref": "#/$defs/TileObject" }, { "$ref": "#/$defs/CloudFilterObject" }, { "$ref": "#/$defs/FileFormatObject" }, { "$ref": "#/$defs/MergeObject" } ] }, "title": "Tools", "type": "array" } }, "$defs": { "BandMathObject": { "description": "See https://developers.planet.com/apis/orders/tools/#band-math and\nhttps://developers.planet.com/apis/orders/bandmath-numpy-routines/ to learn more.", "properties": { "b1": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "B1" }, "b2": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "B2" }, "b3": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "B3" }, "b4": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "B4" }, "b5": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "B5" }, "b6": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "B6" }, "b7": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "B7" }, "b8": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "B8" }, "b9": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "B9" }, "b10": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "B10" }, "b11": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "B11" }, "b12": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "B12" }, "b13": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "B13" }, "b14": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "B14" }, "b15": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "B15" }, "expression": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Expression" }, "pixel_type": { "anyOf": [ { "$ref": "#/$defs/PixelType" }, { "type": "null" } ], "default": null } }, "title": "BandMathObject", "type": "object" }, "BasemapClipObject": { "properties": { "clip": { "default": {}, "title": "Clip", "type": "object" } }, "title": "BasemapClipObject", "type": "object" }, "CloudFilterObject": { "properties": { "clear_min": { "title": "Clear Min", "type": "number" }, "cloud_max": { "title": "Cloud Max", "type": "number" } }, "required": [ "clear_min", "cloud_max" ], "title": "CloudFilterObject", "type": "object" }, "CoRegisterObject": { "properties": { "anchor_item": { "title": "Anchor Item", "type": "string" } }, "required": [ "anchor_item" ], "title": "CoRegisterObject", "type": "object" }, "CompositeGroup": { "enum": [ "order", "strip_id" ], "title": "CompositeGroup", "type": "string" }, "CompositeObject": { "properties": { "group_by": { "anyOf": [ { "$ref": "#/$defs/CompositeGroup" }, { "type": "null" } ], "default": null } }, "title": "CompositeObject", "type": "object" }, "Coordinates": { "maxItems": 2, "minItems": 2, "prefixItems": [ { "anyOf": [ { "type": "number" }, { "type": "integer" } ], "ge": -180, "le": 180, "title": "Lon" }, { "anyOf": [ { "type": "number" }, { "type": "integer" } ], "ge": -90, "le": 90, "title": "Lat" } ], "type": "array" }, "FileFormatObject": { "properties": { "format": { "$ref": "#/$defs/Format" } }, "required": [ "format" ], "title": "FileFormatObject", "type": "object" }, "Format": { "enum": [ "COG", "PL_NITF" ], "title": "Format", "type": "string" }, "HarmonizeObject": { "properties": { "target_sensor": { "allOf": [ { "$ref": "#/$defs/TargetSensor" } ], "description": "Sentinel-2 or PS2" } }, "required": [ "target_sensor" ], "title": "HarmonizeObject", "type": "object" }, "MergeObject": { "properties": { "merge": { "default": {}, "title": "Merge", "type": "object" } }, "title": "MergeObject", "type": "object" }, "MultiPolygonModel": { "properties": { "type": { "default": "MultiPolygon", "title": "Multi Polygon", "type": "string" }, "coordinates": { "items": { "items": { "items": { "$ref": "#/$defs/Coordinates" }, "type": "array" }, "type": "array" }, "title": "Coordinates", "type": "array" } }, "required": [ "coordinates" ], "title": "MultiPolygonModel", "type": "object" }, "PixelType": { "enum": [ "8U", "16U", "16S", "32R" ], "title": "PixelType", "type": "string" }, "PolygonModel": { "properties": { "type": { "default": "Polygon", "title": "Polygon", "type": "string" }, "coordinates": { "items": { "items": { "$ref": "#/$defs/Coordinates" }, "type": "array" }, "title": "Coordinates", "type": "array" } }, "required": [ "coordinates" ], "title": "PolygonModel", "type": "object" }, "ReprojectObject": { "properties": { "projection": { "title": "Projection", "type": "string" }, "kernel": { "anyOf": [ { "$ref": "#/$defs/ResamplingMethod" }, { "type": "null" } ], "default": null }, "resolution": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "title": "Resolution" } }, "required": [ "projection" ], "title": "ReprojectObject", "type": "object" }, "ResamplingMethod": { "enum": [ "bilinear", "cubic", "cubicspline", "lanczos", "average", "mode", "min", "max", "med", "q1", "q3" ], "title": "ResamplingMethod", "type": "string" }, "SceneClipObject": { "properties": { "aoi": { "anyOf": [ { "$ref": "#/$defs/PolygonModel" }, { "$ref": "#/$defs/MultiPolygonModel" } ], "title": "Aoi" } }, "required": [ "aoi" ], "title": "SceneClipObject", "type": "object" }, "TargetSensor": { "enum": [ "Sentinel-2", "PS2" ], "title": "TargetSensor", "type": "string" }, "TileObject": { "properties": { "name_template": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Name Template" }, "origin_x": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "title": "Origin X" }, "origin_y": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "title": "Origin Y" }, "pixel_size": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "title": "Pixel Size" }, "tile_size": { "title": "Tile Size", "type": "number" }, "conformal_x_scaling": { "default": false, "title": "Conformal X Scaling", "type": "boolean" } }, "required": [ "tile_size" ], "title": "TileObject", "type": "object" }, "ToarObject": { "properties": { "scale_factor": { "title": "Scale Factor", "type": "number" } }, "required": [ "scale_factor" ], "title": "ToarObject", "type": "object" } } }
- Fields:
tools (List[cast_planet.orders.models.tools.HarmonizeObject | cast_planet.orders.models.tools.CoRegisterObject | cast_planet.orders.models.tools.ToarObject | cast_planet.orders.models.tools.SceneClipObject | cast_planet.orders.models.tools.BasemapClipObject | cast_planet.orders.models.tools.ReprojectObject | cast_planet.orders.models.tools.BandMathObject | cast_planet.orders.models.tools.CompositeObject | cast_planet.orders.models.tools.TileObject | cast_planet.orders.models.tools.CloudFilterObject | cast_planet.orders.models.tools.FileFormatObject | cast_planet.orders.models.tools.MergeObject])
-
field tools:
List[Union[HarmonizeObject,CoRegisterObject,ToarObject,SceneClipObject,BasemapClipObject,ReprojectObject,BandMathObject,CompositeObject,TileObject,CloudFilterObject,FileFormatObject,MergeObject]] = []
- pydantic model cast_planet.orders.models.Layout
Show JSON schema
{ "title": "Layout", "type": "object", "properties": { "format": { "title": "Format", "type": "string" } }, "required": [ "format" ] }
- Fields:
format (str)
-
field format:
str[Required]
- pydantic model cast_planet.orders.models.LinksBase
Show JSON schema
{ "title": "LinksBase", "type": "object", "properties": { "_self": { "title": " Self", "type": "string" } }, "required": [ "_self" ] }
- Fields:
self (str)
-
field self:
str[Required] (alias '_self')
- pydantic model cast_planet.orders.models.MergeObject
Show JSON schema
{ "title": "MergeObject", "type": "object", "properties": { "merge": { "default": {}, "title": "Merge", "type": "object" } } }
- Fields:
merge (Dict)
-
field merge:
Dict= {}
- pydantic model cast_planet.orders.models.MultiPolygonModel
Show JSON schema
{ "title": "MultiPolygonModel", "type": "object", "properties": { "type": { "default": "MultiPolygon", "title": "Multi Polygon", "type": "string" }, "coordinates": { "items": { "items": { "items": { "$ref": "#/$defs/Coordinates" }, "type": "array" }, "type": "array" }, "title": "Coordinates", "type": "array" } }, "$defs": { "Coordinates": { "maxItems": 2, "minItems": 2, "prefixItems": [ { "anyOf": [ { "type": "number" }, { "type": "integer" } ], "ge": -180, "le": 180, "title": "Lon" }, { "anyOf": [ { "type": "number" }, { "type": "integer" } ], "ge": -90, "le": 90, "title": "Lat" } ], "type": "array" } }, "required": [ "coordinates" ] }
- Fields:
coordinates (List[List[List[pydantic_geojson._base.Coordinates]]])type (str)
-
field coordinates:
List[List[List[Coordinates]]] [Required]
-
field type:
str= 'MultiPolygon'
- pydantic model cast_planet.orders.models.NotificationWebhook
Show JSON schema
{ "title": "NotificationWebhook", "type": "object", "properties": { "url": { "title": "Url", "type": "string" }, "per_order": { "default": false, "description": "If 'true', webhook will be called when order completes.", "title": "Per Order", "type": "boolean" } }, "required": [ "url" ] }
- Fields:
per_order (bool)url (str)
-
field per_order:
bool= False If ‘true’, webhook will be called when order completes.
-
field url:
str[Required]
- pydantic model cast_planet.orders.models.OracleCloudStorage
Show JSON schema
{ "title": "OracleCloudStorage", "type": "object", "properties": { "bucket": { "title": "Bucket", "type": "string" }, "customer_access_key_id": { "title": "Customer Access Key Id", "type": "string" }, "customer_secret_key": { "title": "Customer Secret Key", "type": "string" }, "region": { "title": "Region", "type": "string" }, "namespace": { "title": "Namespace", "type": "string" }, "path_prefix": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Path Prefix" } }, "required": [ "bucket", "customer_access_key_id", "customer_secret_key", "region", "namespace" ] }
- Fields:
bucket (str)customer_access_key_id (str)customer_secret_key (str)namespace (str)path_prefix (str | None)region (str)
-
field bucket:
str[Required]
-
field customer_access_key_id:
str[Required]
-
field customer_secret_key:
str[Required]
-
field namespace:
str[Required]
-
field path_prefix:
Optional[str] = None
-
field region:
str[Required]
- pydantic model cast_planet.orders.models.OrderDelivery
For more information see https://developers.planet.com/apis/orders/reference/#tag/Orders
Show JSON schema
{ "title": "OrderDelivery", "description": "For more information see https://developers.planet.com/apis/orders/reference/#tag/Orders", "type": "object", "properties": { "single_archive": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Single Archive" }, "archive_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Archive Type" }, "archive_filename": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Archive Filename" }, "layout": { "anyOf": [ { "$ref": "#/$defs/Layout" }, { "type": "null" } ], "default": null }, "amazon_s3": { "anyOf": [ { "$ref": "#/$defs/Amazons3" }, { "type": "null" } ], "default": null }, "azure_blob_storage": { "anyOf": [ { "$ref": "#/$defs/AzureBlobStorage" }, { "type": "null" } ], "default": null }, "google_cloud_storage": { "anyOf": [ { "$ref": "#/$defs/GoogleCloudStorage" }, { "type": "null" } ], "default": null }, "google_earth_engine": { "anyOf": [ { "$ref": "#/$defs/GoogleEarthEngine" }, { "type": "null" } ], "default": null }, "oracle_cloud_storage": { "anyOf": [ { "$ref": "#/$defs/OracleCloudStorage" }, { "type": "null" } ], "default": null } }, "$defs": { "Amazons3": { "properties": { "bucket": { "title": "Bucket", "type": "string" }, "aws_region": { "title": "Aws Region", "type": "string" }, "aws_access_key_id": { "title": "Aws Access Key Id", "type": "string" }, "aws_secret_access_key": { "title": "Aws Secret Access Key", "type": "string" }, "path_prefix": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Path Prefix" } }, "required": [ "bucket", "aws_region", "aws_access_key_id", "aws_secret_access_key" ], "title": "Amazons3", "type": "object" }, "AzureBlobStorage": { "properties": { "account": { "title": "Account", "type": "string" }, "container": { "title": "Container", "type": "string" }, "sas_token": { "title": "Sas Token", "type": "string" }, "storage_endpoint_suffix": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Storage Endpoint Suffix" }, "path_prefix": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Path Prefix" } }, "required": [ "account", "container", "sas_token" ], "title": "AzureBlobStorage", "type": "object" }, "GoogleCloudStorage": { "properties": { "bucket": { "title": "Bucket", "type": "string" }, "credentials": { "title": "Credentials", "type": "string" }, "path_prefix": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Path Prefix" } }, "required": [ "bucket", "credentials" ], "title": "GoogleCloudStorage", "type": "object" }, "GoogleEarthEngine": { "properties": { "project": { "title": "Project", "type": "string" }, "collection": { "title": "Collection", "type": "string" }, "credentials": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Credentials" } }, "required": [ "project", "collection" ], "title": "GoogleEarthEngine", "type": "object" }, "Layout": { "properties": { "format": { "title": "Format", "type": "string" } }, "required": [ "format" ], "title": "Layout", "type": "object" }, "OracleCloudStorage": { "properties": { "bucket": { "title": "Bucket", "type": "string" }, "customer_access_key_id": { "title": "Customer Access Key Id", "type": "string" }, "customer_secret_key": { "title": "Customer Secret Key", "type": "string" }, "region": { "title": "Region", "type": "string" }, "namespace": { "title": "Namespace", "type": "string" }, "path_prefix": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Path Prefix" } }, "required": [ "bucket", "customer_access_key_id", "customer_secret_key", "region", "namespace" ], "title": "OracleCloudStorage", "type": "object" } } }
- Fields:
amazon_s3 (cast_planet.orders.models.order_delivery.Amazons3 | None)archive_filename (str | None)archive_type (str | None)azure_blob_storage (cast_planet.orders.models.order_delivery.AzureBlobStorage | None)google_cloud_storage (cast_planet.orders.models.order_delivery.GoogleCloudStorage | None)google_earth_engine (cast_planet.orders.models.order_delivery.GoogleEarthEngine | None)layout (cast_planet.orders.models.order_delivery.Layout | None)oracle_cloud_storage (cast_planet.orders.models.order_delivery.OracleCloudStorage | None)single_archive (bool | None)
-
field archive_filename:
Optional[str] = None
-
field archive_type:
Optional[str] = None
-
field azure_blob_storage:
Optional[AzureBlobStorage] = None
-
field google_cloud_storage:
Optional[GoogleCloudStorage] = None
-
field google_earth_engine:
Optional[GoogleEarthEngine] = None
-
field oracle_cloud_storage:
Optional[OracleCloudStorage] = None
-
field single_archive:
Optional[bool] = None
- pydantic model cast_planet.orders.models.OrderDetails
Show JSON schema
{ "title": "OrderDetails", "type": "object", "properties": { "products": { "anyOf": [ { "items": { "anyOf": [ { "$ref": "#/$defs/SceneSource" }, { "$ref": "#/$defs/BaseMapsGeometrySource" }, { "$ref": "#/$defs/BaseMapsQuadIdSource" } ] }, "type": "array" }, { "type": "null" } ], "default": null, "description": "The products from the Data or Basemaps API to order.", "title": "Products" }, "hosting": { "anyOf": [ { "$ref": "#/$defs/OrderHosting" }, { "type": "null" } ], "default": null }, "tools": { "default": [], "items": { "anyOf": [ { "$ref": "#/$defs/HarmonizeObject" }, { "$ref": "#/$defs/CoRegisterObject" }, { "$ref": "#/$defs/ToarObject" }, { "$ref": "#/$defs/SceneClipObject" }, { "$ref": "#/$defs/BasemapClipObject" }, { "$ref": "#/$defs/ReprojectObject" }, { "$ref": "#/$defs/BandMathObject" }, { "$ref": "#/$defs/CompositeObject" }, { "$ref": "#/$defs/TileObject" }, { "$ref": "#/$defs/CloudFilterObject" }, { "$ref": "#/$defs/FileFormatObject" }, { "$ref": "#/$defs/MergeObject" } ] }, "title": "Tools", "type": "array" }, "_links": { "anyOf": [ { "$ref": "#/$defs/OrderDetailsLinks" }, { "type": "null" } ], "default": null }, "id": { "format": "uuid", "title": "Id", "type": "string" }, "name": { "title": "Name", "type": "string" }, "subscription_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": 0, "title": "Subscription Id" }, "metadata": { "anyOf": [ { "$ref": "#/$defs/OrderMetadata" }, { "type": "null" } ], "default": null }, "created_on": { "format": "date-time", "title": "Created On", "type": "string" }, "last_modified": { "format": "date-time", "title": "Last Modified", "type": "string" }, "state": { "$ref": "#/$defs/OrderState" }, "last_message": { "title": "Last Message", "type": "string" }, "error_hints": { "items": { "type": "string" }, "title": "Error Hints", "type": "array" }, "delivery": { "anyOf": [ { "$ref": "#/$defs/OrderDelivery" }, { "type": "null" } ], "default": null }, "notifications": { "anyOf": [ { "$ref": "#/$defs/OrderNotifications" }, { "type": "null" } ], "default": null }, "order_type": { "title": "Order Type", "type": "string" }, "source_type": { "title": "Source Type", "type": "string" } }, "$defs": { "Amazons3": { "properties": { "bucket": { "title": "Bucket", "type": "string" }, "aws_region": { "title": "Aws Region", "type": "string" }, "aws_access_key_id": { "title": "Aws Access Key Id", "type": "string" }, "aws_secret_access_key": { "title": "Aws Secret Access Key", "type": "string" }, "path_prefix": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Path Prefix" } }, "required": [ "bucket", "aws_region", "aws_access_key_id", "aws_secret_access_key" ], "title": "Amazons3", "type": "object" }, "AzureBlobStorage": { "properties": { "account": { "title": "Account", "type": "string" }, "container": { "title": "Container", "type": "string" }, "sas_token": { "title": "Sas Token", "type": "string" }, "storage_endpoint_suffix": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Storage Endpoint Suffix" }, "path_prefix": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Path Prefix" } }, "required": [ "account", "container", "sas_token" ], "title": "AzureBlobStorage", "type": "object" }, "BandMathObject": { "description": "See https://developers.planet.com/apis/orders/tools/#band-math and\nhttps://developers.planet.com/apis/orders/bandmath-numpy-routines/ to learn more.", "properties": { "b1": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "B1" }, "b2": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "B2" }, "b3": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "B3" }, "b4": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "B4" }, "b5": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "B5" }, "b6": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "B6" }, "b7": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "B7" }, "b8": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "B8" }, "b9": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "B9" }, "b10": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "B10" }, "b11": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "B11" }, "b12": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "B12" }, "b13": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "B13" }, "b14": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "B14" }, "b15": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "B15" }, "expression": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Expression" }, "pixel_type": { "anyOf": [ { "$ref": "#/$defs/PixelType" }, { "type": "null" } ], "default": null } }, "title": "BandMathObject", "type": "object" }, "BaseMapsGeometrySource": { "properties": { "mosaic_name": { "description": "Name of mosaic", "title": "Mosaic Name", "type": "string" }, "geometry": { "anyOf": [ { "$ref": "#/$defs/PointModel" }, { "$ref": "#/$defs/PolygonModel" }, { "$ref": "#/$defs/MultiPolygonModel" }, { "type": "null" } ], "default": null, "description": "GeoJSON object.", "title": "Geometry" } }, "required": [ "mosaic_name" ], "title": "BaseMapsGeometrySource", "type": "object" }, "BaseMapsQuadIdSource": { "properties": { "mosaic_name": { "description": "Name of mosaic", "title": "Mosaic Name", "type": "string" }, "quad_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": [], "description": "List of quad ids.", "title": "Quad Ids" } }, "required": [ "mosaic_name" ], "title": "BaseMapsQuadIdSource", "type": "object" }, "BasemapClipObject": { "properties": { "clip": { "default": {}, "title": "Clip", "type": "object" } }, "title": "BasemapClipObject", "type": "object" }, "CloudFilterObject": { "properties": { "clear_min": { "title": "Clear Min", "type": "number" }, "cloud_max": { "title": "Cloud Max", "type": "number" } }, "required": [ "clear_min", "cloud_max" ], "title": "CloudFilterObject", "type": "object" }, "CoRegisterObject": { "properties": { "anchor_item": { "title": "Anchor Item", "type": "string" } }, "required": [ "anchor_item" ], "title": "CoRegisterObject", "type": "object" }, "CompositeGroup": { "enum": [ "order", "strip_id" ], "title": "CompositeGroup", "type": "string" }, "CompositeObject": { "properties": { "group_by": { "anyOf": [ { "$ref": "#/$defs/CompositeGroup" }, { "type": "null" } ], "default": null } }, "title": "CompositeObject", "type": "object" }, "Coordinates": { "maxItems": 2, "minItems": 2, "prefixItems": [ { "anyOf": [ { "type": "number" }, { "type": "integer" } ], "ge": -180, "le": 180, "title": "Lon" }, { "anyOf": [ { "type": "number" }, { "type": "integer" } ], "ge": -90, "le": 90, "title": "Lat" } ], "type": "array" }, "FileFormatObject": { "properties": { "format": { "$ref": "#/$defs/Format" } }, "required": [ "format" ], "title": "FileFormatObject", "type": "object" }, "Format": { "enum": [ "COG", "PL_NITF" ], "title": "Format", "type": "string" }, "GoogleCloudStorage": { "properties": { "bucket": { "title": "Bucket", "type": "string" }, "credentials": { "title": "Credentials", "type": "string" }, "path_prefix": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Path Prefix" } }, "required": [ "bucket", "credentials" ], "title": "GoogleCloudStorage", "type": "object" }, "GoogleEarthEngine": { "properties": { "project": { "title": "Project", "type": "string" }, "collection": { "title": "Collection", "type": "string" }, "credentials": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Credentials" } }, "required": [ "project", "collection" ], "title": "GoogleEarthEngine", "type": "object" }, "HarmonizeObject": { "properties": { "target_sensor": { "allOf": [ { "$ref": "#/$defs/TargetSensor" } ], "description": "Sentinel-2 or PS2" } }, "required": [ "target_sensor" ], "title": "HarmonizeObject", "type": "object" }, "Layout": { "properties": { "format": { "title": "Format", "type": "string" } }, "required": [ "format" ], "title": "Layout", "type": "object" }, "MergeObject": { "properties": { "merge": { "default": {}, "title": "Merge", "type": "object" } }, "title": "MergeObject", "type": "object" }, "MultiPolygonModel": { "properties": { "type": { "default": "MultiPolygon", "title": "Multi Polygon", "type": "string" }, "coordinates": { "items": { "items": { "items": { "$ref": "#/$defs/Coordinates" }, "type": "array" }, "type": "array" }, "title": "Coordinates", "type": "array" } }, "required": [ "coordinates" ], "title": "MultiPolygonModel", "type": "object" }, "NotificationWebhook": { "properties": { "url": { "title": "Url", "type": "string" }, "per_order": { "default": false, "description": "If 'true', webhook will be called when order completes.", "title": "Per Order", "type": "boolean" } }, "required": [ "url" ], "title": "NotificationWebhook", "type": "object" }, "OracleCloudStorage": { "properties": { "bucket": { "title": "Bucket", "type": "string" }, "customer_access_key_id": { "title": "Customer Access Key Id", "type": "string" }, "customer_secret_key": { "title": "Customer Secret Key", "type": "string" }, "region": { "title": "Region", "type": "string" }, "namespace": { "title": "Namespace", "type": "string" }, "path_prefix": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Path Prefix" } }, "required": [ "bucket", "customer_access_key_id", "customer_secret_key", "region", "namespace" ], "title": "OracleCloudStorage", "type": "object" }, "OrderDelivery": { "description": "For more information see https://developers.planet.com/apis/orders/reference/#tag/Orders", "properties": { "single_archive": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Single Archive" }, "archive_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Archive Type" }, "archive_filename": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Archive Filename" }, "layout": { "anyOf": [ { "$ref": "#/$defs/Layout" }, { "type": "null" } ], "default": null }, "amazon_s3": { "anyOf": [ { "$ref": "#/$defs/Amazons3" }, { "type": "null" } ], "default": null }, "azure_blob_storage": { "anyOf": [ { "$ref": "#/$defs/AzureBlobStorage" }, { "type": "null" } ], "default": null }, "google_cloud_storage": { "anyOf": [ { "$ref": "#/$defs/GoogleCloudStorage" }, { "type": "null" } ], "default": null }, "google_earth_engine": { "anyOf": [ { "$ref": "#/$defs/GoogleEarthEngine" }, { "type": "null" } ], "default": null }, "oracle_cloud_storage": { "anyOf": [ { "$ref": "#/$defs/OracleCloudStorage" }, { "type": "null" } ], "default": null } }, "title": "OrderDelivery", "type": "object" }, "OrderDetailsLinks": { "properties": { "_self": { "title": " Self", "type": "string" }, "results": { "anyOf": [ { "items": { "$ref": "#/$defs/OrderResult" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Results" } }, "required": [ "_self" ], "title": "OrderDetailsLinks", "type": "object" }, "OrderHosting": { "properties": { "sentinel_hub": { "$ref": "#/$defs/SentinelHubHosting" } }, "required": [ "sentinel_hub" ], "title": "OrderHosting", "type": "object" }, "OrderMetadata": { "properties": { "stac": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Stac" } }, "title": "OrderMetadata", "type": "object" }, "OrderNotifications": { "properties": { "webhook": { "anyOf": [ { "$ref": "#/$defs/NotificationWebhook" }, { "type": "null" } ], "default": null, "description": "Details for calling your webhook. An OrderComponent will be POST'ed to endpoint." }, "email": { "default": false, "description": "Send email to address associated with submitter account.", "title": "Email", "type": "boolean" } }, "title": "OrderNotifications", "type": "object" }, "OrderResult": { "properties": { "delivery": { "$ref": "#/$defs/ResultState" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Name" }, "location": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Location" }, "expires_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Expires At" } }, "required": [ "delivery" ], "title": "OrderResult", "type": "object" }, "OrderState": { "enum": [ "queued", "running", "failed", "success", "partial", "cancelled" ], "title": "OrderState", "type": "string" }, "PixelType": { "enum": [ "8U", "16U", "16S", "32R" ], "title": "PixelType", "type": "string" }, "PointModel": { "properties": { "type": { "default": "Point", "title": "Point", "type": "string" }, "coordinates": { "$ref": "#/$defs/Coordinates" } }, "required": [ "coordinates" ], "title": "PointModel", "type": "object" }, "PolygonModel": { "properties": { "type": { "default": "Polygon", "title": "Polygon", "type": "string" }, "coordinates": { "items": { "items": { "$ref": "#/$defs/Coordinates" }, "type": "array" }, "title": "Coordinates", "type": "array" } }, "required": [ "coordinates" ], "title": "PolygonModel", "type": "object" }, "ReprojectObject": { "properties": { "projection": { "title": "Projection", "type": "string" }, "kernel": { "anyOf": [ { "$ref": "#/$defs/ResamplingMethod" }, { "type": "null" } ], "default": null }, "resolution": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "title": "Resolution" } }, "required": [ "projection" ], "title": "ReprojectObject", "type": "object" }, "ResamplingMethod": { "enum": [ "bilinear", "cubic", "cubicspline", "lanczos", "average", "mode", "min", "max", "med", "q1", "q3" ], "title": "ResamplingMethod", "type": "string" }, "ResultState": { "enum": [ "pending", "failed", "success" ], "title": "ResultState", "type": "string" }, "SceneClipObject": { "properties": { "aoi": { "anyOf": [ { "$ref": "#/$defs/PolygonModel" }, { "$ref": "#/$defs/MultiPolygonModel" } ], "title": "Aoi" } }, "required": [ "aoi" ], "title": "SceneClipObject", "type": "object" }, "SceneSource": { "properties": { "item_ids": { "description": "Array of item ids.", "items": { "type": "string" }, "title": "Item Ids", "type": "array" }, "item_type": { "description": "item-type for requested item_id.", "title": "Item Type", "type": "string" }, "product_bundle": { "description": "asset-type for the item.", "title": "Product Bundle", "type": "string" } }, "required": [ "item_ids", "item_type", "product_bundle" ], "title": "SceneSource", "type": "object" }, "SentinelHubHosting": { "description": "Before using, you must follow the steps in this article: Linking Planet User to Sentinel Hub User.\nhttps://support.planet.com/hc/en-us/articles/16417885928221-Linking-Planet-User-to-Sentinel-Hub-User\n\nCollections can be found on the Sentinel Hub Dashboard.\nhttps://apps.sentinel-hub.com/dashboard/#/collections", "properties": { "collection_id": { "description": "A Sentinel Hub BYOC collection to deliver to. If omitted, a new collection will be created for you and returned in the response", "format": "uuid", "title": "Collection Id", "type": "string" } }, "required": [ "collection_id" ], "title": "SentinelHubHosting", "type": "object" }, "TargetSensor": { "enum": [ "Sentinel-2", "PS2" ], "title": "TargetSensor", "type": "string" }, "TileObject": { "properties": { "name_template": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Name Template" }, "origin_x": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "title": "Origin X" }, "origin_y": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "title": "Origin Y" }, "pixel_size": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "title": "Pixel Size" }, "tile_size": { "title": "Tile Size", "type": "number" }, "conformal_x_scaling": { "default": false, "title": "Conformal X Scaling", "type": "boolean" } }, "required": [ "tile_size" ], "title": "TileObject", "type": "object" }, "ToarObject": { "properties": { "scale_factor": { "title": "Scale Factor", "type": "number" } }, "required": [ "scale_factor" ], "title": "ToarObject", "type": "object" } }, "required": [ "id", "name", "created_on", "last_modified", "state", "last_message", "error_hints", "order_type", "source_type" ] }
- Fields:
created_on (datetime.datetime)delivery (cast_planet.orders.models.order_delivery.OrderDelivery | None)error_hints (List[str])hosting (Optional[OrderHosting])id (uuid.UUID)last_message (str)last_modified (datetime.datetime)links (cast_planet.orders.models.order_details.OrderDetailsLinks | None)metadata (cast_planet.orders.models.order_details.OrderMetadata | None)name (str)notifications (cast_planet.orders.models.order_notifications.OrderNotifications | None)order_type (str)products (Optional[List[Union[SceneSource, BaseMapsGeometrySource, BaseMapsQuadIdSource]]])source_type (str)state (cast_planet.orders.models.order_details.OrderState)subscription_id (int | None)tools (List[Union[HarmonizeObject, CoRegisterObject, ToarObject, SceneClipObject, BasemapClipObject, ReprojectObject, BandMathObject, CompositeObject, TileObject, CloudFilterObject, FileFormatObject, MergeObject]])
-
field delivery:
Optional[OrderDelivery] = None
-
field error_hints:
List[str] [Required]
- field hosting: Optional[OrderHosting] = None
-
field last_message:
str[Required]
-
field links:
Optional[OrderDetailsLinks] = None (alias '_links')
-
field metadata:
Optional[OrderMetadata] = None
-
field name:
str[Required]
-
field notifications:
Optional[OrderNotifications] = None
-
field order_type:
str[Required]
- field products: Optional[List[Union[SceneSource, BaseMapsGeometrySource, BaseMapsQuadIdSource]]] = None
The products from the Data or Basemaps API to order.
-
field source_type:
str[Required]
-
field state:
OrderState[Required]
-
field subscription_id:
Optional[int] = 0
- field tools: List[Union[HarmonizeObject, CoRegisterObject, ToarObject, SceneClipObject, BasemapClipObject, ReprojectObject, BandMathObject, CompositeObject, TileObject, CloudFilterObject, FileFormatObject, MergeObject]] = []
- print_info()
- pydantic model cast_planet.orders.models.OrderDetailsLinks
Show JSON schema
{ "title": "OrderDetailsLinks", "type": "object", "properties": { "_self": { "title": " Self", "type": "string" }, "results": { "anyOf": [ { "items": { "$ref": "#/$defs/OrderResult" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Results" } }, "$defs": { "OrderResult": { "properties": { "delivery": { "$ref": "#/$defs/ResultState" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Name" }, "location": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Location" }, "expires_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Expires At" } }, "required": [ "delivery" ], "title": "OrderResult", "type": "object" }, "ResultState": { "enum": [ "pending", "failed", "success" ], "title": "ResultState", "type": "string" } }, "required": [ "_self" ] }
- Fields:
results (List[cast_planet.orders.models.order_details.OrderResult] | None)self (str)
-
field results:
Optional[List[OrderResult]] = None
- field self: str [Required] (alias '_self')
- pydantic model cast_planet.orders.models.OrderHosting
Show JSON schema
{ "title": "OrderHosting", "type": "object", "properties": { "sentinel_hub": { "$ref": "#/$defs/SentinelHubHosting" } }, "$defs": { "SentinelHubHosting": { "description": "Before using, you must follow the steps in this article: Linking Planet User to Sentinel Hub User.\nhttps://support.planet.com/hc/en-us/articles/16417885928221-Linking-Planet-User-to-Sentinel-Hub-User\n\nCollections can be found on the Sentinel Hub Dashboard.\nhttps://apps.sentinel-hub.com/dashboard/#/collections", "properties": { "collection_id": { "description": "A Sentinel Hub BYOC collection to deliver to. If omitted, a new collection will be created for you and returned in the response", "format": "uuid", "title": "Collection Id", "type": "string" } }, "required": [ "collection_id" ], "title": "SentinelHubHosting", "type": "object" } }, "required": [ "sentinel_hub" ] }
- Fields:
sentinel_hub (cast_planet.orders.models.order_hosting.SentinelHubHosting)
-
field sentinel_hub:
SentinelHubHosting[Required]
- pydantic model cast_planet.orders.models.OrderMetadata
Show JSON schema
{ "title": "OrderMetadata", "type": "object", "properties": { "stac": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Stac" } } }
- Fields:
stac (Any | None)
-
field stac:
Optional[Any] = None
- pydantic model cast_planet.orders.models.OrderNotifications
Show JSON schema
{ "title": "OrderNotifications", "type": "object", "properties": { "webhook": { "anyOf": [ { "$ref": "#/$defs/NotificationWebhook" }, { "type": "null" } ], "default": null, "description": "Details for calling your webhook. An OrderComponent will be POST'ed to endpoint." }, "email": { "default": false, "description": "Send email to address associated with submitter account.", "title": "Email", "type": "boolean" } }, "$defs": { "NotificationWebhook": { "properties": { "url": { "title": "Url", "type": "string" }, "per_order": { "default": false, "description": "If 'true', webhook will be called when order completes.", "title": "Per Order", "type": "boolean" } }, "required": [ "url" ], "title": "NotificationWebhook", "type": "object" } } }
- Fields:
email (bool)webhook (cast_planet.orders.models.order_notifications.NotificationWebhook | None)
-
field email:
bool= False Send email to address associated with submitter account.
-
field webhook:
Optional[NotificationWebhook] = None Details for calling your webhook. An OrderComponent will be POST’ed to endpoint.
- pydantic model cast_planet.orders.models.OrderResult
Show JSON schema
{ "title": "OrderResult", "type": "object", "properties": { "delivery": { "$ref": "#/$defs/ResultState" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Name" }, "location": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Location" }, "expires_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Expires At" } }, "$defs": { "ResultState": { "enum": [ "pending", "failed", "success" ], "title": "ResultState", "type": "string" } }, "required": [ "delivery" ] }
- Fields:
delivery (cast_planet.orders.models.order_details.ResultState)expires_at (datetime.datetime | None)location (str | None)name (str | None)
-
field delivery:
ResultState[Required]
-
field location:
Optional[str] = None
-
field name:
Optional[str] = None
- class cast_planet.orders.models.OrderSource(value)
An enumeration.
- class cast_planet.orders.models.OrderState(value)
An enumeration.
- class cast_planet.orders.models.OrderType(value)
An enumeration.
- pydantic model cast_planet.orders.models.OrdersResponse
Show JSON schema
{ "title": "OrdersResponse", "type": "object", "properties": { "_links": { "$ref": "#/$defs/OrdersResponseLinks" }, "orders": { "items": { "$ref": "#/$defs/OrderDetails" }, "title": "Orders", "type": "array" } }, "$defs": { "Amazons3": { "properties": { "bucket": { "title": "Bucket", "type": "string" }, "aws_region": { "title": "Aws Region", "type": "string" }, "aws_access_key_id": { "title": "Aws Access Key Id", "type": "string" }, "aws_secret_access_key": { "title": "Aws Secret Access Key", "type": "string" }, "path_prefix": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Path Prefix" } }, "required": [ "bucket", "aws_region", "aws_access_key_id", "aws_secret_access_key" ], "title": "Amazons3", "type": "object" }, "AzureBlobStorage": { "properties": { "account": { "title": "Account", "type": "string" }, "container": { "title": "Container", "type": "string" }, "sas_token": { "title": "Sas Token", "type": "string" }, "storage_endpoint_suffix": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Storage Endpoint Suffix" }, "path_prefix": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Path Prefix" } }, "required": [ "account", "container", "sas_token" ], "title": "AzureBlobStorage", "type": "object" }, "BandMathObject": { "description": "See https://developers.planet.com/apis/orders/tools/#band-math and\nhttps://developers.planet.com/apis/orders/bandmath-numpy-routines/ to learn more.", "properties": { "b1": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "B1" }, "b2": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "B2" }, "b3": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "B3" }, "b4": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "B4" }, "b5": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "B5" }, "b6": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "B6" }, "b7": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "B7" }, "b8": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "B8" }, "b9": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "B9" }, "b10": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "B10" }, "b11": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "B11" }, "b12": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "B12" }, "b13": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "B13" }, "b14": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "B14" }, "b15": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "B15" }, "expression": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Expression" }, "pixel_type": { "anyOf": [ { "$ref": "#/$defs/PixelType" }, { "type": "null" } ], "default": null } }, "title": "BandMathObject", "type": "object" }, "BaseMapsGeometrySource": { "properties": { "mosaic_name": { "description": "Name of mosaic", "title": "Mosaic Name", "type": "string" }, "geometry": { "anyOf": [ { "$ref": "#/$defs/PointModel" }, { "$ref": "#/$defs/PolygonModel" }, { "$ref": "#/$defs/MultiPolygonModel" }, { "type": "null" } ], "default": null, "description": "GeoJSON object.", "title": "Geometry" } }, "required": [ "mosaic_name" ], "title": "BaseMapsGeometrySource", "type": "object" }, "BaseMapsQuadIdSource": { "properties": { "mosaic_name": { "description": "Name of mosaic", "title": "Mosaic Name", "type": "string" }, "quad_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": [], "description": "List of quad ids.", "title": "Quad Ids" } }, "required": [ "mosaic_name" ], "title": "BaseMapsQuadIdSource", "type": "object" }, "BasemapClipObject": { "properties": { "clip": { "default": {}, "title": "Clip", "type": "object" } }, "title": "BasemapClipObject", "type": "object" }, "CloudFilterObject": { "properties": { "clear_min": { "title": "Clear Min", "type": "number" }, "cloud_max": { "title": "Cloud Max", "type": "number" } }, "required": [ "clear_min", "cloud_max" ], "title": "CloudFilterObject", "type": "object" }, "CoRegisterObject": { "properties": { "anchor_item": { "title": "Anchor Item", "type": "string" } }, "required": [ "anchor_item" ], "title": "CoRegisterObject", "type": "object" }, "CompositeGroup": { "enum": [ "order", "strip_id" ], "title": "CompositeGroup", "type": "string" }, "CompositeObject": { "properties": { "group_by": { "anyOf": [ { "$ref": "#/$defs/CompositeGroup" }, { "type": "null" } ], "default": null } }, "title": "CompositeObject", "type": "object" }, "Coordinates": { "maxItems": 2, "minItems": 2, "prefixItems": [ { "anyOf": [ { "type": "number" }, { "type": "integer" } ], "ge": -180, "le": 180, "title": "Lon" }, { "anyOf": [ { "type": "number" }, { "type": "integer" } ], "ge": -90, "le": 90, "title": "Lat" } ], "type": "array" }, "FileFormatObject": { "properties": { "format": { "$ref": "#/$defs/Format" } }, "required": [ "format" ], "title": "FileFormatObject", "type": "object" }, "Format": { "enum": [ "COG", "PL_NITF" ], "title": "Format", "type": "string" }, "GoogleCloudStorage": { "properties": { "bucket": { "title": "Bucket", "type": "string" }, "credentials": { "title": "Credentials", "type": "string" }, "path_prefix": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Path Prefix" } }, "required": [ "bucket", "credentials" ], "title": "GoogleCloudStorage", "type": "object" }, "GoogleEarthEngine": { "properties": { "project": { "title": "Project", "type": "string" }, "collection": { "title": "Collection", "type": "string" }, "credentials": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Credentials" } }, "required": [ "project", "collection" ], "title": "GoogleEarthEngine", "type": "object" }, "HarmonizeObject": { "properties": { "target_sensor": { "allOf": [ { "$ref": "#/$defs/TargetSensor" } ], "description": "Sentinel-2 or PS2" } }, "required": [ "target_sensor" ], "title": "HarmonizeObject", "type": "object" }, "Layout": { "properties": { "format": { "title": "Format", "type": "string" } }, "required": [ "format" ], "title": "Layout", "type": "object" }, "MergeObject": { "properties": { "merge": { "default": {}, "title": "Merge", "type": "object" } }, "title": "MergeObject", "type": "object" }, "MultiPolygonModel": { "properties": { "type": { "default": "MultiPolygon", "title": "Multi Polygon", "type": "string" }, "coordinates": { "items": { "items": { "items": { "$ref": "#/$defs/Coordinates" }, "type": "array" }, "type": "array" }, "title": "Coordinates", "type": "array" } }, "required": [ "coordinates" ], "title": "MultiPolygonModel", "type": "object" }, "NotificationWebhook": { "properties": { "url": { "title": "Url", "type": "string" }, "per_order": { "default": false, "description": "If 'true', webhook will be called when order completes.", "title": "Per Order", "type": "boolean" } }, "required": [ "url" ], "title": "NotificationWebhook", "type": "object" }, "OracleCloudStorage": { "properties": { "bucket": { "title": "Bucket", "type": "string" }, "customer_access_key_id": { "title": "Customer Access Key Id", "type": "string" }, "customer_secret_key": { "title": "Customer Secret Key", "type": "string" }, "region": { "title": "Region", "type": "string" }, "namespace": { "title": "Namespace", "type": "string" }, "path_prefix": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Path Prefix" } }, "required": [ "bucket", "customer_access_key_id", "customer_secret_key", "region", "namespace" ], "title": "OracleCloudStorage", "type": "object" }, "OrderDelivery": { "description": "For more information see https://developers.planet.com/apis/orders/reference/#tag/Orders", "properties": { "single_archive": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Single Archive" }, "archive_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Archive Type" }, "archive_filename": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Archive Filename" }, "layout": { "anyOf": [ { "$ref": "#/$defs/Layout" }, { "type": "null" } ], "default": null }, "amazon_s3": { "anyOf": [ { "$ref": "#/$defs/Amazons3" }, { "type": "null" } ], "default": null }, "azure_blob_storage": { "anyOf": [ { "$ref": "#/$defs/AzureBlobStorage" }, { "type": "null" } ], "default": null }, "google_cloud_storage": { "anyOf": [ { "$ref": "#/$defs/GoogleCloudStorage" }, { "type": "null" } ], "default": null }, "google_earth_engine": { "anyOf": [ { "$ref": "#/$defs/GoogleEarthEngine" }, { "type": "null" } ], "default": null }, "oracle_cloud_storage": { "anyOf": [ { "$ref": "#/$defs/OracleCloudStorage" }, { "type": "null" } ], "default": null } }, "title": "OrderDelivery", "type": "object" }, "OrderDetails": { "properties": { "products": { "anyOf": [ { "items": { "anyOf": [ { "$ref": "#/$defs/SceneSource" }, { "$ref": "#/$defs/BaseMapsGeometrySource" }, { "$ref": "#/$defs/BaseMapsQuadIdSource" } ] }, "type": "array" }, { "type": "null" } ], "default": null, "description": "The products from the Data or Basemaps API to order.", "title": "Products" }, "hosting": { "anyOf": [ { "$ref": "#/$defs/OrderHosting" }, { "type": "null" } ], "default": null }, "tools": { "default": [], "items": { "anyOf": [ { "$ref": "#/$defs/HarmonizeObject" }, { "$ref": "#/$defs/CoRegisterObject" }, { "$ref": "#/$defs/ToarObject" }, { "$ref": "#/$defs/SceneClipObject" }, { "$ref": "#/$defs/BasemapClipObject" }, { "$ref": "#/$defs/ReprojectObject" }, { "$ref": "#/$defs/BandMathObject" }, { "$ref": "#/$defs/CompositeObject" }, { "$ref": "#/$defs/TileObject" }, { "$ref": "#/$defs/CloudFilterObject" }, { "$ref": "#/$defs/FileFormatObject" }, { "$ref": "#/$defs/MergeObject" } ] }, "title": "Tools", "type": "array" }, "_links": { "anyOf": [ { "$ref": "#/$defs/OrderDetailsLinks" }, { "type": "null" } ], "default": null }, "id": { "format": "uuid", "title": "Id", "type": "string" }, "name": { "title": "Name", "type": "string" }, "subscription_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": 0, "title": "Subscription Id" }, "metadata": { "anyOf": [ { "$ref": "#/$defs/OrderMetadata" }, { "type": "null" } ], "default": null }, "created_on": { "format": "date-time", "title": "Created On", "type": "string" }, "last_modified": { "format": "date-time", "title": "Last Modified", "type": "string" }, "state": { "$ref": "#/$defs/OrderState" }, "last_message": { "title": "Last Message", "type": "string" }, "error_hints": { "items": { "type": "string" }, "title": "Error Hints", "type": "array" }, "delivery": { "anyOf": [ { "$ref": "#/$defs/OrderDelivery" }, { "type": "null" } ], "default": null }, "notifications": { "anyOf": [ { "$ref": "#/$defs/OrderNotifications" }, { "type": "null" } ], "default": null }, "order_type": { "title": "Order Type", "type": "string" }, "source_type": { "title": "Source Type", "type": "string" } }, "required": [ "id", "name", "created_on", "last_modified", "state", "last_message", "error_hints", "order_type", "source_type" ], "title": "OrderDetails", "type": "object" }, "OrderDetailsLinks": { "properties": { "_self": { "title": " Self", "type": "string" }, "results": { "anyOf": [ { "items": { "$ref": "#/$defs/OrderResult" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Results" } }, "required": [ "_self" ], "title": "OrderDetailsLinks", "type": "object" }, "OrderHosting": { "properties": { "sentinel_hub": { "$ref": "#/$defs/SentinelHubHosting" } }, "required": [ "sentinel_hub" ], "title": "OrderHosting", "type": "object" }, "OrderMetadata": { "properties": { "stac": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Stac" } }, "title": "OrderMetadata", "type": "object" }, "OrderNotifications": { "properties": { "webhook": { "anyOf": [ { "$ref": "#/$defs/NotificationWebhook" }, { "type": "null" } ], "default": null, "description": "Details for calling your webhook. An OrderComponent will be POST'ed to endpoint." }, "email": { "default": false, "description": "Send email to address associated with submitter account.", "title": "Email", "type": "boolean" } }, "title": "OrderNotifications", "type": "object" }, "OrderResult": { "properties": { "delivery": { "$ref": "#/$defs/ResultState" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Name" }, "location": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Location" }, "expires_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Expires At" } }, "required": [ "delivery" ], "title": "OrderResult", "type": "object" }, "OrderState": { "enum": [ "queued", "running", "failed", "success", "partial", "cancelled" ], "title": "OrderState", "type": "string" }, "OrdersResponseLinks": { "properties": { "_self": { "title": " Self", "type": "string" }, "next": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Next" } }, "required": [ "_self" ], "title": "OrdersResponseLinks", "type": "object" }, "PixelType": { "enum": [ "8U", "16U", "16S", "32R" ], "title": "PixelType", "type": "string" }, "PointModel": { "properties": { "type": { "default": "Point", "title": "Point", "type": "string" }, "coordinates": { "$ref": "#/$defs/Coordinates" } }, "required": [ "coordinates" ], "title": "PointModel", "type": "object" }, "PolygonModel": { "properties": { "type": { "default": "Polygon", "title": "Polygon", "type": "string" }, "coordinates": { "items": { "items": { "$ref": "#/$defs/Coordinates" }, "type": "array" }, "title": "Coordinates", "type": "array" } }, "required": [ "coordinates" ], "title": "PolygonModel", "type": "object" }, "ReprojectObject": { "properties": { "projection": { "title": "Projection", "type": "string" }, "kernel": { "anyOf": [ { "$ref": "#/$defs/ResamplingMethod" }, { "type": "null" } ], "default": null }, "resolution": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "title": "Resolution" } }, "required": [ "projection" ], "title": "ReprojectObject", "type": "object" }, "ResamplingMethod": { "enum": [ "bilinear", "cubic", "cubicspline", "lanczos", "average", "mode", "min", "max", "med", "q1", "q3" ], "title": "ResamplingMethod", "type": "string" }, "ResultState": { "enum": [ "pending", "failed", "success" ], "title": "ResultState", "type": "string" }, "SceneClipObject": { "properties": { "aoi": { "anyOf": [ { "$ref": "#/$defs/PolygonModel" }, { "$ref": "#/$defs/MultiPolygonModel" } ], "title": "Aoi" } }, "required": [ "aoi" ], "title": "SceneClipObject", "type": "object" }, "SceneSource": { "properties": { "item_ids": { "description": "Array of item ids.", "items": { "type": "string" }, "title": "Item Ids", "type": "array" }, "item_type": { "description": "item-type for requested item_id.", "title": "Item Type", "type": "string" }, "product_bundle": { "description": "asset-type for the item.", "title": "Product Bundle", "type": "string" } }, "required": [ "item_ids", "item_type", "product_bundle" ], "title": "SceneSource", "type": "object" }, "SentinelHubHosting": { "description": "Before using, you must follow the steps in this article: Linking Planet User to Sentinel Hub User.\nhttps://support.planet.com/hc/en-us/articles/16417885928221-Linking-Planet-User-to-Sentinel-Hub-User\n\nCollections can be found on the Sentinel Hub Dashboard.\nhttps://apps.sentinel-hub.com/dashboard/#/collections", "properties": { "collection_id": { "description": "A Sentinel Hub BYOC collection to deliver to. If omitted, a new collection will be created for you and returned in the response", "format": "uuid", "title": "Collection Id", "type": "string" } }, "required": [ "collection_id" ], "title": "SentinelHubHosting", "type": "object" }, "TargetSensor": { "enum": [ "Sentinel-2", "PS2" ], "title": "TargetSensor", "type": "string" }, "TileObject": { "properties": { "name_template": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Name Template" }, "origin_x": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "title": "Origin X" }, "origin_y": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "title": "Origin Y" }, "pixel_size": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "title": "Pixel Size" }, "tile_size": { "title": "Tile Size", "type": "number" }, "conformal_x_scaling": { "default": false, "title": "Conformal X Scaling", "type": "boolean" } }, "required": [ "tile_size" ], "title": "TileObject", "type": "object" }, "ToarObject": { "properties": { "scale_factor": { "title": "Scale Factor", "type": "number" } }, "required": [ "scale_factor" ], "title": "ToarObject", "type": "object" } }, "required": [ "_links", "orders" ] }
- Fields:
links (cast_planet.orders.models.orders_list.OrdersResponseLinks)orders (List[cast_planet.orders.models.order_details.OrderDetails])
-
field links:
OrdersResponseLinks[Required] (alias '_links')
-
field orders:
List[OrderDetails] [Required]
- pydantic model cast_planet.orders.models.OrdersResponseLinks
Show JSON schema
{ "title": "OrdersResponseLinks", "type": "object", "properties": { "_self": { "title": " Self", "type": "string" }, "next": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Next" } }, "required": [ "_self" ] }
- Fields:
next (str | None)self (str)
-
field next:
Optional[str] = None
-
field self:
str[Required] (alias '_self')
- pydantic model cast_planet.orders.models.OrdersStats
Show JSON schema
{ "title": "OrdersStats", "type": "object", "properties": { "user": { "$ref": "#/$defs/ActiveOrderStats" }, "organization": { "$ref": "#/$defs/ActiveOrderStats" } }, "$defs": { "ActiveOrderStats": { "properties": { "queued_orders": { "title": "Queued Orders", "type": "integer" }, "running_orders": { "title": "Running Orders", "type": "integer" } }, "required": [ "queued_orders", "running_orders" ], "title": "ActiveOrderStats", "type": "object" } }, "required": [ "user", "organization" ] }
- Fields:
organization (cast_planet.orders.models.orders_stats.ActiveOrderStats)user (cast_planet.orders.models.orders_stats.ActiveOrderStats)
-
field organization:
ActiveOrderStats[Required]
-
field user:
ActiveOrderStats[Required]
- class cast_planet.orders.models.PixelType(value)
An enumeration.
- pydantic model cast_planet.orders.models.PointModel
Show JSON schema
{ "title": "PointModel", "type": "object", "properties": { "type": { "default": "Point", "title": "Point", "type": "string" }, "coordinates": { "$ref": "#/$defs/Coordinates" } }, "$defs": { "Coordinates": { "maxItems": 2, "minItems": 2, "prefixItems": [ { "anyOf": [ { "type": "number" }, { "type": "integer" } ], "ge": -180, "le": 180, "title": "Lon" }, { "anyOf": [ { "type": "number" }, { "type": "integer" } ], "ge": -90, "le": 90, "title": "Lat" } ], "type": "array" } }, "required": [ "coordinates" ] }
- Fields:
coordinates (pydantic_geojson._base.Coordinates)type (str)
-
field coordinates:
Coordinates[Required]
-
field type:
str= 'Point'
- pydantic model cast_planet.orders.models.PolygonModel
Show JSON schema
{ "title": "PolygonModel", "type": "object", "properties": { "type": { "default": "Polygon", "title": "Polygon", "type": "string" }, "coordinates": { "items": { "items": { "$ref": "#/$defs/Coordinates" }, "type": "array" }, "title": "Coordinates", "type": "array" } }, "$defs": { "Coordinates": { "maxItems": 2, "minItems": 2, "prefixItems": [ { "anyOf": [ { "type": "number" }, { "type": "integer" } ], "ge": -180, "le": 180, "title": "Lon" }, { "anyOf": [ { "type": "number" }, { "type": "integer" } ], "ge": -90, "le": 90, "title": "Lat" } ], "type": "array" } }, "required": [ "coordinates" ] }
- Fields:
coordinates (List[List[pydantic_geojson._base.Coordinates]])type (str)
-
field coordinates:
List[List[Coordinates]] [Required]
-
field type:
str= 'Polygon'
- pydantic model cast_planet.orders.models.ReprojectObject
Show JSON schema
{ "title": "ReprojectObject", "type": "object", "properties": { "projection": { "title": "Projection", "type": "string" }, "kernel": { "anyOf": [ { "$ref": "#/$defs/ResamplingMethod" }, { "type": "null" } ], "default": null }, "resolution": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "title": "Resolution" } }, "$defs": { "ResamplingMethod": { "enum": [ "bilinear", "cubic", "cubicspline", "lanczos", "average", "mode", "min", "max", "med", "q1", "q3" ], "title": "ResamplingMethod", "type": "string" } }, "required": [ "projection" ] }
- Fields:
kernel (cast_planet.orders.models.tools.ResamplingMethod | None)projection (str)resolution (float | None)
-
field kernel:
Optional[ResamplingMethod] = None
-
field projection:
str[Required]
-
field resolution:
Optional[float] = None
- class cast_planet.orders.models.ResamplingMethod(value)
An enumeration.
- class cast_planet.orders.models.ResultState(value)
An enumeration.
- pydantic model cast_planet.orders.models.SceneClipObject
Show JSON schema
{ "title": "SceneClipObject", "type": "object", "properties": { "aoi": { "anyOf": [ { "$ref": "#/$defs/PolygonModel" }, { "$ref": "#/$defs/MultiPolygonModel" } ], "title": "Aoi" } }, "$defs": { "Coordinates": { "maxItems": 2, "minItems": 2, "prefixItems": [ { "anyOf": [ { "type": "number" }, { "type": "integer" } ], "ge": -180, "le": 180, "title": "Lon" }, { "anyOf": [ { "type": "number" }, { "type": "integer" } ], "ge": -90, "le": 90, "title": "Lat" } ], "type": "array" }, "MultiPolygonModel": { "properties": { "type": { "default": "MultiPolygon", "title": "Multi Polygon", "type": "string" }, "coordinates": { "items": { "items": { "items": { "$ref": "#/$defs/Coordinates" }, "type": "array" }, "type": "array" }, "title": "Coordinates", "type": "array" } }, "required": [ "coordinates" ], "title": "MultiPolygonModel", "type": "object" }, "PolygonModel": { "properties": { "type": { "default": "Polygon", "title": "Polygon", "type": "string" }, "coordinates": { "items": { "items": { "$ref": "#/$defs/Coordinates" }, "type": "array" }, "title": "Coordinates", "type": "array" } }, "required": [ "coordinates" ], "title": "PolygonModel", "type": "object" } }, "required": [ "aoi" ] }
- Fields:
aoi (pydantic_geojson.polygon.PolygonModel | pydantic_geojson.multi_polygon.MultiPolygonModel)
-
field aoi:
Union[PolygonModel,MultiPolygonModel] [Required]
- pydantic model cast_planet.orders.models.SceneSource
Show JSON schema
{ "title": "SceneSource", "type": "object", "properties": { "item_ids": { "description": "Array of item ids.", "items": { "type": "string" }, "title": "Item Ids", "type": "array" }, "item_type": { "description": "item-type for requested item_id.", "title": "Item Type", "type": "string" }, "product_bundle": { "description": "asset-type for the item.", "title": "Product Bundle", "type": "string" } }, "required": [ "item_ids", "item_type", "product_bundle" ] }
- Fields:
item_ids (List[str])item_type (str)product_bundle (str)
-
field item_ids:
List[str] [Required] Array of item ids.
-
field item_type:
str[Required] item-type for requested item_id.
-
field product_bundle:
str[Required] asset-type for the item.
- pydantic model cast_planet.orders.models.SentinelHubHosting
Before using, you must follow the steps in this article: Linking Planet User to Sentinel Hub User. https://support.planet.com/hc/en-us/articles/16417885928221-Linking-Planet-User-to-Sentinel-Hub-User
Collections can be found on the Sentinel Hub Dashboard. https://apps.sentinel-hub.com/dashboard/#/collections
Show JSON schema
{ "title": "SentinelHubHosting", "description": "Before using, you must follow the steps in this article: Linking Planet User to Sentinel Hub User.\nhttps://support.planet.com/hc/en-us/articles/16417885928221-Linking-Planet-User-to-Sentinel-Hub-User\n\nCollections can be found on the Sentinel Hub Dashboard.\nhttps://apps.sentinel-hub.com/dashboard/#/collections", "type": "object", "properties": { "collection_id": { "description": "A Sentinel Hub BYOC collection to deliver to. If omitted, a new collection will be created for you and returned in the response", "format": "uuid", "title": "Collection Id", "type": "string" } }, "required": [ "collection_id" ] }
- Fields:
collection_id (uuid.UUID)
- class cast_planet.orders.models.TargetSensor(value)
An enumeration.
- pydantic model cast_planet.orders.models.TileObject
Show JSON schema
{ "title": "TileObject", "type": "object", "properties": { "name_template": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Name Template" }, "origin_x": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "title": "Origin X" }, "origin_y": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "title": "Origin Y" }, "pixel_size": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "title": "Pixel Size" }, "tile_size": { "title": "Tile Size", "type": "number" }, "conformal_x_scaling": { "default": false, "title": "Conformal X Scaling", "type": "boolean" } }, "required": [ "tile_size" ] }
- Fields:
conformal_x_scaling (bool)name_template (str | None)origin_x (float | None)origin_y (float | None)pixel_size (float | None)tile_size (float)
-
field conformal_x_scaling:
bool= False
-
field name_template:
Optional[str] = None
-
field origin_x:
Optional[float] = None
-
field origin_y:
Optional[float] = None
-
field pixel_size:
Optional[float] = None
-
field tile_size:
float[Required]
- pydantic model cast_planet.orders.models.ToarObject
Show JSON schema
{ "title": "ToarObject", "type": "object", "properties": { "scale_factor": { "title": "Scale Factor", "type": "number" } }, "required": [ "scale_factor" ] }
- Fields:
scale_factor (float)
-
field scale_factor:
float[Required]
- class cast_planet.orders.models.UUID(hex=None, bytes=None, bytes_le=None, fields=None, int=None, version=None, *, is_safe=SafeUUID.unknown)
Instances of the UUID class represent UUIDs as specified in RFC 4122. UUID objects are immutable, hashable, and usable as dictionary keys. Converting a UUID to a string with str() yields something in the form ‘12345678-1234-1234-1234-123456789abc’. The UUID constructor accepts five possible forms: a similar string of hexadecimal digits, or a tuple of six integer fields (with 32-bit, 16-bit, 16-bit, 8-bit, 8-bit, and 48-bit values respectively) as an argument named ‘fields’, or a string of 16 bytes (with all the integer fields in big-endian order) as an argument named ‘bytes’, or a string of 16 bytes (with the first three fields in little-endian order) as an argument named ‘bytes_le’, or a single 128-bit integer as an argument named ‘int’.
UUIDs have these read-only attributes:
- bytes the UUID as a 16-byte string (containing the six
integer fields in big-endian byte order)
- bytes_le the UUID as a 16-byte string (with time_low, time_mid,
and time_hi_version in little-endian byte order)
- fields a tuple of the six integer fields of the UUID,
which are also available as six individual attributes and two derived attributes:
time_low the first 32 bits of the UUID time_mid the next 16 bits of the UUID time_hi_version the next 16 bits of the UUID clock_seq_hi_variant the next 8 bits of the UUID clock_seq_low the next 8 bits of the UUID node the last 48 bits of the UUID
time the 60-bit timestamp clock_seq the 14-bit sequence number
hex the UUID as a 32-character hexadecimal string
int the UUID as a 128-bit integer
urn the UUID as a URN as specified in RFC 4122
- variant the UUID variant (one of the constants RESERVED_NCS,
RFC_4122, RESERVED_MICROSOFT, or RESERVED_FUTURE)
- version the UUID version number (1 through 5, meaningful only
when the variant is RFC_4122)
- is_safe An enum indicating whether the UUID has been generated in
a way that is safe for multiprocessing applications, via uuid_generate_time_safe(3).
- class cast_planet.orders.models.datetime(year, month, day[, hour[, minute[, second[, microsecond[, tzinfo]]]]])
The year, month and day arguments are required. tzinfo may be None, or an instance of a tzinfo subclass. The remaining arguments may be ints.
- astimezone()
tz -> convert to local time in new timezone tz
- combine()
date, time -> datetime with same date and time fields
- ctime()
Return ctime() style string.
- date()
Return date object with same year, month and day.
- dst()
Return self.tzinfo.dst(self).
- fromisoformat()
string -> datetime from datetime.isoformat() output
- fromtimestamp()
timestamp[, tz] -> tz’s local time from POSIX timestamp.
- isoformat()
[sep] -> string in ISO 8601 format, YYYY-MM-DDT[HH[:MM[:SS[.mmm[uuu]]]]][+HH:MM]. sep is used to separate the year from the time, and defaults to ‘T’. The optional argument timespec specifies the number of additional terms of the time to include. Valid options are ‘auto’, ‘hours’, ‘minutes’, ‘seconds’, ‘milliseconds’ and ‘microseconds’.
- now()
Returns new datetime object representing current time local to tz.
- tz
Timezone object.
If no tz is specified, uses local timezone.
- replace()
Return datetime with new specified fields.
- strptime()
string, format -> new datetime parsed from a string (like time.strptime()).
- time()
Return time object with same time but with tzinfo=None.
- timestamp()
Return POSIX timestamp as float.
- timetuple()
Return time tuple, compatible with time.localtime().
- timetz()
Return time object with same time and tzinfo.
- tzname()
Return self.tzinfo.tzname(self).
- utcfromtimestamp()
Construct a naive UTC datetime from a POSIX timestamp.
- utcnow()
Return a new datetime representing UTC day and time.
- utcoffset()
Return self.tzinfo.utcoffset(self).
- utctimetuple()
Return UTC time tuple, compatible with time.localtime().