API Reference

module NWIS

Provides functions for retrieving legacy data from the National Water Information System (NWIS). Includes functions to retrieve daily values (dv), instantaneous values (iv), and site metadata.

Note: Legacy NWIS services are being decommissioned by the USGS. Users are encouraged to migrate to the modernized DataRetrieval.WaterData functions (e.g., WaterData.daily, WaterData.continuous, WaterData.samples) which use the new Water Data APIs.

module WQP

Provides functions for retrieving data from the Water Quality Portal (WQP). Includes functions to retrieve results, sites, organizations, projects, activities, detection limits, habitat metrics, project weights, and activity metrics.

module WaterData

Provides functions for retrieving data from the modernized USGS Water Data API and Samples API. Includes functions for generic OGC API retrieval, daily values (daily), continuous values (continuous), monitoring locations, field measurements, series metadata, and chemical sample results (samples, results).

module NLDI

Provides functions for retrieving data from the Network Linked Data Index (NLDI) API. Includes functions to navigate flowlines (flowlines), find upstream/downstream basin boundaries (basin), and discover linked features (features and search).

Note: If you wish to receive spatial features as genuine GeoDataFrames instead of standard Julia DataFrames containing raw GeoJSON geometries, you must add and load GeoDataFrames.jl in your environment (using GeoDataFrames).

url(site_numbers; kwargs...)

Function to construct a Nwis URL based on the different available parameters.

dv(site_numbers, parameter_cd; start_date="", end_date="", stat_cd="00003", format="rdb")

Function to obtain daily value data from the Nwis web service.

pcode(pcodes)

Function to obtain parameter code information from the Nwis web service.

qwdata(site_numbers; start_date="", end_date="", format="rdb", expanded=true)

site(site_numbers)

Function to obtain site information from the Nwis web service.

iv(site_numbers, parameter_cd; start_date="", end_date="", format="rdb")

Function to obtain instantaneous value data from the Nwis web service.

iv(site_numbers, parameter_cd; start_date="", end_date="", format="rdb")

Function to obtain instantaneous value data from the Nwis web service.

iv(site_numbers, parameter_cd; start_date="", end_date="", format="rdb")

Function to obtain instantaneous value data from the Nwis web service.

url(service; legacy=true)

Function to construct the URL for the Wqp service.

data(service; legacy=true, ssl_check=true, kwargs...)

results(; legacy=true, ssl_check=true, kwargs...)

sites(; legacy=true, ssl_check=true, kwargs...)

organizations(; legacy=true, ssl_check=true, kwargs...)

projects(; legacy=true, ssl_check=true, kwargs...)

activities(; legacy=true, ssl_check=true, kwargs...)

detection_limits(; legacy=true, ssl_check=true, kwargs...)

habitat_metrics(; legacy=true, ssl_check=true, kwargs...)

project_weights(; legacy=true, ssl_check=true, kwargs...)

activity_metrics(; legacy=true, ssl_check=true, kwargs...)

samples(; ssl_check=true, service="results", profile="fullphyschem", kwargs...)

Flexible query of the USGS Samples database.

data(service; cql=nothing, ssl_check=true, kwargs...)

Generalized USGS Waterdata OGC retrieval for any supported collection.

codes(code_service; ssl_check=true)

Return code values from a USGS Samples code-service endpoint.

checkogcrequests(; endpoint="daily", requesttype="queryables", sslcheck=true)

Request OGC collection metadata (queryables or schema) for a Waterdata collection.

ogcparams(service; sslcheck=true)

Get parameter descriptions for a Waterdata OGC collection using the collection schema endpoint.

results(; profile="fullphyschem", kwargs...)

Query the USGS Samples database for measurement results.

locations(; profile="site", kwargs...)

Query the USGS Samples database for monitoring locations.

activities(; profile="sampact", kwargs...)

Query the USGS Samples database for field activities.

projects(; profile="project", kwargs...)

Query the USGS Samples database for monitoring projects.

organizations(; profile="organization", kwargs...)

Query the USGS Samples database for organizations.

daily(; ssl_check=true, kwargs...)

Get daily observations from the USGS Waterdata OGC API (daily collection).

continuous(; ssl_check=true, kwargs...)

Get continuous observations from the USGS Waterdata OGC API (continuous collection).

monitoring_locations(; ssl_check=true, kwargs...)

Query monitoring-location metadata from the USGS Waterdata OGC API.

series_metadata(; ssl_check=true, kwargs...)

Query time-series metadata from the USGS Waterdata OGC API.

latest_continuous(; ssl_check=true, kwargs...)

Query the most recent continuous observation for each matching time series.

latest_daily(; ssl_check=true, kwargs...)

Query the most recent daily observation for each matching time series.

field_measurements(; ssl_check=true, kwargs...)

Query field-measurement observations from the USGS Waterdata OGC API.

channel_measurements(; ssl_check=true, kwargs...)

Query channel-measurement observations from the USGS Waterdata OGC API.

field_metadata(; ssl_check=true, kwargs...)

Query field-measurement metadata from the USGS Waterdata OGC API.

combined_metadata(; ssl_check=true, kwargs...)

Query combined site and time-series metadata from the USGS Waterdata OGC API.

reference_table(collection; query=Dict(), ssl_check=true)

Fetch a Waterdata metadata reference table from the OGC API.

stats_por(; ssl_check=true, expand_percentiles=true, kwargs...)

Query period-of-record statistics from the Waterdata statistics API.

stats_date_range(; ssl_check=true, expand_percentiles=true, kwargs...)

Query interval-based statistics from the Waterdata statistics API.

flowlines(navigation_mode; comid=nothing, distance=5, feature_source=nothing, feature_id=nothing, stop_comid=nothing, trim_start=false, as_json=false)

basin(feature_source, feature_id; simplified=true, split_catchment=false, as_json=false)

features(; data_source=nothing, navigation_mode=nothing, distance=50, feature_source=nothing, feature_id=nothing, comid=nothing, lat=nothing, long=nothing, as_json=false)

search(; feature_source=nothing, feature_id=nothing, navigation_mode=nothing, data_source=nothing, find="features", comid=nothing, lat=nothing, long=nothing, distance=50, as_json=false)

set_token!(token::AbstractString)

Set a USGS WaterData API token for this Julia session. The token is attached to requests as the X-Api-Key header and takes precedence over the API_USGS_PAT environment variable.

clear_token!()

Clear the session token set by set_token!. If API_USGS_PAT is present in the environment, requests will continue to use that value.