---
title: "Get USGS water data"
method: POST
path: "/api/v1/get_water_data"
tags: ["earth"]
---

# Get USGS water data

`POST /api/v1/get_water_data`

## Request

- Base URL: `https://scholarmuse.ai`
- URL: `https://scholarmuse.ai/api/v1/get_water_data`
- Auth: HTTP bearer

Daily mean streamflow, gage height or water temperature from a USGS monitoring site in the United States, or a list of sites in a state or bounding box when no site number is given. Use the site list first if you do not know the site number.

Discipline pack: earth. Cost: 1 credit per successful call.

## Request body

- object
  - `site` string: USGS site number, e.g. 01646500 (Potomac River near Washington, DC).
  - `state` string: US state to list sites in: two-letter code (MD) or full name.
  - `bbox` number[]: Bounding box to list sites in: [west, south, east, north] in decimal degrees.
  - `parameter` 'streamflow' | 'gage_height' | 'water_temperature': What to measure (default streamflow).
  - `start` string: First day, YYYY-MM-DD. Default: 30 days before end.
  - `end` string: Last day, YYYY-MM-DD. Default: today.
  - `limit` integer: Sites to list when no site is given (default 20).

## Response `200`

The tool result.

- ToolResult
  - `summary` string, required
  - `billing` CreditStatus
    - `creditsRemaining` integer, nullable, required: Spendable, unexpired balance at checkedAt; null if refresh failed. Credits reserved by pending figures are excluded.
    - `status` 'ok' | 'low' | 'empty' | 'unavailable', required
    - `lowBalanceThreshold` integer, required
    - `topUpUrl` string, uri, required
    - `pricingUrl` string, uri, required
    - `checkedAt` string, date-time, required
    - `notice` string
  - `records` Record[]
    - `id` string, required
    - `type` string, required
    - `source` string, required
    - `title` string
    - `url` string
    - `license` string
    - `attribution` string
    - `retrievedAt` string, date-time, required
    - `data` object, required
  - `partial` boolean
  - `failedSources` object[]
    - `source` string
    - `error` string
  - `files` object[]
    - `name` string
    - `url` string
    - `mimeType` string
  - `extra` object
  - `credits_used` number, required
  - `call_id` string, required

## Other responses

- `400`: The call failed and was not charged.
- `401`: The call failed and was not charged.
- `402`: The call failed and was not charged.
- `429`: The call failed and was not charged.
- `502`: The call failed and was not charged.

---

[API](https://skmtc.dev/scholarmuse/apis/scholarmuse-rest-api.md) · [All operations](https://skmtc.dev/scholarmuse/apis/scholarmuse-rest-api/llms.txt) · [OpenAPI document](https://skmtc.dev/scholarmuse/apis/scholarmuse-rest-api/revisions/beafd92e4bfb?raw)
