tsgettoolbox - Quick Guide
The ‘tsgettoolbox’ is a Python script and library to get time-series data from different web services. The tsgettoolbox will work with Python and 3.10+.
Documentation
Reference documentation is at tsgettoolbox_documentation.
Installation
At the command line:
$ pip install tsgettoolbox
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 ‘coops’, type ‘tsgettoolbox coops –help’.
Sub-command |
Spatial Extent |
Time Extent |
Type |
Time Interval |
Description |
|---|---|---|---|---|---|
cdec |
US/CA |
varies |
station |
E,H,D,M |
California Department of Water Resources |
coops |
global |
varies |
station |
1T,6T,H, D,M |
Center for Operational Oceanographic Products and Services |
cpc DISCONTINUED |
US |
varies |
region |
W |
Climate Prediction Center |
daymet |
NAmerica |
1980- |
grid 1km |
D,M |
daily meteorology by the Oak Ridge National Laboratory |
fawn |
US/FL |
varies |
station |
15T,H,D, M |
Florida Automated Weather |
hydstra_ts |
varies |
varies |
station |
E,H,D,M |
Kisters Hydstra Webservice - time series values |
hydstrsa_catalog |
varies |
varies |
station |
-NA- |
Kisters Hydstra Webservice - variable catalog |
hydrstra_stations |
varies |
varies |
station |
-NA- |
Kisters Hydstra Webservice - station list |
ldas DEPRECATED use ldas_* functions below instead |
global |
varies |
grid |
varies |
Land Data Assimilation System |
ldas_gldas_noah |
global |
2000- |
grid 0.25deg |
3H |
GLDAS NOAH hydrology model results |
ldas_gldas_noah_v2_0 |
global |
1948- 2014 |
grid 0.25deg |
3H |
GLDAS NOAH hydrology model |
ldas_gldas_noah_v2_1 |
global |
2000- |
grid 0.25deg |
3H |
GLDAS NOAH hydrology model |
ldas_grace |
NAmerica |
2002- |
grid 0.125deg |
7D |
Groundwater and soil moisture from GRACE |
ldas_merra |
global |
1980- |
grid 0.5x 0.625deg |
H |
MERRA-2 Land surface |
ldas_nldas_fora |
NAmerica |
1979- |
grid 0.125deg |
H |
NLDAS Weather Forcing A (surface) |
ldas_nldas_noah |
NAmerica |
1979- |
grid 0.125deg |
H |
NLDAS NOAH hydrology model |
ldas_nldas_vic |
NAmerica |
1979- |
grid 0.125deg |
H |
NLDAS VIC hydrology model |
ldas_smerge |
global |
1997- |
grid 0.125deg |
D |
SMERGE-Noah-CCI root zone soil |
metdata |
NAmerica |
1980- |
grid 4km |
D |
Daily data from METDATA based on PRISM. |
modis |
global |
2000- |
grid 250m, 500m, 1000m |
4D,8D,16 D,A |
MODIS derived data |
ncei_ghcnd_ftp |
global |
varies |
station |
D |
NCEI Global Historical Climatology Network - Daily (GHCND) from FTP server. |
ncei_ghcnd |
global |
varies |
station |
D |
NCEI Global Historical Climatology Network - Daily (GHCND) from web services. |
ncei_gsod |
global |
varies |
station |
D |
NCEI Global Summary of the Day (GSOD) |
ncei_gsom |
global |
varies |
station |
M |
NCEI Global Summary of the Month (GSOM) |
ncei_gsoy |
global |
varies |
station |
A |
NCEI Global Summary of Year |
ncei_normal_ann |
global |
varies |
station |
A |
NCEI annual normals |
ncei_normal_dly |
global |
varies |
station |
D |
NCEI daily normals |
ncei_normal_hly |
global |
varies |
station |
H |
NCEI hourly normals |
ncei_normal_mly |
global |
varies |
station |
M |
NCEI monthly normals |
ncei_precip_15 |
global |
varies |
station |
15T |
NCEI 15 minute precipitation |
ncei_precip_hly |
global |
varies |
station |
H |
NCEI hourly precipitation |
ncei_annual |
global |
varies |
station |
A |
NCEI annual data summaries |
ncei_ghcndms |
global |
varies |
station |
M |
NCEI GHCND Monthly Summaries (GHCNDMS) |
ncei_ish |
global |
varies |
station |
H |
NCEI Integrated Surface hourly |
ndbc |
US |
varies |
station |
6T,10T, 15T,H,D |
National Data Buoy Center |
nwis DEPRECATED use nwis_* functions below instead. |
US |
varies |
station |
varies |
USGS National Water |
nwis_iv DEPRECATED: use wdfn_continuous |
US |
varies |
station |
E |
USGS NWIS Instantaneous Values |
nwis_dv DEPRECATED: use wdfn_daily |
US |
varies |
station |
D |
USGS NWIS Daily Values |
nwis_site DEPRECATED: use wdfn_monitoring_locations |
US |
varies |
station |
-NA- |
USGS NWIS Site Database |
nwis_gwlevels DEPRECATED: use wdfn_field_measurements |
US |
varies |
station |
varies |
USGS NWIS Groundwater |
nwis_measurements DEPRECATED: use wdfn_field_measurements |
US |
varies |
station |
varies |
USGS NWIS Measurements |
nwis_peak DEPRECATED: use wdfn_peaks |
US |
varies |
station |
varies |
USGS NWIS Peak |
nwis_stat DEPRECATED: use wdfn_read_normal_observations or wdfn_read_interval_observations |
US |
varies |
station |
varies |
USGS NWIS Statistic |
epa_wqp |
US |
varies |
station |
varies |
US EPA Water Quality |
rivergages |
US |
varies |
station |
varies |
USACE river gages |
terraclimate |
global |
varies |
grid 1/24deg |
M |
Monthly data from TerraClimate |
terraclimate19812010 |
global |
varies |
grid 1/24deg |
M |
Monthly normals using TerraClimate monthly data from 1981 to 2010 |
terraclimate19912020 |
global |
varies |
grid 1/24deg |
M |
Monthly normals using TerraClimate monthly data from 1991 to 2020 |
twc |
US/OK |
varies |
station |
D |
Texas Weather Connection (TWC) data |
unavco |
US |
varies |
station |
varies |
UNAVCO well data |
wdfn_agency_codes |
US |
varies |
station |
USGS WDFN Agency codes as table |
|
wdfn_altitude_datums |
US |
varies |
station |
USGS WDFN Altitude datums as table |
|
wdfn_aquifer_codes |
US |
varies |
station |
USGS WDFN Aquifer codes as table |
|
wdfn_aquifer_types |
US |
varies |
station |
USGS WDFN Aquifer types as table |
|
wdfn_channel_measurements |
US |
varies |
station |
E |
USGS WDFN Channel measurements as time- series |
wdfn_citations |
US |
varies |
station |
USGS WDFN Citations as table |
|
wdfn_combined_metadata |
US |
varies |
station |
USGS WDFN Combined metadata as table |
|
wdfn_continuous |
US |
varies |
station |
E |
USGS WDFN Continuous data as time-series |
wdfn_coordinate_accuracy_codes |
US |
varies |
station |
USGS WDFN Coordinate accuracy codes as table |
|
wdfn_coordinate_datum_codes |
US |
varies |
station |
USGS WDFN Coordinate datum codes as table |
|
wdfn_coordinate_method_codes |
US |
varies |
station |
USGS WDFN Coordinate method codes as table |
|
wdfn_counties |
US |
varies |
station |
USGS WDFN Counties as table |
|
wdfn_countries |
US |
varies |
station |
USGS WDFN Countries as table |
|
wdfn_daily |
US |
varies |
station |
D |
USGS WDFN Daily data as time-series |
wdfn_field_measurements |
US |
varies |
station |
E |
USGS WDFN Field measurements as time- series |
wdfn_field_measurements_metadata |
US |
varies |
station |
USGS WDFN Field measurements metadata as table |
|
wdfn_hydrologic_unit_codes |
US |
varies |
station |
USGS WDFN Hydrologic unit codes as table |
|
wdfn_latest_continuous |
US |
varies |
station |
E |
USGS WDFN Latest continuous data as time- series |
wdfn_latest_daily |
US |
varies |
station |
D |
USGS WDFN Latest daily data as time-series |
wdfn_latest_field_measurements |
US |
varies |
station |
E |
USGS WDFN Latest field measurements as time- series |
wdfn_medium_codes |
US |
varies |
station |
USGS WDFN Medium codes as table |
|
wdfn_method_categories |
US |
varies |
station |
USGS WDFN Method categories as table |
|
wdfn_method_citations |
US |
varies |
station |
USGS WDFN Method citations as table |
|
wdfn_methods |
US |
varies |
station |
USGS WDFN Methods as table |
|
wdfn_monitoring_locations |
US |
varies |
station |
USGS WDFN Monitoring locations as table |
|
wdfn_national_aquifer_codes |
US |
varies |
station |
USGS WDFN National aquifer codes as table |
|
wdfn_parameter_codes |
US |
varies |
station |
USGS WDFN Parameter codes as table |
|
wdfn_peaks |
US |
varies |
station |
E |
USGS WDFN Peaks as time- series |
wdfn_reliability_codes |
US |
varies |
station |
USGS WDFN Reliability codes as table |
|
wdfn_site_types |
US |
varies |
station |
USGS WDFN Site types as table |
|
wdfn_states |
US |
varies |
station |
USGS WDFN States as table |
|
wdfn_statistic_codes |
US |
varies |
station |
USGS WDFN Statistic codes as table |
|
wdfn_time_series_metadata |
US |
varies |
station |
USGS WDFN Time series metadata as table |
|
wdfn_time_series_methods |
US |
varies |
station |
USGS WDFN Time series methods as table |
|
wdfn_time_series_revisions |
US |
varies |
station |
E |
USGS WDFN Time series revisions as time-series |
wdfn_time_zone_codes |
US |
varies |
station |
USGS WDFN Time zone codes as table |
|
wdfn_read_normal_observations |
US |
varies |
station |
DM |
USGS WDFN Statistical normal observations |
wdfn_read_interval_observations |
US |
varies |
station |
MA |
USGS WDFN Statistical interval obs as time- series |
Time Interval Code |
Description |
|---|---|
E |
Event |
T |
Minute |
H |
Hourly |
D |
Daily |
M |
Monthly |
A |
Annual |
Usage Summary - Python Library
To use the tsgettoolbox in a project:
from tsgettoolbox import tsgettoolbox df = tsgettoolbox.wdfn_daily(monitoring_location_number="02329500", time="2000-01-01/..")
Refer to the API Documentation at tsgettoolbox_api.
Usage Summary - Command Line
tsgettoolbox wdfn_daily –monitoring_location_number 02329500 –time 2000-01-01/..
Refer to the command line documentation at tsgettoolbox_cli.
Development
Development is managed on bitbucket or github. https://bitbucket.org/timcera/tsgettoolbox/overview. https://github.com/timcera/tsgettoolbox
1 maintainer
Release files for tsgettoolbox 26.3.1
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-26.3.1.tar.gz | 19.7 MB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| tsgettoolbox-26.3.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 39.1 MB
Release files / tsgettoolbox-26.3.1.tar.gz
| Download URL | tsgettoolbox-26.3.1.tar.gz |
|---|---|
| Size | 19.7 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
91cbe5b086c59bba91c4fc7a382d5b72a4426de596ef1f251d7ab0c9a6f96865
|
|
BLAKE2b-256 checksum How to use checksums |
2fa64fcbdd0c32bdb78677d50fa56230551de5345c87401d0a9ff169f7700678
|
| 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 Sep 26, 2026.
Transparency logRelease files / tsgettoolbox-26.3.1-py3-none-any.whl
| Download URL | tsgettoolbox-26.3.1-py3-none-any.whl |
|---|---|
| Size | 19.4 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
bbbe3e0cc8a42c288bb9ed5916031a3c6832cb1dae19fa0d6ea3e10edb30acf2
|
|
BLAKE2b-256 checksum How to use checksums |
ae6249269d64e2b6c0924f391ba33bbca7bd3dee4b366eaacc17efd911bf8ca9
|
| 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 Sep 26, 2026.
Transparency log
