tsgettoolbox_nwis - Quick Guide
DEPRECATED: Replaced by the functions in the ‘tsgettoolbox_wdfn’ plugin.
USGS will remove the NWIS web service that ‘tsgettoolbox_nwis’ uses between 11-2026 and 02-2027. The ‘tsgettoolbox_nwis’ plugin will be removed from the tsgettoolbox package at that time. Users should transition to the ‘tsgettoolbox_wdfn’ functions.
The ‘tsgettoolbox_nwis’ is a plugin-in for ‘tsgettoolbox’ that supplies a command line interface and Python library to get time-series data from the USGS National Water Information System (WSIS). The tsgettoolbox_nwis will work with Python 3.10+.
Documentation
Reference documentation is at tsgettoolbox_documentation.
Installation
At the command line:
$ pip install tsgettoolbox_nwis
Usage Summary - Command Line
Just run ‘tsgettoolbox –help’ to get a list of subcommands. To get detailed help for a particular sub-command, for instance ‘nwis’, type ‘tsgettoolbox nwis –help’.
Sub-command |
Spatial Extent |
Time Extent |
Type |
Time Interval |
Description |
|---|---|---|---|---|---|
tsgettoolbox_nwis DEPRECATED use wdfn_* functions from tsgetoolbox_wdfn instead. |
US |
varies |
station |
varies |
USGS National Water |
nwis_iv DEPRECATED: use tsgettoolbox_wdfn. wdfn_continuous |
US |
varies |
station |
E |
USGS NWIS Instantaneous Values |
nwis_dv DEPRECATED: use tsgettoolbox_wdfn.wdfn_daily |
US |
varies |
station |
D |
USGS NWIS Daily Values |
nwis_site DEPRECATED: use tsgettoolbox_wdfn. wdfn_monitoring_locations |
US |
varies |
station |
-NA- |
USGS NWIS Site Database |
nwis_gwlevels DEPRECATED: use tsgettoolbox_wdfn. wdfn_field_measurements |
US |
varies |
station |
varies |
USGS NWIS Groundwater |
nwis_measurements DEPRECATED: use tsgettoolbox_wdfn. wdfn_field_measurements |
US |
varies |
station |
varies |
USGS NWIS Measurements |
nwis_peak DEPRECATED: use tsgettoolbox_wdfn.wdfn_peaks |
US |
varies |
station |
varies |
USGS NWIS Peak |
nwis_stat DEPRECATED: use tsgettoolbox_wdfn. wdfn_read_normal_observations or tsgettoolbox_wdfn. wdfn_read_interval_observations |
US |
varies |
station |
varies |
USGS NWIS Statistic |
Time Interval Code |
Description |
|---|---|
E |
Event |
D |
Daily |
Usage Summary - Python Library
To use the tsgettoolbox in a project:
from tsgettoolbox import tsgettoolbox df = tsgettoolbox.nwis_dv(sites="02325000", startDT="2015-07-01", endDT="2015-07-30") print(df.head())
Refer to the API Documentation at tsgettoolbox_api.
Usage Summary - Command Line
- tsgettoolbox nwis_dv
–sites 02325000 –startDT 2015-07-01 –endDT 2015-07-30 > output.csv
Refer to the command line documentation at tsgettoolbox_cli.
Development
Development is managed on bitbucket or github. https://bitbucket.org/timcera/tsgettoolbox_nwis/overview. https://github.com/timcera/tsgettoolbox_nwis
1 maintainer
Metadata
1 maintainer
Release files for tsgettoolbox-nwis 27.0.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| tsgettoolbox_nwis-27.0.0.tar.gz | 31.7 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| tsgettoolbox_nwis-27.0.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 57.6 kB
Release files / tsgettoolbox_nwis-27.0.0.tar.gz
| Download URL | tsgettoolbox_nwis-27.0.0.tar.gz |
|---|---|
| Size | 31.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
db1db8ed1dd8584d256651c6f4d41dfc68a5b67f6d2a3099bf8aa5478b03aca4
|
|
BLAKE2b-256 checksum How to use checksums |
5642d1ba5c2537105550e4963a7a266db9720b6b2576159797fcf2e20f65ee3d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
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 15, 2026.
Transparency logRelease files / tsgettoolbox_nwis-27.0.0-py3-none-any.whl
| Download URL | tsgettoolbox_nwis-27.0.0-py3-none-any.whl |
|---|---|
| Size | 25.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
af2b82727ba80e954713a96a7f41d5bff61824d91b63ca128f88a7dc7593c3df
|
|
BLAKE2b-256 checksum How to use checksums |
dd9eef262c3cb8b9c1b99883295993a4a21fb98a4b2355f68aa467569e905b67
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
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 15, 2026.
Transparency log
