ICEYEConnector

ICEYE (https://www.iceye.com) provides near real-time hazard information worldwide. This connector streamlines data access, letting you integrate flood depth rasters, flood extent polygons, and other layers directly into FME workflows.

The ICEYEConnector transformer connects to the ICEYE API using secure credentials (OAuth 2.0 Client Credentials Flow) and retrieves peril data — currently Flood, Cyclone, and (coming soon) Wildfire.

To use the ICEYEConnector, you must have an active subscription with ICEYE and valid API credentials. If you do not yet have access, please contact ICEYE to learn more about subscription options and to obtain credentials for API integration.

The transformer can operate globally or within a specified area of interest (AOI)supplied as a polygon geometry and supports two primary actions:

List existing perils for a given time range, returning bounding boxes and download links.

Download selected perils either to disk or directly into the FME workspace as vector or raster features.

Input

An initiator feature, which can be either a polygon or a feature with no geometry.

Used to trigger the connection and pass parameters to ICEYE.

If an AOI geometry is supplied, it will be used to filter results spatially.

The geometry should be provided in EPSG:4326 (latitude/longitude, WGS84).

If no geometry is supplied, the connector retrieves results globally.

Output

Depending on the selected Action and Peril Types, the outputs can be either bounding boxes of the perils ("List" and "Download as Files") or features with downloaded geometries. In "List" mode, the transformer does not download any data, but allows accessing files through "download_link" attribute with HTTPCaller at a later stage in the workspace. This is a convenient mode when the analysis of the available data is required before actual downloading.

Port - Description

Flood_Depth - Flood depth rasters (GeoTIFF, typically UInt16 Gray).

Flood_Extents - Flood extent polygons (GeoPackage vectors).

Flood_Early_Warning* - Early warning datasets (points, grids, hazard zones, watersheds).

Flood_Rapid* - Rapid event analysis layers, including extent, accumulated extent, and observation coverage.

Cyclone* - Cyclone-related rasters, hexgrids, and release notes.

\<Rejected> Any features that failed to download or parse.

Parameters

ICEYE Web Connection

OAuth 2.0 connection (Client Credentials) for ICEYE API. Tokens are managed automatically.

The ICEYEConnector uses OAuth 2.0 (Client Credentials Flow) to securely authenticate with the ICEYE API under the hood. Before using the connector, configure an OAuth 2.0 Web Connection in FME with your ICEYE credentials. For detailed setup, see the FME documentation on creating an OAuth-enabled Web Service and Connection https://support.safe.com/hc/en-us/articles/25407422190861-Creating-an-OAuth-2-0-Web-Service-and-Connection-in-FME.

Action

Choose between List (list available datasets) and Download (retrieve data).

Published After / Before

Filter perils by their publication time range.

Peril Types

Select which peril types to retrieve — Flood, Cyclone, or Wildfire (coming soon).

Deliverables

Choose which deliverables to download (e.g., flood_depth, flood_extent).

Event ID

(Optional) Retrieve data for a specific event ID.

Units

Select between metric and imperial for numeric attributes.

Page Size (currently not implemented)

Defines how many items per API page are retrieved (default: 200).

Download as

Determines how downloads are handled:

- Features — load data directly into FME as raster/vector features.

- Files — save data to disk for external use.

Notes

When Action is set to List, the transformer returns metadata, bounding boxes of the selected perils, and download URLs only.

When Action is set to Download, data can be written directly to disk or read as features inside FME.

The transformer automatically refreshes ICEYE tokens (via Web Connection). No manual token handling is needed.

If no AOI is supplied, requests operate globally.

Typical outputs include:

Flood Depths — GeoTIFF rasters (UInt16, NoData = 0)

Flood Extents — GeoPackage vectors

Cyclone Damage — raster or hexgrid layers

When using Download as Features, the number of output features is usually greater than the number of files you would get with Download as Files.

Each downloaded file (typically a GeoPackage) may contain multiple features — for example, several polygons representing individual flood extents.