DataAPI

Wrapper class for interacting with the Planet Data API. Provides methods for searching, retrieving, and managing items, item assets, and item types.

See the Planet Data API documentation for more details: https://developers.planet.com/docs/apis/data/

Example usage

from cast_planet import DataAPI

api = DataAPI(api_key='your api key here')

Filters

Users can use a combination of filters to search for data using the DataAPI ‘quick_search’ method. Below are all the available filter options.

Asset

pydantic model cast_planet.data.filters.AssetFilter

From the asset filter documentation:

The filter’s configuration is a list of asset types. When multiple values are specified, an implicit “or” logic is applied, returning all items which include any of the listed asset types. An AndFilter can be used to filter items by multiple asset types. https://developers.planet.com/docs/apis/data/searches-filtering/#asset-filters

Show JSON schema

{
   "title": "AssetFilter",
   "description": "From the asset filter documentation:\n\nThe filter's configuration is a list of asset types. When multiple values are specified,\nan implicit \u201cor\u201d logic is applied, returning all items which include any of the listed asset\ntypes. An AndFilter can be used to filter items by multiple asset types.\nhttps://developers.planet.com/docs/apis/data/searches-filtering/#asset-filters",
   "type": "object",
   "properties": {
      "type": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "description": "The type of filter being created. This is automatically generated. Do not alter.",
         "title": "type"
      },
      "config": {
         "description": "A list of item assets.",
         "examples": [
            "ortho_analytics_4b"
         ],
         "items": {
            "type": "string"
         },
         "minItems": 1,
         "title": "Config",
         "type": "array"
      }
   },
   "required": [
      "type",
      "config"
   ]
}

Fields:

config (List[str])

field config: List[str] [Required]

A list of item assets.

Constraints:

min_length = 1

Field

Learn more about each individual Field search filter at https://developers.planet.com/docs/apis/data/searches-filtering/#field-filters

pydantic model cast_planet.data.filters.field.DateRangeConfig

Show JSON schema

{
   "title": "DateRangeConfig",
   "type": "object",
   "properties": {
      "gt": {
         "anyOf": [
            {
               "format": "date-time",
               "type": "string"
            },
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Greater than",
         "title": "gt"
      },
      "lt": {
         "anyOf": [
            {
               "format": "date-time",
               "type": "string"
            },
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Lt"
      },
      "gte": {
         "anyOf": [
            {
               "format": "date-time",
               "type": "string"
            },
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Gte"
      },
      "lte": {
         "anyOf": [
            {
               "format": "date-time",
               "type": "string"
            },
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Lte"
      }
   }
}

Fields:

gt (datetime.datetime | str | None)
gte (datetime.datetime | str | None)
lt (datetime.datetime | str | None)
lte (datetime.datetime | str | None)

field gt: Union[Annotated[datetime], str, None] = None: Greater than

field gte: Union[Annotated[datetime], str, None] = None

field lt: Union[Annotated[datetime], str, None] = None

field lte: Union[Annotated[datetime], str, None] = None

pydantic model cast_planet.data.filters.field.DateRangeFilter

Show JSON schema

{
   "title": "DateRangeFilter",
   "type": "object",
   "properties": {
      "type": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "description": "The type of filter being created. This is automatically generated. Do not alter.",
         "title": "type"
      },
      "field_name": {
         "title": "Field Name",
         "type": "string"
      },
      "config": {
         "$ref": "#/$defs/DateRangeConfig"
      }
   },
   "$defs": {
      "DateRangeConfig": {
         "properties": {
            "gt": {
               "anyOf": [
                  {
                     "format": "date-time",
                     "type": "string"
                  },
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Greater than",
               "title": "gt"
            },
            "lt": {
               "anyOf": [
                  {
                     "format": "date-time",
                     "type": "string"
                  },
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Lt"
            },
            "gte": {
               "anyOf": [
                  {
                     "format": "date-time",
                     "type": "string"
                  },
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Gte"
            },
            "lte": {
               "anyOf": [
                  {
                     "format": "date-time",
                     "type": "string"
                  },
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Lte"
            }
         },
         "title": "DateRangeConfig",
         "type": "object"
      }
   },
   "required": [
      "type",
      "field_name",
      "config"
   ]
}

Fields:

config (cast_planet.data.filters.field.DateRangeConfig)

field config: DateRangeConfig [Required]

pydantic model cast_planet.data.filters.field.GeometryFilter

Matches items with a footprint that intersects with a specified GeoJSON geometry.

Parameters:: config – A valid GeJSON feature dictionary.

Show JSON schema

{
   "title": "GeometryFilter",
   "description": "Matches items with a footprint that intersects with a specified GeoJSON geometry.\n\n:param config: A valid GeJSON feature dictionary.",
   "type": "object",
   "properties": {
      "type": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "description": "The type of filter being created. This is automatically generated. Do not alter.",
         "title": "type"
      },
      "field_name": {
         "title": "Field Name",
         "type": "string"
      },
      "config": {
         "anyOf": [
            {
               "$ref": "#/$defs/PointModel"
            },
            {
               "$ref": "#/$defs/MultiPointModel"
            },
            {
               "$ref": "#/$defs/LineStringModel"
            },
            {
               "$ref": "#/$defs/MultiLineStringModel"
            },
            {
               "$ref": "#/$defs/PolygonModel"
            },
            {
               "$ref": "#/$defs/MultiPolygonModel"
            }
         ],
         "title": "Config"
      }
   },
   "$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"
      },
      "LineStringModel": {
         "properties": {
            "type": {
               "default": "LineString",
               "title": "LineS String",
               "type": "string"
            },
            "coordinates": {
               "items": {
                  "$ref": "#/$defs/Coordinates"
               },
               "title": "Coordinates",
               "type": "array"
            }
         },
         "required": [
            "coordinates"
         ],
         "title": "LineStringModel",
         "type": "object"
      },
      "MultiLineStringModel": {
         "properties": {
            "type": {
               "default": "MultiLineString",
               "title": "Multi Line String",
               "type": "string"
            },
            "coordinates": {
               "items": {
                  "items": {
                     "$ref": "#/$defs/Coordinates"
                  },
                  "type": "array"
               },
               "title": "Coordinates",
               "type": "array"
            }
         },
         "required": [
            "coordinates"
         ],
         "title": "MultiLineStringModel",
         "type": "object"
      },
      "MultiPointModel": {
         "properties": {
            "type": {
               "default": "MultiPoint",
               "title": "Multi Point",
               "type": "string"
            },
            "coordinates": {
               "items": {
                  "$ref": "#/$defs/Coordinates"
               },
               "title": "Coordinates",
               "type": "array"
            }
         },
         "required": [
            "coordinates"
         ],
         "title": "MultiPointModel",
         "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"
      },
      "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": [
      "type",
      "field_name",
      "config"
   ]
}

Fields:

config (pydantic_geojson.point.PointModel | pydantic_geojson.multi_point.MultiPointModel | pydantic_geojson.line_string.LineStringModel | pydantic_geojson.multi_line_string.MultiLineStringModel | pydantic_geojson.polygon.PolygonModel | pydantic_geojson.multi_polygon.MultiPolygonModel)

field config: Union[PointModel, MultiPointModel, LineStringModel, MultiLineStringModel, PolygonModel, MultiPolygonModel] [Required]

pydantic model cast_planet.data.filters.field.NumberInFilter

Show JSON schema

{
   "title": "NumberInFilter",
   "type": "object",
   "properties": {
      "type": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "description": "The type of filter being created. This is automatically generated. Do not alter.",
         "title": "type"
      },
      "field_name": {
         "title": "Field Name",
         "type": "string"
      },
      "config": {
         "items": {
            "anyOf": [
               {
                  "type": "integer"
               },
               {
                  "type": "number"
               }
            ]
         },
         "minItems": 1,
         "title": "Config",
         "type": "array"
      }
   },
   "required": [
      "type",
      "field_name",
      "config"
   ]
}

Fields:

config (List[int | float])

field config: List[Union[int, float]] [Required]

Constraints:

min_length = 1

pydantic model cast_planet.data.filters.field.RangeConfig

Show JSON schema

{
   "title": "RangeConfig",
   "type": "object",
   "properties": {
      "lt": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Lt"
      },
      "gte": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Gte"
      },
      "lte": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Lte"
      }
   }
}

Fields:

gte (int | float | None)
lt (int | float | None)
lte (int | float | None)

field gte: Union[int, float, None] = None

field lt: Union[int, float, None] = None

field lte: Union[int, float, None] = None

pydantic model cast_planet.data.filters.field.RangeFilter

Show JSON schema

{
   "title": "RangeFilter",
   "type": "object",
   "properties": {
      "type": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "description": "The type of filter being created. This is automatically generated. Do not alter.",
         "title": "type"
      },
      "field_name": {
         "title": "Field Name",
         "type": "string"
      },
      "config": {
         "$ref": "#/$defs/RangeConfig"
      }
   },
   "$defs": {
      "RangeConfig": {
         "properties": {
            "lt": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "number"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Lt"
            },
            "gte": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "number"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Gte"
            },
            "lte": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "number"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Lte"
            }
         },
         "title": "RangeConfig",
         "type": "object"
      }
   },
   "required": [
      "type",
      "field_name",
      "config"
   ]
}

Fields:

config (cast_planet.data.filters.field.RangeConfig)

field config: RangeConfig [Required]

pydantic model cast_planet.data.filters.field.StringInFilter

Show JSON schema

{
   "title": "StringInFilter",
   "type": "object",
   "properties": {
      "type": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "description": "The type of filter being created. This is automatically generated. Do not alter.",
         "title": "type"
      },
      "field_name": {
         "title": "Field Name",
         "type": "string"
      },
      "config": {
         "items": {
            "type": "string"
         },
         "minItems": 1,
         "title": "Config",
         "type": "array"
      }
   },
   "required": [
      "type",
      "field_name",
      "config"
   ]
}

Fields:

config (List[str])

field config: List[str] [Required]

Constraints:

min_length = 1

pydantic model cast_planet.data.filters.field.UpdateConfig

Show JSON schema

{
   "title": "UpdateConfig",
   "type": "object",
   "properties": {
      "type": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "description": "The type of filter being created. This is automatically generated. Do not alter.",
         "title": "type"
      },
      "field_name": {
         "title": "Field Name",
         "type": "string"
      },
      "gt": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "title": "Gt"
      },
      "gte": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "title": "Gte"
      }
   },
   "required": [
      "type",
      "field_name",
      "gt",
      "gte"
   ]
}

Fields:

gt (int | float | None)
gte (int | float | None)

field gt: Union[int, float, None] [Required]

field gte: Union[int, float, None] [Required]

pydantic model cast_planet.data.filters.field.UpdateFilter

Show JSON schema

{
   "title": "UpdateFilter",
   "type": "object",
   "properties": {
      "type": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "description": "The type of filter being created. This is automatically generated. Do not alter.",
         "title": "type"
      },
      "field_name": {
         "title": "Field Name",
         "type": "string"
      },
      "config": {
         "$ref": "#/$defs/UpdateConfig"
      }
   },
   "$defs": {
      "UpdateConfig": {
         "properties": {
            "type": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "description": "The type of filter being created. This is automatically generated. Do not alter.",
               "title": "type"
            },
            "field_name": {
               "title": "Field Name",
               "type": "string"
            },
            "gt": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "number"
                  },
                  {
                     "type": "null"
                  }
               ],
               "title": "Gt"
            },
            "gte": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "number"
                  },
                  {
                     "type": "null"
                  }
               ],
               "title": "Gte"
            }
         },
         "required": [
            "type",
            "field_name",
            "gt",
            "gte"
         ],
         "title": "UpdateConfig",
         "type": "object"
      }
   },
   "required": [
      "type",
      "field_name",
      "config"
   ]
}

Fields:

config (cast_planet.data.filters.field.UpdateConfig)

field config: UpdateConfig [Required]

Logical

pydantic model cast_planet.data.filters.AndFilter

Matches items with properties or permissions which match all the nested filters.

See more at: https://developers.planet.com/docs/apis/data/searches-filtering/#logical-filters

Show JSON schema

{
   "title": "AndFilter",
   "description": "Matches items with properties or permissions which match all the nested filters.\n\nSee more at:\nhttps://developers.planet.com/docs/apis/data/searches-filtering/#logical-filters",
   "type": "object",
   "properties": {
      "type": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "description": "The type of filter being created. This is automatically generated. Do not alter.",
         "title": "type"
      },
      "config": {
         "description": "A list of objects to which this logic will apply.",
         "items": {},
         "minItems": 1,
         "title": "Config",
         "type": "array"
      }
   },
   "required": [
      "type",
      "config"
   ]
}

Fields:

config (List[Any])
type (str | None)

pydantic model cast_planet.data.filters.NotFilter

Matches items with properties or permissions which do not match the nested filter. This filter type supports a single nested filter.

See more at: https://developers.planet.com/docs/apis/data/searches-filtering/#logical-filters

Show JSON schema

{
   "title": "NotFilter",
   "description": "Matches items with properties or permissions which do not match the nested\nfilter. This filter type supports a single nested filter.\n\n\nSee more at:\nhttps://developers.planet.com/docs/apis/data/searches-filtering/#logical-filters",
   "type": "object",
   "properties": {
      "type": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "description": "The type of filter being created. This is automatically generated. Do not alter.",
         "title": "type"
      },
      "config": {
         "$ref": "#/$defs/BaseFilter"
      }
   },
   "$defs": {
      "BaseFilter": {
         "description": "Base filter for creating Data API filters.\n\nBe sure any subclasses created from this filter match the\ntype naming conventions from https://developers.planet.com/docs/apis/data/searches-filtering/",
         "properties": {
            "type": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "description": "The type of filter being created. This is automatically generated. Do not alter.",
               "title": "type"
            }
         },
         "required": [
            "type"
         ],
         "title": "BaseFilter",
         "type": "object"
      }
   },
   "required": [
      "type",
      "config"
   ]
}

Fields:

config (cast_planet.data.filters.base.BaseFilter)

field config: BaseFilter [Required]

pydantic model cast_planet.data.filters.OrFilter

Matches items with properties or permissions which match at least one of the nested filters.

See more at: https://developers.planet.com/docs/apis/data/searches-filtering/#logical-filters

Show JSON schema

{
   "title": "OrFilter",
   "description": "Matches items with properties or permissions which match at least one of the nested filters.\n\nSee more at:\nhttps://developers.planet.com/docs/apis/data/searches-filtering/#logical-filters",
   "type": "object",
   "properties": {
      "type": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "description": "The type of filter being created. This is automatically generated. Do not alter.",
         "title": "type"
      },
      "config": {
         "description": "A list of objects to which this logic will apply.",
         "items": {},
         "minItems": 1,
         "title": "Config",
         "type": "array"
      }
   },
   "required": [
      "type",
      "config"
   ]
}

Fields:

config (List[Any])
type (str | None)

Permission

pydantic model cast_planet.data.filters.PermissionFilter

Limits search results to items the user has permission to download. This filter is added by default for all searches.

IMPORTANT: Not recommended for use with logical ‘Or’ or ‘Not’ filters. Use of these without an ‘And’ filter will void the permissions’ requirement.

Show JSON schema

{
   "title": "PermissionFilter",
   "description": "Limits search results to items the user has permission to download.\nThis filter is added by default for all searches.\n\nIMPORTANT: Not recommended for use with logical 'Or' or 'Not' filters. Use of these without an 'And' filter will\nvoid the permissions' requirement.",
   "type": "object",
   "properties": {
      "type": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "description": "The type of filter being created. This is automatically generated. Do not alter.",
         "title": "type"
      },
      "config": {
         "default": [
            "assets:download"
         ],
         "items": {
            "type": "string"
         },
         "title": "Config",
         "type": "array"
      }
   },
   "required": [
      "type"
   ]
}

Fields:

config (List[str])

field config: List[str] = ['assets:download']: This is automatically set to ‘assets:download’. Do not change.

API reference

DataAPI

class cast_planet.DataAPI(api_key, base_url='https://api.planet.com/data/v1', logging_filepath=None, log_level=None)

Wrapper class for interacting with the Planet Data API. Provides methods for searching, retrieving, and managing items, item assets, and item types.

See the Planet Data API documentation for more details: https://developers.planet.com/docs/apis/data/

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 (Optional[str]) – If supplied, class will log to file.
log_level (Optional[int]) – If supplied, sets the log level for the class. Default logging level is logging.ERROR.

activate_item_asset(item, item_asset)

Activates an item asset if its status is inactive. If the asset is already active or activating, the method does nothing. If the asset is inactive, the method sends a request to activate it.

Parameters:

item (QuickSearchItem) – The QuickSearchItem that contains the asset to activate.
item_asset (str) – The ID of the item asset to activate.

Return type:

ItemAsset

Returns:

An ItemAsset object representing the activated asset.

Raises:

AssetNotFoundException – If the asset is not found in the item.

check_asset_status(asset)

Checks the current status of an activated item asset by querying its status from the Planet API.

Parameters:: asset (ItemAsset) – The ItemAsset object representing the asset whose status is being checked.
Return type:: ItemAsset
Returns:: The updated ItemAsset object with the current status.

download_item_asset(item_asset, folder=None, filename=None)

Downloads an active item asset and saves it to the specified folder. If the asset is not active or does not have a valid location, a ValueError is raised.

Parameters:

item_asset (ItemAsset) – The ItemAsset object representing the asset to download.
folder (Optional[str]) – Optional. The folder where the asset will be saved. If not provided, the current directory is used.
filename (Optional[str]) – Optional. The filename to save the asset as. If not provided, the filename is derived from the asset.

Return type:

str

Returns:

The file path where the asset was saved.

Raises:

ValueError – If the item asset does not have a valid location.

download_item_previews(items, folder='.'): Gather and download a previews for a group of items :type items: List[QuickSearchItem] :param items: :type folder: str :param folder: :rtype: List[str] :return:

item_types()

Retrieves all available item types from the Planet Data API.

This method calls the /item-types endpoint to list the supported item types.

Return type:: List[ItemType]
Returns:: A list of ItemType objects representing all available item types.

jupyter_preview(item)

Displays a preview of the item’s thumbnail image in a Jupyter notebook.

This method fetches the thumbnail image from the Planet API and displays it using IPython’s display functionality.

Parameters:: item (QuickSearchItem) – The QuickSearchItem object representing the item to preview.
Returns:: Displays the thumbnail image.

quick_search(item_types, search_filter, asset_types=None, name=None, sort=None, permissions=True)

Searches for items that match the provided filter criteria. Optionally, results can be filtered by asset types, name, and sorting options. Permissions can also be applied to limit the search to items with download permissions.

The search criteria are combined into a request body, which is then sent to the /quick-search endpoint of the Planet Data API.

Parameters:

item_types (List[Union[str, ItemType]]) – Required. A list of item types to include in the search. Can be a mix of ItemType objects and strings representing item types.
search_filter (BaseFilter) – Required. A filter to limit the search results.
asset_types (Optional[List[str]]) – Optional. A list of asset types to limit the search results.
name (Optional[str]) – Optional. A name fragment to search for.
sort (Optional[QuerySort]) – Optional. The sorting criteria for the search results.
permissions (bool) – Optional. If True, limits results to items with download permissions.

Return type:

QuickSearchResponse

Returns:

A QuickSearchResponse object containing the search results.

Models

pydantic model cast_planet.data.models.FeatureLinks

Show JSON schema

{
   "title": "FeatureLinks",
   "type": "object",
   "properties": {
      "_self": {
         "title": " Self",
         "type": "string"
      },
      "assets": {
         "title": "Assets",
         "type": "string"
      },
      "thumbnail": {
         "title": "Thumbnail",
         "type": "string"
      }
   },
   "required": [
      "_self",
      "assets",
      "thumbnail"
   ]
}

Fields:

assets (str)
self (str)
thumbnail (str)

field assets: str [Required]

field self: str [Required] (alias '_self')

field thumbnail: str [Required]

pydantic model cast_planet.data.models.ItemAsset

Show JSON schema

{
   "title": "ItemAsset",
   "type": "object",
   "properties": {
      "_links": {
         "$ref": "#/$defs/ItemAssetLinks"
      },
      "_permissions": {
         "items": {
            "type": "string"
         },
         "title": " Permissions",
         "type": "array"
      },
      "expires_at": {
         "anyOf": [
            {
               "format": "date-time",
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Expires At"
      },
      "location": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Location"
      },
      "status": {
         "$ref": "#/$defs/ItemAssetStatus"
      },
      "type": {
         "title": "Type",
         "type": "string"
      }
   },
   "$defs": {
      "ItemAssetLinks": {
         "properties": {
            "_self": {
               "title": " Self",
               "type": "string"
            },
            "activate": {
               "title": "Activate",
               "type": "string"
            },
            "type": {
               "title": "Type",
               "type": "string"
            }
         },
         "required": [
            "_self",
            "activate",
            "type"
         ],
         "title": "ItemAssetLinks",
         "type": "object"
      },
      "ItemAssetStatus": {
         "enum": [
            "inactive",
            "activating",
            "active"
         ],
         "title": "ItemAssetStatus",
         "type": "string"
      }
   },
   "required": [
      "_links",
      "_permissions",
      "status",
      "type"
   ]
}

Fields:

expires_at (datetime.datetime | None)
links (cast_planet.data.models.ItemAssetLinks)
location (str | None)
permissions (List[str])
status (cast_planet.data.models.ItemAssetStatus)
type (str)

field expires_at: Optional[datetime] = None

field links: ItemAssetLinks [Required] (alias '_links')

field location: Optional[str] = None

field permissions: List[str] [Required] (alias '_permissions')

field status: ItemAssetStatus [Required]

field type: str [Required]

pydantic model cast_planet.data.models.ItemAssetLinks

Show JSON schema

{
   "title": "ItemAssetLinks",
   "type": "object",
   "properties": {
      "_self": {
         "title": " Self",
         "type": "string"
      },
      "activate": {
         "title": "Activate",
         "type": "string"
      },
      "type": {
         "title": "Type",
         "type": "string"
      }
   },
   "required": [
      "_self",
      "activate",
      "type"
   ]
}

Fields:

activate (str)
self (str)
type (str)

field activate: str [Required]

field self: str [Required] (alias '_self')

field type: str [Required]

class cast_planet.data.models.ItemAssetStatus(value): An enumeration.

pydantic model cast_planet.data.models.ItemType

Show JSON schema

{
   "title": "ItemType",
   "description": "    ",
   "type": "object",
   "properties": {
      "id": {
         "title": "Id",
         "type": "string"
      },
      "display_description": {
         "title": "Display Description",
         "type": "string"
      },
      "display_name": {
         "title": "Display Name",
         "type": "string"
      },
      "supported_asset_types": {
         "items": {
            "type": "string"
         },
         "title": "Supported Asset Types",
         "type": "array"
      }
   },
   "required": [
      "id",
      "display_description",
      "display_name",
      "supported_asset_types"
   ]
}

Fields:

display_description (str)
display_name (str)
id (str)
supported_asset_types (List[str])

field display_description: str [Required]

field display_name: str [Required]

field id: str [Required]

field supported_asset_types: List[str] [Required]

pydantic model cast_planet.data.models.Links

Show JSON schema

{
   "title": "Links",
   "type": "object",
   "properties": {
      "_self": {
         "title": " Self",
         "type": "string"
      },
      "_first": {
         "title": " First",
         "type": "string"
      },
      "_next": {
         "title": " Next",
         "type": "string"
      }
   },
   "required": [
      "_self",
      "_first",
      "_next"
   ]
}

Fields:

first (str)
next (str)
self (str)

field first: str [Required] (alias '_first')

field next: str [Required] (alias '_next')

field self: str [Required] (alias '_self')

class cast_planet.data.models.QuerySort(value): Supported values for the _sort query parameter. Default value if none specified is published desc

pydantic model cast_planet.data.models.QuickSearchItem

Show JSON schema

{
   "title": "QuickSearchItem",
   "type": "object",
   "properties": {
      "type": {
         "default": "Feature",
         "title": "Feature",
         "type": "string"
      },
      "geometry": {
         "anyOf": [
            {
               "$ref": "#/$defs/PointModel"
            },
            {
               "$ref": "#/$defs/MultiPointModel"
            },
            {
               "$ref": "#/$defs/LineStringModel"
            },
            {
               "$ref": "#/$defs/MultiLineStringModel"
            },
            {
               "$ref": "#/$defs/PolygonModel"
            },
            {
               "$ref": "#/$defs/MultiPolygonModel"
            }
         ],
         "title": "Geometry"
      },
      "_links": {
         "$ref": "#/$defs/FeatureLinks"
      },
      "_permissions": {
         "items": {
            "type": "string"
         },
         "title": " Permissions",
         "type": "array"
      },
      "properties": {
         "type": "object",
         "title": "Properties"
      },
      "assets": {
         "items": {
            "type": "string"
         },
         "title": "Assets",
         "type": "array"
      },
      "id": {
         "title": "Id",
         "type": "string"
      }
   },
   "$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"
      },
      "FeatureLinks": {
         "properties": {
            "_self": {
               "title": " Self",
               "type": "string"
            },
            "assets": {
               "title": "Assets",
               "type": "string"
            },
            "thumbnail": {
               "title": "Thumbnail",
               "type": "string"
            }
         },
         "required": [
            "_self",
            "assets",
            "thumbnail"
         ],
         "title": "FeatureLinks",
         "type": "object"
      },
      "LineStringModel": {
         "properties": {
            "type": {
               "default": "LineString",
               "title": "LineS String",
               "type": "string"
            },
            "coordinates": {
               "items": {
                  "$ref": "#/$defs/Coordinates"
               },
               "title": "Coordinates",
               "type": "array"
            }
         },
         "required": [
            "coordinates"
         ],
         "title": "LineStringModel",
         "type": "object"
      },
      "MultiLineStringModel": {
         "properties": {
            "type": {
               "default": "MultiLineString",
               "title": "Multi Line String",
               "type": "string"
            },
            "coordinates": {
               "items": {
                  "items": {
                     "$ref": "#/$defs/Coordinates"
                  },
                  "type": "array"
               },
               "title": "Coordinates",
               "type": "array"
            }
         },
         "required": [
            "coordinates"
         ],
         "title": "MultiLineStringModel",
         "type": "object"
      },
      "MultiPointModel": {
         "properties": {
            "type": {
               "default": "MultiPoint",
               "title": "Multi Point",
               "type": "string"
            },
            "coordinates": {
               "items": {
                  "$ref": "#/$defs/Coordinates"
               },
               "title": "Coordinates",
               "type": "array"
            }
         },
         "required": [
            "coordinates"
         ],
         "title": "MultiPointModel",
         "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"
      },
      "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": [
      "geometry",
      "_links",
      "_permissions",
      "properties",
      "assets",
      "id"
   ]
}

Fields:

assets (List[str])
id (str)
links (cast_planet.data.models.FeatureLinks)
permissions (List[str])
properties (Dict[str, Any])

field assets: List[str] [Required]

field id: str [Required]

field links: FeatureLinks [Required] (alias '_links')

field permissions: List[str] [Required] (alias '_permissions')

field properties: Dict[str, Any] [Required]

pydantic model cast_planet.data.models.QuickSearchResponse

Show JSON schema

{
   "title": "QuickSearchResponse",
   "type": "object",
   "properties": {
      "type": {
         "default": "FeatureCollection",
         "title": "Feature Collection",
         "type": "string"
      },
      "features": {
         "items": {
            "$ref": "#/$defs/QuickSearchItem"
         },
         "title": "Features",
         "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"
      },
      "FeatureLinks": {
         "properties": {
            "_self": {
               "title": " Self",
               "type": "string"
            },
            "assets": {
               "title": "Assets",
               "type": "string"
            },
            "thumbnail": {
               "title": "Thumbnail",
               "type": "string"
            }
         },
         "required": [
            "_self",
            "assets",
            "thumbnail"
         ],
         "title": "FeatureLinks",
         "type": "object"
      },
      "LineStringModel": {
         "properties": {
            "type": {
               "default": "LineString",
               "title": "LineS String",
               "type": "string"
            },
            "coordinates": {
               "items": {
                  "$ref": "#/$defs/Coordinates"
               },
               "title": "Coordinates",
               "type": "array"
            }
         },
         "required": [
            "coordinates"
         ],
         "title": "LineStringModel",
         "type": "object"
      },
      "MultiLineStringModel": {
         "properties": {
            "type": {
               "default": "MultiLineString",
               "title": "Multi Line String",
               "type": "string"
            },
            "coordinates": {
               "items": {
                  "items": {
                     "$ref": "#/$defs/Coordinates"
                  },
                  "type": "array"
               },
               "title": "Coordinates",
               "type": "array"
            }
         },
         "required": [
            "coordinates"
         ],
         "title": "MultiLineStringModel",
         "type": "object"
      },
      "MultiPointModel": {
         "properties": {
            "type": {
               "default": "MultiPoint",
               "title": "Multi Point",
               "type": "string"
            },
            "coordinates": {
               "items": {
                  "$ref": "#/$defs/Coordinates"
               },
               "title": "Coordinates",
               "type": "array"
            }
         },
         "required": [
            "coordinates"
         ],
         "title": "MultiPointModel",
         "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"
      },
      "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"
      },
      "QuickSearchItem": {
         "properties": {
            "type": {
               "default": "Feature",
               "title": "Feature",
               "type": "string"
            },
            "geometry": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/PointModel"
                  },
                  {
                     "$ref": "#/$defs/MultiPointModel"
                  },
                  {
                     "$ref": "#/$defs/LineStringModel"
                  },
                  {
                     "$ref": "#/$defs/MultiLineStringModel"
                  },
                  {
                     "$ref": "#/$defs/PolygonModel"
                  },
                  {
                     "$ref": "#/$defs/MultiPolygonModel"
                  }
               ],
               "title": "Geometry"
            },
            "_links": {
               "$ref": "#/$defs/FeatureLinks"
            },
            "_permissions": {
               "items": {
                  "type": "string"
               },
               "title": " Permissions",
               "type": "array"
            },
            "properties": {
               "type": "object",
               "title": "Properties"
            },
            "assets": {
               "items": {
                  "type": "string"
               },
               "title": "Assets",
               "type": "array"
            },
            "id": {
               "title": "Id",
               "type": "string"
            }
         },
         "required": [
            "geometry",
            "_links",
            "_permissions",
            "properties",
            "assets",
            "id"
         ],
         "title": "QuickSearchItem",
         "type": "object"
      }
   },
   "required": [
      "features"
   ]
}

Fields:

features (List[cast_planet.data.models.QuickSearchItem])

field features: List[QuickSearchItem] [Required]: A list of QuickSearchItem(s) returned from the REST API.

filter(func)

Filter results by a custom comparer.

Parameters:: func (Callable[[QuickSearchItem], bool]) – Any function that takes in a ResponseFeature and returns a boolean result.

property count