United States Army Corps of Engineers Parameters API

Physical parameters and units

OpenAPI Specification

united-states-army-corps-of-engineers-parameters-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: CWMS Data Basins Parameters API
  description: The Corps Water Management System (CWMS) Data API provides a RESTful interface for accessing water management data from the U.S. Army Corps of Engineers. This includes time series data, locations, levels, ratings, forecasts, projects, turbines, gates, and water supply information for USACE-managed water resources across the United States.
  version: 3.0.0
  contact:
    name: USACE CWMS Data API Support
    url: https://github.com/USACE/cwms-data-api
  license:
    name: MIT
    url: https://github.com/USACE/cwms-data-api/blob/develop/LICENSE.md
  x-tags:
  - Water Management
  - Federal Government
  - Hydrology
  - Engineering
servers:
- url: https://cwms-data.usace.army.mil/cwms-data
  description: Production CWMS Data API
- url: https://water.usace.army.mil/cwms-data
  description: Water Data Platform
tags:
- name: Parameters
  description: Physical parameters and units
paths:
  /parameters:
    get:
      operationId: getParameters
      summary: Get Parameters
      description: Returns the list of physical parameters available in the CWMS system (e.g., Stage, Flow, Precip, Temp).
      tags:
      - Parameters
      responses:
        '200':
          description: List of CWMS parameters
          content:
            application/json:
              schema:
                type: object
  /units:
    get:
      operationId: getUnits
      summary: Get Units
      description: Returns the list of measurement units available in the CWMS system.
      tags:
      - Parameters
      parameters:
      - name: format
        in: query
        required: false
        description: Response format
        schema:
          type: string
      responses:
        '200':
          description: List of measurement units
          content:
            application/json:
              schema:
                type: object
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: JWT Bearer token for authenticated operations (create, update, delete). Obtain a token from the CWMS authorization endpoint.