Flood Forecasting API

  • The floodforecasting.googleapis.com API offers REST resources for managing flood-related data, including flood status, gauge models, gauges, and serialized polygons.

  • The API service endpoint is https://floodforecasting.googleapis.com, and all URIs are relative to this base URL.

  • The v1.floodStatus resource allows querying the latest flood status by gauge IDs or searching by geographical area.

  • The v1.gauges resource provides methods for retrieving metadata about gauges, querying forecasts, and searching by area.

  • The v1.gaugeModels and v1.serializedPolygons resources allow users to retrieve metadata for hydrological models of gauges, and serialized polygons respectively.

floodforecasting.googleapis.com API.

Service: floodforecasting.googleapis.com

To call this service, we recommend that you use the Google-provided client libraries. If your application needs to use your own libraries to call this service, use the following information when you make the API requests.

Discovery document

A Discovery Document is a machine-readable specification for describing and consuming REST APIs. It is used to build client libraries, IDE plugins, and other tools that interact with Google APIs. One service may provide multiple discovery documents. This service provides the following discovery document:

Service endpoint

A service endpoint is a base URL that specifies the network address of an API service. One service might have multiple service endpoints. This service has the following service endpoint and all URIs below are relative to this service endpoint:

  • https://floodforecasting.googleapis.com

REST Resource: v1.floodStatus

Methods
queryLatestFloodStatusByGaugeIds GET /v1/floodStatus:queryLatestFloodStatusByGaugeIds
Query latest flood status by gauge ids.
searchLatestFloodStatusByArea POST /v1/floodStatus:searchLatestFloodStatusByArea
Search latest flood status by geographical area.

REST Resource: v1.gaugeModels

Methods
batchGet GET /v1/gaugeModels:batchGet
Get the current hydrological model metadata for multiple gauges.
get GET /v1/{name=gaugeModels/*}
Get the current hydrological model metadata for a given gauge.

REST Resource: v1.gauges

Methods
batchGet GET /v1/gauges:batchGet
Get metadata about multiple gauges.
get GET /v1/{name=gauges/*}
Get metadata about a gauge.
queryGaugeForecasts GET /v1/gauges:queryGaugeForecasts
Query gauge forecasts.
searchGaugesByArea POST /v1/gauges:searchGaugesByArea
Search for gauges by geographical area.

REST Resource: v1.serializedPolygons

Methods
get GET /v1/{name=serializedPolygons/*}
Get a serialized polygon.