### GET / Source: https://api.waterdata.usgs.gov/ogcapi/v0/openapi Landing page ```markdown ### Parameters - **f** (string (json|html|jsonld|csv), query, optional): The optional f parameter indicates the output format which the server shall provide as part of the response document. The default format is GeoJSON. CSV is also available. - **lang** (string (en-US), query, optional): The optional lang parameter instructs the server return a response in a certain language, if supported. If the language is not among the available values, the Accept-Language header language will be used if it is supported. If the header is missing, the default server language is used. Note that providers may only support a single language (or often no language at all), that can be different from the server language. Language strings can be written in a complex (e.g. "fr-CA,fr;q=0.9,en-US;q=0.8,en;q=0.7"), simple (e.g. "de") or locale-like (e.g. "de-CH" or "fr_BE") fashion. ### Responses #### 200 - response #### 400 - response #### 403 - response **Error** - **error** (object) - **code** (string) (required): Error code such as OVER_RATE_LIMIT, see https://api.data.gov/docs/developer-manual/#general-web-service-errors - **message** (string) (required): Error message - **response** (object) #### 429 - response **Error** - **error** (object) - **code** (string) (required): Error code such as OVER_RATE_LIMIT, see https://api.data.gov/docs/developer-manual/#general-web-service-errors - **message** (string) (required): Error message - **response** (object) #### 500 - response ### Example Usage ```bash curl -X GET "https://api.waterdata.usgs.gov/ogcapi/v0/?f=json&lang=en-US" ``` ``` -------------------------------- ### GET /collections Source: https://api.waterdata.usgs.gov/ogcapi/v0/openapi Collections ```markdown ### Parameters - **f** (string (json|html|jsonld|csv), query, optional): The optional f parameter indicates the output format which the server shall provide as part of the response document. The default format is GeoJSON. CSV is also available. - **lang** (string (en-US), query, optional): The optional lang parameter instructs the server return a response in a certain language, if supported. If the language is not among the available values, the Accept-Language header language will be used if it is supported. If the header is missing, the default server language is used. Note that providers may only support a single language (or often no language at all), that can be different from the server language. Language strings can be written in a complex (e.g. "fr-CA,fr;q=0.9,en-US;q=0.8,en;q=0.7"), simple (e.g. "de") or locale-like (e.g. "de-CH" or "fr_BE") fashion. ### Responses #### 200 - response #### 400 - response #### 403 - response **Error** - **error** (object) - **code** (string) (required): Error code such as OVER_RATE_LIMIT, see https://api.data.gov/docs/developer-manual/#general-web-service-errors - **message** (string) (required): Error message - **response** (object) #### 429 - response **Error** - **error** (object) - **code** (string) (required): Error code such as OVER_RATE_LIMIT, see https://api.data.gov/docs/developer-manual/#general-web-service-errors - **message** (string) (required): Error message - **response** (object) #### 500 - response ### Example Usage ```bash curl -X GET "https://api.waterdata.usgs.gov/ogcapi/v0/collections?f=json&lang=en-US" ``` ``` -------------------------------- ### GET /collections/citations/schema Source: https://api.waterdata.usgs.gov/ogcapi/v0/openapi Citations associated with water measurement methods. ```markdown ### Parameters - **f** (string (json|html|jsonld|csv), query, optional): The optional f parameter indicates the output format which the server shall provide as part of the response document. The default format is GeoJSON. CSV is also available. - **lang** (string (en-US), query, optional): The optional lang parameter instructs the server return a response in a certain language, if supported. If the language is not among the available values, the Accept-Language header language will be used if it is supported. If the header is missing, the default server language is used. Note that providers may only support a single language (or often no language at all), that can be different from the server language. Language strings can be written in a complex (e.g. "fr-CA,fr;q=0.9,en-US;q=0.8,en;q=0.7"), simple (e.g. "de") or locale-like (e.g. "de-CH" or "fr_BE") fashion. ### Responses #### 200 - response **queryables** - **queryables** (array (queryable)) (required) Array items: - **description** (string): a human-readable narrative describing the queryable - **language** (string): the language used for the title and description - **queryable** (string) (required): the token that may be used in a CQL predicate - **title** (string): a human readable title for the queryable - **type** (string) (required): the data type of the queryable - **type-ref** (string (url)): a reference to the formal definition of the type #### 400 - response #### 403 - response **Error** - **error** (object) - **code** (string) (required): Error code such as OVER_RATE_LIMIT, see https://api.data.gov/docs/developer-manual/#general-web-service-errors - **message** (string) (required): Error message - **response** (object) #### 404 - response #### 429 - response **Error** - **error** (object) - **code** (string) (required): Error code such as OVER_RATE_LIMIT, see https://api.data.gov/docs/developer-manual/#general-web-service-errors - **message** (string) (required): Error message - **response** (object) #### 500 - response ### Example Usage ```bash curl -X GET "https://api.waterdata.usgs.gov/ogcapi/v0/collections/citations/schema?f=json&lang=en-US" ``` ``` -------------------------------- ### GET /collections/statistic-codes/queryables Source: https://api.waterdata.usgs.gov/ogcapi/v0/openapi Statistic codes. ```markdown ### Parameters - **properties** (array (string (id|statistic_name|statistic_description)), query, optional): The properties that should be included. The parameter value is a comma-separated list of property names. - **f** (string (json|html|jsonld|csv), query, optional): The optional f parameter indicates the output format which the server shall provide as part of the response document. The default format is GeoJSON. CSV is also available. - **profile** (string (actual-domain|valid-domain), query, optional): The profile to be applied to a given request - **lang** (string (en-US), query, optional): The optional lang parameter instructs the server return a response in a certain language, if supported. If the language is not among the available values, the Accept-Language header language will be used if it is supported. If the header is missing, the default server language is used. Note that providers may only support a single language (or often no language at all), that can be different from the server language. Language strings can be written in a complex (e.g. "fr-CA,fr;q=0.9,en-US;q=0.8,en;q=0.7"), simple (e.g. "de") or locale-like (e.g. "de-CH" or "fr_BE") fashion. ### Responses #### 200 - response **queryables** - **queryables** (array (queryable)) (required) Array items: - **description** (string): a human-readable narrative describing the queryable - **language** (string): the language used for the title and description - **queryable** (string) (required): the token that may be used in a CQL predicate - **title** (string): a human readable title for the queryable - **type** (string) (required): the data type of the queryable - **type-ref** (string (url)): a reference to the formal definition of the type #### 400 - response #### 403 - response **Error** - **error** (object) - **code** (string) (required): Error code such as OVER_RATE_LIMIT, see https://api.data.gov/docs/developer-manual/#general-web-service-errors - **message** (string) (required): Error message - **response** (object) #### 404 - response #### 429 - response **Error** - **error** (object) - **code** (string) (required): Error code such as OVER_RATE_LIMIT, see https://api.data.gov/docs/developer-manual/#general-web-service-errors - **message** (string) (required): Error message - **response** (object) #### 500 - response ### Example Usage ```bash curl -X GET "https://api.waterdata.usgs.gov/ogcapi/v0/collections/statistic-codes/queryables?properties=item1,item2&f=json&profile=actual-domain&lang=en-US" ``` ``` -------------------------------- ### GET /collections/time-zone-codes/schema Source: https://api.waterdata.usgs.gov/ogcapi/v0/openapi The ISO 8601 standard defines time zone offsets as a numerical value added to a local time to convert it to Coordinated Universal Time (UTC), either as +hh:mm or -hh:mm, or represented by the letter Z to explicitly indicate UTC. For example, +05:30 means 5 hours and 30 minutes ahead of UTC, while -08:00 means 8 hours behind UTC. The offset Z specifically signifies UTC. ```markdown ### Parameters - **f** (string (json|html|jsonld|csv), query, optional): The optional f parameter indicates the output format which the server shall provide as part of the response document. The default format is GeoJSON. CSV is also available. - **lang** (string (en-US), query, optional): The optional lang parameter instructs the server return a response in a certain language, if supported. If the language is not among the available values, the Accept-Language header language will be used if it is supported. If the header is missing, the default server language is used. Note that providers may only support a single language (or often no language at all), that can be different from the server language. Language strings can be written in a complex (e.g. "fr-CA,fr;q=0.9,en-US;q=0.8,en;q=0.7"), simple (e.g. "de") or locale-like (e.g. "de-CH" or "fr_BE") fashion. ### Responses #### 200 - response **queryables** - **queryables** (array (queryable)) (required) Array items: - **description** (string): a human-readable narrative describing the queryable - **language** (string): the language used for the title and description - **queryable** (string) (required): the token that may be used in a CQL predicate - **title** (string): a human readable title for the queryable - **type** (string) (required): the data type of the queryable - **type-ref** (string (url)): a reference to the formal definition of the type #### 400 - response #### 403 - response **Error** - **error** (object) - **code** (string) (required): Error code such as OVER_RATE_LIMIT, see https://api.data.gov/docs/developer-manual/#general-web-service-errors - **message** (string) (required): Error message - **response** (object) #### 404 - response #### 429 - response **Error** - **error** (object) - **code** (string) (required): Error code such as OVER_RATE_LIMIT, see https://api.data.gov/docs/developer-manual/#general-web-service-errors - **message** (string) (required): Error message - **response** (object) #### 500 - response ### Example Usage ```bash curl -X GET "https://api.waterdata.usgs.gov/ogcapi/v0/collections/time-zone-codes/schema?f=json&lang=en-US" ``` ``` -------------------------------- ### GET /collections/time-zone-codes/queryables Source: https://api.waterdata.usgs.gov/ogcapi/v0/openapi The ISO 8601 standard defines time zone offsets as a numerical value added to a local time to convert it to Coordinated Universal Time (UTC), either as +hh:mm or -hh:mm, or represented by the letter Z to explicitly indicate UTC. For example, +05:30 means 5 hours and 30 minutes ahead of UTC, while -08:00 means 8 hours behind UTC. The offset Z specifically signifies UTC. ```markdown ### Parameters - **properties** (array (string (id|time_zone_name|time_zone_description|time_zone_utc_offset|time_zone_daylight_savings_time_code|time_zone_daylight_savings_time_name|time_zone_daylight_savings_utc_offset)), query, optional): The properties that should be included. The parameter value is a comma-separated list of property names. - **f** (string (json|html|jsonld|csv), query, optional): The optional f parameter indicates the output format which the server shall provide as part of the response document. The default format is GeoJSON. CSV is also available. - **profile** (string (actual-domain|valid-domain), query, optional): The profile to be applied to a given request - **lang** (string (en-US), query, optional): The optional lang parameter instructs the server return a response in a certain language, if supported. If the language is not among the available values, the Accept-Language header language will be used if it is supported. If the header is missing, the default server language is used. Note that providers may only support a single language (or often no language at all), that can be different from the server language. Language strings can be written in a complex (e.g. "fr-CA,fr;q=0.9,en-US;q=0.8,en;q=0.7"), simple (e.g. "de") or locale-like (e.g. "de-CH" or "fr_BE") fashion. ### Responses #### 200 - response **queryables** - **queryables** (array (queryable)) (required) Array items: - **description** (string): a human-readable narrative describing the queryable - **language** (string): the language used for the title and description - **queryable** (string) (required): the token that may be used in a CQL predicate - **title** (string): a human readable title for the queryable - **type** (string) (required): the data type of the queryable - **type-ref** (string (url)): a reference to the formal definition of the type #### 400 - response #### 403 - response **Error** - **error** (object) - **code** (string) (required): Error code such as OVER_RATE_LIMIT, see https://api.data.gov/docs/developer-manual/#general-web-service-errors - **message** (string) (required): Error message - **response** (object) #### 404 - response #### 429 - response **Error** - **error** (object) - **code** (string) (required): Error code such as OVER_RATE_LIMIT, see https://api.data.gov/docs/developer-manual/#general-web-service-errors - **message** (string) (required): Error message - **response** (object) #### 500 - response ### Example Usage ```bash curl -X GET "https://api.waterdata.usgs.gov/ogcapi/v0/collections/time-zone-codes/queryables?properties=item1,item2&f=json&profile=actual-domain&lang=en-US" ``` ``` -------------------------------- ### Schema: queryable Source: https://api.waterdata.usgs.gov/ogcapi/v0/openapi Schema definition for queryable ```markdown ## Schema: queryable Schema definition for queryable **Type:** object - **description** (string): a human-readable narrative describing the queryable - **language** (string): the language used for the title and description - **queryable** (string) (required): the token that may be used in a CQL predicate - **title** (string): a human readable title for the queryable - **type** (string) (required): the data type of the queryable - **type-ref** (string (url)): a reference to the formal definition of the type ``` -------------------------------- ### GET /collections/time-zone-codes/items Source: https://api.waterdata.usgs.gov/ogcapi/v0/openapi The ISO 8601 standard defines time zone offsets as a numerical value added to a local time to convert it to Coordinated Universal Time (UTC), either as +hh:mm or -hh:mm, or represented by the letter Z to explicitly indicate UTC. For example, +05:30 means 5 hours and 30 minutes ahead of UTC, while -08:00 means 8 hours behind UTC. The offset Z specifically signifies UTC. ```markdown ### Parameters - **f** (string (json|html|jsonld|csv), query, optional): The optional f parameter indicates the output format which the server shall provide as part of the response document. The default format is GeoJSON. - **lang** (string (en-US), query, optional): The optional lang parameter instructs the server return a response in a certain language, if supported. If the language is not among the available values, the Accept-Language header language will be used if it is supported. If the header is missing, the default server language is used. Note that providers may only support a single language (or often no language at all), that can be different from the server language. Language strings can be written in a complex (e.g. "fr-CA,fr;q=0.9,en-US;q=0.8,en;q=0.7"), simple (e.g. "de") or locale-like (e.g. "de-CH" or "fr_BE") fashion. - **bbox** (array (number), query, optional): Only features that have a geometry that intersects the bounding box are selected.The bounding box is provided as four or six numbers, depending on whether the coordinate reference system includes a vertical axis (height or depth). - **limit** (integer, query, optional): The optional limit parameter limits the number of items that are presented in the response document (maximum=50000, default=10000). - **crs** (string (uri), query, optional): Indicates the coordinate reference system for the results. - **bbox-crs** (string (uri), query, optional): Indicates the coordinate reference system for the given bbox coordinates. - **properties** (array (string (id|time_zone_name|time_zone_description|time_zone_utc_offset|time_zone_daylight_savings_time_code|time_zone_daylight_savings_time_name|time_zone_daylight_savings_utc_offset)), query, optional): The properties that should be included. The parameter value is a comma-separated list of property names. - **skipGeometry** (boolean, query, optional): This option can be used to skip response geometries for each feature. - **undefined** (string, query, optional) - **offset** (integer, query, optional): The optional offset parameter indicates the index within the result set from which the server shall begin presenting results in the response document. The first element has an index of 0 (default). - **id** (string, query, optional): Time zone code. An NWIS time zone code. - **time_zone_name** (string, query, optional): Time zone name. An English name for a world time zone. - **time_zone_description** (string, query, optional): Time zone description. - **time_zone_utc_offset** (string, query, optional): Coordinated Universal Time (UTC) offset time. The number of hours offset from UTC time, in ISO format. - **time_zone_daylight_savings_time_code** (string, query, optional): Time zone Daylight Saving Time code. - **time_zone_daylight_savings_time_name** (string, query, optional): Time zone Daylight Saving Time name. - **time_zone_daylight_savings_utc_offset** (string, query, optional): Daylight Saving Time offset time. The number of hours offset from UTC time when Daylight Saving Time is in effect, in ISO format. - **filter** (string, query, optional): CQL Text filter expression. CQL JSON cannot be used here, only in the body. See also: https://docs.pygeoapi.io/en/latest/cql.html Example: time_series_id IN ('64ee32f5350a4ec4967435dcd2e364ea', '3e55d9c2d8a54bec9ca5e292b07d5a96') ### Responses #### 200 - response #### 400 - response #### 403 - response **Error** - **error** (object) - **code** (string) (required): Error code such as OVER_RATE_LIMIT, see https://api.data.gov/docs/developer-manual/#general-web-service-errors - **message** (string) (required): Error message - **response** (object) #### 404 - response #### 429 - response **Error** - **error** (object) - **code** (string) (required): Error code such as OVER_RATE_LIMIT, see https://api.data.gov/docs/developer-manual/#general-web-service-errors - **message** (string) (required): Error message - **response** (object) #### 500 - response ### Example Usage ```bash curl -X GET "https://api.waterdata.usgs.gov/ogcapi/v0/collections/time-zone-codes/items?f=json&lang=en-US&bbox=item1,item2&limit=10000&crs=string&bbox-crs=string&properties=item1,item2&skipGeometry=false&offset=0&id=string&time_zone_name=string&time_zone_description=string&time_zone_utc_offset=string&time_zone_daylight_savings_time_code=string&time_zone_daylight_savings_time_name=string&time_zone_daylight_savings_utc_offset=string&filter=string" ``` ``` -------------------------------- ### OPTIONS /collections/citations/items Source: https://api.waterdata.usgs.gov/ogcapi/v0/openapi Citations associated with water measurement methods. ```markdown ### Responses #### 200 - options response Empty response body ### Example Usage ```bash curl -X OPTIONS "https://api.waterdata.usgs.gov/ogcapi/v0/collections/citations/items" ``` ``` -------------------------------- ### POST /collections/citations/items Source: https://api.waterdata.usgs.gov/ogcapi/v0/openapi Citations associated with water measurement methods. ```markdown ### Request Body **Content-Type:** application/json ### Responses #### 200 - response #### 400 - response #### 403 - response **Error** - **error** (object) - **code** (string) (required): Error code such as OVER_RATE_LIMIT, see https://api.data.gov/docs/developer-manual/#general-web-service-errors - **message** (string) (required): Error message - **response** (object) #### 429 - response **Error** - **error** (object) - **code** (string) (required): Error code such as OVER_RATE_LIMIT, see https://api.data.gov/docs/developer-manual/#general-web-service-errors - **message** (string) (required): Error message - **response** (object) #### 500 - response ### Example Usage ```bash curl -X POST "https://api.waterdata.usgs.gov/ogcapi/v0/collections/citations/items" \ -H "Content-Type: application/json" \ -d '"value"' ``` ``` -------------------------------- ### GET /collections/time-zone-codes Source: https://api.waterdata.usgs.gov/ogcapi/v0/openapi The ISO 8601 standard defines time zone offsets as a numerical value added to a local time to convert it to Coordinated Universal Time (UTC), either as +hh:mm or -hh:mm, or represented by the letter Z to explicitly indicate UTC. For example, +05:30 means 5 hours and 30 minutes ahead of UTC, while -08:00 means 8 hours behind UTC. The offset Z specifically signifies UTC. ```markdown ### Parameters - **f** (string (json|html|jsonld|csv), query, optional): The optional f parameter indicates the output format which the server shall provide as part of the response document. The default format is GeoJSON. CSV is also available. - **lang** (string (en-US), query, optional): The optional lang parameter instructs the server return a response in a certain language, if supported. If the language is not among the available values, the Accept-Language header language will be used if it is supported. If the header is missing, the default server language is used. Note that providers may only support a single language (or often no language at all), that can be different from the server language. Language strings can be written in a complex (e.g. "fr-CA,fr;q=0.9,en-US;q=0.8,en;q=0.7"), simple (e.g. "de") or locale-like (e.g. "de-CH" or "fr_BE") fashion. ### Responses #### 200 - response #### 400 - response #### 403 - response **Error** - **error** (object) - **code** (string) (required): Error code such as OVER_RATE_LIMIT, see https://api.data.gov/docs/developer-manual/#general-web-service-errors - **message** (string) (required): Error message - **response** (object) #### 404 - response #### 429 - response **Error** - **error** (object) - **code** (string) (required): Error code such as OVER_RATE_LIMIT, see https://api.data.gov/docs/developer-manual/#general-web-service-errors - **message** (string) (required): Error message - **response** (object) #### 500 - response ### Example Usage ```bash curl -X GET "https://api.waterdata.usgs.gov/ogcapi/v0/collections/time-zone-codes?f=json&lang=en-US" ``` ``` -------------------------------- ### GET /collections/citations/queryables Source: https://api.waterdata.usgs.gov/ogcapi/v0/openapi Citations associated with water measurement methods. ```markdown ### Parameters - **properties** (array (string (id|citation_description)), query, optional): The properties that should be included. The parameter value is a comma-separated list of property names. - **f** (string (json|html|jsonld|csv), query, optional): The optional f parameter indicates the output format which the server shall provide as part of the response document. The default format is GeoJSON. CSV is also available. - **profile** (string (actual-domain|valid-domain), query, optional): The profile to be applied to a given request - **lang** (string (en-US), query, optional): The optional lang parameter instructs the server return a response in a certain language, if supported. If the language is not among the available values, the Accept-Language header language will be used if it is supported. If the header is missing, the default server language is used. Note that providers may only support a single language (or often no language at all), that can be different from the server language. Language strings can be written in a complex (e.g. "fr-CA,fr;q=0.9,en-US;q=0.8,en;q=0.7"), simple (e.g. "de") or locale-like (e.g. "de-CH" or "fr_BE") fashion. ### Responses #### 200 - response **queryables** - **queryables** (array (queryable)) (required) Array items: - **description** (string): a human-readable narrative describing the queryable - **language** (string): the language used for the title and description - **queryable** (string) (required): the token that may be used in a CQL predicate - **title** (string): a human readable title for the queryable - **type** (string) (required): the data type of the queryable - **type-ref** (string (url)): a reference to the formal definition of the type #### 400 - response #### 403 - response **Error** - **error** (object) - **code** (string) (required): Error code such as OVER_RATE_LIMIT, see https://api.data.gov/docs/developer-manual/#general-web-service-errors - **message** (string) (required): Error message - **response** (object) #### 404 - response #### 429 - response **Error** - **error** (object) - **code** (string) (required): Error code such as OVER_RATE_LIMIT, see https://api.data.gov/docs/developer-manual/#general-web-service-errors - **message** (string) (required): Error message - **response** (object) #### 500 - response ### Example Usage ```bash curl -X GET "https://api.waterdata.usgs.gov/ogcapi/v0/collections/citations/queryables?properties=item1,item2&f=json&profile=actual-domain&lang=en-US" ``` ``` -------------------------------- ### GET /collections/time-zone-codes/items/{featureId} Source: https://api.waterdata.usgs.gov/ogcapi/v0/openapi The ISO 8601 standard defines time zone offsets as a numerical value added to a local time to convert it to Coordinated Universal Time (UTC), either as +hh:mm or -hh:mm, or represented by the letter Z to explicitly indicate UTC. For example, +05:30 means 5 hours and 30 minutes ahead of UTC, while -08:00 means 8 hours behind UTC. The offset Z specifically signifies UTC. ```markdown ### Parameters - **undefined** (string, query, optional) - **crs** (string (uri), query, optional): Indicates the coordinate reference system for the results. - **f** (string (json|html|jsonld|csv), query, optional): The optional f parameter indicates the output format which the server shall provide as part of the response document. The default format is GeoJSON. CSV is also available. - **lang** (string (en-US), query, optional): The optional lang parameter instructs the server return a response in a certain language, if supported. If the language is not among the available values, the Accept-Language header language will be used if it is supported. If the header is missing, the default server language is used. Note that providers may only support a single language (or often no language at all), that can be different from the server language. Language strings can be written in a complex (e.g. "fr-CA,fr;q=0.9,en-US;q=0.8,en;q=0.7"), simple (e.g. "de") or locale-like (e.g. "de-CH" or "fr_BE") fashion. ### Responses #### 200 - response #### 400 - response #### 403 - response **Error** - **error** (object) - **code** (string) (required): Error code such as OVER_RATE_LIMIT, see https://api.data.gov/docs/developer-manual/#general-web-service-errors - **message** (string) (required): Error message - **response** (object) #### 404 - response #### 429 - response **Error** - **error** (object) - **code** (string) (required): Error code such as OVER_RATE_LIMIT, see https://api.data.gov/docs/developer-manual/#general-web-service-errors - **message** (string) (required): Error message - **response** (object) #### 500 - response ### Example Usage ```bash curl -X GET "https://api.waterdata.usgs.gov/ogcapi/v0/collections/time-zone-codes/items/{featureId}?crs=string&f=json&lang=en-US" ``` ``` -------------------------------- ### GET /collections/parameter-codes/schema Source: https://api.waterdata.usgs.gov/ogcapi/v0/openapi Parameter codes are 5-digit codes and associated descriptions used to identify the constituent measured and the units of measure. Some parameter code definitions include information about the sampling matrix, fraction, and methods used to measure the constituent. Some parameters are fixed-value (fxd) numeric codes having textual meaning (for example: parameter code 00041 is a weather code parameter, code of 60 means rain), but more commonly represent a numeric value for chemical, physical, or biological data. ```markdown ### Parameters - **f** (string (json|html|jsonld|csv), query, optional): The optional f parameter indicates the output format which the server shall provide as part of the response document. The default format is GeoJSON. CSV is also available. - **lang** (string (en-US), query, optional): The optional lang parameter instructs the server return a response in a certain language, if supported. If the language is not among the available values, the Accept-Language header language will be used if it is supported. If the header is missing, the default server language is used. Note that providers may only support a single language (or often no language at all), that can be different from the server language. Language strings can be written in a complex (e.g. "fr-CA,fr;q=0.9,en-US;q=0.8,en;q=0.7"), simple (e.g. "de") or locale-like (e.g. "de-CH" or "fr_BE") fashion. ### Responses #### 200 - response **queryables** - **queryables** (array (queryable)) (required) Array items: - **description** (string): a human-readable narrative describing the queryable - **language** (string): the language used for the title and description - **queryable** (string) (required): the token that may be used in a CQL predicate - **title** (string): a human readable title for the queryable - **type** (string) (required): the data type of the queryable - **type-ref** (string (url)): a reference to the formal definition of the type #### 400 - response #### 403 - response **Error** - **error** (object) - **code** (string) (required): Error code such as OVER_RATE_LIMIT, see https://api.data.gov/docs/developer-manual/#general-web-service-errors - **message** (string) (required): Error message - **response** (object) #### 404 - response #### 429 - response **Error** - **error** (object) - **code** (string) (required): Error code such as OVER_RATE_LIMIT, see https://api.data.gov/docs/developer-manual/#general-web-service-errors - **message** (string) (required): Error message - **response** (object) #### 500 - response ### Example Usage ```bash curl -X GET "https://api.waterdata.usgs.gov/ogcapi/v0/collections/parameter-codes/schema?f=json&lang=en-US" ``` ``` -------------------------------- ### GET /collections/parameter-codes/queryables Source: https://api.waterdata.usgs.gov/ogcapi/v0/openapi Parameter codes are 5-digit codes and associated descriptions used to identify the constituent measured and the units of measure. Some parameter code definitions include information about the sampling matrix, fraction, and methods used to measure the constituent. Some parameters are fixed-value (fxd) numeric codes having textual meaning (for example: parameter code 00041 is a weather code parameter, code of 60 means rain), but more commonly represent a numeric value for chemical, physical, or biological data. ```markdown ### Parameters - **properties** (array (string (id|parameter_name|unit_of_measure|parameter_group_code|parameter_description|medium|statistical_basis|time_basis|weight_basis|particle_size_basis|sample_fraction|temperature_basis|epa_equivalence)), query, optional): The properties that should be included. The parameter value is a comma-separated list of property names. - **f** (string (json|html|jsonld|csv), query, optional): The optional f parameter indicates the output format which the server shall provide as part of the response document. The default format is GeoJSON. CSV is also available. - **profile** (string (actual-domain|valid-domain), query, optional): The profile to be applied to a given request - **lang** (string (en-US), query, optional): The optional lang parameter instructs the server return a response in a certain language, if supported. If the language is not among the available values, the Accept-Language header language will be used if it is supported. If the header is missing, the default server language is used. Note that providers may only support a single language (or often no language at all), that can be different from the server language. Language strings can be written in a complex (e.g. "fr-CA,fr;q=0.9,en-US;q=0.8,en;q=0.7"), simple (e.g. "de") or locale-like (e.g. "de-CH" or "fr_BE") fashion. ### Responses #### 200 - response **queryables** - **queryables** (array (queryable)) (required) Array items: - **description** (string): a human-readable narrative describing the queryable - **language** (string): the language used for the title and description - **queryable** (string) (required): the token that may be used in a CQL predicate - **title** (string): a human readable title for the queryable - **type** (string) (required): the data type of the queryable - **type-ref** (string (url)): a reference to the formal definition of the type #### 400 - response #### 403 - response **Error** - **error** (object) - **code** (string) (required): Error code such as OVER_RATE_LIMIT, see https://api.data.gov/docs/developer-manual/#general-web-service-errors - **message** (string) (required): Error message - **response** (object) #### 404 - response #### 429 - response **Error** - **error** (object) - **code** (string) (required): Error code such as OVER_RATE_LIMIT, see https://api.data.gov/docs/developer-manual/#general-web-service-errors - **message** (string) (required): Error message - **response** (object) #### 500 - response ### Example Usage ```bash curl -X GET "https://api.waterdata.usgs.gov/ogcapi/v0/collections/parameter-codes/queryables?properties=item1,item2&f=json&profile=actual-domain&lang=en-US" ``` ``` -------------------------------- ### GET /collections/citations/items Source: https://api.waterdata.usgs.gov/ogcapi/v0/openapi Citations associated with water measurement methods. ```markdown ### Parameters - **f** (string (json|html|jsonld|csv), query, optional): The optional f parameter indicates the output format which the server shall provide as part of the response document. The default format is GeoJSON. - **lang** (string (en-US), query, optional): The optional lang parameter instructs the server return a response in a certain language, if supported. If the language is not among the available values, the Accept-Language header language will be used if it is supported. If the header is missing, the default server language is used. Note that providers may only support a single language (or often no language at all), that can be different from the server language. Language strings can be written in a complex (e.g. "fr-CA,fr;q=0.9,en-US;q=0.8,en;q=0.7"), simple (e.g. "de") or locale-like (e.g. "de-CH" or "fr_BE") fashion. - **bbox** (array (number), query, optional): Only features that have a geometry that intersects the bounding box are selected.The bounding box is provided as four or six numbers, depending on whether the coordinate reference system includes a vertical axis (height or depth). - **limit** (integer, query, optional): The optional limit parameter limits the number of items that are presented in the response document (maximum=50000, default=10000). - **crs** (string (uri), query, optional): Indicates the coordinate reference system for the results. - **bbox-crs** (string (uri), query, optional): Indicates the coordinate reference system for the given bbox coordinates. - **properties** (array (string (id|citation_description)), query, optional): The properties that should be included. The parameter value is a comma-separated list of property names. - **skipGeometry** (boolean, query, optional): This option can be used to skip response geometries for each feature. - **undefined** (string, query, optional) - **offset** (integer, query, optional): The optional offset parameter indicates the index within the result set from which the server shall begin presenting results in the response document. The first element has an index of 0 (default). - **id** (string, query, optional): Method citation name. An abbreviated citation that describes the reference. - **citation_description** (string, query, optional): Method citation description. - **filter** (string, query, optional): CQL Text filter expression. CQL JSON cannot be used here, only in the body. See also: https://docs.pygeoapi.io/en/latest/cql.html Example: time_series_id IN ('64ee32f5350a4ec4967435dcd2e364ea', '3e55d9c2d8a54bec9ca5e292b07d5a96') ### Responses #### 200 - response #### 400 - response #### 403 - response **Error** - **error** (object) - **code** (string) (required): Error code such as OVER_RATE_LIMIT, see https://api.data.gov/docs/developer-manual/#general-web-service-errors - **message** (string) (required): Error message - **response** (object) #### 404 - response #### 429 - response **Error** - **error** (object) - **code** (string) (required): Error code such as OVER_RATE_LIMIT, see https://api.data.gov/docs/developer-manual/#general-web-service-errors - **message** (string) (required): Error message - **response** (object) #### 500 - response ### Example Usage ```bash curl -X GET "https://api.waterdata.usgs.gov/ogcapi/v0/collections/citations/items?f=json&lang=en-US&bbox=item1,item2&limit=10000&crs=string&bbox-crs=string&properties=item1,item2&skipGeometry=false&offset=0&id=string&citation_description=string&filter=string" ``` ``` -------------------------------- ### OPTIONS /collections/method-categories/items Source: https://api.waterdata.usgs.gov/ogcapi/v0/openapi Categorical standards for methods describing the associated data's appropriateness for an intended use. ```markdown ### Responses #### 200 - options response Empty response body ### Example Usage ```bash curl -X OPTIONS "https://api.waterdata.usgs.gov/ogcapi/v0/collections/method-categories/items" ``` ```