Flood Forecasting API
Stay organized with collections
Save and categorize content based on your preferences.
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
| 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. |
| 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. |
| Methods |
get |
GET /v1/{name=serializedPolygons/*}
Get a serialized polygon. |
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-03-05 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-03-05 UTC."],[[["\u003cp\u003eThe floodforecasting.googleapis.com API offers REST resources for managing flood-related data, including flood status, gauge models, gauges, and serialized polygons.\u003c/p\u003e\n"],["\u003cp\u003eThe API service endpoint is \u003ccode\u003ehttps://floodforecasting.googleapis.com\u003c/code\u003e, and all URIs are relative to this base URL.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003ev1.floodStatus\u003c/code\u003e resource allows querying the latest flood status by gauge IDs or searching by geographical area.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003ev1.gauges\u003c/code\u003e resource provides methods for retrieving metadata about gauges, querying forecasts, and searching by area.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003ev1.gaugeModels\u003c/code\u003e and \u003ccode\u003ev1.serializedPolygons\u003c/code\u003e resources allow users to retrieve metadata for hydrological models of gauges, and serialized polygons respectively.\u003c/p\u003e\n"]]],[],null,["# Flood Forecasting API\n\nfloodforecasting.googleapis.com API.\n\n- [REST Resource: v1.floodStatus](#v1.floodStatus)\n- [REST Resource: v1.gaugeModels](#v1.gaugeModels)\n- [REST Resource: v1.gauges](#v1.gauges)\n- [REST Resource: v1.serializedPolygons](#v1.serializedPolygons)\n\nService: floodforecasting.googleapis.com\n----------------------------------------\n\nTo 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.\n\n### Discovery document\n\nA [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:\n\n- \u003chttps://floodforecasting.googleapis.com/$discovery/rest?version=v1\u003e\n\n### Service endpoint\n\nA [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:\n\n- `https://floodforecasting.googleapis.com`\n\nREST Resource: [v1.floodStatus](/flood-forecasting/rest/v1/floodStatus)\n-----------------------------------------------------------------------\n\n| Methods ||\n|-------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------|\n| [queryLatestFloodStatusByGaugeIds](/flood-forecasting/rest/v1/floodStatus/queryLatestFloodStatusByGaugeIds) | `GET /v1/floodStatus:queryLatestFloodStatusByGaugeIds` Query latest flood status by gauge ids. |\n| [searchLatestFloodStatusByArea](/flood-forecasting/rest/v1/floodStatus/searchLatestFloodStatusByArea) | `POST /v1/floodStatus:searchLatestFloodStatusByArea` Search latest flood status by geographical area. |\n\nREST Resource: [v1.gaugeModels](/flood-forecasting/rest/v1/gaugeModels)\n-----------------------------------------------------------------------\n\n| Methods ||\n|-------------------------------------------------------------|-------------------------------------------------------------------------------------------------|\n| [batchGet](/flood-forecasting/rest/v1/gaugeModels/batchGet) | `GET /v1/gaugeModels:batchGet` Get the current hydrological model metadata for multiple gauges. |\n| [get](/flood-forecasting/rest/v1/gaugeModels/get) | `GET /v1/{name=gaugeModels/*}` Get the current hydrological model metadata for a given gauge. |\n\nREST Resource: [v1.gauges](/flood-forecasting/rest/v1/gauges)\n-------------------------------------------------------------\n\n| Methods ||\n|------------------------------------------------------------------------------|------------------------------------------------------------------------------|\n| [batchGet](/flood-forecasting/rest/v1/gauges/batchGet) | `GET /v1/gauges:batchGet` Get metadata about multiple gauges. |\n| [get](/flood-forecasting/rest/v1/gauges/get) | `GET /v1/{name=gauges/*}` Get metadata about a gauge. |\n| [queryGaugeForecasts](/flood-forecasting/rest/v1/gauges/queryGaugeForecasts) | `GET /v1/gauges:queryGaugeForecasts` Query gauge forecasts. |\n| [searchGaugesByArea](/flood-forecasting/rest/v1/gauges/searchGaugesByArea) | `POST /v1/gauges:searchGaugesByArea` Search for gauges by geographical area. |\n\nREST Resource: [v1.serializedPolygons](/flood-forecasting/rest/v1/serializedPolygons)\n-------------------------------------------------------------------------------------\n\n| Methods ||\n|----------------------------------------------------------|-----------------------------------------------------------------|\n| [get](/flood-forecasting/rest/v1/serializedPolygons/get) | `GET /v1/{name=serializedPolygons/*}` Get a serialized polygon. |"]]