Method: gauges.searchGaugesByArea
Stay organized with collections
Save and categorize content based on your preferences.
Search for gauges by geographical area.
Note: Gauges are occasionally added or removed, so the result of this API should not be cached or stored for long periods of time. Consider no more than a day to be relatively safe.
HTTP request
POST https://floodforecasting.googleapis.com/v1/gauges:searchGaugesByArea
The URL uses gRPC Transcoding syntax.
Request body
The request body contains data with the following structure:
| JSON representation |
{
"pageSize": integer,
"pageToken": string,
// Union field search_by can be only one of the following:
"regionCode": string,
"loop": {
object (Loop)
}
// End of list of possible types for union field search_by.
"includeNonQualityVerified": boolean,
"includeGaugesWithoutHydroModel": boolean
} |
| Fields |
pageSize |
integer
Optional. The maximum number of gauges to return. The service may return fewer than this value. If unspecified, at most 50,000 gauges will be returned. The maximum value is 50,000; values above 50,000 will be coerced to 50,000.
|
pageToken |
string
Optional. A page token, received from a previous SearchGauges call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SearchGauges must match the call that provided the page token.
|
Union field search_by. search_by can be only one of the following:
|
regionCode |
string
Search for all gauges within a region by region code. Use https://cldr.unicode.org/ (list https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry).
|
loop |
object (Loop)
Search for all gauges within a loop (a simple spherical polygon, see Loop).
|
includeNonQualityVerified |
boolean
Optional. Include in the result gauges that aren't quality verified. Please use with caution. Default is false.
|
includeGaugesWithoutHydroModel |
boolean
Optional. Include in the result gauges that don't have a Google in-house hydro model. Default is false.
|
Response body
The response of gauges.searchGaugesByArea.
If successful, the response body contains data with the following structure:
| JSON representation |
{
"gauges": [
{
object (Gauge)
}
],
"nextPageToken": string
} |
| Fields |
gauges[] |
object (Gauge)
Gauges found in the requested area.
|
nextPageToken |
string
Optional. A token that can be sent as pageToken to retrieve the next page. If this field is omitted, there are no subsequent pages.
|
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-09-01 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-09-01 UTC."],[[["\u003cp\u003eThis API allows you to search for gauges within a specific geographical area using a POST request to \u003ccode\u003ehttps://floodforecasting.googleapis.com/v1/gauges:searchGaugesByArea\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe request body supports searching by either a region code or a defined loop (spherical polygon), and includes options to set the page size, page token, and whether to include non-quality-verified gauges.\u003c/p\u003e\n"],["\u003cp\u003eThe response body contains a list of gauges found in the requested area, along with an optional \u003ccode\u003enextPageToken\u003c/code\u003e for retrieving subsequent pages of results.\u003c/p\u003e\n"],["\u003cp\u003eDue to the dynamic nature of gauge data, it is recommended not to cache or store the results from this API for long durations, with a day being the suggested maximum.\u003c/p\u003e\n"]]],[],null,["# Method: gauges.searchGaugesByArea\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Request body](#body.request_body)\n - [JSON representation](#body.request_body.SCHEMA_REPRESENTATION)\n- [Response body](#body.response_body)\n - [JSON representation](#body.SearchGaugesByAreaResponse.SCHEMA_REPRESENTATION)\n\nSearch for gauges by geographical area.\n\nNote: Gauges are occasionally added or removed, so the result of this API should not be cached or stored for long periods of time. Consider no more than a day to be relatively safe.\n\n### HTTP request\n\n`POST https://floodforecasting.googleapis.com/v1/gauges:searchGaugesByArea`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Request body\n\nThe request body contains data with the following structure:\n\n| JSON representation |\n|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"pageSize\": integer, \"pageToken\": string, // Union field `search_by` can be only one of the following: \"regionCode\": string, \"loop\": { object (/flood-forecasting/rest/v1/Loop) } // End of list of possible types for union field `search_by`. \"includeNonQualityVerified\": boolean, \"includeGaugesWithoutHydroModel\": boolean } ``` |\n\n| Fields ||\n|----------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `pageSize` | `integer` Optional. The maximum number of gauges to return. The service may return fewer than this value. If unspecified, at most 50,000 gauges will be returned. The maximum value is 50,000; values above 50,000 will be coerced to 50,000. The maximum value is currently not enforced by the API, but will be in the future. |\n| `pageToken` | `string` Optional. A page token, received from a previous `SearchGauges` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `SearchGauges` must match the call that provided the page token. |\n| Union field `search_by`. `search_by` can be only one of the following: ||\n| `regionCode` | `string` Search for all gauges within a region by region code. Use \u003chttps://cldr.unicode.org/\u003e (list \u003chttps://www.iana.org/assignments/language-subtag-registry/language-subtag-registry)\u003e. |\n| `loop` | `object (`[Loop](/flood-forecasting/rest/v1/Loop)`)` Search for all gauges within a loop (a simple spherical polygon, see [Loop](/flood-forecasting/rest/v1/Loop)). |\n| `includeNonQualityVerified` | `boolean` Optional. Include in the result gauges that aren't quality verified. Please use with caution. Default is false. |\n| `includeGaugesWithoutHydroModel` | `boolean` Optional. Include in the result gauges that don't have a Google in-house hydro model. Default is false. |\n\n### Response body\n\nThe response of gauges.searchGaugesByArea.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|---------------------------------------------------------------------------------------------------------|\n| ``` { \"gauges\": [ { object (/flood-forecasting/rest/v1/gauges#Gauge) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|------------------------------------------------------------------------------------------------------------------------------------------------|\n| `gauges[]` | `object (`[Gauge](/flood-forecasting/rest/v1/gauges#Gauge)`)` Gauges found in the requested area. |\n| `nextPageToken` | `string` Optional. A token that can be sent as `pageToken` to retrieve the next page. If this field is omitted, there are no subsequent pages. |"]]