Creating an order for multiple items.

Import the DataAPI and OrdersAPI wrapper.

[1]:

from cast_planet import DataAPI, OrdersApi

[2]:

data_api = DataAPI(api_key='your-api-key-here')
orders_api = OrdersApi(api_key='your-api-key-here')

Searching for items.

For this example, we want to get an image for each month, over the UA Farm. To do this, we will modify some the same filters used in the basic example.

[3]:

from cast_planet.data.filters.field import GeometryFilter, DateRangeFilter
from cast_planet.data.filters.logical import AndFilter

Since the area of interest will not be altered, we can create a single filter.

[4]:

point_of_interest = {
    "type": "Point",
    "coordinates": [-94.16987610350382, 36.09799882432394]
}
aoi_filter = GeometryFilter(field_name='geometry', config=point_of_interest)

Now, we can create a loop to iterate over each month, create a new date filter and perform the search.

[5]:

full_search_results = []
for i in range(1,13):
    # Create the date filter
    start_time = f'2023-{i:02}-15T00:00'
    end_time = f'2023-{i:02}-15T23:59'
    date_filter = DateRangeFilter(field_name='acquired', config={'gte': start_time, 'lte': end_time})

    # Combine the date filter with a logic filter
    search_filter = AndFilter(config=[aoi_filter,date_filter])

    # Perform the search.
    response = data_api.quick_search(item_types=['PSScene'], search_filter=search_filter)

    # Aggregate the search results to a single list.
    full_search_results.extend(response.features)

# Display the final result count
len(full_search_results)

[5]:

Create an order to request multiple assets at once.

We can create an order by sending a list of products that we want to acquire, along with the item type and product bundle needed.

To learn more about creating an order see the Planet Orders API documentation. To learn more about the CreateOrder data model, please see the package documentation.

[6]:

from cast_planet.orders.models.order_new import CreateOrder

order_information = {
    "name" :f"Farm Monthly - 2023",
    "source_type": 'scenes',
    "order_type": "partial",
    "products": [
        {
            "item_ids": [x.id for x in full_search_results],
            "item_type": "PSScene",
            "product_bundle": "analytic_udm2",
        }
    ],
    "notifications": {
        'email': True
    }
}
order = orders_api.create_order(CreateOrder(**order_information))

View order status and download results.

Once your order is created, you can see it’s updated status by using the get_order_details_by_id method, or you can view your order in the My Orders section of your planet account dashboard.

[7]:

order = orders_api.get_order_details_by_id('5bfa8287-f605-439e-8c55-523a8450f739')

Once your order is completed, you can download all the via the api with the download_order_results method. This will download ALL files produced by the order. If you find that you only want to download some files, or you would like to preview the items beforehand. You may view the order by clicking on order in the My Orders section of the dashboard, or going to https://www.planet.com/account/#/orders/your-order-id-here

[8]:

orders_api.download_order_results('5bfa8287-f605-439e-8c55-523a8450f739', 'order-example')

order-example/5bfa8287-f605-439e-8c55-523a8450f739/PSScene/20231215_161357_05_2415_3B_udm2.tif: 100%|##########| 6.25M/6.25M [00:00<00:00, 24.1MB/s]
order-example/5bfa8287-f605-439e-8c55-523a8450f739/PSScene/20231215_161357_05_2415_3B_AnalyticMS_metadata.xml: 100%|##########| 10.3k/10.3k [00:00<00:00, 10.7MB/s]
order-example/5bfa8287-f605-439e-8c55-523a8450f739/PSScene/20231215_161357_05_2415_3B_AnalyticMS.tif: 100%|##########| 494M/494M [00:14<00:00, 35.1MB/s]
order-example/5bfa8287-f605-439e-8c55-523a8450f739/PSScene/20231215_161357_05_2415_metadata.json: 100%|##########| 961/961 [00:00<00:00, 10.5MB/s]
order-example/5bfa8287-f605-439e-8c55-523a8450f739/PSScene/20231015_160905_18_24a9_3B_udm2.tif: 100%|##########| 5.77M/5.77M [00:00<00:00, 24.4MB/s]
order-example/5bfa8287-f605-439e-8c55-523a8450f739/PSScene/20231015_160905_18_24a9_3B_AnalyticMS_metadata.xml: 100%|##########| 10.3k/10.3k [00:00<00:00, 22.7MB/s]
order-example/5bfa8287-f605-439e-8c55-523a8450f739/PSScene/20231015_160905_18_24a9_3B_AnalyticMS.tif: 100%|##########| 586M/586M [00:16<00:00, 34.5MB/s]
order-example/5bfa8287-f605-439e-8c55-523a8450f739/PSScene/20231015_160905_18_24a9_metadata.json: 100%|##########| 969/969 [00:00<00:00, 3.12MB/s]
order-example/5bfa8287-f605-439e-8c55-523a8450f739/PSScene/20230615_164415_25_248e_3B_udm2.tif: 100%|##########| 4.29M/4.29M [00:00<00:00, 36.4MB/s]
order-example/5bfa8287-f605-439e-8c55-523a8450f739/PSScene/20230615_164415_25_248e_3B_AnalyticMS_metadata.xml: 100%|##########| 10.3k/10.3k [00:00<00:00, 10.3MB/s]
order-example/5bfa8287-f605-439e-8c55-523a8450f739/PSScene/20230615_164415_25_248e_3B_AnalyticMS.tif: 100%|##########| 584M/584M [00:16<00:00, 34.8MB/s]
order-example/5bfa8287-f605-439e-8c55-523a8450f739/PSScene/20230615_164415_25_248e_metadata.json: 100%|##########| 969/969 [00:00<00:00, 3.23MB/s]
order-example/5bfa8287-f605-439e-8c55-523a8450f739/PSScene/20230815_160845_66_24a7_3B_udm2.tif: 100%|##########| 4.23M/4.23M [00:00<00:00, 33.8MB/s]
order-example/5bfa8287-f605-439e-8c55-523a8450f739/PSScene/20230815_160845_66_24a7_3B_AnalyticMS_metadata.xml: 100%|##########| 10.3k/10.3k [00:00<00:00, 11.8MB/s]
order-example/5bfa8287-f605-439e-8c55-523a8450f739/PSScene/20230815_160845_66_24a7_3B_AnalyticMS.tif: 100%|##########| 612M/612M [00:17<00:00, 34.4MB/s]
order-example/5bfa8287-f605-439e-8c55-523a8450f739/PSScene/20230815_160845_66_24a7_metadata.json: 100%|##########| 970/970 [00:00<00:00, 10.7MB/s]
order-example/5bfa8287-f605-439e-8c55-523a8450f739/PSScene/20230115_160153_73_241d_3B_udm2.tif: 100%|##########| 8.20M/8.20M [00:00<00:00, 37.4MB/s]
order-example/5bfa8287-f605-439e-8c55-523a8450f739/PSScene/20230115_160153_73_241d_3B_AnalyticMS_metadata.xml: 100%|##########| 10.3k/10.3k [00:00<00:00, 8.15MB/s]
order-example/5bfa8287-f605-439e-8c55-523a8450f739/PSScene/20230115_160153_73_241d_3B_AnalyticMS.tif: 100%|##########| 564M/564M [00:16<00:00, 35.2MB/s]
order-example/5bfa8287-f605-439e-8c55-523a8450f739/PSScene/20230115_160153_73_241d_metadata.json: 100%|##########| 975/975 [00:00<00:00, 11.6MB/s]
order-example/5bfa8287-f605-439e-8c55-523a8450f739/PSScene/20230515_160646_65_24b9_3B_udm2.tif: 100%|##########| 10.9M/10.9M [00:00<00:00, 36.1MB/s]
order-example/5bfa8287-f605-439e-8c55-523a8450f739/PSScene/20230515_160646_65_24b9_3B_AnalyticMS_metadata.xml: 100%|##########| 10.3k/10.3k [00:00<00:00, 26.9MB/s]
order-example/5bfa8287-f605-439e-8c55-523a8450f739/PSScene/20230515_160646_65_24b9_3B_AnalyticMS.tif: 100%|##########| 667M/667M [00:19<00:00, 34.4MB/s]
order-example/5bfa8287-f605-439e-8c55-523a8450f739/PSScene/20230515_160646_65_24b9_metadata.json: 100%|##########| 971/971 [00:00<00:00, 4.08MB/s]
order-example/5bfa8287-f605-439e-8c55-523a8450f739/PSScene/20230615_160747_52_24ab_3B_udm2.tif: 100%|##########| 8.70M/8.70M [00:00<00:00, 38.5MB/s]
order-example/5bfa8287-f605-439e-8c55-523a8450f739/PSScene/20230615_160747_52_24ab_3B_AnalyticMS_metadata.xml: 100%|##########| 10.3k/10.3k [00:00<00:00, 12.8MB/s]
order-example/5bfa8287-f605-439e-8c55-523a8450f739/PSScene/20230615_160747_52_24ab_3B_AnalyticMS.tif: 100%|##########| 666M/666M [00:19<00:00, 33.6MB/s]
order-example/5bfa8287-f605-439e-8c55-523a8450f739/PSScene/20230615_160747_52_24ab_metadata.json: 100%|##########| 973/973 [00:00<00:00, 3.58MB/s]
order-example/5bfa8287-f605-439e-8c55-523a8450f739/PSScene/20230615_160749_84_24ab_3B_udm2.tif: 100%|##########| 7.28M/7.28M [00:00<00:00, 34.8MB/s]
order-example/5bfa8287-f605-439e-8c55-523a8450f739/PSScene/20230615_160749_84_24ab_3B_AnalyticMS_metadata.xml: 100%|##########| 10.3k/10.3k [00:00<00:00, 7.93MB/s]
order-example/5bfa8287-f605-439e-8c55-523a8450f739/PSScene/20230615_160749_84_24ab_3B_AnalyticMS.tif: 100%|##########| 658M/658M [00:18<00:00, 34.7MB/s]
order-example/5bfa8287-f605-439e-8c55-523a8450f739/PSScene/20230615_160749_84_24ab_metadata.json: 100%|##########| 972/972 [00:00<00:00, 8.15MB/s]
order-example/5bfa8287-f605-439e-8c55-523a8450f739/PSScene/20230315_160524_30_241f_3B_udm2.tif: 100%|##########| 8.40M/8.40M [00:00<00:00, 35.5MB/s]
order-example/5bfa8287-f605-439e-8c55-523a8450f739/PSScene/20230315_160524_30_241f_3B_AnalyticMS_metadata.xml: 100%|##########| 10.3k/10.3k [00:00<00:00, 12.5MB/s]
order-example/5bfa8287-f605-439e-8c55-523a8450f739/PSScene/20230315_160524_30_241f_3B_AnalyticMS.tif: 100%|##########| 546M/546M [00:15<00:00, 35.1MB/s]
order-example/5bfa8287-f605-439e-8c55-523a8450f739/PSScene/20230315_160524_30_241f_metadata.json: 100%|##########| 972/972 [00:00<00:00, 4.12MB/s]
order-example/5bfa8287-f605-439e-8c55-523a8450f739/PSScene/20230715_160842_98_24b4_3B_udm2.tif: 100%|##########| 5.34M/5.34M [00:00<00:00, 32.0MB/s]
order-example/5bfa8287-f605-439e-8c55-523a8450f739/PSScene/20230715_160842_98_24b4_3B_AnalyticMS_metadata.xml: 100%|##########| 10.3k/10.3k [00:00<00:00, 3.17MB/s]
order-example/5bfa8287-f605-439e-8c55-523a8450f739/PSScene/20230715_160842_98_24b4_3B_AnalyticMS.tif: 100%|##########| 646M/646M [00:18<00:00, 34.5MB/s]
order-example/5bfa8287-f605-439e-8c55-523a8450f739/PSScene/20230715_160842_98_24b4_metadata.json: 100%|##########| 968/968 [00:00<00:00, 8.71MB/s]
order-example/5bfa8287-f605-439e-8c55-523a8450f739/PSScene/20230915_161141_08_24bc_3B_udm2.tif: 100%|##########| 2.42M/2.42M [00:00<00:00, 38.8MB/s]
order-example/5bfa8287-f605-439e-8c55-523a8450f739/PSScene/20230915_161141_08_24bc_3B_AnalyticMS_metadata.xml: 100%|##########| 10.3k/10.3k [00:00<00:00, 8.76MB/s]
order-example/5bfa8287-f605-439e-8c55-523a8450f739/PSScene/20230915_161141_08_24bc_3B_AnalyticMS.tif: 100%|##########| 615M/615M [00:17<00:00, 34.2MB/s]
order-example/5bfa8287-f605-439e-8c55-523a8450f739/PSScene/20230915_161141_08_24bc_metadata.json: 100%|##########| 971/971 [00:00<00:00, 10.2MB/s]
order-example/5bfa8287-f605-439e-8c55-523a8450f739/PSScene/20230115_160156_05_241d_3B_udm2.tif: 100%|##########| 8.28M/8.28M [00:00<00:00, 38.1MB/s]
order-example/5bfa8287-f605-439e-8c55-523a8450f739/PSScene/20230115_160156_05_241d_3B_AnalyticMS_metadata.xml: 100%|##########| 10.3k/10.3k [00:00<00:00, 22.5MB/s]
order-example/5bfa8287-f605-439e-8c55-523a8450f739/PSScene/20230115_160156_05_241d_3B_AnalyticMS.tif: 100%|##########| 557M/557M [00:16<00:00, 34.6MB/s]
order-example/5bfa8287-f605-439e-8c55-523a8450f739/PSScene/20230115_160156_05_241d_metadata.json: 100%|##########| 970/970 [00:00<00:00, 4.01MB/s]
order-example/5bfa8287-f605-439e-8c55-523a8450f739/manifest.json: 100%|##########| 18.1k/18.1k [00:00<00:00, 19.7MB/s]

[8]:

['order-example/5bfa8287-f605-439e-8c55-523a8450f739/PSScene/20231215_161357_05_2415_3B_udm2.tif',
 'order-example/5bfa8287-f605-439e-8c55-523a8450f739/PSScene/20231215_161357_05_2415_3B_AnalyticMS_metadata.xml',
 'order-example/5bfa8287-f605-439e-8c55-523a8450f739/PSScene/20231215_161357_05_2415_3B_AnalyticMS.tif',
 'order-example/5bfa8287-f605-439e-8c55-523a8450f739/PSScene/20231215_161357_05_2415_metadata.json',
 'order-example/5bfa8287-f605-439e-8c55-523a8450f739/PSScene/20231015_160905_18_24a9_3B_udm2.tif',
 'order-example/5bfa8287-f605-439e-8c55-523a8450f739/PSScene/20231015_160905_18_24a9_3B_AnalyticMS_metadata.xml',
 'order-example/5bfa8287-f605-439e-8c55-523a8450f739/PSScene/20231015_160905_18_24a9_3B_AnalyticMS.tif',
 'order-example/5bfa8287-f605-439e-8c55-523a8450f739/PSScene/20231015_160905_18_24a9_metadata.json',
 'order-example/5bfa8287-f605-439e-8c55-523a8450f739/PSScene/20230615_164415_25_248e_3B_udm2.tif',
 'order-example/5bfa8287-f605-439e-8c55-523a8450f739/PSScene/20230615_164415_25_248e_3B_AnalyticMS_metadata.xml',
 'order-example/5bfa8287-f605-439e-8c55-523a8450f739/PSScene/20230615_164415_25_248e_3B_AnalyticMS.tif',
 'order-example/5bfa8287-f605-439e-8c55-523a8450f739/PSScene/20230615_164415_25_248e_metadata.json',
 'order-example/5bfa8287-f605-439e-8c55-523a8450f739/PSScene/20230815_160845_66_24a7_3B_udm2.tif',
 'order-example/5bfa8287-f605-439e-8c55-523a8450f739/PSScene/20230815_160845_66_24a7_3B_AnalyticMS_metadata.xml',
 'order-example/5bfa8287-f605-439e-8c55-523a8450f739/PSScene/20230815_160845_66_24a7_3B_AnalyticMS.tif',
 'order-example/5bfa8287-f605-439e-8c55-523a8450f739/PSScene/20230815_160845_66_24a7_metadata.json',
 'order-example/5bfa8287-f605-439e-8c55-523a8450f739/PSScene/20230115_160153_73_241d_3B_udm2.tif',
 'order-example/5bfa8287-f605-439e-8c55-523a8450f739/PSScene/20230115_160153_73_241d_3B_AnalyticMS_metadata.xml',
 'order-example/5bfa8287-f605-439e-8c55-523a8450f739/PSScene/20230115_160153_73_241d_3B_AnalyticMS.tif',
 'order-example/5bfa8287-f605-439e-8c55-523a8450f739/PSScene/20230115_160153_73_241d_metadata.json',
 'order-example/5bfa8287-f605-439e-8c55-523a8450f739/PSScene/20230515_160646_65_24b9_3B_udm2.tif',
 'order-example/5bfa8287-f605-439e-8c55-523a8450f739/PSScene/20230515_160646_65_24b9_3B_AnalyticMS_metadata.xml',
 'order-example/5bfa8287-f605-439e-8c55-523a8450f739/PSScene/20230515_160646_65_24b9_3B_AnalyticMS.tif',
 'order-example/5bfa8287-f605-439e-8c55-523a8450f739/PSScene/20230515_160646_65_24b9_metadata.json',
 'order-example/5bfa8287-f605-439e-8c55-523a8450f739/PSScene/20230615_160747_52_24ab_3B_udm2.tif',
 'order-example/5bfa8287-f605-439e-8c55-523a8450f739/PSScene/20230615_160747_52_24ab_3B_AnalyticMS_metadata.xml',
 'order-example/5bfa8287-f605-439e-8c55-523a8450f739/PSScene/20230615_160747_52_24ab_3B_AnalyticMS.tif',
 'order-example/5bfa8287-f605-439e-8c55-523a8450f739/PSScene/20230615_160747_52_24ab_metadata.json',
 'order-example/5bfa8287-f605-439e-8c55-523a8450f739/PSScene/20230615_160749_84_24ab_3B_udm2.tif',
 'order-example/5bfa8287-f605-439e-8c55-523a8450f739/PSScene/20230615_160749_84_24ab_3B_AnalyticMS_metadata.xml',
 'order-example/5bfa8287-f605-439e-8c55-523a8450f739/PSScene/20230615_160749_84_24ab_3B_AnalyticMS.tif',
 'order-example/5bfa8287-f605-439e-8c55-523a8450f739/PSScene/20230615_160749_84_24ab_metadata.json',
 'order-example/5bfa8287-f605-439e-8c55-523a8450f739/PSScene/20230315_160524_30_241f_3B_udm2.tif',
 'order-example/5bfa8287-f605-439e-8c55-523a8450f739/PSScene/20230315_160524_30_241f_3B_AnalyticMS_metadata.xml',
 'order-example/5bfa8287-f605-439e-8c55-523a8450f739/PSScene/20230315_160524_30_241f_3B_AnalyticMS.tif',
 'order-example/5bfa8287-f605-439e-8c55-523a8450f739/PSScene/20230315_160524_30_241f_metadata.json',
 'order-example/5bfa8287-f605-439e-8c55-523a8450f739/PSScene/20230715_160842_98_24b4_3B_udm2.tif',
 'order-example/5bfa8287-f605-439e-8c55-523a8450f739/PSScene/20230715_160842_98_24b4_3B_AnalyticMS_metadata.xml',
 'order-example/5bfa8287-f605-439e-8c55-523a8450f739/PSScene/20230715_160842_98_24b4_3B_AnalyticMS.tif',
 'order-example/5bfa8287-f605-439e-8c55-523a8450f739/PSScene/20230715_160842_98_24b4_metadata.json',
 'order-example/5bfa8287-f605-439e-8c55-523a8450f739/PSScene/20230915_161141_08_24bc_3B_udm2.tif',
 'order-example/5bfa8287-f605-439e-8c55-523a8450f739/PSScene/20230915_161141_08_24bc_3B_AnalyticMS_metadata.xml',
 'order-example/5bfa8287-f605-439e-8c55-523a8450f739/PSScene/20230915_161141_08_24bc_3B_AnalyticMS.tif',
 'order-example/5bfa8287-f605-439e-8c55-523a8450f739/PSScene/20230915_161141_08_24bc_metadata.json',
 'order-example/5bfa8287-f605-439e-8c55-523a8450f739/PSScene/20230115_160156_05_241d_3B_udm2.tif',
 'order-example/5bfa8287-f605-439e-8c55-523a8450f739/PSScene/20230115_160156_05_241d_3B_AnalyticMS_metadata.xml',
 'order-example/5bfa8287-f605-439e-8c55-523a8450f739/PSScene/20230115_160156_05_241d_3B_AnalyticMS.tif',
 'order-example/5bfa8287-f605-439e-8c55-523a8450f739/PSScene/20230115_160156_05_241d_metadata.json',
 'order-example/5bfa8287-f605-439e-8c55-523a8450f739/manifest.json']