{"id":47634254,"url":"https://github.com/yieldhog/usgs_streamflow","last_synced_at":"2026-04-02T00:00:17.649Z","repository":{"id":346223885,"uuid":"1188991896","full_name":"yieldhog/usgs_streamflow","owner":"yieldhog","description":"Home Assistant integration for real-time USGS stream gauge data (flow, gauge height, water temperature)","archived":false,"fork":false,"pushed_at":"2026-03-22T23:09:31.000Z","size":73,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-03-23T14:11:37.925Z","etag":null,"topics":["hacs","hacs-integration","home-assistant","streamflow","usgs"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/yieldhog.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2026-03-22T21:13:05.000Z","updated_at":"2026-03-22T23:09:35.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/yieldhog/usgs_streamflow","commit_stats":null,"previous_names":["yieldhog/usgs_streamflow"],"tags_count":5,"template":false,"template_full_name":null,"purl":"pkg:github/yieldhog/usgs_streamflow","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yieldhog%2Fusgs_streamflow","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yieldhog%2Fusgs_streamflow/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yieldhog%2Fusgs_streamflow/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yieldhog%2Fusgs_streamflow/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/yieldhog","download_url":"https://codeload.github.com/yieldhog/usgs_streamflow/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yieldhog%2Fusgs_streamflow/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31293139,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-01T21:15:39.731Z","status":"ssl_error","status_checked_at":"2026-04-01T21:15:34.046Z","response_time":53,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["hacs","hacs-integration","home-assistant","streamflow","usgs"],"created_at":"2026-04-02T00:00:14.788Z","updated_at":"2026-04-02T00:00:17.555Z","avatar_url":"https://github.com/yieldhog.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# USGS Streamflow for Home Assistant\n\n[![hacs_badge](https://img.shields.io/badge/HACS-Custom-orange.svg)](https://github.com/hacs/integration)\n[![GitHub Release](https://img.shields.io/github/release/yieldhog/usgs_streamflow.svg)](https://github.com/yieldhog/usgs_streamflow/releases)\n![HA Version](https://img.shields.io/badge/Home%20Assistant-%3E%3D%202026.3-brightgreen)\n\nA Home Assistant integration that pulls real-time streamflow data from the [USGS National Water Information System (NWIS)](https://waterservices.usgs.gov/) for any active stream gauge in the United States.\n\n## Features\n\n- **Search by name or site number** — find any active USGS stream gauge via the setup wizard\n- **Up to 3 sensors per gauge** — Gauge Height (ft), Discharge (ft³/s), and Water Temperature (°C) where available\n- **Station Status sensor** — shows `Active` or `Offline` so seasonal/winter shutdowns are handled cleanly\n- **Proper unavailability handling** — sensors mark as `Unavailable` (not `Unknown`) when a gauge is seasonally decommissioned\n- **Polled every 15 minutes** — matches USGS data update frequency\n- **Multiple gauges** — add as many stations as you want, each becomes its own device\n\n## Requirements\n\n- Home Assistant 2026.3 or newer\n- HACS installed\n\n## Installation\n\n### Via HACS (recommended)\n\n1. Open HACS in your Home Assistant instance\n2. Click the three-dot menu → **Custom repositories**\n3. Add `https://github.com/yieldhog/usgs_streamflow` as an **Integration**\n4. Find **USGS Streamflow** in HACS and click **Download**\n5. Restart Home Assistant\n\n### Manual\n\n1. Download the latest release zip from the [releases page](https://github.com/yieldhog/usgs_streamflow/releases)\n2. Extract and copy the `custom_components/usgs_streamflow` folder into your HA `config/custom_components/` directory\n3. Restart Home Assistant\n\n## Setup\n\n1. Go to **Settings → Devices \u0026 Services → Add Integration**\n2. Search for **USGS Streamflow**\n3. Enter a stream or station name (e.g. `Bear Creek`) and a two-letter state code (e.g. `CO`)\n   - You can also paste a USGS site number directly (e.g. `06711565`) — no state code needed\n   - Not sure of your site number? [Search on the USGS Water Resources site](https://waterdata.usgs.gov/nwis/rt)\n4. Pick your gauge from the results list\n5. Repeat to add additional gauges\n\n## Sensors\n\nEach configured gauge creates a device with up to 4 entities:\n\n| Entity | Unit | Notes |\n|--------|------|-------|\n| Gauge Height | ft | Water level above the gauge datum |\n| Discharge | ft³/s | Volumetric flow rate (CFS) |\n| Water Temperature | °C | Not available at all gauges |\n| Station Status | — | `Active` or `Offline` |\n\nThe Station Status entity stays active even when the gauge is offline for the season, and includes an `offline_reason` attribute explaining why.\n\nMeasurement sensors for parameters a gauge never reports (e.g., Water Temperature at a gauge with no thermistor) will show as `Unavailable` after the first successful data fetch.\n\n## Data Source\n\nAll data comes from the [USGS NWIS Instantaneous Values API](https://waterservices.usgs.gov/rest/IV-Service.html), which is free and requires no API key.\n\n## Contributing\n\nIssues and pull requests welcome at [github.com/yieldhog/usgs_streamflow](https://github.com/yieldhog/usgs_streamflow).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyieldhog%2Fusgs_streamflow","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fyieldhog%2Fusgs_streamflow","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyieldhog%2Fusgs_streamflow/lists"}