Skip to main content

API Reference

API docs by Redocly

Planet Tasking API (2.0.0)

Download OpenAPI specification:Download

High resolution satellite imagery as a service.

For in-depth guides and usage examples, refer to the Planet Tasking API Documentation.

Orders

A tasking order is a request to capture new imagery of a specific area of interest (AOI) within a given time of interest (TOI). Tasking orders are not to be confused with Scene and Basemap Orders offered by the Planet Orders API.

List Tasking Orders

Retrieve all tasking orders you have access to. This includes all orders created within your organization.

Rate Limits

  • 300 requests/minute (scope: sustained)
  • 40 requests/second (scope: burst)
Authorizations:
BearerTokenAuthApiKeyBasicAuthApiKeyInAuthorizationHeaderAuth
query Parameters
altitude
integer

Filter by the altitude to be equal to the given value

altitude__gt
integer

Filter by the altitude to be greater than the given value

altitude__gte
integer

Filter by the altitude to be greater than or equal to the given value

altitude__lt
integer

Filter by the altitude to be less than the given value

altitude__lte
integer

Filter by the altitude to be less than or equal to the given value

asset_types
Array of strings
Items Enum: "ortho_visual" "basic_analytic" "basic_analytic_udm2" "basic_analytic_rpc" "basic_panchromatic" "basic_panchromatic_rpc" "basic_panchromatic_udm2" "ortho_analytic" "ortho_analytic_sr" "ortho_analytic_udm2" "ortho_panchromatic" "ortho_pansharpened" "ortho_pansharpened_udm2" "basic_radiance_hdf5" "ortho_radiance_hdf5" "ortho_beta_udm" "basic_sr_hdf5" "ortho_sr_hdf5" "ortho_ql_ch4" "ql_ch4_json" "basic_beta_udm" "geolocation_array" "recent_monthly_mosaic" "ortho_qc_ch4" "qc_ch4_json" "basic_l1a_panchromatic" "basic_l1a_panchromatic_rpc" "basic_analytic_dn" "basic_analytic_dn_rpc" "basic_analytic_udm" "basic_l1a_panchromatic_dn" "basic_l1a_panchromatic_dn_rpc" "basic_panchromatic_dn" "basic_panchromatic_dn_rpc" "ortho_analytic_dn" "ortho_analytic_udm" "ortho_panchromatic_dn" "ortho_panchromatic_udm" "ortho_panchromatic_udm2" "ortho_pansharpened_udm"

Filter by the asset types to be equal to the given value

asset_types__in
Array of strings[ items ]
Items Enum: "ortho_visual" "basic_analytic" "basic_analytic_udm2" "basic_analytic_rpc" "basic_panchromatic" "basic_panchromatic_rpc" "basic_panchromatic_udm2" "ortho_analytic" "ortho_analytic_sr" "ortho_analytic_udm2" "ortho_panchromatic" "ortho_pansharpened" "ortho_pansharpened_udm2" "basic_radiance_hdf5" "ortho_radiance_hdf5" "ortho_beta_udm" "basic_sr_hdf5" "ortho_sr_hdf5" "ortho_ql_ch4" "ql_ch4_json" "basic_beta_udm" "geolocation_array" "recent_monthly_mosaic" "ortho_qc_ch4" "qc_ch4_json" "basic_l1a_panchromatic" "basic_l1a_panchromatic_rpc" "basic_analytic_dn" "basic_analytic_dn_rpc" "basic_analytic_udm" "basic_l1a_panchromatic_dn" "basic_l1a_panchromatic_dn_rpc" "basic_panchromatic_dn" "basic_panchromatic_dn_rpc" "ortho_analytic_dn" "ortho_analytic_udm" "ortho_panchromatic_dn" "ortho_panchromatic_udm" "ortho_panchromatic_udm2" "ortho_pansharpened_udm"

Multiple values may be separated by commas.

asset_types__ne
Array of strings
Items Enum: "ortho_visual" "basic_analytic" "basic_analytic_udm2" "basic_analytic_rpc" "basic_panchromatic" "basic_panchromatic_rpc" "basic_panchromatic_udm2" "ortho_analytic" "ortho_analytic_sr" "ortho_analytic_udm2" "ortho_panchromatic" "ortho_pansharpened" "ortho_pansharpened_udm2" "basic_radiance_hdf5" "ortho_radiance_hdf5" "ortho_beta_udm" "basic_sr_hdf5" "ortho_sr_hdf5" "ortho_ql_ch4" "ql_ch4_json" "basic_beta_udm" "geolocation_array" "recent_monthly_mosaic" "ortho_qc_ch4" "qc_ch4_json" "basic_l1a_panchromatic" "basic_l1a_panchromatic_rpc" "basic_analytic_dn" "basic_analytic_dn_rpc" "basic_analytic_udm" "basic_l1a_panchromatic_dn" "basic_l1a_panchromatic_dn_rpc" "basic_panchromatic_dn" "basic_panchromatic_dn_rpc" "ortho_analytic_dn" "ortho_analytic_udm" "ortho_panchromatic_dn" "ortho_panchromatic_udm" "ortho_panchromatic_udm2" "ortho_pansharpened_udm"

Filter by the asset types to not be equal to the given value

asset_types__notin
Array of strings[ items ]
Items Enum: "ortho_visual" "basic_analytic" "basic_analytic_udm2" "basic_analytic_rpc" "basic_panchromatic" "basic_panchromatic_rpc" "basic_panchromatic_udm2" "ortho_analytic" "ortho_analytic_sr" "ortho_analytic_udm2" "ortho_panchromatic" "ortho_pansharpened" "ortho_pansharpened_udm2" "basic_radiance_hdf5" "ortho_radiance_hdf5" "ortho_beta_udm" "basic_sr_hdf5" "ortho_sr_hdf5" "ortho_ql_ch4" "ql_ch4_json" "basic_beta_udm" "geolocation_array" "recent_monthly_mosaic" "ortho_qc_ch4" "qc_ch4_json" "basic_l1a_panchromatic" "basic_l1a_panchromatic_rpc" "basic_analytic_dn" "basic_analytic_dn_rpc" "basic_analytic_udm" "basic_l1a_panchromatic_dn" "basic_l1a_panchromatic_dn_rpc" "basic_panchromatic_dn" "basic_panchromatic_dn_rpc" "ortho_analytic_dn" "ortho_analytic_udm" "ortho_panchromatic_dn" "ortho_panchromatic_udm" "ortho_panchromatic_udm2" "ortho_pansharpened_udm"

Multiple values may be separated by commas.

assured_tasking_tier
string
Enum: "EXPRESS" "NOT_APPLICABLE" "STANDARD"

Filter by the assured tasking tier to be equal to the given value

  • NOT_APPLICABLE - Not Applicable
  • STANDARD - Standard
  • EXPRESS - Express
assured_tasking_tier__in
Array of strings

Multiple values may be separated by commas.

assured_tasking_tier__ne
string

Filter by the assured tasking tier to not be equal to the given value

assured_tasking_tier__notin
Array of strings

Multiple values may be separated by commas.

cancellation_fee_applied
boolean

Filter by the cancellation fee applied to be equal to the given value

cancelled_by_replacement
boolean

Filter by the cancelled by replacement to be equal to the given value

cancelled_time
string <date-time>

Filter by the cancelled time to be equal to the given value

cancelled_time__gt
string <date-time>

Filter by the cancelled time to be greater than the given value

cancelled_time__gte
string <date-time>

Filter by the cancelled time to be greater than or equal to the given value

cancelled_time__lt
string <date-time>

Filter by the cancelled time to be less than the given value

cancelled_time__lte
string <date-time>

Filter by the cancelled time to be less than or equal to the given value

capture_assessment_invalid_count
integer

Filter by the number of captures assessed invalid to be equal to the given value

capture_assessment_invalid_count__gt
integer

Filter by the number of captures assessed invalid to be greater than the given value

capture_assessment_invalid_count__gte
integer

Filter by the number of captures assessed invalid to be greater than or equal to the given value

capture_assessment_invalid_count__lt
integer

Filter by the number of captures assessed invalid to be less than the given value

capture_assessment_invalid_count__lte
integer

Filter by the number of captures assessed invalid to be less than or equal to the given value

capture_assessment_success_count
integer

Filter by the number of captures assessed successful to be equal to the given value

capture_assessment_success_count__gt
integer

Filter by the number of captures assessed successful to be greater than the given value

capture_assessment_success_count__gte
integer

Filter by the number of captures assessed successful to be greater than or equal to the given value

capture_assessment_success_count__lt
integer

Filter by the number of captures assessed successful to be less than the given value

capture_assessment_success_count__lte
integer

Filter by the number of captures assessed successful to be less than or equal to the given value

capture_count
integer

Filter by the capture count to be equal to the given value

capture_count__gt
integer

Filter by the capture count to be greater than the given value

capture_count__gte
integer

Filter by the capture count to be greater than or equal to the given value

capture_count__lt
integer

Filter by the capture count to be less than the given value

capture_count__lte
integer

Filter by the capture count to be less than or equal to the given value

capture_status_deriving_count
integer

Filter by the capture status deriving count to be equal to the given value

capture_status_deriving_count__gt
integer

Filter by the capture status deriving count to be greater than the given value

capture_status_deriving_count__gte
integer

Filter by the capture status deriving count to be greater than or equal to the given value

capture_status_deriving_count__lt
integer

Filter by the capture status deriving count to be less than the given value

capture_status_deriving_count__lte
integer

Filter by the capture status deriving count to be less than or equal to the given value

capture_status_failed_count
integer

Filter by the number of failed captures to be equal to the given value

capture_status_failed_count__gt
integer

Filter by the number of failed captures to be greater than the given value

capture_status_failed_count__gte
integer

Filter by the number of failed captures to be greater than or equal to the given value

capture_status_failed_count__lt
integer

Filter by the number of failed captures to be less than the given value

capture_status_failed_count__lte
integer

Filter by the number of failed captures to be less than or equal to the given value

capture_status_processing_count
integer

Filter by the number of processing captures to be equal to the given value

capture_status_processing_count__gt
integer

Filter by the number of processing captures to be greater than the given value

capture_status_processing_count__gte
integer

Filter by the number of processing captures to be greater than or equal to the given value

capture_status_processing_count__lt
integer

Filter by the number of processing captures to be less than the given value

capture_status_processing_count__lte
integer

Filter by the number of processing captures to be less than or equal to the given value

capture_status_published_count
integer

Filter by the number of published captures to be equal to the given value

capture_status_published_count__gt
integer

Filter by the number of published captures to be greater than the given value

capture_status_published_count__gte
integer

Filter by the number of published captures to be greater than or equal to the given value

capture_status_published_count__lt
integer

Filter by the number of published captures to be less than the given value

capture_status_published_count__lte
integer

Filter by the number of published captures to be less than or equal to the given value

capture_status_queued_count
integer

Filter by the number of queued captures to be equal to the given value

capture_status_queued_count__gt
integer

Filter by the number of queued captures to be greater than the given value

capture_status_queued_count__gte
integer

Filter by the number of queued captures to be greater than or equal to the given value

capture_status_queued_count__lt
integer

Filter by the number of queued captures to be less than the given value

capture_status_queued_count__lte
integer

Filter by the number of queued captures to be less than or equal to the given value

cloud_cover_max__gt
number <float>

Filter by the maximum cloud coverage to be greater than the given value

cloud_cover_max__gte
number <float>

Filter by the maximum cloud coverage to be greater than or equal to the given value

cloud_cover_max__lt
number <float>

Filter by the maximum cloud coverage to be less than the given value

cloud_cover_max__lte
number <float>

Filter by the maximum cloud coverage to be less than or equal to the given value

cloud_cover_min__gt
number <float>

Filter by the minimum cloud coverage to be greater than the given value

cloud_cover_min__gte
number <float>

Filter by the minimum cloud coverage to be greater than or equal to the given value

cloud_cover_min__lt
number <float>

Filter by the minimum cloud coverage to be less than the given value

cloud_cover_min__lte
number <float>

Filter by the minimum cloud coverage to be less than or equal to the given value

cloud_threshold
number <float>

Filter by the cloud threshold to be equal to the given value

cloud_threshold__gt
number <float>

Filter by the cloud threshold to be greater than the given value

cloud_threshold__gte
number <float>

Filter by the cloud threshold to be greater than or equal to the given value

cloud_threshold__lt
number <float>

Filter by the cloud threshold to be less than the given value

cloud_threshold__lte
number <float>

Filter by the cloud threshold to be less than or equal to the given value

created_as_replacement
boolean

Filter by the created as replacement to be equal to the given value

created_as_waitlisted
boolean

Filter by the created as waitlisted to be equal to the given value

created_by
string

Filter by the created by to be equal to the given value

created_by__icontains
string

Filter by the created by to contain the given value (case-insensitive)

created_by__in
Array of strings

Multiple values may be separated by commas.

created_by__ne
string

Filter by the created by to not be equal to the given value

created_by__notin
Array of strings

Multiple values may be separated by commas.

created_time
string <date-time>

Filter by the created time to be equal to the given value

created_time__gt
string <date-time>

Filter by the created time to be greater than the given value

created_time__gte
string <date-time>

Filter by the created time to be greater than or equal to the given value

created_time__lt
string <date-time>

Filter by the created time to be less than the given value

created_time__lte
string <date-time>

Filter by the created time to be less than or equal to the given value

customer_aoi_name
string

Filter by the customer aoi name to be equal to the given value

customer_aoi_name__icontains
string

Filter by the customer aoi name to contain the given value (case-insensitive)

customer_aoi_name__isnotnull
boolean

Filter by the customer aoi name to not be null/unset

customer_aoi_name__isnull
boolean

Filter by the customer aoi name to be null/unset

customer_aoi_name__ne
string

Filter by the customer aoi name to not be equal to the given value

customer_name
string

Filter by the customer name to be equal to the given value

customer_name__icontains
string

Filter by the customer name to contain the given value (case-insensitive)

customer_name__in
Array of strings

Multiple values may be separated by commas.

customer_name__ne
string

Filter by the customer name to not be equal to the given value

customer_name__notin
Array of strings

Multiple values may be separated by commas.

customer_org_id
integer

Filter by the customer org ID to be equal to the given value

customer_org_id__in
Array of integers

Multiple values may be separated by commas.

customer_org_id__ne
integer

Filter by the customer org ID to not be equal to the given value

customer_org_id__notin
Array of integers

Multiple values may be separated by commas.

data_products
Array of strings
Items Enum: "HIGH_RESOLUTION_SCENES" "HYPERSPECTRAL_SCENES" "TANAGER_METHANE_DETECTION"

Filter by the data products to be equal to the given value

data_products__in
Array of strings[ items ]
Items Enum: "HIGH_RESOLUTION_SCENES" "HYPERSPECTRAL_SCENES" "TANAGER_METHANE_DETECTION"

Multiple values may be separated by commas.

dedicated_capacity_area_name
string

Filter by the dedicated capacity area name to be equal to the given value

dedicated_capacity_area_name__icontains
string

Filter by the dedicated capacity area name to contain the given value (case-insensitive)

dedicated_capacity_area_name__isnotnull
boolean

Filter by the dedicated capacity area name to not be null/unset

dedicated_capacity_area_name__isnull
boolean

Filter by the dedicated capacity area name to be null/unset

dedicated_capacity_area_name__ne
string

Filter by the dedicated capacity area name to not be equal to the given value

end_time
string <date-time>

Filter by the end time to be equal to the given value

end_time__gt
string <date-time>

Filter by the end time to be greater than the given value

end_time__gte
string <date-time>

Filter by the end time to be greater than or equal to the given value

end_time__lt
string <date-time>

Filter by the end time to be less than the given value

end_time__lte
string <date-time>

Filter by the end time to be less than or equal to the given value

ends_in_hours__exact
number

Filter by the ends in hours to be equal to the given value

ends_in_hours__gt
number

Filter by the ends in hours to be greater than the given value

ends_in_hours__gte
number

Filter by the ends in hours to be greater than or equal to the given value

ends_in_hours__lt
number

Filter by the ends in hours to be less than the given value

ends_in_hours__lte
number

Filter by the ends in hours to be less than or equal to the given value

estimated_quota_cost
number <float>

Filter by the estimated quota cost to be equal to the given value

estimated_quota_cost__gt
number <float>

Filter by the estimated quota cost to be greater than the given value

estimated_quota_cost__gte
number <float>

Filter by the estimated quota cost to be greater than or equal to the given value

estimated_quota_cost__lt
number <float>

Filter by the estimated quota cost to be less than the given value

estimated_quota_cost__lte
number <float>

Filter by the estimated quota cost to be less than or equal to the given value

exclusivity_days
integer

Filter by the exclusivity days to be equal to the given value

exclusivity_days__gt
integer

Filter by the exclusivity days to be greater than the given value

exclusivity_days__gte
integer

Filter by the exclusivity days to be greater than or equal to the given value

exclusivity_days__lt
integer

Filter by the exclusivity days to be less than the given value

exclusivity_days__lte
integer

Filter by the exclusivity days to be less than or equal to the given value

fields
string

Comma-separated list of fields to include in the response. If not provided, all available fields are returned.

format
string
Enum: "csv" "json"
fulfilled_sqkm
number <float>

Filter by the fulfilled square kilometers to be equal to the given value

fulfilled_sqkm__gt
number <float>

Filter by the fulfilled square kilometers to be greater than the given value

fulfilled_sqkm__gte
number <float>

Filter by the fulfilled square kilometers to be greater than or equal to the given value

fulfilled_sqkm__lt
number <float>

Filter by the fulfilled square kilometers to be less than the given value

fulfilled_sqkm__lte
number <float>

Filter by the fulfilled square kilometers to be less than or equal to the given value

fulfilled_time
string <date-time>

Filter by the fulfilled time to be equal to the given value

fulfilled_time__gt
string <date-time>

Filter by the fulfilled time to be greater than the given value

fulfilled_time__gte
string <date-time>

Filter by the fulfilled time to be greater than or equal to the given value

fulfilled_time__lt
string <date-time>

Filter by the fulfilled time to be less than the given value

fulfilled_time__lte
string <date-time>

Filter by the fulfilled time to be less than or equal to the given value

geometry__centroid_within
string

Filter by the geometry to have its centroid within the given geometry (GeoJSON or WKT string)

geometry__intersects
string

Filter by the geometry to to intersect with the given geometry (GeoJSON or WKT string)

ground_sample_distance_max
number <float>

Filter by the maximum ground sample distance to be equal to the given value

ground_sample_distance_max__gt
number <float>

Filter by the maximum ground sample distance to be greater than the given value

ground_sample_distance_max__gte
number <float>

Filter by the maximum ground sample distance to be greater than or equal to the given value

ground_sample_distance_max__lt
number <float>

Filter by the maximum ground sample distance to be less than the given value

ground_sample_distance_max__lte
number <float>

Filter by the maximum ground sample distance to be less than or equal to the given value

has_unassessed_captures
boolean

Filter by the has unassessed captures to be equal to the given value

id
string <uuid>

Filter by the id to be equal to the given value

id__in
Array of strings <uuid> [ items <uuid > ]

Multiple values may be separated by commas.

id__ne
string <uuid>

Filter by the id to not be equal to the given value

id__notin
Array of strings <uuid> [ items <uuid > ]

Multiple values may be separated by commas.

imaging_conops
string
Enum: "dark" "experimental" "flatfield" "glint" "high_capacity" "high_data_volume" "nominal" "video"

Filter by the imaging collection preset to be equal to the given value

  • nominal - Nominal
  • high_capacity - High Capacity
  • high_data_volume - High Data Volume
  • experimental - Experimental
  • dark - Dark
  • glint - Glint
  • flatfield - Flatfield
  • video - Video
imaging_conops__in
Array of strings

Multiple values may be separated by commas.

imaging_conops__ne
string

Filter by the imaging collection preset to not be equal to the given value

imaging_conops__notin
Array of strings

Multiple values may be separated by commas.

last_acquired_time
string <date-time>

Filter by the last acquired time to be equal to the given value

last_acquired_time__gt
string <date-time>

Filter by the last acquired time to be greater than the given value

last_acquired_time__gte
string <date-time>

Filter by the last acquired time to be greater than or equal to the given value

last_acquired_time__lt
string <date-time>

Filter by the last acquired time to be less than the given value

last_acquired_time__lte
string <date-time>

Filter by the last acquired time to be less than or equal to the given value

limit
integer [ 1 .. 1000 ]

Number of results to return per page.

listing
string
Enum: "hotlisted" "unlisted"

Filter by the hotlist to be equal to the given value

  • unlisted - Unlisted
  • hotlisted - Hotlisted
listing__ne
string

Filter by the hotlist to not be equal to the given value

n_stereo_pov
integer or null
Enum: 2 3

Filter by the number of stereo captures to be equal to the given value

  • 2 - 2
  • 3 - 3
n_stereo_pov__ne
integer

Filter by the number of stereo captures to not be equal to the given value

name
string

Filter by the name to be equal to the given value

name__icontains
string

Filter by the name to contain the given value (case-insensitive)

name__ne
string

Filter by the name to not be equal to the given value

name_ascii
string

Filter by the name ascii to be equal to the given value

name_ascii__icontains
string

Filter by the name ascii to contain the given value (case-insensitive)

name_ascii__ne
string

Filter by the name ascii to not be equal to the given value

offset
integer [ 0 .. 30000 ]

The initial index from which to return the results.

omit
string

Comma-separated list of fields to exclude from the response. If not provided, all available fields are returned.

order_type
string
Enum: "IMAGE" "STEREO" "VIDEO"

Filter by the order type to be equal to the given value

  • IMAGE - Image
  • VIDEO - Video
  • STEREO - Stereo
order_type__in
Array of strings

Multiple values may be separated by commas.

order_type__ne
string

Filter by the order type to not be equal to the given value

order_type__notin
Array of strings

Multiple values may be separated by commas.

ordering
string

Which field to use when ordering the results.

original_geometry_type
string
Enum: "GeometryCollection" "LineString" "MultiLineString" "MultiPoint" "MultiPolygon" "Point" "Polygon"

Filter by the original geometry type to be equal to the given value

  • Point - Point
  • MultiPoint - MultiPoint
  • LineString - LineString
  • MultiLineString - MultiLineString
  • Polygon - Polygon
  • MultiPolygon - MultiPolygon
  • GeometryCollection - GeometryCollection
original_geometry_type__in
Array of strings

Multiple values may be separated by commas.

original_geometry_type__ne
string

Filter by the original geometry type to not be equal to the given value

original_geometry_type__notin
Array of strings

Multiple values may be separated by commas.

pending_quota_cost
number <float>

Filter by the pending quota cost to be equal to the given value

pending_quota_cost__gt
number <float>

Filter by the pending quota cost to be greater than the given value

pending_quota_cost__gte
number <float>

Filter by the pending quota cost to be greater than or equal to the given value

pending_quota_cost__lt
number <float>

Filter by the pending quota cost to be less than the given value

pending_quota_cost__lte
number <float>

Filter by the pending quota cost to be less than or equal to the given value

pl_number
string

Filter by the contract number to be equal to the given value

pl_number__icontains
string

Filter by the contract number to contain the given value (case-insensitive)

pl_number__in
Array of strings

Multiple values may be separated by commas.

pl_number__ne
string

Filter by the contract number to not be equal to the given value

pl_number__notin
Array of strings

Multiple values may be separated by commas.

priority
integer

Filter by the priority to be equal to the given value

priority__gt
integer

Filter by the priority to be greater than the given value

priority__gte
integer

Filter by the priority to be greater than or equal to the given value

priority__lt
integer

Filter by the priority to be less than the given value

priority__lte
integer

Filter by the priority to be less than or equal to the given value

product
string

Filter by the product name to be equal to the given value

product__in
Array of strings

Multiple values may be separated by commas.

product__ne
string

Filter by the product name to not be equal to the given value

product__notin
Array of strings

Multiple values may be separated by commas.

progress
number <float>

Filter by the progress to be equal to the given value

progress__gt
number <float>

Filter by the progress to be greater than the given value

progress__gte
number <float>

Filter by the progress to be greater than or equal to the given value

progress__lt
number <float>

Filter by the progress to be less than the given value

progress__lte
number <float>

Filter by the progress to be less than or equal to the given value

quota_units
string or null
Enum: "CREDITS" "SQKM"

Filter by the quota units to be equal to the given value

  • SQKM - Sqkm
  • CREDITS - Credits
rank
integer

Filter by the rank to be equal to the given value

rank__gt
integer

Filter by the rank to be greater than the given value

rank__gte
integer

Filter by the rank to be greater than or equal to the given value

rank__lt
integer

Filter by the rank to be less than the given value

rank__lte
integer

Filter by the rank to be less than or equal to the given value

requested_sqkm
number <float>

Filter by the requested square kilometers to be equal to the given value

requested_sqkm__gt
number <float>

Filter by the requested square kilometers to be greater than the given value

requested_sqkm__gte
number <float>

Filter by the requested square kilometers to be greater than or equal to the given value

requested_sqkm__lt
number <float>

Filter by the requested square kilometers to be less than the given value

requested_sqkm__lte
number <float>

Filter by the requested square kilometers to be less than or equal to the given value

sat_azimuth_angle_max
number <float>

Filter by the maximum satellite azimuth angle to be equal to the given value

sat_azimuth_angle_max__gt
number <float>

Filter by the maximum satellite azimuth angle to be greater than the given value

sat_azimuth_angle_max__gte
number <float>

Filter by the maximum satellite azimuth angle to be greater than or equal to the given value

sat_azimuth_angle_max__lt
number <float>

Filter by the maximum satellite azimuth angle to be less than the given value

sat_azimuth_angle_max__lte
number <float>

Filter by the maximum satellite azimuth angle to be less than or equal to the given value

sat_azimuth_angle_min
number <float>

Filter by the minimum satellite azimuth angle to be equal to the given value

sat_azimuth_angle_min__gt
number <float>

Filter by the minimum satellite azimuth angle to be greater than the given value

sat_azimuth_angle_min__gte
number <float>

Filter by the minimum satellite azimuth angle to be greater than or equal to the given value

sat_azimuth_angle_min__lt
number <float>

Filter by the minimum satellite azimuth angle to be less than the given value

sat_azimuth_angle_min__lte
number <float>

Filter by the minimum satellite azimuth angle to be less than or equal to the given value

sat_elevation_angle_max
number <float>

Filter by the maximum satellite elevation angle to be equal to the given value

sat_elevation_angle_max__gt
number <float>

Filter by the maximum satellite elevation angle to be greater than the given value

sat_elevation_angle_max__gte
number <float>

Filter by the maximum satellite elevation angle to be greater than or equal to the given value

sat_elevation_angle_max__lt
number <float>

Filter by the maximum satellite elevation angle to be less than the given value

sat_elevation_angle_max__lte
number <float>

Filter by the maximum satellite elevation angle to be less than or equal to the given value

sat_elevation_angle_min
number <float>

Filter by the minimum satellite elevation angle to be equal to the given value

sat_elevation_angle_min__gt
number <float>

Filter by the minimum satellite elevation angle to be greater than the given value

sat_elevation_angle_min__gte
number <float>

Filter by the minimum satellite elevation angle to be greater than or equal to the given value

sat_elevation_angle_min__lt
number <float>

Filter by the minimum satellite elevation angle to be less than the given value

sat_elevation_angle_min__lte
number <float>

Filter by the minimum satellite elevation angle to be less than or equal to the given value

satellite_hw_ids
Array of strings[ items <= 10 characters ]

Filter by the satellite hw IDs to be equal to the given value

satellite_hw_ids__in
Array of strings[ items[ items <= 10 characters ] ]

Multiple values may be separated by commas.

satellite_hw_ids__ne
Array of strings[ items <= 10 characters ]

Filter by the satellite hw IDs to not be equal to the given value

satellite_hw_ids__notin
Array of strings[ items[ items <= 10 characters ] ]

Multiple values may be separated by commas.

satellite_types
Array of strings
Items Enum: "SKYSAT" "PELICAN" "TANAGER"

Filter by the satellite types to be equal to the given value

satellite_types__in
Array of strings[ items ]
Items Enum: "SKYSAT" "PELICAN" "TANAGER"

Multiple values may be separated by commas.

scheduling_type
string
Enum: "ARCHIVE" "ASSURED" "EXPRESS" "FLEXIBLE" "LOCK_IN" "MONITORING"

Filter by the scheduling type to be equal to the given value

  • FLEXIBLE - Flexible
  • LOCK_IN - Lock-In
  • MONITORING - Monitoring
  • EXPRESS - Express
  • ASSURED - Assured
  • ARCHIVE - Archive
scheduling_type__in
Array of strings

Multiple values may be separated by commas.

scheduling_type__ne
string

Filter by the scheduling type to not be equal to the given value

scheduling_type__notin
Array of strings

Multiple values may be separated by commas.

sensitivity_mode
string
Enum: "GLINT" "HIGH" "MAX" "MEDIUM" "NOT_APPLICABLE" "PUSHBROOM" "STANDARD"

Filter by the sensitivity mode to be equal to the given value

  • NOT_APPLICABLE - Not Applicable
  • GLINT - Glint
  • STANDARD - Standard
  • MEDIUM - Medium
  • HIGH - High
  • MAX - Max
  • PUSHBROOM - Pushbroom
sensitivity_mode__in
Array of strings

Multiple values may be separated by commas.

sensitivity_mode__ne
string

Filter by the sensitivity mode to not be equal to the given value

sensitivity_mode__notin
Array of strings

Multiple values may be separated by commas.

solar_azimuth_angle_max
number <float>

Filter by the maximum solar azimuth angle to be equal to the given value

solar_azimuth_angle_max__gt
number <float>

Filter by the maximum solar azimuth angle to be greater than the given value

solar_azimuth_angle_max__gte
number <float>

Filter by the maximum solar azimuth angle to be greater than or equal to the given value

solar_azimuth_angle_max__lt
number <float>

Filter by the maximum solar azimuth angle to be less than the given value

solar_azimuth_angle_max__lte
number <float>

Filter by the maximum solar azimuth angle to be less than or equal to the given value

solar_azimuth_angle_min
number <float>

Filter by the minimum solar azimuth angle to be equal to the given value

solar_azimuth_angle_min__gt
number <float>

Filter by the minimum solar azimuth angle to be greater than the given value

solar_azimuth_angle_min__gte
number <float>

Filter by the minimum solar azimuth angle to be greater than or equal to the given value

solar_azimuth_angle_min__lt
number <float>

Filter by the minimum solar azimuth angle to be less than the given value

solar_azimuth_angle_min__lte
number <float>

Filter by the minimum solar azimuth angle to be less than or equal to the given value

solar_zenith_angle_max
number <float>

Filter by the maximum solar zenith angle to be equal to the given value

solar_zenith_angle_max__gt
number <float>

Filter by the maximum solar zenith angle to be greater than the given value

solar_zenith_angle_max__gte
number <float>

Filter by the maximum solar zenith angle to be greater than or equal to the given value

solar_zenith_angle_max__lt
number <float>

Filter by the maximum solar zenith angle to be less than the given value

solar_zenith_angle_max__lte
number <float>

Filter by the maximum solar zenith angle to be less than or equal to the given value

solar_zenith_angle_min
number <float>

Filter by the minimum solar zenith angle to be equal to the given value

solar_zenith_angle_min__gt
number <float>

Filter by the minimum solar zenith angle to be greater than the given value

solar_zenith_angle_min__gte
number <float>

Filter by the minimum solar zenith angle to be greater than or equal to the given value

solar_zenith_angle_min__lt
number <float>

Filter by the minimum solar zenith angle to be less than the given value

solar_zenith_angle_min__lte
number <float>

Filter by the minimum solar zenith angle to be less than or equal to the given value

start_time
string <date-time>

Filter by the start time to be equal to the given value

start_time__gt
string <date-time>

Filter by the start time to be greater than the given value

start_time__gte
string <date-time>

Filter by the start time to be greater than or equal to the given value

start_time__lt
string <date-time>

Filter by the start time to be less than the given value

start_time__lte
string <date-time>

Filter by the start time to be less than or equal to the given value

status
string
Enum: "CANCELLED" "EXPIRED" "FAILED" "FINALIZING" "FULFILLED" "IN_PROGRESS" "PENDING" "PENDING_CANCELLATION" "RECEIVED" "REJECTED" "REQUESTED" "WAITLISTED" "WAITLIST_ABANDONED" "WAITLIST_EXPIRED"

Filter by the status to be equal to the given value

  • RECEIVED - Received
  • PENDING - Pending
  • IN_PROGRESS - In Progress
  • EXPIRED - Expired
  • FULFILLED - Fulfilled
  • FAILED - Failed
  • CANCELLED - Cancelled
  • REQUESTED - Requested
  • FINALIZING - Finalizing
  • PENDING_CANCELLATION - Pending Cancellation
  • REJECTED - Rejected
  • WAITLISTED - Waitlisted
  • WAITLIST_ABANDONED - Waitlist Abandoned
  • WAITLIST_EXPIRED - Waitlist Expired
status__in
Array of strings

Multiple values may be separated by commas.

status__ne
string

Filter by the status to not be equal to the given value

status__notin
Array of strings

Multiple values may be separated by commas.

target_coverage_min
number <float>

Filter by the target coverage min to be equal to the given value

target_coverage_min__gt
number <float>

Filter by the target coverage min to be greater than the given value

target_coverage_min__gte
number <float>

Filter by the target coverage min to be greater than or equal to the given value

target_coverage_min__lt
number <float>

Filter by the target coverage min to be less than the given value

target_coverage_min__lte
number <float>

Filter by the target coverage min to be less than or equal to the given value

task_count
integer

Filter by the task count to be equal to the given value

task_count__gt
integer

Filter by the task count to be greater than the given value

task_count__gte
integer

Filter by the task count to be greater than or equal to the given value

task_count__lt
integer

Filter by the task count to be less than the given value

task_count__lte
integer

Filter by the task count to be less than or equal to the given value

total_delivered_sqkm
number <float>

Filter by the total delivered square kilometers to be equal to the given value

total_delivered_sqkm__gt
number <float>

Filter by the total delivered square kilometers to be greater than the given value

total_delivered_sqkm__gte
number <float>

Filter by the total delivered square kilometers to be greater than or equal to the given value

total_delivered_sqkm__lt
number <float>

Filter by the total delivered square kilometers to be less than the given value

total_delivered_sqkm__lte
number <float>

Filter by the total delivered square kilometers to be less than or equal to the given value

updated_time
string <date-time>

Filter by the updated time to be equal to the given value

updated_time__gt
string <date-time>

Filter by the updated time to be greater than the given value

updated_time__gte
string <date-time>

Filter by the updated time to be greater than or equal to the given value

updated_time__lt
string <date-time>

Filter by the updated time to be less than the given value

updated_time__lte
string <date-time>

Filter by the updated time to be less than or equal to the given value

used_quota
number <float>

Filter by the used quota to be equal to the given value

used_quota__gt
number <float>

Filter by the used quota to be greater than the given value

used_quota__gte
number <float>

Filter by the used quota to be greater than or equal to the given value

used_quota__lt
number <float>

Filter by the used quota to be less than the given value

used_quota__lte
number <float>

Filter by the used quota to be less than or equal to the given value

user_id
integer

Filter by the user ID to be equal to the given value

user_id__in
Array of integers

Multiple values may be separated by commas.

user_id__ne
integer

Filter by the user ID to not be equal to the given value

user_id__notin
Array of integers

Multiple values may be separated by commas.

user_org_id
integer

Filter by the user org ID to be equal to the given value

user_org_id__in
Array of integers

Multiple values may be separated by commas.

user_org_id__ne
integer

Filter by the user org ID to not be equal to the given value

user_org_id__notin
Array of integers

Multiple values may be separated by commas.

Responses

Response samples

Content type
{
  • "count": 123,
  • "next": "http://api.example.org/accounts/?offset=400&limit=100",
  • "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  • "results": [
    ]
}

Create Tasking Order

Submit a new tasking order.

Rate Limits

  • 300 requests/minute (scope: sustained)
  • 40 requests/second (scope: burst)
Authorizations:
BearerTokenAuthApiKeyBasicAuthApiKeyInAuthorizationHeaderAuth
query Parameters
fields
string

Comma-separated list of fields to include in the response. If not provided, all available fields are returned.

format
string
Enum: "csv" "json"
omit
string

Comma-separated list of fields to exclude from the response. If not provided, all available fields are returned.

Request Body schema: application/json
required
imaging_window
string or null <uuid> (Imaging Window ID)

Imaging window ID to create an order for. Required to place an Assured Tasking order. Cannot be used for other scheduling types.

object or object or object or object or object or object or object

GeoJSON representation of a Point, a two-point LineString or a Polygon. Point and LineString inputs will be will be expanded into a circular or rectangle Polygon respectively to serve as the area of interest for this order. The expansion size defaults to 5 km for SkySat imagery but can vary based on product parameters. Required for all orders except Assured Tasking orders.

(object or null) or (object or null) or (object or null) or (object or null) or (object or null) or (object or null) or (object or null)

GeoJSON representation of the original geometry submitted when the order was created

capture_count
integer [ 0 .. 2147483647 ]

Number of captures to be taken to fulfill the order

capture_status_queued_count
integer (Number of queued captures) [ 0 .. 2147483647 ]

Number of captures currently scheduled for acquisition on a satellite

capture_status_processing_count
integer (Number of processing captures) [ 0 .. 2147483647 ]

Number of captures currently being processed by Planet's image processing pipeline

order_type
string
Enum: "IMAGE" "STEREO"

Type of imagery to be acquired for this order. Possible values are:

  • IMAGE: A regular capture with a single point of view onto the area of interest

  • STEREO: A stereographic capture that consists of 2 or 3 points of view (depending on n_stereo_pov)

  • IMAGE - Image

  • STEREO - Stereo

fulfilled_time
string or null <date-time>

Time the order was fulfilled

pl_number
string or null (Contract number)

Contract number of the order. Required if you have access to multiple products or contracts.

product
string or null (Product name)

Name of the product of the order. Required if you have access to multiple products or contracts.

sat_elevation_angle_min
number <double> (Minimum satellite elevation angle) [ 15 .. 90 ]

Minimum elevation of the satellite to acquire imagery for the order

sat_elevation_angle_max
number <double> (Maximum satellite elevation angle) [ 15 .. 90 ]

Maximum elevation of the satellite to acquire imagery for the order

start_time
string <date-time>

Time at which to start acquiring imagery for the order. Defaults to the time of order submission.

end_time
string or null <date-time>

Latest time by which imagery will be acquired for the order. Defaults to the contract's default order duration (from the time of order submission).

early_start
boolean or null

Whether a Monitoring Tasking order should begin immediately. This causes the first occurrence to have a shorter time of interest. Cannot be used for other scheduling types.

cloud_threshold
number <double> [ 0 .. 1 ]

Cloud coverage threshold for an order to be scheduled for imaging

satellite_types
Array of strings
Items Enum: "SKYSAT" "PELICAN" "TANAGER"

Satellite types to acquire the imagery for the order

n_stereo_pov
integer or null (Number of stereo captures)
Enum: 2 3 null

Number of captures to be taken for Stereo Tasking orders. The convergence half angle is 15° for 2 stereo captures, and 27.5° for 3 stereo captures.

  • 2 - 2
  • 3 - 3
exclusivity_days
integer or null
Enum: 0 7 30 null

Number of days for the captured imagery to be held exclusive for this order

  • 0 - 0
  • 7 - 7
  • 30 - 30
requested_item_ids
Array of strings

Requested item IDs for Archive Tasking orders. Cannot be used for other scheduling types.

name
required
string

User-defined name of an order

capture_status_deriving_count
integer [ 0 .. 2147483647 ]

Number of captures that have been published, but some requested assets are still being processed

scheduling_type
string
Enum: "FLEXIBLE" "LOCK_IN" "MONITORING" "EXPRESS" "ASSURED" "ARCHIVE"

The way the order will be scheduled for capturing imagery. Must match the product.

  • FLEXIBLE - Flexible
  • LOCK_IN - Lock-In
  • MONITORING - Monitoring
  • EXPRESS - Express
  • ASSURED - Assured
  • ARCHIVE - Archive
rrule
string or null (Frequency)

Rrule used to schedule individual captures of the order. Only available for Monitoring Tasking orders.

asset_types
Array of strings
Items Enum: "ortho_visual" "basic_analytic" "basic_analytic_udm2" "basic_analytic_rpc" "basic_panchromatic" "basic_panchromatic_rpc" "basic_panchromatic_udm2" "ortho_analytic" "ortho_analytic_sr" "ortho_analytic_udm2" "ortho_panchromatic" "ortho_pansharpened" "ortho_pansharpened_udm2" "basic_radiance_hdf5" "ortho_radiance_hdf5" "ortho_beta_udm" "basic_sr_hdf5" "ortho_sr_hdf5" "ortho_ql_ch4" "ql_ch4_json" "basic_beta_udm" "geolocation_array" "recent_monthly_mosaic" "ortho_qc_ch4" "qc_ch4_json" "basic_l1a_panchromatic" "basic_l1a_panchromatic_rpc" "basic_analytic_dn" "basic_analytic_dn_rpc" "basic_analytic_udm" "basic_l1a_panchromatic_dn" "basic_l1a_panchromatic_dn_rpc" "basic_panchromatic_dn" "basic_panchromatic_dn_rpc" "ortho_analytic_dn" "ortho_analytic_udm" "ortho_panchromatic_dn" "ortho_panchromatic_udm" "ortho_panchromatic_udm2" "ortho_pansharpened_udm"

Derived asset types to be generated for the order

sensitivity_mode
string
Enum: "NOT_APPLICABLE" "GLINT" "STANDARD" "MEDIUM" "HIGH" "MAX" "PUSHBROOM"

The sensitivity mode influences the number of integrations performed during hyperspectral imagery capture. Possible values are:

  • NOT_APPLICABLE: Not a hyperspectral imagery order

  • GLINT:

  • `STANDARD: 1 integrations per line over a 8 ms duration (1x8)

  • MEDIUM: 2 integrations per line over a 8 ms duration (2x8)

  • `HIGH: 3 integrations per line over a 8 ms duration (3x8)

  • `MAX: 4 integrations per line over a 8 ms duration (4x8)

  • NOT_APPLICABLE - Not Applicable

  • GLINT - Glint

  • STANDARD - Standard

  • MEDIUM - Medium

  • HIGH - High

  • MAX - Max

  • PUSHBROOM - Pushbroom

integrations_per_line
integer or null [ 0 .. 32767 ]

Number of integrations per line should be performed via the sensitivity mode. This is an internal numerical interpretation of that mode.

integration_ms
integer or null [ 0 .. 32767 ]

Duration of a single integration during a hyperspectral imagery capture (in milliseconds). This is an experimental setting, and not widely available.

uplink_method
string
Enum: "STANDARD" "RTCOMMS"

Method used to uplink scheduling information to the satellite

  • STANDARD - Standard
  • RTCOMMS - RT Comms
downlink_method
string
Enum: "STANDARD" "RTCOMMS"

Method used to downlink imagery from the satellite

  • STANDARD - Standard
  • RTCOMMS - RT Comms

Responses

Request samples

Content type
application/json
{
  • "imaging_window": "a1da9ea0-27e5-48b8-87e5-6fbff34aa067",
  • "geometry": {
    },
  • "original_geometry": {
    },
  • "capture_count": 2147483647,
  • "capture_status_queued_count": 2147483647,
  • "capture_status_processing_count": 2147483647,
  • "order_type": "IMAGE",
  • "fulfilled_time": "2019-08-24T14:15:22Z",
  • "pl_number": "string",
  • "product": "string",
  • "sat_elevation_angle_min": 15,
  • "sat_elevation_angle_max": 15,
  • "start_time": "2019-08-24T14:15:22Z",
  • "end_time": "2019-08-24T14:15:22Z",
  • "early_start": true,
  • "cloud_threshold": 1,
  • "satellite_types": [
    ],
  • "n_stereo_pov": 2,
  • "exclusivity_days": 0,
  • "requested_item_ids": [
    ],
  • "name": "string",
  • "capture_status_deriving_count": 2147483647,
  • "scheduling_type": "FLEXIBLE",
  • "rrule": "string",
  • "asset_types": [
    ],
  • "sensitivity_mode": "NOT_APPLICABLE",
  • "integrations_per_line": 32767,
  • "integration_ms": 32767,
  • "uplink_method": "STANDARD",
  • "downlink_method": "STANDARD"
}

Response samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "imaging_window": "a1da9ea0-27e5-48b8-87e5-6fbff34aa067",
  • "geometry": {
    },
  • "original_geometry": {
    },
  • "fulfilled_geometry": {
    },
  • "capture_count": 2147483647,
  • "capture_status_queued_count": 2147483647,
  • "capture_status_processing_count": 2147483647,
  • "capture_status_failed_count": 2147483647,
  • "capture_status_published_count": 2147483647,
  • "capture_assessment_success_count": 2147483647,
  • "capture_assessment_invalid_count": 2147483647,
  • "order_type": "IMAGE",
  • "fulfilled_time": "2019-08-24T14:15:22Z",
  • "pl_number": "string",
  • "product": "string",
  • "sat_elevation_angle_min": 15,
  • "sat_elevation_angle_max": 15,
  • "start_time": "2019-08-24T14:15:22Z",
  • "end_time": "2019-08-24T14:15:22Z",
  • "early_start": true,
  • "cloud_threshold": 1,
  • "satellite_types": [
    ],
  • "data_products": [
    ],
  • "n_stereo_pov": 2,
  • "is_cancellable": true,
  • "cancellable_until": "2019-08-24T14:15:22Z",
  • "requested_sqkm": 0.1,
  • "fulfilled_sqkm": 0.1,
  • "next_planned_acquisition_time": "2019-08-24T14:15:22Z",
  • "exclusivity_days": 0,
  • "created_by": "string",
  • "requested_item_ids": [
    ],
  • "created_time": "2019-08-24T14:15:22Z",
  • "updated_time": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "status": "RECEIVED",
  • "original_geometry_type": "Point",
  • "capture_status_deriving_count": 2147483647,
  • "scheduling_type": "FLEXIBLE",
  • "rrule": "string",
  • "cancellation_period": "string",
  • "cancellation_fee_applied": true,
  • "created_as_waitlisted": true,
  • "last_acquired_time": "2019-08-24T14:15:22Z",
  • "estimated_quota_cost": 0.1,
  • "used_quota": 0.1,
  • "min_strip_length": 0.1,
  • "max_strip_length": 0.1,
  • "point_order_radius": 0.1,
  • "asset_types": [
    ],
  • "sensitivity_mode": "NOT_APPLICABLE",
  • "integrations_per_line": 32767,
  • "integration_ms": 32767,
  • "uplink_method": "STANDARD",
  • "downlink_method": "STANDARD"
}

Retrieve Tasking Order

Retrieve details of a specific tasking order by its ID.

Rate Limits

  • 300 requests/minute (scope: sustained)
  • 40 requests/second (scope: burst)
Authorizations:
BearerTokenAuthApiKeyBasicAuthApiKeyInAuthorizationHeaderAuth
path Parameters
id
required
string <uuid> (Order ID)

A UUID string identifying this order.

query Parameters
fields
string

Comma-separated list of fields to include in the response. If not provided, all available fields are returned.

format
string
Enum: "csv" "json"
omit
string

Comma-separated list of fields to exclude from the response. If not provided, all available fields are returned.

Responses

Response samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "imaging_window": "a1da9ea0-27e5-48b8-87e5-6fbff34aa067",
  • "geometry": {
    },
  • "original_geometry": {
    },
  • "fulfilled_geometry": {
    },
  • "capture_count": 2147483647,
  • "capture_status_queued_count": 2147483647,
  • "capture_status_processing_count": 2147483647,
  • "capture_status_failed_count": 2147483647,
  • "capture_status_published_count": 2147483647,
  • "capture_assessment_success_count": 2147483647,
  • "capture_assessment_invalid_count": 2147483647,
  • "order_type": "IMAGE",
  • "fulfilled_time": "2019-08-24T14:15:22Z",
  • "pl_number": "string",
  • "product": "string",
  • "sat_elevation_angle_min": 15,
  • "sat_elevation_angle_max": 15,
  • "start_time": "2019-08-24T14:15:22Z",
  • "end_time": "2019-08-24T14:15:22Z",
  • "early_start": true,
  • "cloud_threshold": 1,
  • "satellite_types": [
    ],
  • "data_products": [
    ],
  • "n_stereo_pov": 2,
  • "is_cancellable": true,
  • "cancellable_until": "2019-08-24T14:15:22Z",
  • "requested_sqkm": 0.1,
  • "fulfilled_sqkm": 0.1,
  • "next_planned_acquisition_time": "2019-08-24T14:15:22Z",
  • "exclusivity_days": 0,
  • "created_by": "string",
  • "requested_item_ids": [
    ],
  • "created_time": "2019-08-24T14:15:22Z",
  • "updated_time": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "status": "RECEIVED",
  • "original_geometry_type": "Point",
  • "capture_status_deriving_count": 2147483647,
  • "scheduling_type": "FLEXIBLE",
  • "rrule": "string",
  • "cancellation_period": "string",
  • "cancellation_fee_applied": true,
  • "created_as_waitlisted": true,
  • "last_acquired_time": "2019-08-24T14:15:22Z",
  • "estimated_quota_cost": 0.1,
  • "used_quota": 0.1,
  • "min_strip_length": 0.1,
  • "max_strip_length": 0.1,
  • "point_order_radius": 0.1,
  • "asset_types": [
    ],
  • "sensitivity_mode": "NOT_APPLICABLE",
  • "integrations_per_line": 32767,
  • "integration_ms": 32767,
  • "uplink_method": "STANDARD",
  • "downlink_method": "STANDARD",
  • "cloud_forecast": [
    ]
}

Update Tasking Order

Change the properties of a tasking order by its ID. Changes may be prohibited by certain conditions under your contract's Terms of Service, for example if an order is already in status IN_PROGRESS.

Rate Limits

  • 300 requests/minute (scope: sustained)
  • 40 requests/second (scope: burst)
Authorizations:
BearerTokenAuthApiKeyBasicAuthApiKeyInAuthorizationHeaderAuth
path Parameters
id
required
string <uuid> (Order ID)

A UUID string identifying this order.

query Parameters
fields
string

Comma-separated list of fields to include in the response. If not provided, all available fields are returned.

format
string
Enum: "csv" "json"
omit
string

Comma-separated list of fields to exclude from the response. If not provided, all available fields are returned.

Request Body schema: application/json
start_time
string <date-time>

Time at which to start acquiring imagery for the order. Defaults to the time of order submission.

end_time
string <date-time>

Latest time by which imagery will be acquired for the order. Defaults to the contract's default order duration (from the time of order submission).

Responses

Request samples

Content type
application/json
{
  • "start_time": "2019-08-24T14:15:22Z",
  • "end_time": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "start_time": "2019-08-24T14:15:22Z",
  • "end_time": "2019-08-24T14:15:22Z"
}

Cancel Tasking Order

Cancel an existing tasking order. An order is cancellable if is_cancellable=true. Cancellation may be prohibited by certain conditions under your contract's Terms of Service, for example if an order is already in status IN_PROGRESS.

Rate Limits

  • 300 requests/minute (scope: sustained)
  • 40 requests/second (scope: burst)
Authorizations:
BearerTokenAuthApiKeyBasicAuthApiKeyInAuthorizationHeaderAuth
path Parameters
id
required
string <uuid> (Order ID)

A UUID string identifying this order.

query Parameters
fields
string

Comma-separated list of fields to include in the response. If not provided, all available fields are returned.

format
string
Enum: "csv" "json"
omit
string

Comma-separated list of fields to exclude from the response. If not provided, all available fields are returned.

Responses

Retrieve Order Pricing Information

Retrieve detailed pricing information for a specific tasking order by its ID.

Rate Limits

  • 300 requests/minute (scope: sustained)
  • 40 requests/second (scope: burst)
Authorizations:
BearerTokenAuthApiKeyBasicAuthApiKeyInAuthorizationHeaderAuth
path Parameters
id
required
string <uuid> (Order ID)

A UUID string identifying this order.

query Parameters
fields
string

Comma-separated list of fields to include in the response. If not provided, all available fields are returned.

format
string
Enum: "csv" "json"
omit
string

Comma-separated list of fields to exclude from the response. If not provided, all available fields are returned.

Responses

Response samples

Content type
{
  • "order_id": "93101167-9065-4b9c-b98b-5d789a3ed9fe",
  • "units": "SQKM",
  • "estimated_quota_cost": 0.1,
  • "determined_by": "pricing_model",
  • "pricing_model": {
    },
  • "replaced_orders": [
    ]
}

Imaging Windows

An imaging window is a distinct opportunity for imagery to be taken by a specific satellite as it passes over an area of interest (AOI) at a given time of interest (TOI). Submitting an Assured Tasking order requires you to specify an imaging window.

Retrieve Imaging Windows Deprecated

Retrieve the available imaging windows after completing a synchronous (blocking) imaging window search using the search_id returned from the initial search request as a query parameter.

This operation is deprecated. Please create an asynchronous imaging windows search request instead.

Rate Limits

  • 300 requests/minute (scope: sustained)
  • 40 requests/second (scope: burst)
Authorizations:
BearerTokenAuthApiKeyBasicAuthApiKeyInAuthorizationHeaderAuth
query Parameters
end_time
string <date-time>

Filter by the end time to be equal to the given value

end_time__gt
string <date-time>

Filter by the end time to be greater than the given value

end_time__gte
string <date-time>

Filter by the end time to be greater than or equal to the given value

end_time__lt
string <date-time>

Filter by the end time to be less than the given value

end_time__lte
string <date-time>

Filter by the end time to be less than or equal to the given value

fields
string

Comma-separated list of fields to include in the response. If not provided, all available fields are returned.

limit
integer [ 1 .. 1000 ]

Number of results to return per page.

offset
integer [ 0 .. 30000 ]

The initial index from which to return the results.

omit
string

Comma-separated list of fields to exclude from the response. If not provided, all available fields are returned.

ordering
string

Which field to use when ordering the results.

search_id
required
string <uuid>

Filter by the search ID to be equal to the given value

search_request_id
string <uuid> (Search Request ID)

Filter by the search request ID to be equal to the given value

show_replacing_imaging_windows
boolean

If true, the search results will include imaging windows that require the replacement of existing orders. If one of these imaging windows is used to submit an order, all orders listed in its conflicting_orders will be cancelled.

show_waitlistable_imaging_windows
boolean

If true, the search results will include imaging windows that are only available via waitlisting. If an imaging window with only_via_waitlist=true is used to submit an order, the order will remain in status WAITLISTED until the imaging window becomes available.

start_time
string <date-time>

Filter by the start time to be equal to the given value

start_time__gt
string <date-time>

Filter by the start time to be greater than the given value

start_time__gte
string <date-time>

Filter by the start time to be greater than or equal to the given value

start_time__lt
string <date-time>

Filter by the start time to be less than the given value

start_time__lte
string <date-time>

Filter by the start time to be less than or equal to the given value

Responses

Response samples

Content type
application/json
{
  • "count": 123,
  • "next": "http://api.example.org/accounts/?offset=400&limit=100",
  • "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  • "results": [
    ]
}

Search Imaging Windows Deprecated

Performs a synchronous (blocking) search for available imaging windows. The request will return only after all available imaging windows have been determined. This process may take up to two minutes.

This operation is deprecated. Please create an asynchronous imaging windows search request instead.

Rate Limits

  • 3 requests/second (scope: imaging window search)
  • 300 requests/minute (scope: sustained)
  • 40 requests/second (scope: burst)
Authorizations:
BearerTokenAuthApiKeyBasicAuthApiKeyInAuthorizationHeaderAuth
Request Body schema: application/json
required
pl_number
string (Contract number)

Contract number of the search request. Required if you have access to multiple products or contracts.

product
string (Product name)

Name of the product of the search request. Required if you have access to multiple products or contracts.

required
object or object or object or object or object or object or object

GeoJSON representation of a Point or a two-point LineString to serve as the area of interest for the imaging window search

start_time
string <date-time>

Time from which to consider imaging windows. Defaults to now.

end_time
string <date-time>

Time until which to consider imaging windows. Defaults to 7 days from now.

sat_elevation_angle_min
number <double> (Minimum satellite elevation angle) [ 15 .. 90 ]

Minimum elevation of the satellite flying over the chosen area of interest. Passing satellite elevation and off-nadir angle ranges is mutually exclusive.

sat_elevation_angle_max
number <double> (Maximum satellite elevation angle) [ 15 .. 90 ]

Maximum elevation of the satellite flying over the chosen area of interest. Passing satellite elevation and off-nadir angle ranges is mutually exclusive.

off_nadir_angle_min
number <double> (Minimum off-nadir angle) [ 0 .. 65 ]

Minimum off-nadir angle of the satellite flying over the chosen area of interest. Passing satellite elevation and off-nadir angle ranges is mutually exclusive.

off_nadir_angle_max
number <double> (Maximum off-nadir angle) [ 0 .. 65 ]

Maximum off-nadir angle of the satellite flying over the chosen area of interest. Passing satellite elevation and off-nadir angle ranges is mutually exclusive.

satellite_types
Array of strings
Items Enum: "SKYSAT" "PELICAN" "TANAGER"

Satellite types to search for imaging windows for

sensitivity_mode
string
Enum: "NOT_APPLICABLE" "GLINT" "STANDARD" "MEDIUM" "HIGH" "MAX" "PUSHBROOM"

The sensitivity mode influences the number of integrations performed during hyperspectral imagery capture. Possible values are:

  • NOT_APPLICABLE: Not a hyperspectral imagery order

  • GLINT:

  • `STANDARD: 1 integrations per line over a 8 ms duration (1x8)

  • MEDIUM: 2 integrations per line over a 8 ms duration (2x8)

  • `HIGH: 3 integrations per line over a 8 ms duration (3x8)

  • `MAX: 4 integrations per line over a 8 ms duration (4x8)

  • NOT_APPLICABLE - Not Applicable

  • GLINT - Glint

  • STANDARD - Standard

  • MEDIUM - Medium

  • HIGH - High

  • MAX - Max

  • PUSHBROOM - Pushbroom

Responses

Request samples

Content type
application/json
{
  • "pl_number": "string",
  • "product": "string",
  • "geometry": {
    },
  • "start_time": "2019-08-24T14:15:22Z",
  • "end_time": "2019-08-24T14:15:22Z",
  • "sat_elevation_angle_min": 15,
  • "sat_elevation_angle_max": 15,
  • "off_nadir_angle_min": 65,
  • "off_nadir_angle_max": 65,
  • "satellite_types": [
    ],
  • "sensitivity_mode": "NOT_APPLICABLE"
}

Response samples

Content type
application/json
{}

Create Asynchronous Imaging Windows Search Request

Submit an asynchronous request to search for imaging windows. Once the search request has been created its status and results can be observed by retrieving the resource by its ID. Additional results will be returned over time as they become available until the status of the search request changes to DONE.

Rate Limits

  • 3 requests/second (scope: imaging window search)
  • 300 requests/minute (scope: sustained)
  • 40 requests/second (scope: burst)
Authorizations:
BearerTokenAuthApiKeyBasicAuthApiKeyInAuthorizationHeaderAuth
query Parameters
fields
string

Comma-separated list of fields to include in the response. If not provided, all available fields are returned.

omit
string

Comma-separated list of fields to exclude from the response. If not provided, all available fields are returned.

Request Body schema: application/json
required
pl_number
string (Contract number)

Contract number of the search request. Required if you have access to multiple products or contracts.

product
string (Product name)

Name of the product of the search request. Required if you have access to multiple products or contracts.

required
object or object or object or object or object or object or object

GeoJSON representation of a Point or a two-point LineString to serve as the area of interest for the imaging window search

start_time
string <date-time>

Time from which to consider imaging windows. Defaults to now.

end_time
string <date-time>

Time until which to consider imaging windows. Defaults to 7 days from now.

sat_elevation_angle_min
number <double> (Minimum satellite elevation angle) [ 15 .. 90 ]

Minimum elevation of the satellite flying over the chosen area of interest. Passing satellite elevation and off-nadir angle ranges is mutually exclusive.

sat_elevation_angle_max
number <double> (Maximum satellite elevation angle) [ 15 .. 90 ]

Maximum elevation of the satellite flying over the chosen area of interest. Passing satellite elevation and off-nadir angle ranges is mutually exclusive.

off_nadir_angle_min
number <double> (Minimum off-nadir angle) [ 0 .. 65 ]

Minimum off-nadir angle of the satellite flying over the chosen area of interest. Passing satellite elevation and off-nadir angle ranges is mutually exclusive.

off_nadir_angle_max
number <double> (Maximum off-nadir angle) [ 0 .. 65 ]

Maximum off-nadir angle of the satellite flying over the chosen area of interest. Passing satellite elevation and off-nadir angle ranges is mutually exclusive.

satellite_types
Array of strings
Items Enum: "SKYSAT" "PELICAN" "TANAGER"

Satellite types to search for imaging windows for

sensitivity_mode
string
Enum: "NOT_APPLICABLE" "GLINT" "STANDARD" "MEDIUM" "HIGH" "MAX" "PUSHBROOM"

The sensitivity mode influences the number of integrations performed during hyperspectral imagery capture. Possible values are:

  • NOT_APPLICABLE: Not a hyperspectral imagery order

  • GLINT:

  • `STANDARD: 1 integrations per line over a 8 ms duration (1x8)

  • MEDIUM: 2 integrations per line over a 8 ms duration (2x8)

  • `HIGH: 3 integrations per line over a 8 ms duration (3x8)

  • `MAX: 4 integrations per line over a 8 ms duration (4x8)

  • NOT_APPLICABLE - Not Applicable

  • GLINT - Glint

  • STANDARD - Standard

  • MEDIUM - Medium

  • HIGH - High

  • MAX - Max

  • PUSHBROOM - Pushbroom

Responses

Request samples

Content type
application/json
{
  • "pl_number": "string",
  • "product": "string",
  • "geometry": {
    },
  • "start_time": "2019-08-24T14:15:22Z",
  • "end_time": "2019-08-24T14:15:22Z",
  • "sat_elevation_angle_min": 15,
  • "sat_elevation_angle_max": 15,
  • "off_nadir_angle_min": 65,
  • "off_nadir_angle_max": 65,
  • "satellite_types": [
    ],
  • "sensitivity_mode": "NOT_APPLICABLE"
}

Response samples

Content type
application/json
{
  • "pl_number": "string",
  • "product": "string",
  • "geometry": {
    },
  • "start_time": "2019-08-24T14:15:22Z",
  • "end_time": "2019-08-24T14:15:22Z",
  • "sat_elevation_angle_min": 15,
  • "sat_elevation_angle_max": 15,
  • "off_nadir_angle_min": 65,
  • "off_nadir_angle_max": 65,
  • "satellite_types": [
    ],
  • "sensitivity_mode": "NOT_APPLICABLE"
}

Retrieve Asynchronous Imaging Windows Search Results

Retrieve the status and results of an imaging window search request by its ID. Additional results will be returned over time as they become available until the status of the search request changes to DONE.

Rate Limits

  • 300 requests/minute (scope: sustained)
  • 40 requests/second (scope: burst)
Authorizations:
BearerTokenAuthApiKeyBasicAuthApiKeyInAuthorizationHeaderAuth
path Parameters
id
required
string <uuid> (Search Request ID)

UUID of the Imaging Window Search Request

query Parameters
fields
string

Comma-separated list of fields to include in the response. If not provided, all available fields are returned.

omit
string

Comma-separated list of fields to exclude from the response. If not provided, all available fields are returned.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "imaging_windows": [ ],
  • "status": "CREATED",
  • "pl_number": "string",
  • "product": "string",
  • "geometry": {
    },
  • "start_time": "2019-08-24T14:15:22Z",
  • "end_time": "2019-08-24T14:15:22Z",
  • "sat_elevation_angle_min": 15,
  • "sat_elevation_angle_max": 15,
  • "off_nadir_angle_min": 65,
  • "off_nadir_angle_max": 65,
  • "error_code": "INTERNAL_ERROR",
  • "error_message": "string"
}

Captures

A capture is a reference to the imagery acquired for the order submitted by the user.

List Captures

Retrieve all captures you have access to. This includes all captures related to your organization.

Rate Limits

  • 300 requests/minute (scope: sustained)
  • 40 requests/second (scope: burst)
Authorizations:
BearerTokenAuthApiKeyBasicAuthApiKeyInAuthorizationHeaderAuth
query Parameters
acquired_time
string <date-time>

Filter by the acquired time to be equal to the given value

acquired_time__gt
string <date-time>

Filter by the acquired time to be greater than the given value

acquired_time__gte
string <date-time>

Filter by the acquired time to be greater than or equal to the given value

acquired_time__lt
string <date-time>

Filter by the acquired time to be less than the given value

acquired_time__lte
string <date-time>

Filter by the acquired time to be less than or equal to the given value

aqua_assessment
string or null
Enum: "ATTEMPT" "INVALID" "SUCCESS"

Filter by the aqua assessment to be equal to the given value

  • SUCCESS - Success
  • ATTEMPT - Attempt
  • INVALID - Invalid
aqua_assessment__in
Array of strings

Multiple values may be separated by commas.

archive_time
string <date-time>

Filter by the archive time to be equal to the given value

archive_time__gt
string <date-time>

Filter by the archive time to be greater than the given value

archive_time__gte
string <date-time>

Filter by the archive time to be greater than or equal to the given value

archive_time__lt
string <date-time>

Filter by the archive time to be less than the given value

archive_time__lte
string <date-time>

Filter by the archive time to be less than or equal to the given value

assessment
string or null
Enum: "ATTEMPT" "INVALID" "SUCCESS"

Filter by the assessment to be equal to the given value

  • SUCCESS - Success
  • ATTEMPT - Attempt
  • INVALID - Invalid
assessment__in
Array of strings

Multiple values may be separated by commas.

assessment__isnotnull
boolean

Filter by the assessment to not be null/unset

assessment__isnull
boolean

Filter by the assessment to be null/unset

assessment_time
string <date-time>

Filter by the assessment time to be equal to the given value

assessment_time__gt
string <date-time>

Filter by the assessment time to be greater than the given value

assessment_time__gte
string <date-time>

Filter by the assessment time to be greater than or equal to the given value

assessment_time__isnotnull
boolean

Filter by the assessment time to not be null/unset

assessment_time__isnull
boolean

Filter by the assessment time to be null/unset

assessment_time__lt
string <date-time>

Filter by the assessment time to be less than the given value

assessment_time__lte
string <date-time>

Filter by the assessment time to be less than or equal to the given value

assessment_user_email
string

Filter by the assessment user email to be equal to the given value

assessment_user_email__icontains
string

Filter by the assessment user email to contain the given value (case-insensitive)

assessment_user_email__in
Array of strings

Multiple values may be separated by commas.

assessment_user_email__isnotnull
boolean

Filter by the assessment user email to not be null/unset

assessment_user_email__isnull
boolean

Filter by the assessment user email to be null/unset

assessment_user_email__ne
string

Filter by the assessment user email to not be equal to the given value

assessment_user_email__notin
Array of strings

Multiple values may be separated by commas.

cloud_cover__gt
number <float>

Filter by the cloud cover to be greater than the given value

cloud_cover__gte
number <float>

Filter by the cloud cover to be greater than or equal to the given value

cloud_cover__lt
number <float>

Filter by the cloud cover to be less than the given value

cloud_cover__lte
number <float>

Filter by the cloud cover to be less than or equal to the given value

cloud_cover_max__gt
number <float>

Filter by the maximum cloud coverage to be greater than the given value

cloud_cover_max__gte
number <float>

Filter by the maximum cloud coverage to be greater than or equal to the given value

cloud_cover_max__lt
number <float>

Filter by the maximum cloud coverage to be less than the given value

cloud_cover_max__lte
number <float>

Filter by the maximum cloud coverage to be less than or equal to the given value

combined_assessment
string or null
Enum: "ATTEMPT" "INVALID" "SUCCESS"

Filter by the combined assessment (deprecated, use Evaluation instead) to be equal to the given value

  • SUCCESS - Success
  • ATTEMPT - Attempt
  • INVALID - Invalid
combined_assessment__in
Array of strings

Multiple values may be separated by commas.

combined_assessment__isnotnull
boolean

Filter by the combined assessment (deprecated, use Evaluation instead) to not be null/unset

combined_assessment__isnull
boolean

Filter by the combined assessment (deprecated, use Evaluation instead) to be null/unset

created_time
string <date-time>

Filter by the created time to be equal to the given value

created_time__gt
string <date-time>

Filter by the created time to be greater than the given value

created_time__gte
string <date-time>

Filter by the created time to be greater than or equal to the given value

created_time__lt
string <date-time>

Filter by the created time to be less than the given value

created_time__lte
string <date-time>

Filter by the created time to be less than or equal to the given value

customer_aoi_name
string

Filter by the customer aoi name to be equal to the given value

customer_aoi_name__icontains
string

Filter by the customer aoi name to contain the given value (case-insensitive)

customer_aoi_name__isnotnull
boolean

Filter by the customer aoi name to not be null/unset

customer_aoi_name__isnull
boolean

Filter by the customer aoi name to be null/unset

customer_aoi_name__ne
string

Filter by the customer aoi name to not be equal to the given value

customer_org_id
integer

Filter by the customer org ID to be equal to the given value

customer_org_id__in
Array of integers

Multiple values may be separated by commas.

customer_org_id__ne
integer

Filter by the customer org ID to not be equal to the given value

customer_org_id__notin
Array of integers

Multiple values may be separated by commas.

dedicated_capacity_area_name
string

Filter by the dedicated capacity area name to be equal to the given value

dedicated_capacity_area_name__icontains
string

Filter by the dedicated capacity area name to contain the given value (case-insensitive)

dedicated_capacity_area_name__isnotnull
boolean

Filter by the dedicated capacity area name to not be null/unset

dedicated_capacity_area_name__isnull
boolean

Filter by the dedicated capacity area name to be null/unset

dedicated_capacity_area_name__ne
string

Filter by the dedicated capacity area name to not be equal to the given value

delivered_asset_types
Array of strings
Items Enum: "ortho_visual" "basic_analytic" "basic_analytic_udm2" "basic_analytic_rpc" "basic_panchromatic" "basic_panchromatic_rpc" "basic_panchromatic_udm2" "ortho_analytic" "ortho_analytic_sr" "ortho_analytic_udm2" "ortho_panchromatic" "ortho_pansharpened" "ortho_pansharpened_udm2" "basic_radiance_hdf5" "ortho_radiance_hdf5" "ortho_beta_udm" "basic_sr_hdf5" "ortho_sr_hdf5" "ortho_ql_ch4" "ql_ch4_json" "basic_beta_udm" "geolocation_array" "recent_monthly_mosaic" "ortho_qc_ch4" "qc_ch4_json" "basic_l1a_panchromatic" "basic_l1a_panchromatic_rpc" "basic_analytic_dn" "basic_analytic_dn_rpc" "basic_analytic_udm" "basic_l1a_panchromatic_dn" "basic_l1a_panchromatic_dn_rpc" "basic_panchromatic_dn" "basic_panchromatic_dn_rpc" "ortho_analytic_dn" "ortho_analytic_udm" "ortho_panchromatic_dn" "ortho_panchromatic_udm" "ortho_panchromatic_udm2" "ortho_pansharpened_udm"

Filter by the delivered asset types to be equal to the given value

delivered_asset_types__in
Array of strings[ items ]
Items Enum: "ortho_visual" "basic_analytic" "basic_analytic_udm2" "basic_analytic_rpc" "basic_panchromatic" "basic_panchromatic_rpc" "basic_panchromatic_udm2" "ortho_analytic" "ortho_analytic_sr" "ortho_analytic_udm2" "ortho_panchromatic" "ortho_pansharpened" "ortho_pansharpened_udm2" "basic_radiance_hdf5" "ortho_radiance_hdf5" "ortho_beta_udm" "basic_sr_hdf5" "ortho_sr_hdf5" "ortho_ql_ch4" "ql_ch4_json" "basic_beta_udm" "geolocation_array" "recent_monthly_mosaic" "ortho_qc_ch4" "qc_ch4_json" "basic_l1a_panchromatic" "basic_l1a_panchromatic_rpc" "basic_analytic_dn" "basic_analytic_dn_rpc" "basic_analytic_udm" "basic_l1a_panchromatic_dn" "basic_l1a_panchromatic_dn_rpc" "basic_panchromatic_dn" "basic_panchromatic_dn_rpc" "ortho_analytic_dn" "ortho_analytic_udm" "ortho_panchromatic_dn" "ortho_panchromatic_udm" "ortho_panchromatic_udm2" "ortho_pansharpened_udm"

Multiple values may be separated by commas.

delivered_asset_types__ne
Array of strings
Items Enum: "ortho_visual" "basic_analytic" "basic_analytic_udm2" "basic_analytic_rpc" "basic_panchromatic" "basic_panchromatic_rpc" "basic_panchromatic_udm2" "ortho_analytic" "ortho_analytic_sr" "ortho_analytic_udm2" "ortho_panchromatic" "ortho_pansharpened" "ortho_pansharpened_udm2" "basic_radiance_hdf5" "ortho_radiance_hdf5" "ortho_beta_udm" "basic_sr_hdf5" "ortho_sr_hdf5" "ortho_ql_ch4" "ql_ch4_json" "basic_beta_udm" "geolocation_array" "recent_monthly_mosaic" "ortho_qc_ch4" "qc_ch4_json" "basic_l1a_panchromatic" "basic_l1a_panchromatic_rpc" "basic_analytic_dn" "basic_analytic_dn_rpc" "basic_analytic_udm" "basic_l1a_panchromatic_dn" "basic_l1a_panchromatic_dn_rpc" "basic_panchromatic_dn" "basic_panchromatic_dn_rpc" "ortho_analytic_dn" "ortho_analytic_udm" "ortho_panchromatic_dn" "ortho_panchromatic_udm" "ortho_panchromatic_udm2" "ortho_pansharpened_udm"

Filter by the delivered asset types to not be equal to the given value

delivered_asset_types__notin
Array of strings[ items ]
Items Enum: "ortho_visual" "basic_analytic" "basic_analytic_udm2" "basic_analytic_rpc" "basic_panchromatic" "basic_panchromatic_rpc" "basic_panchromatic_udm2" "ortho_analytic" "ortho_analytic_sr" "ortho_analytic_udm2" "ortho_panchromatic" "ortho_pansharpened" "ortho_pansharpened_udm2" "basic_radiance_hdf5" "ortho_radiance_hdf5" "ortho_beta_udm" "basic_sr_hdf5" "ortho_sr_hdf5" "ortho_ql_ch4" "ql_ch4_json" "basic_beta_udm" "geolocation_array" "recent_monthly_mosaic" "ortho_qc_ch4" "qc_ch4_json" "basic_l1a_panchromatic" "basic_l1a_panchromatic_rpc" "basic_analytic_dn" "basic_analytic_dn_rpc" "basic_analytic_udm" "basic_l1a_panchromatic_dn" "basic_l1a_panchromatic_dn_rpc" "basic_panchromatic_dn" "basic_panchromatic_dn_rpc" "ortho_analytic_dn" "ortho_analytic_udm" "ortho_panchromatic_dn" "ortho_panchromatic_udm" "ortho_panchromatic_udm2" "ortho_pansharpened_udm"

Multiple values may be separated by commas.

evaluation
string
Enum: "INVALID" "NONE" "SUCCESS"

Filter by the evaluation to be equal to the given value

  • NONE - None
  • SUCCESS - Success
  • INVALID - Invalid
expired_time
string <date-time>

Filter by the expired time to be equal to the given value

expired_time__gt
string <date-time>

Filter by the expired time to be greater than the given value

expired_time__gte
string <date-time>

Filter by the expired time to be greater than or equal to the given value

expired_time__lt
string <date-time>

Filter by the expired time to be less than the given value

expired_time__lte
string <date-time>

Filter by the expired time to be less than or equal to the given value

fast_rectification_latency
string <duration>

Filter by the fast rectification latency to be equal to the given value

fast_rectification_latency__gt
string <duration>

Filter by the fast rectification latency to be greater than the given value

fast_rectification_latency__gte
string <duration>

Filter by the fast rectification latency to be greater than or equal to the given value

fast_rectification_latency__lt
string <duration>

Filter by the fast rectification latency to be less than the given value

fast_rectification_latency__lte
string <duration>

Filter by the fast rectification latency to be less than or equal to the given value

fields
string

Comma-separated list of fields to include in the response. If not provided, all available fields are returned.

format
string
Enum: "csv" "json"
fulfilling
boolean

Filter by the fulfilling to be equal to the given value

full_ortho_latency
string <duration>

Filter by the full orthorectification latency to be equal to the given value

full_ortho_latency__gt
string <duration>

Filter by the full orthorectification latency to be greater than the given value

full_ortho_latency__gte
string <duration>

Filter by the full orthorectification latency to be greater than or equal to the given value

full_ortho_latency__lt
string <duration>

Filter by the full orthorectification latency to be less than the given value

full_ortho_latency__lte
string <duration>

Filter by the full orthorectification latency to be less than or equal to the given value

ground_id
string <uuid>

Filter by the ground ID to be equal to the given value

ground_id__in
Array of strings <uuid> [ items <uuid > ]

Multiple values may be separated by commas.

ground_id__ne
string <uuid>

Filter by the ground ID to not be equal to the given value

ground_id__notin
Array of strings <uuid> [ items <uuid > ]

Multiple values may be separated by commas.

id
string <uuid>

Filter by the id to be equal to the given value

id__in
Array of strings <uuid> [ items <uuid > ]

Multiple values may be separated by commas.

id__ne
string <uuid>

Filter by the id to not be equal to the given value

id__notin
Array of strings <uuid> [ items <uuid > ]

Multiple values may be separated by commas.

imaging_conops
string
Enum: "dark" "experimental" "flatfield" "glint" "high_capacity" "high_data_volume" "nominal" "video"

Filter by the imaging collection preset to be equal to the given value

  • nominal - Nominal
  • high_capacity - High Capacity
  • high_data_volume - High Data Volume
  • experimental - Experimental
  • dark - Dark
  • glint - Glint
  • flatfield - Flatfield
  • video - Video
imaging_conops__in
Array of strings

Multiple values may be separated by commas.

imaging_conops__ne
string

Filter by the imaging collection preset to not be equal to the given value

imaging_conops__notin
Array of strings

Multiple values may be separated by commas.

item_ids
string

Filter by the item IDs to contain the given value

l1a_latency
string <duration>

Filter by the l1A latency to be equal to the given value

l1a_latency__gt
string <duration>

Filter by the l1A latency to be greater than the given value

l1a_latency__gte
string <duration>

Filter by the l1A latency to be greater than or equal to the given value

l1a_latency__lt
string <duration>

Filter by the l1A latency to be less than the given value

l1a_latency__lte
string <duration>

Filter by the l1A latency to be less than or equal to the given value

limit
integer [ 1 .. 1000 ]

Number of results to return per page.

metis_activity_id
string <uuid>

Filter by the metis activity ID to be equal to the given value

metis_activity_id__in
Array of strings <uuid> [ items <uuid > ]

Multiple values may be separated by commas.

needs_manual_assessment
boolean

Filter by the needs manual assessment to be equal to the given value

off_nadir_angle_max
number <float>

Filter by the maximum off-nadir angle to be equal to the given value

off_nadir_angle_max__gt
number <float>

Filter by the maximum off-nadir angle to be greater than the given value

off_nadir_angle_max__gte
number <float>

Filter by the maximum off-nadir angle to be greater than or equal to the given value

off_nadir_angle_max__lt
number <float>

Filter by the maximum off-nadir angle to be less than the given value

off_nadir_angle_max__lte
number <float>

Filter by the maximum off-nadir angle to be less than or equal to the given value

offset
integer [ 0 .. 30000 ]

The initial index from which to return the results.

omit
string

Comma-separated list of fields to exclude from the response. If not provided, all available fields are returned.

order__created_time
string <date-time>

Filter by the order created time to be equal to the given value

order__created_time__gt
string <date-time>

Filter by the order created time to be greater than the given value

order__created_time__gte
string <date-time>

Filter by the order created time to be greater than or equal to the given value

order__created_time__lt
string <date-time>

Filter by the order created time to be less than the given value

order__created_time__lte
string <date-time>

Filter by the order created time to be less than or equal to the given value

order__end_time
string <date-time>

Filter by the order end time to be equal to the given value

order__end_time__gt
string <date-time>

Filter by the order end time to be greater than the given value

order__end_time__gte
string <date-time>

Filter by the order end time to be greater than or equal to the given value

order__end_time__lt
string <date-time>

Filter by the order end time to be less than the given value

order__end_time__lte
string <date-time>

Filter by the order end time to be less than or equal to the given value

order__order_type
string
Enum: "IMAGE" "STEREO" "VIDEO"

Filter by the order order type to be equal to the given value

  • IMAGE - Image
  • VIDEO - Video
  • STEREO - Stereo
order__order_type__in
Array of strings

Multiple values may be separated by commas.

order__order_type__ne
string

Filter by the order order type to not be equal to the given value

order__order_type__notin
Array of strings

Multiple values may be separated by commas.

order__priority
integer

Filter by the order priority to be equal to the given value

order__priority__gt
integer

Filter by the order priority to be greater than the given value

order__priority__gte
integer

Filter by the order priority to be greater than or equal to the given value

order__priority__lt
integer

Filter by the order priority to be less than the given value

order__priority__lte
integer

Filter by the order priority to be less than or equal to the given value

order__rank
integer

Filter by the order rank to be equal to the given value

order__rank__gt
integer

Filter by the order rank to be greater than the given value

order__rank__gte
integer

Filter by the order rank to be greater than or equal to the given value

order__rank__lt
integer

Filter by the order rank to be less than the given value

order__rank__lte
integer

Filter by the order rank to be less than or equal to the given value

order__start_time
string <date-time>

Filter by the order start time to be equal to the given value

order__start_time__gt
string <date-time>

Filter by the order start time to be greater than the given value

order__start_time__gte
string <date-time>

Filter by the order start time to be greater than or equal to the given value

order__start_time__lt
string <date-time>

Filter by the order start time to be less than the given value

order__start_time__lte
string <date-time>

Filter by the order start time to be less than or equal to the given value

order__status
string
Enum: "CANCELLED" "EXPIRED" "FAILED" "FINALIZING" "FULFILLED" "IN_PROGRESS" "PENDING" "PENDING_CANCELLATION" "RECEIVED" "REJECTED" "REQUESTED" "WAITLISTED" "WAITLIST_ABANDONED" "WAITLIST_EXPIRED"

Filter by the order status to be equal to the given value

  • RECEIVED - Received
  • PENDING - Pending
  • IN_PROGRESS - In Progress
  • EXPIRED - Expired
  • FULFILLED - Fulfilled
  • FAILED - Failed
  • CANCELLED - Cancelled
  • REQUESTED - Requested
  • FINALIZING - Finalizing
  • PENDING_CANCELLATION - Pending Cancellation
  • REJECTED - Rejected
  • WAITLISTED - Waitlisted
  • WAITLIST_ABANDONED - Waitlist Abandoned
  • WAITLIST_EXPIRED - Waitlist Expired
order__status__in
Array of strings

Multiple values may be separated by commas.

order__status__ne
string

Filter by the order status to not be equal to the given value

order__status__notin
Array of strings

Multiple values may be separated by commas.

order_id
string <uuid>

Filter by the order ID to be equal to the given value

order_id__in
Array of strings <uuid> [ items <uuid > ]

Multiple values may be separated by commas.

order_name
string

Filter by the order name to be equal to the given value

order_name__icontains
string

Filter by the order name to contain the given value (case-insensitive)

order_name__in
Array of strings

Multiple values may be separated by commas.

order_name__ne
string

Filter by the order name to not be equal to the given value

order_name__notin
Array of strings

Multiple values may be separated by commas.

ordering
string

Which field to use when ordering the results.

pl_number
string

Filter by the contract number to be equal to the given value

pl_number__icontains
string

Filter by the contract number to contain the given value (case-insensitive)

pl_number__in
Array of strings

Multiple values may be separated by commas.

pl_number__ne
string

Filter by the contract number to not be equal to the given value

pl_number__notin
Array of strings

Multiple values may be separated by commas.

planned_acquisition_time
string <date-time>

Filter by the planned acquisition time to be equal to the given value

planned_acquisition_time__gt
string <date-time>

Filter by the planned acquisition time to be greater than the given value

planned_acquisition_time__gte
string <date-time>

Filter by the planned acquisition time to be greater than or equal to the given value

planned_acquisition_time__lt
string <date-time>

Filter by the planned acquisition time to be less than the given value

planned_acquisition_time__lte
string <date-time>

Filter by the planned acquisition time to be less than or equal to the given value

prioritized_processing
boolean

Filter by the prioritized processing to be equal to the given value

product
string

Filter by the product name to be equal to the given value

product__in
Array of strings

Multiple values may be separated by commas.

product__ne
string

Filter by the product name to not be equal to the given value

product__notin
Array of strings

Multiple values may be separated by commas.

published_time
string <date-time>

Filter by the published to customer to be equal to the given value

published_time__gt
string <date-time>

Filter by the published to customer to be greater than the given value

published_time__gte
string <date-time>

Filter by the published to customer to be greater than or equal to the given value

published_time__lt
string <date-time>

Filter by the published to customer to be less than the given value

published_time__lte
string <date-time>

Filter by the published to customer to be less than or equal to the given value

review_outcome
string or null
Enum: "ACCEPTED" "DECLINED" "QUOTA_ADJUSTED" "REFUNDED" "REPROCESSED" "RE_TASKED"

Filter by the capture review outcome to be equal to the given value

  • DECLINED - Declined
  • REFUNDED - Refunded
  • RE_TASKED - Re-tasked
  • QUOTA_ADJUSTED - Quota Adjusted
  • REPROCESSED - Reprocessed
  • ACCEPTED - Accepted
review_outcome__in
Array of strings

Multiple values may be separated by commas.

review_outcome__isnull
boolean

Filter by the capture review outcome to be null/unset

review_status
string
Enum: "IN_PROGRESS" "PENDING" "PROCESSED"

Filter by the capture review status to be equal to the given value

  • PENDING - Pending
  • IN_PROGRESS - In Progress
  • PROCESSED - Processed
review_status__in
Array of strings

Multiple values may be separated by commas.

review_status__isnull
boolean

Filter by the capture review status to be null/unset

satellite_hw_id
string

Filter by the satellite hw ID to be equal to the given value

satellite_hw_id__in
Array of strings

Multiple values may be separated by commas.

satellite_hw_id__ne
string

Filter by the satellite hw ID to not be equal to the given value

satellite_hw_id__notin
Array of strings

Multiple values may be separated by commas.

satellite_type
string
Enum: "PELICAN" "SKYSAT" "TANAGER"

Filter by the satellite type to be equal to the given value

  • SKYSAT - SkySat
  • PELICAN - Pelican
  • TANAGER - Tanager
satellite_type__in
Array of strings

Multiple values may be separated by commas.

satellite_type__ne
string

Filter by the satellite type to not be equal to the given value

satellite_type__notin
Array of strings

Multiple values may be separated by commas.

saturated_pixel_ratio
number <float>

Filter by the saturated pixel ratio to be equal to the given value

saturated_pixel_ratio__gt
number <float>

Filter by the saturated pixel ratio to be greater than the given value

saturated_pixel_ratio__gte
number <float>

Filter by the saturated pixel ratio to be greater than or equal to the given value

saturated_pixel_ratio__lt
number <float>

Filter by the saturated pixel ratio to be less than the given value

saturated_pixel_ratio__lte
number <float>

Filter by the saturated pixel ratio to be less than or equal to the given value

sensitivity_mode
string
Enum: "GLINT" "HIGH" "MAX" "MEDIUM" "NOT_APPLICABLE" "PUSHBROOM" "STANDARD"

Filter by the sensitivity mode to be equal to the given value

  • NOT_APPLICABLE - Not Applicable
  • GLINT - Glint
  • STANDARD - Standard
  • MEDIUM - Medium
  • HIGH - High
  • MAX - Max
  • PUSHBROOM - Pushbroom
sensitivity_mode__in
Array of strings

Multiple values may be separated by commas.

sensitivity_mode__ne
string

Filter by the sensitivity mode to not be equal to the given value

sensitivity_mode__notin
Array of strings

Multiple values may be separated by commas.

status
string
Enum: "DERIVING" "FAILED" "PROCESSING" "PUBLISHED" "QUEUED" "REMOVED" "SCHEDULED"

Filter by the status to be equal to the given value

  • SCHEDULED - Scheduled
  • REMOVED - Removed
  • QUEUED - Queued
  • PROCESSING - Processing
  • FAILED - Failed
  • DERIVING - Deriving
  • PUBLISHED - Published
status__in
Array of strings

Multiple values may be separated by commas.

status__ne
string

Filter by the status to not be equal to the given value

status__notin
Array of strings

Multiple values may be separated by commas.

strip_id
string

Filter by the strip ID to be equal to the given value

strip_id__in
Array of strings

Multiple values may be separated by commas.

strip_id__ne
string

Filter by the strip ID to not be equal to the given value

strip_id__notin
Array of strings

Multiple values may be separated by commas.

strip_id_base
string

Filter by the strip ID base to be equal to the given value

strip_id_base__in
Array of strings

Multiple values may be separated by commas.

strip_id_base__ne
string

Filter by the strip ID base to not be equal to the given value

strip_id_base__notin
Array of strings

Multiple values may be separated by commas.

task__created_time
string <date-time>

Filter by the task created time to be equal to the given value

task__created_time__gt
string <date-time>

Filter by the task created time to be greater than the given value

task__created_time__gte
string <date-time>

Filter by the task created time to be greater than or equal to the given value

task__created_time__lt
string <date-time>

Filter by the task created time to be less than the given value

task__created_time__lte
string <date-time>

Filter by the task created time to be less than or equal to the given value

task__end_time
string <date-time>

Filter by the task end time to be equal to the given value

task__end_time__gt
string <date-time>

Filter by the task end time to be greater than the given value

task__end_time__gte
string <date-time>

Filter by the task end time to be greater than or equal to the given value

task__end_time__lt
string <date-time>

Filter by the task end time to be less than the given value

task__end_time__lte
string <date-time>

Filter by the task end time to be less than or equal to the given value

task__priority
integer

Filter by the task priority to be equal to the given value

task__priority__gt
integer

Filter by the task priority to be greater than the given value

task__priority__gte
integer

Filter by the task priority to be greater than or equal to the given value

task__priority__lt
integer

Filter by the task priority to be less than the given value

task__priority__lte
integer

Filter by the task priority to be less than or equal to the given value

task__start_time
string <date-time>

Filter by the task start time to be equal to the given value

task__start_time__gt
string <date-time>

Filter by the task start time to be greater than the given value

task__start_time__gte
string <date-time>

Filter by the task start time to be greater than or equal to the given value

task__start_time__lt
string <date-time>

Filter by the task start time to be less than the given value

task__start_time__lte
string <date-time>

Filter by the task start time to be less than or equal to the given value

task__status
string
Enum: "CANCELLED" "EXPIRED" "FAILED" "FINALIZING" "FULFILLED" "LOCKED_IN" "LOCK_IN_REQUESTED" "LOCK_IN_TIMEOUT" "PENDING" "PENDING_CANCELLATION" "PROCESSING" "PUBLISHED" "QUEUED" "REQUESTED" "REQUEST_RETRYING" "WAITLISTED" "WAITLIST_ABANDONED" "WAITLIST_EXPIRED"

Filter by the task status to be equal to the given value

  • PENDING - Pending
  • REQUESTED - Requested
  • FULFILLED - Fulfilled
  • CANCELLED - Cancelled
  • PROCESSING - Processing
  • QUEUED - Queued
  • EXPIRED - Expired
  • FINALIZING - Finalizing
  • LOCK_IN_REQUESTED - Lock-In Requested
  • LOCK_IN_TIMEOUT - Lock-In Timeout
  • LOCKED_IN - Locked In
  • PENDING_CANCELLATION - Pending Cancellation
  • FAILED - Failed
  • PUBLISHED - Published
  • WAITLISTED - Waitlisted
  • WAITLIST_ABANDONED - Waitlist Abandoned
  • WAITLIST_EXPIRED - Waitlist Expired
  • REQUEST_RETRYING - Request Retrying
task__status__in
Array of strings

Multiple values may be separated by commas.

task__status__ne
string

Filter by the task status to not be equal to the given value

task__status__notin
Array of strings

Multiple values may be separated by commas.

task_id
string <uuid>

Filter by the task ID to be equal to the given value

task_id__in
Array of strings <uuid> [ items <uuid > ]

Multiple values may be separated by commas.

task_name
string

Filter by the task name to be equal to the given value

task_name__icontains
string

Filter by the task name to contain the given value (case-insensitive)

task_name__in
Array of strings

Multiple values may be separated by commas.

task_name__ne
string

Filter by the task name to not be equal to the given value

task_name__notin
Array of strings

Multiple values may be separated by commas.

test_quality_image
boolean

Filter by the test quality image to be equal to the given value

updated_time
string <date-time>

Filter by the updated time to be equal to the given value

updated_time__gt
string <date-time>

Filter by the updated time to be greater than the given value

updated_time__gte
string <date-time>

Filter by the updated time to be greater than or equal to the given value

updated_time__lt
string <date-time>

Filter by the updated time to be less than the given value

updated_time__lte
string <date-time>

Filter by the updated time to be less than or equal to the given value

Responses

Response samples

Content type
{
  • "count": 123,
  • "next": "http://api.example.org/accounts/?offset=400&limit=100",
  • "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  • "results": [
    ]
}

Open a capture review

Create a capture review for a capture by its ID.

Rate Limits

  • 300 requests/minute (scope: sustained)
  • 40 requests/second (scope: burst)
Authorizations:
BearerTokenAuthApiKeyBasicAuthApiKeyInAuthorizationHeaderAuth
path Parameters
capture_id
required
string
query Parameters
fields
string

Comma-separated list of fields to include in the response. If not provided, all available fields are returned.

omit
string

Comma-separated list of fields to exclude from the response. If not provided, all available fields are returned.

Request Body schema: application/json
required
review_type
string
Default: "REJECTION"
Enum: "REJECTION" "APPROVAL"
  • REJECTION - Rejection
  • APPROVAL - Approval
capture_id
required
string <uuid>
category
string
Enum: "CLOUD_COVER" "HAZE" "DISPLACEMENT" "BRIGHTNESS_ISSUE" "SHADOWS" "OTHER"
  • CLOUD_COVER - Cloud Coverage
  • HAZE - Haze
  • DISPLACEMENT - Gaps / Misalignment
  • BRIGHTNESS_ISSUE - Brightness Issue
  • SHADOWS - Shadows
  • OTHER - Other
object or object or object or object or object or object or object
description
string
Default: ""
jira_ticket_id
string or null
tags
any or null

Responses

Request samples

Content type
application/json
{
  • "review_type": "REJECTION",
  • "capture_id": "1eabca11-8bcb-444a-a4a9-8a931337656a",
  • "category": "CLOUD_COVER",
  • "geometry": {
    },
  • "description": "",
  • "jira_ticket_id": "string",
  • "tags": null
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_time": "2019-08-24T14:15:22Z",
  • "updated_time": "2019-08-24T14:15:22Z",
  • "review_type": "REJECTION",
  • "capture_id": "1eabca11-8bcb-444a-a4a9-8a931337656a",
  • "status": "PENDING",
  • "category": "CLOUD_COVER",
  • "created_by_user_id": "209f54c4-4c33-43bc-9c6a-ef4c65ad7473",
  • "geometry": {
    },
  • "description": "",
  • "jira_ticket_id": "string",
  • "resolution": "DECLINED",
  • "outcome": "DECLINED",
  • "tags": null
}

Retrieve Capture

Retrieve details of a specific capture by its ID.

Rate Limits

  • 300 requests/minute (scope: sustained)
  • 40 requests/second (scope: burst)
Authorizations:
BearerTokenAuthApiKeyBasicAuthApiKeyInAuthorizationHeaderAuth
path Parameters
id
required
string <uuid> (Capture ID)

A UUID string identifying this capture.

query Parameters
fields
string

Comma-separated list of fields to include in the response. If not provided, all available fields are returned.

format
string
Enum: "csv" "json"
omit
string

Comma-separated list of fields to exclude from the response. If not provided, all available fields are returned.

Responses

Response samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "order_id": "93101167-9065-4b9c-b98b-5d789a3ed9fe",
  • "captured_area": {
    },
  • "area_of_interest": {
    },
  • "fulfilling": true,
  • "status": "SCHEDULED",
  • "ground_id": "197878e8-56d8-4151-987b-fa5783651ac5",
  • "item_ids": [
    ],
  • "scene_ids": [
    ],
  • "cloud_cover": 1,
  • "order_name": "string",
  • "order__status": "RECEIVED",
  • "evaluation": "NONE",
  • "delivered_asset_types": [
    ],
  • "created_time": "2019-08-24T14:15:22Z",
  • "updated_time": "2019-08-24T14:15:22Z",
  • "planned_acquisition_time": "2019-08-24T14:15:22Z",
  • "acquired_time": "2019-08-24T14:15:22Z",
  • "published_time": "2019-08-24T14:15:22Z",
  • "status_description": "string",
  • "assessment": "SUCCESS",
  • "assessment_time": "2019-08-24T14:15:22Z",
  • "pl_number": "string",
  • "product": "string",
  • "strip_id": "string",
  • "item_types": [
    ],
  • "satellite_type": "SKYSAT"
}

Bulk Processes

Bulk processes allows you to submit up to 1000 orders in a single request. Upon submission, the orders will be created asynchronously and will become available individually. Orders may also be edited or cancelled in bulk by changing the operation_type of the bulk process.

List Bulk Processes

Retrieve all bulk processes you have access to. This includes all bulk processes created within your organization.

Rate Limits

  • 300 requests/minute (scope: sustained)
  • 40 requests/second (scope: burst)
Authorizations:
BearerTokenAuthApiKeyBasicAuthApiKeyInAuthorizationHeaderAuth
query Parameters
end_time
string <date-time>

Filter by the end time to be equal to the given value

end_time__gt
string <date-time>

Filter by the end time to be greater than the given value

end_time__gte
string <date-time>

Filter by the end time to be greater than or equal to the given value

end_time__lt
string <date-time>

Filter by the end time to be less than the given value

end_time__lte
string <date-time>

Filter by the end time to be less than or equal to the given value

failed_payload_count
integer

Filter by the failed payload count to be equal to the given value

failed_payload_count__gt
integer

Filter by the failed payload count to be greater than the given value

failed_payload_count__gte
integer

Filter by the failed payload count to be greater than or equal to the given value

failed_payload_count__lt
integer

Filter by the failed payload count to be less than the given value

failed_payload_count__lte
integer

Filter by the failed payload count to be less than or equal to the given value

fields
string

Comma-separated list of fields to include in the response. If not provided, all available fields are returned.

limit
integer [ 1 .. 1000 ]

Number of results to return per page.

offset
integer [ 0 .. 30000 ]

The initial index from which to return the results.

omit
string

Comma-separated list of fields to exclude from the response. If not provided, all available fields are returned.

order_payloads__error__isnotnull
boolean

Filter by the order payloads error to not be null/unset

order_payloads__error__isnull
boolean

Filter by the order payloads error to be null/unset

order_payloads__order_id__isnotnull
boolean

Filter by the order payloads order ID to not be null/unset

order_payloads__order_id__isnull
boolean

Filter by the order payloads order ID to be null/unset

ordering
string

Which field to use when ordering the results.

payload_count
integer

Filter by the payload count to be equal to the given value

payload_count__gt
integer

Filter by the payload count to be greater than the given value

payload_count__gte
integer

Filter by the payload count to be greater than or equal to the given value

payload_count__lt
integer

Filter by the payload count to be less than the given value

payload_count__lte
integer

Filter by the payload count to be less than or equal to the given value

start_time
string <date-time>

Filter by the start time to be equal to the given value

start_time__gt
string <date-time>

Filter by the start time to be greater than the given value

start_time__gte
string <date-time>

Filter by the start time to be greater than or equal to the given value

start_time__lt
string <date-time>

Filter by the start time to be less than the given value

start_time__lte
string <date-time>

Filter by the start time to be less than or equal to the given value

status
string
Enum: "COMPLETE" "PENDING" "RUNNING"

Filter by the status to be equal to the given value

  • PENDING - Pending
  • RUNNING - Running
  • COMPLETE - Complete
status__in
Array of strings

Multiple values may be separated by commas.

status__ne
string

Filter by the status to not be equal to the given value

status__notin
Array of strings

Multiple values may be separated by commas.

Responses

Response samples

Content type
application/json
{}

Create Bulk Order

Submit an asynchronous request to bulk-process tasking orders. Orders may be created, edited or cancelled depending on the operation_type.

Rate Limits

  • 300 requests/minute (scope: sustained)
  • 40 requests/second (scope: burst)
Authorizations:
BearerTokenAuthApiKeyBasicAuthApiKeyInAuthorizationHeaderAuth
query Parameters
fields
string

Comma-separated list of fields to include in the response. If not provided, all available fields are returned.

omit
string

Comma-separated list of fields to exclude from the response. If not provided, all available fields are returned.

Request Body schema: application/json
required
required
Array of objects (OrderPayload)
id
string <uuid> (Bulk ID)

Unique identifier of a bulk process

operation_type
string
Enum: "CREATE" "CANCEL" "EDIT"

Operation type of the bulk process

  • CREATE - Create
  • CANCEL - Cancel
  • EDIT - Edit

Responses

Request samples

Content type
application/json
{
  • "order_payloads": [
    ],
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "operation_type": "CREATE"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "operation_type": "CREATE"
}

Retrieve Bulk Order

After submitting a bulk order, this endpoint allows monitoring the status of that bulk request by its ID.

Rate Limits

  • 300 requests/minute (scope: sustained)
  • 40 requests/second (scope: burst)
Authorizations:
BearerTokenAuthApiKeyBasicAuthApiKeyInAuthorizationHeaderAuth
path Parameters
id
required
string <uuid> (Bulk ID)

A UUID string identifying this bulk process.

query Parameters
fields
string

Comma-separated list of fields to include in the response. If not provided, all available fields are returned.

omit
string

Comma-separated list of fields to exclude from the response. If not provided, all available fields are returned.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "start_time": "2019-08-24T14:15:22Z",
  • "end_time": "2019-08-24T14:15:22Z",
  • "operation_type": "CREATE",
  • "payload_count": -2147483648,
  • "status": "PENDING",
  • "processing_payload_count": -2147483648,
  • "failed_payload_count": -2147483648,
  • "successful_payload_count": -2147483648
}

Retrieve Bulk Order Payloads

After submitting a bulk order, this endpoint provides an in-depth view of the tasking orders that were part of the bulk request, including the status of each tasking order.

Rate Limits

  • 300 requests/minute (scope: sustained)
  • 40 requests/second (scope: burst)
Authorizations:
BearerTokenAuthApiKeyBasicAuthApiKeyInAuthorizationHeaderAuth
path Parameters
id
required
string <uuid> (Bulk ID)

A UUID string identifying this bulk process.

query Parameters
fields
string

Comma-separated list of fields to include in the response. If not provided, all available fields are returned.

omit
string

Comma-separated list of fields to exclude from the response. If not provided, all available fields are returned.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "start_time": "2019-08-24T14:15:22Z",
  • "end_time": "2019-08-24T14:15:22Z",
  • "operation_type": "CREATE",
  • "payload_count": -2147483648,
  • "status": "PENDING",
  • "processing_payload_count": -2147483648,
  • "failed_payload_count": -2147483648,
  • "successful_payload_count": -2147483648
}

Order History

The order history provides insights on your orders moving through the stages order process. Whenever an order changes its status, a new history event will be recorded to represent the change.

List Order History

List history events for all orders and captures that relate to the given filters.

Rate Limits

  • 300 requests/minute (scope: sustained)
  • 40 requests/second (scope: burst)
Authorizations:
BearerTokenAuthApiKeyBasicAuthApiKeyInAuthorizationHeaderAuth
query Parameters
created_time
string <date-time>

Filter by the created time to be equal to the given value

created_time__gt
string <date-time>

Filter by the created time to be greater than the given value

created_time__gte
string <date-time>

Filter by the created time to be greater than or equal to the given value

created_time__lt
string <date-time>

Filter by the created time to be less than the given value

created_time__lte
string <date-time>

Filter by the created time to be less than or equal to the given value

event_type
string
Enum: "BULK_CREATED" "BULK_FINISHED" "CAPTURE_DERIVING" "CAPTURE_FAILED" "CAPTURE_L1A_PUBLISHED" "CAPTURE_MANUALLY_ASSESSED" "CAPTURE_NOT_COVERED" "CAPTURE_PROCESSING" "CAPTURE_PUBLISHED" "CAPTURE_REVIEW_UPDATE" "CAPTURE_SCHEDULED" "DELIVERY_TASK_CANCELLED" "DELIVERY_TASK_COMPLETED" "DELIVERY_TASK_EXPIRED" "DELIVERY_TASK_FAILED" "DELIVERY_TASK_STARTED" "EXPRESS_ORDER_IMAGING_WINDOW_CONFIRMATION_TIMEOUT" "EXPRESS_ORDER_MAX_ATTEMPTS_REACHED" "EXPRESS_ORDER_NO_IMAGING_WINDOW_FOUND" "ORDER_CANCELLED" "ORDER_CREATED" "ORDER_EDITED" "ORDER_EXPIRED" "ORDER_EXPIRING_SOON" "ORDER_FAILED" "ORDER_FULFILLED" "ORDER_LOCK_IN_CANCELLATION_FAILED" "ORDER_LOCK_IN_CANCELLATION_REQUESTED" "ORDER_LOCK_IN_CONFIRMED" "ORDER_LOCK_IN_EXCEPTION" "ORDER_LOCK_IN_FAILED" "ORDER_LOCK_IN_FINALIZING" "ORDER_LOCK_IN_REJECTED" "ORDER_MONITORING_PARTIAL_FAILED" "ORDER_PENDING" "ORDER_REJECTED" "ORDER_STARTED" "ORDER_WAITLISTED" "ORDER_WAITLIST_ABANDONED" "ORDER_WAITLIST_EXPIRED"

Filter by the event type to be equal to the given value

  • CAPTURE_MANUALLY_ASSESSED - Capture Manually Assessed
  • CAPTURE_SCHEDULED - Capture Scheduled
  • CAPTURE_PROCESSING - Capture Processing
  • CAPTURE_PUBLISHED - Capture Published
  • CAPTURE_DERIVING - Capture Deriving
  • CAPTURE_L1A_PUBLISHED - Capture L1A Published
  • CAPTURE_FAILED - Capture Failed
  • CAPTURE_NOT_COVERED - Capture Not Covered
  • BULK_CREATED - Bulk Created
  • BULK_FINISHED - Bulk Finished
  • ORDER_CANCELLED - Order Cancelled
  • ORDER_CREATED - Order Created
  • ORDER_FULFILLED - Order Fulfilled
  • ORDER_EDITED - Order Edited
  • ORDER_EXPIRED - Order Expired
  • ORDER_EXPIRING_SOON - Order Expiring Soon
  • ORDER_FAILED - Order Failed
  • ORDER_MONITORING_PARTIAL_FAILED - Order Monitoring Partial Failed
  • ORDER_REJECTED - Order Rejected
  • ORDER_LOCK_IN_CONFIRMED - Order Lock-In Confirmed
  • ORDER_LOCK_IN_FAILED - Order Lock-In Failed
  • ORDER_LOCK_IN_EXCEPTION - Order Lock-In Exception
  • ORDER_LOCK_IN_REJECTED - Order Lock-In Rejected
  • ORDER_LOCK_IN_FINALIZING - Order Lock-In Finalizing
  • ORDER_LOCK_IN_CANCELLATION_FAILED - Order Lock-In Cancellation Failed
  • ORDER_LOCK_IN_CANCELLATION_REQUESTED - Order Lock-In Cancellation Requested
  • ORDER_PENDING - Order Pending
  • ORDER_STARTED - Order Started
  • ORDER_WAITLISTED - Order Waitlisted
  • ORDER_WAITLIST_EXPIRED - Order Waitlist Expired
  • ORDER_WAITLIST_ABANDONED - Order Waitlist Abandoned
  • EXPRESS_ORDER_NO_IMAGING_WINDOW_FOUND - Express Order No Imaging Window Found
  • EXPRESS_ORDER_MAX_ATTEMPTS_REACHED - Express Order Max Attempts Reached
  • EXPRESS_ORDER_IMAGING_WINDOW_CONFIRMATION_TIMEOUT - Express Order Imaging Window Confirmation Timeout
  • CAPTURE_REVIEW_UPDATE - Capture Review Update
  • DELIVERY_TASK_STARTED - The delivery process has started.
  • DELIVERY_TASK_COMPLETED - The delivery process has been completed.
  • DELIVERY_TASK_FAILED - The delivery process has failed.
  • DELIVERY_TASK_CANCELLED - The delivery process has been cancelled.
  • DELIVERY_TASK_EXPIRED - The delivery has expired.
event_type__in
Array of strings

Multiple values may be separated by commas.

event_type__ne
string

Filter by the event type to not be equal to the given value

event_type__notin
Array of strings

Multiple values may be separated by commas.

fields
string

Comma-separated list of fields to include in the response. If not provided, all available fields are returned.

limit
integer [ 1 .. 1000 ]

Number of results to return per page.

offset
integer [ 0 .. 30000 ]

The initial index from which to return the results.

omit
string

Comma-separated list of fields to exclude from the response. If not provided, all available fields are returned.

order_id
string <uuid>

Filter by the order ID to be equal to the given value

ordering
string

Which field to use when ordering the results.

search
string

A search term.

target_id
string <uuid>

Filter by the target ID to be equal to the given value

target_id__in
Array of strings <uuid> [ items <uuid > ]

Multiple values may be separated by commas.

target_id__ne
string <uuid>

Filter by the target ID to not be equal to the given value

target_id__notin
Array of strings <uuid> [ items <uuid > ]

Multiple values may be separated by commas.

target_type
string

Filter by the target type to be equal to the given value

Responses

Response samples

Content type
application/json
{}

Retrieve Order History

Return a specific history event related to the given ID.

Rate Limits

  • 300 requests/minute (scope: sustained)
  • 40 requests/second (scope: burst)
Authorizations:
BearerTokenAuthApiKeyBasicAuthApiKeyInAuthorizationHeaderAuth
path Parameters
id
required
string <uuid>

A UUID string identifying this history event.

query Parameters
fields
string

Comma-separated list of fields to include in the response. If not provided, all available fields are returned.

omit
string

Comma-separated list of fields to exclude from the response. If not provided, all available fields are returned.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "target_type": "string",
  • "user_email": "string",
  • "message": "string",
  • "data": null,
  • "target_id": "d3bcdc92-4191-401b-ad0c-42056c6efab9",
  • "event_type": "CAPTURE_MANUALLY_ASSESSED",
  • "created_time": "2019-08-24T14:15:22Z",
  • "order_id": "93101167-9065-4b9c-b98b-5d789a3ed9fe",
  • "org_id": -2147483648
}

Preferences

Preferences allow you to modify the behavior of the Tasking API.

Retrieve Tasking Preferences

Retrieve the tasking preferences for the current user.

Rate Limits

  • 300 requests/minute (scope: sustained)
  • 40 requests/second (scope: burst)
Authorizations:
BearerTokenAuthApiKeyBasicAuthApiKeyInAuthorizationHeaderAuth
query Parameters
fields
string

Comma-separated list of fields to include in the response. If not provided, all available fields are returned.

omit
string

Comma-separated list of fields to exclude from the response. If not provided, all available fields are returned.

Responses

Response samples

Content type
application/json
{
  • "delivery_option": "CLOUD_DESTINATION"
}

Update Tasking Preferences

Update the tasking preferences for the current user.

Rate Limits

  • 300 requests/minute (scope: sustained)
  • 40 requests/second (scope: burst)
Authorizations:
BearerTokenAuthApiKeyBasicAuthApiKeyInAuthorizationHeaderAuth
query Parameters
fields
string

Comma-separated list of fields to include in the response. If not provided, all available fields are returned.

omit
string

Comma-separated list of fields to exclude from the response. If not provided, all available fields are returned.

Request Body schema: application/json
required
delivery_option
required
string
Enum: "CLOUD_DESTINATION" "NONE"

How the user's future orders are delivered. Possible values are:

  • CLOUD_DESTINATION: Captures are pushed to a customer-owned cloud destination configured on the order

  • DIRECT_DOWNLOAD: Captures are activated for on-demand download in the Tasking Dashboard

  • NONE: No automated delivery is initiated for the user's orders

  • CLOUD_DESTINATION - Cloud destination

  • NONE - None

Responses

Request samples

Content type
application/json
{
  • "delivery_option": "CLOUD_DESTINATION"
}

Response samples

Content type
application/json
{
  • "delivery_option": "CLOUD_DESTINATION"
}

List Notification Preferences

List the email notification preferences for the current user.

Rate Limits

  • 300 requests/minute (scope: sustained)
  • 40 requests/second (scope: burst)
Authorizations:
BearerTokenAuthApiKeyBasicAuthApiKeyInAuthorizationHeaderAuth
query Parameters
fields
string

Comma-separated list of fields to include in the response. If not provided, all available fields are returned.

omit
string

Comma-separated list of fields to exclude from the response. If not provided, all available fields are returned.

ordering
string

Which field to use when ordering the results.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Set Notification Preferences

Set the email notification preferences for the current user.

Rate Limits

  • 300 requests/minute (scope: sustained)
  • 40 requests/second (scope: burst)
Authorizations:
BearerTokenAuthApiKeyBasicAuthApiKeyInAuthorizationHeaderAuth
query Parameters
fields
string

Comma-separated list of fields to include in the response. If not provided, all available fields are returned.

omit
string

Comma-separated list of fields to exclude from the response. If not provided, all available fields are returned.

Request Body schema: application/json
required
enabled_emails
required
Array of strings
Items Enum: "ORDER_FULFILLED" "ORDER_EXPIRED" "ORDER_EXPIRING_SOON" "ORDER_CREATED" "ORDER_REJECTED" "CAPTURE_FAILED" "CAPTURE_PUBLISHED" "CAPTURE_DERIVING" "CAPTURE_L1A_PUBLISHED" "CAPTURE_SCHEDULED" "ORDER_LOCK_IN_CONFIRMED" "ORDER_LOCK_IN_CANCELLATION_FAILED" "ORDER_LOCK_IN_FAILED" "ORDER_LOCK_IN_EXCEPTION" "ORDER_LOCK_IN_REJECTED" "BULK_FINISHED" "CAPTURE_REVIEW_UPDATE" "ORDER_FAILED" "ORDER_WAITLISTED" "ORDER_WAITLIST_EXPIRED" "ORDER_WAITLIST_ABANDONED" "DELIVERY_TASK_STARTED" "DELIVERY_TASK_COMPLETED" "DELIVERY_TASK_FAILED" "DELIVERY_TASK_EXPIRED" "DELIVERY_TASK_CANCELLED"

Events for which email notifications are enabled. Possible values are listed under event_type on Retrieve Order History.

Responses

Request samples

Content type
application/json
{
  • "enabled_emails": [
    ]
}

Response samples

Content type
application/json
{
  • "enabled_emails": [
    ]
}

Pricing

Retrieve pricing information for orders placed via Tasking API.

Retrieve Order Pricing Information

Retrieve detailed pricing information for a specific tasking order by its ID.

Rate Limits

  • 300 requests/minute (scope: sustained)
  • 40 requests/second (scope: burst)
Authorizations:
BearerTokenAuthApiKeyBasicAuthApiKeyInAuthorizationHeaderAuth
path Parameters
id
required
string <uuid> (Order ID)

A UUID string identifying this order.

query Parameters
fields
string

Comma-separated list of fields to include in the response. If not provided, all available fields are returned.

format
string
Enum: "csv" "json"
omit
string

Comma-separated list of fields to exclude from the response. If not provided, all available fields are returned.

Responses

Response samples

Content type
{
  • "order_id": "93101167-9065-4b9c-b98b-5d789a3ed9fe",
  • "units": "SQKM",
  • "estimated_quota_cost": 0.1,
  • "determined_by": "pricing_model",
  • "pricing_model": {
    },
  • "replaced_orders": [
    ]
}

Retrieve Pricing Preview

Retrieve a preview pricing details based on the given order parameters.

Rate Limits

  • 300 requests/minute (scope: sustained)
  • 40 requests/second (scope: burst)
Authorizations:
BearerTokenAuthApiKeyBasicAuthApiKeyInAuthorizationHeaderAuth
Request Body schema: application/json
imaging_window
string or null <uuid> (Imaging Window ID)

Imaging window ID to create an order for. Required to place an Assured Tasking order. Cannot be used for other scheduling types.

object or object or object or object or object or object or object

GeoJSON representation of a Point, a two-point LineString or a Polygon. Point and LineString inputs will be will be expanded into a circular or rectangle Polygon respectively to serve as the area of interest for this order. The expansion size defaults to 5 km for SkySat imagery but can vary based on product parameters. Required for all orders except Assured Tasking orders.

pl_number
string or null (Contract number)

Contract number of the order. Required if you have access to multiple products or contracts.

product
string or null (Product name)

Name of the product of the order. Required if you have access to multiple products or contracts.

start_time
string <date-time>

Time at which to start acquiring imagery for the order. Defaults to the time of order submission.

end_time
string or null <date-time>

Latest time by which imagery will be acquired for the order. Defaults to the contract's default order duration (from the time of order submission).

n_stereo_pov
integer or null (Number of stereo captures)
Enum: 2 3 null

Number of captures to be taken for Stereo Tasking orders. The convergence half angle is 15° for 2 stereo captures, and 27.5° for 3 stereo captures.

  • 2 - 2
  • 3 - 3
exclusivity_days
integer or null
Enum: 0 7 30 null

Number of days for the captured imagery to be held exclusive for this order

  • 0 - 0
  • 7 - 7
  • 30 - 30
scheduling_type
string
Enum: "FLEXIBLE" "LOCK_IN" "MONITORING" "EXPRESS" "ASSURED" "ARCHIVE"

The way the order will be scheduled for capturing imagery. Must match the product.

  • FLEXIBLE - Flexible
  • LOCK_IN - Lock-In
  • MONITORING - Monitoring
  • EXPRESS - Express
  • ASSURED - Assured
  • ARCHIVE - Archive

Responses

Request samples

Content type
application/json
{
  • "imaging_window": "a1da9ea0-27e5-48b8-87e5-6fbff34aa067",
  • "geometry": {
    },
  • "pl_number": "string",
  • "product": "string",
  • "start_time": "2019-08-24T14:15:22Z",
  • "end_time": "2019-08-24T14:15:22Z",
  • "n_stereo_pov": 2,
  • "exclusivity_days": 0,
  • "scheduling_type": "FLEXIBLE"
}

Response samples

Content type
application/json
Example
{
  • "order_id": "93101167-9065-4b9c-b98b-5d789a3ed9fe",
  • "units": "SQKM",
  • "estimated_quota_cost": 0.1,
  • "determined_by": "pricing_model",
  • "pricing_model": {
    },
  • "replaced_orders": [
    ]
}
Last updated on