USGS Water Data APIs — Time Series Data

naftiko: 1.0.0-alpha2
info:
  label: USGS Water Data APIs — Time Series Data
  description: 'USGS Water Data APIs — Time Series Data. 1 operations. Lead operation: USGS Water Data Get Time Series. Self-contained
    Naftiko capability covering one U S Geological Survey business surface.'
  tags:
  - U S Geological Survey
  - Time Series Data
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    U_S_GEOLOGICAL_SURVEY_API_KEY: U_S_GEOLOGICAL_SURVEY_API_KEY
capability:
  consumes:
  - type: http
    namespace: usgs-water-data-time-series-data
    baseUri: https://api.waterdata.usgs.gov/ogcapi/v0
    description: USGS Water Data APIs — Time Series Data business capability. Self-contained, no shared references.
    resources:
    - name: collections-time-series-items
      path: /collections/time-series/items
      operations:
      - name: gettimeseries
        method: GET
        description: USGS Water Data Get Time Series
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: monitoringLocationIdentifier
          in: query
          type: string
          description: Filter by specific monitoring location identifier (e.g., USGS-11169025).
        - name: observedPropertyId
          in: query
          type: string
          description: USGS parameter code for the measured property (e.g., 00060 for streamflow in cfs, 00065 for gage height
            in feet).
        - name: statistic
          in: query
          type: string
          description: Statistic code for daily values (00001=max, 00002=min, 00003=mean).
    authentication:
      type: apikey
      key: api_key
      value: '{{env.U_S_GEOLOGICAL_SURVEY_API_KEY}}'
      placement: query
  exposes:
  - type: rest
    namespace: usgs-water-data-time-series-data-rest
    port: 8080
    description: REST adapter for USGS Water Data APIs — Time Series Data. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/collections/time-series/items
      name: collections-time-series-items
      description: REST surface for collections-time-series-items.
      operations:
      - method: GET
        name: gettimeseries
        description: USGS Water Data Get Time Series
        call: usgs-water-data-time-series-data.gettimeseries
        with:
          monitoringLocationIdentifier: rest.monitoringLocationIdentifier
          observedPropertyId: rest.observedPropertyId
          statistic: rest.statistic
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: usgs-water-data-time-series-data-mcp
    port: 9090
    transport: http
    description: MCP adapter for USGS Water Data APIs — Time Series Data. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: usgs-water-data-get-time
      description: USGS Water Data Get Time Series
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: usgs-water-data-time-series-data.gettimeseries
      with:
        monitoringLocationIdentifier: tools.monitoringLocationIdentifier
        observedPropertyId: tools.observedPropertyId
        statistic: tools.statistic
      outputParameters:
      - type: object
        mapping: $.