Fast Flood will be offered as an API interface, where you can call simulations to run in the cloud, and get back your results in record speeds! If you aim to implement the method in your own geospatial platform, or want to automate or operationalize the usage of the model, the API can help you do this efficiently. 

The API for Fast Flood will become commercially available fall 2024.  

It will work by means of a HTTPS POST request to our cloud endpoint. 
This API entry point can run the model using your own data, or automatically selected data from global datasets. This API can either return to the caller directly, or after finishing the simulation. In case of returning directly, the API request will await for the model run to finish, which typically happens within several seconds. 

Please find the draft API specification below. Note that this specification is subject to change until the official API is publicly released. 

Required Input 

• API KEY 

And Either  
– DEMDownload Dataset name (e.g. cop30, ahn, usned), Resolution (e.g. 10m, 20m, 40m, …) and Region, array of 4 numbers, representing upper left and bottom right coordinates of domain area. Can be in either lat/long or in Pseudo-Mercator projection coordinates 

Or 
– Elevation file URL A url linking to a geotiff file to be used as model elevation data input. 

NOTE: The elevation data defines the model domain, size and resolution. This will also be the dimensions and resolution of the output, all provided in geotiff. 

Optional Input 

• Rain  Rain intensity, could be a number or a url to a geotiff file (Default = 30, value in mm/hour) 

• DesignStorm Design storm to be used, 2 numbers: return period (years) and duration (hours) 

• Barrier GeoJSON with polyline elements for barriers, all with an attribute “Height”, which represents the barrier height in meter. 

• Culvert GeoJSON with polylines culvert start and end points, all with an attribute “Flow Capacity (m3/s)” and “fractional inflow (%)”  

• Stormdrain GeoJSON with polylines, all with attributes “inlet distance”, “inlet type” and “inlet area” 

• QInput Discharge boundary conditions, GeoJSON with points, all with attributes “Peak Discharge (m3/s)” 

• LandUse Url to a geotiff containing manning values, or a manning roughness value 
  
  

LandUseDownload Dataset name/Region to download, array of 4 numbers, representing upper left and bottom right coordinates of domain area. Can be in either lat/long or in Pseudo-Mercator projection coordinates 

InfiltrationDownload Dataset name/Region to download, array of 4 numbers, representing upper left and bottom right coordinates of domain area. Can be in either lat/long or in Pseudo-Mercator projection coordinates 

• Infiltration Url to a geotiff containing infiltration values, or a infiltration value (mm/hour) 

• Channel Channel empirical relationships, Array of 5 numbers 

• Ocean Activates ocean boundary condition, 1 number: Height (m) 

• Dur Duration of the event (rainfall or oceanic), 1 number: Duration (Hours) 

• Shape Temporal shape of the rainfall event (Default = 1.0, meaning a triangular rainfall curve) 

• WHInitial Initial water height, single value or link to geotiff. Value in meters (default = 0.0) 

• Quality Option from “medium” “High” or “Very High”. Determines run-time and quality of output. Generally nothing beyond medium is required. 

• Adaptation GeoJSON with polygons for other parameters from the above (Infiltration, manning, rain, elevation) that need to be changed according to user input. Will be rasterized and values assigned. 
  
  

Note; All GeoJSONS have input coordinates in lat/lng coordinates 

Output  

List of urls where the results can be downloaded (…/flood.tif, …/discharge.tif, …./velocities.tif)