Users can search for available data using the find-deliverables endpoint in ICEYE's Solutions Suite. This endpoint allows you to query based on date, area of interest, or peril and returns a list of available deliverables matching the query parameters. For an exhaustive list of parameters, please refer to the API Specification. The response contains the deliverables metadata as well as download links. The deliverables listed in the response are also controlled by account permissions.
Parameters: Date
Filters the results to those published within the specified time window. Both published_after and published_before are optional and accept ISO-formatted timestamps. Timestamps with fractional seconds will return an error. In other words, 2024-01-01T00:00:00Z and 2024-01-01T00:00:00.000Z are valid but 2024-01-01T00:00:00.001Z is not. The available data catalog starts in April 2024.
Parameters: Area of Interest
Filters the results to those that intersect the specified area of interest. The area of interest should be provided in the request body in Polygon/MultiPolygon GeoJSON geometry. Not specifying an area of interest will return results globally.
Parameters: Peril
Filters the result to just the specified perils, or just individual deliverables. For example, you can request just the earthquake damage hexgrid deliverables instead of all deliverables related to earthquakes. Certain deliverables have additional options such as file type.
Available peril types
| Peril Type | Available Deliverable Types | Options |
|---|---|---|
| "earthquake" | "earthquake_building_damage" | file_type: "geopackage" |
| "earthquake_damage_raster" | file_type: "raster" | |
| "earthquake_damage_vector_hexgrid" | file_type: "geopackage" | |
| "earthquake_release_notes" | file_type: "geopackage" | |
| "fire" | "fire_building_damage_vector" | file_type: "geopackage" |
Example workflow – Automatically download all deliverables of interest as they are published
By periodically querying the endpoint for deliverables published since the last query, you can set up automation to download new deliverables as they are released.
- Set up the request payload parameters to query for deliverables of interest e.g. earthquake damage hexgrids
- Query find-deliverables with a recent timestamp for the
published_afterparameter. - Loop through the download links of any deliverables returned.
- Save
latest_published_time. - Pause for some time.
- Query find-deliverables with the saved
latest_published_timeas thepublished_afterparameter. - Repeat steps 3-6.
- If the user would like to specify an area of interest, the clause should be added within the json after the
selected_perils.
Python sample
The sample below is intended solely for illustrative purposes. We do not commit to updating this with every API change and we do not guarantee the functionality, performance, or suitability of the code for any particular purpose.
