# Flood Forecasting API

floodforecasting.googleapis.com API.

- [REST Resource: v1.flashFloods](https://developers.google.com/flood-forecasting/rest#v1.flashFloods)
- [REST Resource: v1.floodStatus](https://developers.google.com/flood-forecasting/rest#v1.floodStatus)
- [REST Resource: v1.gaugeModels](https://developers.google.com/flood-forecasting/rest#v1.gaugeModels)
- [REST Resource: v1.gauges](https://developers.google.com/flood-forecasting/rest#v1.gauges)
- [REST Resource: v1.serializedPolygons](https://developers.google.com/flood-forecasting/rest#v1.serializedPolygons)
- [REST Resource: v1.significantEvents](https://developers.google.com/flood-forecasting/rest#v1.significantEvents)

## Service: floodforecasting.googleapis.com

To call this service, we recommend that you use the Google-provided [client libraries](https://cloud.google.com/apis/docs/client-libraries-explained). 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](https://developers.google.com/discovery/v1/reference/apis) 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:

- <https://floodforecasting.googleapis.com/$discovery/rest?version=v1>

### Service endpoint

A [service endpoint](https://cloud.google.com/apis/design/glossary#api_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.flashFloods](https://developers.google.com/flood-forecasting/rest/v1/flashFloods)

| Methods ||
|---|---|
| `https://developers.google.com/flood-forecasting/rest/v1/flashFloods/search` | `POST /v1/flashFloods:search` Search for flash floods. |

## REST Resource: [v1.floodStatus](https://developers.google.com/flood-forecasting/rest/v1/floodStatus)

| Methods ||
|---|---|
| `https://developers.google.com/flood-forecasting/rest/v1/floodStatus/queryLatestFloodStatusByGaugeIds` | `GET /v1/floodStatus:queryLatestFloodStatusByGaugeIds` Query latest flood status by gauge ids. |
| `https://developers.google.com/flood-forecasting/rest/v1/floodStatus/searchLatestFloodStatusByArea` | `POST /v1/floodStatus:searchLatestFloodStatusByArea` Search latest flood status by geographical area. |

## REST Resource: [v1.gaugeModels](https://developers.google.com/flood-forecasting/rest/v1/gaugeModels)

| Methods ||
|---|---|
| `https://developers.google.com/flood-forecasting/rest/v1/gaugeModels/batchGet` | `GET /v1/gaugeModels:batchGet` Get the current hydrological model metadata for multiple gauges. |
| `https://developers.google.com/flood-forecasting/rest/v1/gaugeModels/get` | `GET /v1/{name=gaugeModels/*}` Get the current hydrological model metadata for a given gauge. |

## REST Resource: [v1.gauges](https://developers.google.com/flood-forecasting/rest/v1/gauges)

| Methods ||
|---|---|
| `https://developers.google.com/flood-forecasting/rest/v1/gauges/batchGet` | `GET /v1/gauges:batchGet` Get metadata about multiple gauges. |
| `https://developers.google.com/flood-forecasting/rest/v1/gauges/get` | `GET /v1/{name=gauges/*}` Get metadata about a gauge. |
| `https://developers.google.com/flood-forecasting/rest/v1/gauges/queryGaugeForecasts` | `GET /v1/gauges:queryGaugeForecasts` Query gauge forecasts. |
| `https://developers.google.com/flood-forecasting/rest/v1/gauges/searchGaugesByArea` | `POST /v1/gauges:searchGaugesByArea` Search for gauges by geographical area. |

## REST Resource: [v1.serializedPolygons](https://developers.google.com/flood-forecasting/rest/v1/serializedPolygons)

| Methods ||
|---|---|
| `https://developers.google.com/flood-forecasting/rest/v1/serializedPolygons/get` | `GET /v1/{name=serializedPolygons/*}` Get a serialized polygon. |

## REST Resource: [v1.significantEvents](https://developers.google.com/flood-forecasting/rest/v1/significantEvents)

| Methods ||
|---|---|
| `https://developers.google.com/flood-forecasting/rest/v1/significantEvents/search` | `POST /v1/significantEvents:search` Search for latest significant events. |