resource-facade

Measure WHERE cloud and shadow sit in each candidate scene, and how much of the AOI each one sees clearly. Buys nothing.

Changed on
post/v1/catalog/clear_coverage/analyze

Request

  • Base URL: https://api.geopera.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.geopera.com/v1/catalog/clear_coverage/analyze
  • Auth: HTTP bearer

Headers

x-api-keystring nullable

Request body

aoiobject required

GeoJSON Polygon of the area of interest

target_coveragenumber

Stop once this fraction of the AOI is covered by clear ground.

max_span_daysinteger

Hard limit on the date range of a composite. A stack spanning months is not a single-date image; sun angle, shadow length and vegetation all differ. Set 0 to forbid compositing entirely.

max_scenesinteger
target_datestring nullable

ISO date to prefer captures near, e.g. 2026-03-15

date_prioritystring

How hard to pull toward target_date. 'off' ignores it; 'balanced' lets it break ties and order a series without buying a worse capture; 'strict' outweighs even a billing step, for work where the date matters more than the price.

max_off_nadir_degnumber nullable
min_sun_elevation_degnumber nullable
vendorsstring[] nullable

e.g. ["CGSTL"] to order Jilin only

min_marginal_gainnumber

Smallest share of the AOI a capture must add to be worth taking, when taking it does NOT push the order into a higher billing multiplier.

allow_billing_stepboolean

Whether a capture may push the order into a higher billing multiplier at all. False caps the order at its current multiplier.

objectivestring
billing_step_min_gainnumber

How much a capture must add before it is allowed to cross a billing threshold. Guards against buying 2% more ground for twice the price.

Response

Successful Response

analysedinteger required
failedinteger required

Changes