1. Welcome to Planet Support
  2. Planet API's
  3. Orders API

How can I get a list of orders?

Avatar
Paulina Brozek

You can get a list of all orders created within the last three months with the following request:

GET https://api.planet.com/compute/ops/orders/v2/

Query Parameters

The List Orders endpoint supports filtering on order_state with the following query parameters appended to the request:

  • ?order_state=<queued|running|success|partial|failed|cancelled>

Orders created more than three months ago will not be available through the Orders API. You can reach out to Contact Support for inquiries about orders placed more than three months ago.

Example Request

GET https://api.planet.com/compute/ops/orders/v2/?order_state=queued

Example Response

The List Orders response will return a paged list of all your queued orders placed in the last three months with an order schema that is consistent with the Get Order response.

Was this article helpful?
0 out of 0 found this helpful

Comments

1 comment
Date Votes
  • Avatar
    Andrea Melchiorre

    This does not seem to work using requests in Python, I always get only 20 orders, and always the same orders regardless of the state requested....

     

    def list_orders(api_key, state=None):
        '''state can be: queued|running|success|partial|failed|cancelled'''
        # Setup the session
        session = requests.Session()
        if state is not None:
            orders_url = orders_url+"/?order_state="+state
        # Authenticate
        session.auth = (api_key, "")
        response = requests.get(orders_url, auth=session.auth)
        orders = response.json()['orders']
        return orders
    0

Please sign in to leave a comment.

Articles in this section

See more