sdk.order.list()

elements.sdk.api.order

List orders.

List orders filtered by data source, state, or computation IDs.

Parameters

  • data_source_ids (List[str]) - List of data source IDs to filter by
  • [Optional] states (List[str]) - List of order states to filter by (e.g., "PENDING", "COMPLETED")
  • [Optional] analysis_computation_ids (List[str]) - Filter by analysis computation IDs
  • [Optional] algorithm_computation_ids (List[str]) - Filter by algorithm computation IDs

Returns

List[Order] - List of matching orders

Example(s)

# List all orders for a data source
orders = await sdk.order.list(
    data_source_ids=["planet-imagery"]
)

# List pending orders only
orders = await sdk.order.list(
    data_source_ids=["planet-imagery"],
    states=["PENDING"]
)

# List orders associated with a computation
orders = await sdk.order.list(
    data_source_ids=["planet-imagery"],
    algorithm_computation_ids=["computation-uuid"]
)

# Output (List[Order])
[
    id: "order-uuid-1"
    state: PENDING
    ,
    id: "order-uuid-2"
    state: COMPLETED
]