This release is a pre-release and may not be stable for production use.
Water OGC API: Water Data Client for the USGS Services
An async-first Python client for USGS water data services over OGC API Features.
Status: early development. The async transport exists and the query API is in progress. The release candidate on PyPI only reserves the name and has no query API, so install from this repository until the first final release.
Features
- Native async over HTTP/2, with bounded concurrency.
- Retries transient failures with exponential backoff and honors
Retry-After. - Two direct runtime dependencies,
httpx2andh2. No pandas.
Services
| Service | Base URL |
|---|---|
| NWIS | api.waterdata.usgs.gov/ogcapi/v1 |
| FabricData | api.water.usgs.gov/fabric/pygeoapi |
| GeoConnex | reference.geoconnex.us |
Installation
water-ogcapi is not on PyPI or conda-forge yet. Install the development version from GitHub (Python 3.12 or later):
pip install git+https://github.com/hyriver/water-ogcapi
Quick start
The query API is in progress, so there is no runnable example yet. In its planned shape,
iter_pages() streams each page as it arrives and collect() returns one result
holding the aggregated GeoJSON and the evidence for every page. The
design decisions (D-02 and D-03)
describe it.
Documentation
The documentation has the API reference, a logging guide, and the design decisions behind the library. Example notebooks arrive with the query API.
Roadmap
The roadmap shows the progress on each GitHub milestone, regenerated daily from the milestone issues.
Contributing
Report bugs and ask questions in GitHub issues. The contributing guide covers the development setup, the checks a change must pass, and the project conventions.
License
MIT. See LICENSE.
1 maintainer
Metadata
1 maintainer
Release files for water-ogcapi 0.1.0rc1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| water_ogcapi-0.1.0rc1.tar.gz | 190.0 kB | With provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| water_ogcapi-0.1.0rc1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 207.8 kB
Release files / water_ogcapi-0.1.0rc1.tar.gz
| Download URL | water_ogcapi-0.1.0rc1.tar.gz |
|---|---|
| Size | 190.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
54cf0df7f64dd0c31af3697f126989cbee32a1e3d909530f93bb876d87f7a2bb
|
|
BLAKE2b-256 checksum How to use checksums |
1977b7405748b794087578603ddd393e39b4e94b92749c3aad5342dae597f936
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.12.24 {"installer":{"name":"uv","version":"0.12.24","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 9, 2026.
Transparency logRelease files / water_ogcapi-0.1.0rc1-py3-none-any.whl
| Download URL | water_ogcapi-0.1.0rc1-py3-none-any.whl |
|---|---|
| Size | 17.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
d02c02e48a8a376b40476faac18951f4627b5f7bb1ac7c671535ec197abe8d28
|
|
BLAKE2b-256 checksum How to use checksums |
18a5a80ade572590948ed29618d316feb67c4eb14beb4ce550f8acf64119a599
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.12.24 {"installer":{"name":"uv","version":"0.12.24","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 9, 2026.
Transparency logSecurity for water-ogcapi 0.1.0rc1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
All 2 files in this release have been uploaded with provenance metadata.
Attestation for water_ogcapi-0.1.0rc1.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 9, 2026.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
