{
  "opencollection": "1.0.0",
  "info": {
    "name": "USGS Water Data OGC APIs agency-codes hydrologic-unit-codes API",
    "version": "0.56.0"
  },
  "items": [
    {
      "info": {
        "name": "hydrologic-unit-codes",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get Hydrologic unit codes (HUCs) metadata",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.waterdata.usgs.gov/ogcapi/v0/collections/hydrologic-unit-codes",
            "params": [
              {
                "name": "f",
                "value": "",
                "type": "query",
                "description": "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."
              },
              {
                "name": "lang",
                "value": "",
                "type": "query",
                "description": "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."
              }
            ]
          },
          "docs": "Hydrologic units are geographic areas representing part or all of a surface drainage basin or distinct hydrologic feature identified by a unique number (HUC), and a name. The United States is divided and sub-divided into successively smaller hydrologic units which are classified into four levels: regions, sub-regions, accounting units, and cataloging units. Each unit consists of two to eight digits based on the four levels of classification in the hydrologic unit system. Additional information c"
        },
        {
          "info": {
            "name": "Get Hydrologic unit codes (HUCs) items",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.waterdata.usgs.gov/ogcapi/v0/collections/hydrologic-unit-codes/items",
            "params": [
              {
                "name": "f",
                "value": "",
                "type": "query",
                "description": "The optional f parameter indicates the output format which the server shall provide as part of the response document.  The default format is GeoJSON."
              },
              {
                "name": "lang",
                "value": "",
                "type": "query",
                "description": "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."
              },
              {
                "name": "bbox",
                "value": "",
                "type": "query",
                "description": "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)."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "The optional limit parameter limits the number of items that are presented in the response document (maximum=50000, default=10000)."
              },
              {
                "name": "crs",
                "value": "",
                "type": "query",
                "description": "Indicates the coordinate reference system for the results."
              },
              {
                "name": "bbox-crs",
                "value": "",
                "type": "query",
                "description": "Indicates the coordinate reference system for the given bbox coordinates."
              },
              {
                "name": "properties",
                "value": "",
                "type": "query",
                "description": "The properties that should be included. The parameter value is a comma-separated list of property names."
              },
              {
                "name": "skipGeometry",
                "value": "",
                "type": "query",
                "description": "This option can be used to skip response geometries for each feature."
              },
              {
                "name": "offset",
                "value": "",
                "type": "query",
                "description": "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)."
              },
              {
                "name": "id",
                "value": "",
                "type": "query",
                "description": "Hydrologic unit code. The format of the code is ('RRSSBBUUWWXX') where: 'RR' is the 2-digit code for the region. 'SS' is the 2-digit code for the sub-region. 'BB' is the 2-digit code for the basin. 'UU' is the 2-digit code for the sub-basin. 'WW' is the 2-digit code for the watershed. 'XX' is the 2-digit code for the sub-watershed. Watersheds are delineated by USGS using a nationwide system based on surface hydrologic features. This system divides the country into 22 regions (2-digit), 245 subregions (4-digit), 405 basins (6-digit), ~2,400 subbasins (8-digit), ~19,000 watersheds (10-digit), and ~105,000 subwatersheds (12-digit). A hierarchical hydrologic unit code (HUC) consisting of 2 additional digits for each level in the hydrologic unit system is used to identify any hydrologic area (see Federal Standards and Procedures for the National Watershed Boundary Dataset - https://pubs.usgs.gov/tm/11/a3/)."
              },
              {
                "name": "hydrologic_unit_name",
                "value": "",
                "type": "query",
                "description": "Hydrologic unit name."
              },
              {
                "name": "hydrologic_unit_classification_code",
                "value": "",
                "type": "query",
                "description": "Hydrologic unit classification code."
              },
              {
                "name": "filter",
                "value": "",
                "type": "query",
                "description": "CQL Text filter expression.  CQL JSON cannot be used here, only in the body. \nSee also: https://docs.pygeoapi.io/en/latest/cql.html \n\nExample: time_series_id IN ('64ee32f5350a4ec4967435dcd2e364ea', '3e55d9c2d8a54bec9ca5e292b07d5a96')"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "api_key",
              "value": "{{api_key}}",
              "placement": "query"
            }
          },
          "docs": "Hydrologic units are geographic areas representing part or all of a surface drainage basin or distinct hydrologic feature identified by a unique number (HUC), and a name. The United States is divided and sub-divided into successively smaller hydrologic units which are classified into four levels: regions, sub-regions, accounting units, and cataloging units. Each unit consists of two to eight digits based on the four levels of classification in the hydrologic unit system. Additional information c"
        },
        {
          "info": {
            "name": "Get Hydrologic unit codes (HUCs) items with CQL2",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.waterdata.usgs.gov/ogcapi/v0/collections/hydrologic-unit-codes/items",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "api_key",
              "value": "{{api_key}}",
              "placement": "query"
            }
          },
          "docs": "Hydrologic units are geographic areas representing part or all of a surface drainage basin or distinct hydrologic feature identified by a unique number (HUC), and a name. The United States is divided and sub-divided into successively smaller hydrologic units which are classified into four levels: regions, sub-regions, accounting units, and cataloging units. Each unit consists of two to eight digits based on the four levels of classification in the hydrologic unit system. Additional information c"
        },
        {
          "info": {
            "name": "Options for Hydrologic unit codes (HUCs) items",
            "type": "http"
          },
          "http": {
            "method": "OPTIONS",
            "url": "https://api.waterdata.usgs.gov/ogcapi/v0/collections/hydrologic-unit-codes/items",
            "auth": {
              "type": "apikey",
              "key": "api_key",
              "value": "{{api_key}}",
              "placement": "query"
            }
          },
          "docs": "Hydrologic units are geographic areas representing part or all of a surface drainage basin or distinct hydrologic feature identified by a unique number (HUC), and a name. The United States is divided and sub-divided into successively smaller hydrologic units which are classified into four levels: regions, sub-regions, accounting units, and cataloging units. Each unit consists of two to eight digits based on the four levels of classification in the hydrologic unit system. Additional information c"
        },
        {
          "info": {
            "name": "Get Hydrologic unit codes (HUCs) item by id",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.waterdata.usgs.gov/ogcapi/v0/collections/hydrologic-unit-codes/items/:featureId",
            "params": [
              {
                "name": "crs",
                "value": "",
                "type": "query",
                "description": "Indicates the coordinate reference system for the results."
              },
              {
                "name": "f",
                "value": "",
                "type": "query",
                "description": "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."
              },
              {
                "name": "lang",
                "value": "",
                "type": "query",
                "description": "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."
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "api_key",
              "value": "{{api_key}}",
              "placement": "query"
            }
          },
          "docs": "Hydrologic units are geographic areas representing part or all of a surface drainage basin or distinct hydrologic feature identified by a unique number (HUC), and a name. The United States is divided and sub-divided into successively smaller hydrologic units which are classified into four levels: regions, sub-regions, accounting units, and cataloging units. Each unit consists of two to eight digits based on the four levels of classification in the hydrologic unit system. Additional information c"
        },
        {
          "info": {
            "name": "Options for Hydrologic unit codes (HUCs) item by id",
            "type": "http"
          },
          "http": {
            "method": "OPTIONS",
            "url": "https://api.waterdata.usgs.gov/ogcapi/v0/collections/hydrologic-unit-codes/items/:featureId",
            "auth": {
              "type": "apikey",
              "key": "api_key",
              "value": "{{api_key}}",
              "placement": "query"
            }
          },
          "docs": "Hydrologic units are geographic areas representing part or all of a surface drainage basin or distinct hydrologic feature identified by a unique number (HUC), and a name. The United States is divided and sub-divided into successively smaller hydrologic units which are classified into four levels: regions, sub-regions, accounting units, and cataloging units. Each unit consists of two to eight digits based on the four levels of classification in the hydrologic unit system. Additional information c"
        },
        {
          "info": {
            "name": "Get Hydrologic unit codes (HUCs) queryables",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.waterdata.usgs.gov/ogcapi/v0/collections/hydrologic-unit-codes/queryables",
            "params": [
              {
                "name": "properties",
                "value": "",
                "type": "query",
                "description": "The properties that should be included. The parameter value is a comma-separated list of property names."
              },
              {
                "name": "f",
                "value": "",
                "type": "query",
                "description": "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."
              },
              {
                "name": "profile",
                "value": "",
                "type": "query",
                "description": "The profile to be applied to a given request"
              },
              {
                "name": "lang",
                "value": "",
                "type": "query",
                "description": "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."
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "api_key",
              "value": "{{api_key}}",
              "placement": "query"
            }
          },
          "docs": "Hydrologic units are geographic areas representing part or all of a surface drainage basin or distinct hydrologic feature identified by a unique number (HUC), and a name. The United States is divided and sub-divided into successively smaller hydrologic units which are classified into four levels: regions, sub-regions, accounting units, and cataloging units. Each unit consists of two to eight digits based on the four levels of classification in the hydrologic unit system. Additional information c"
        },
        {
          "info": {
            "name": "Get Hydrologic unit codes (HUCs) schema",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.waterdata.usgs.gov/ogcapi/v0/collections/hydrologic-unit-codes/schema",
            "params": [
              {
                "name": "f",
                "value": "",
                "type": "query",
                "description": "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."
              },
              {
                "name": "lang",
                "value": "",
                "type": "query",
                "description": "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."
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "api_key",
              "value": "{{api_key}}",
              "placement": "query"
            }
          },
          "docs": "Hydrologic units are geographic areas representing part or all of a surface drainage basin or distinct hydrologic feature identified by a unique number (HUC), and a name. The United States is divided and sub-divided into successively smaller hydrologic units which are classified into four levels: regions, sub-regions, accounting units, and cataloging units. Each unit consists of two to eight digits based on the four levels of classification in the hydrologic unit system. Additional information c"
        }
      ]
    }
  ],
  "bundled": true
}