datasources

datasources

Extends the data sources on the framework to the data module.

Source:

Namespaces

CUAHSI

Members

(static) AEMET :Object

AEMET: API REST from the Spanish Meteorological Service. For more information about the service, please visit: https://opendata.aemet.es/dist/index.html?#!/observacion-convencional/Datos_de_observaci%C3%B3n_Tiempo_actual_1 Note: Different data sources may have different limitations -> E.g., they may limit the # of queries per unit time AEMET requires registration to get KEY and must be included in parameters. The API KEY has format 'api_key'. Dates in format YYYY-MM-DDThh:mm:ss

Type:
  • Object
Source:

(static) AORC :Object

NOAA AORC (Analysis of Record for Calibration) datasource Provides access to high-resolution meteorological forcing data stored in Zarr format on S3.

Data Information:

  • Source: NOAA NWS
  • Format: Zarr (accessed via S3)
  • Resolution: 1km roughly (0.008333 deg), Hourly
  • Coverage: CONUS, some transboundary

Available Data Types:

  • point-data: Extract time series for a single lat/lon coordinate for specific variables.
  • grid-data: Extract a spatial subset (bounding box) for specific variables and time.
  • timeseries-data: Extract time series for multiple locations.
  • bulk-extraction: Large scale extraction (caution: data heavy).

Key Variables:

  • APCP_surface: Total Precipitation (kg/m²)
  • TMP_2maboveground: Temperature at 2m (K)
  • DSWRF_surface: Short-wave Radiation (W/m²)
  • DLWRF_surface: Long-wave Radiation (W/m²)
Type:
  • Object
Source:
Examples
// 1. Retrieve Point Data (Precipitation & Temperature) for specific location/time
const pointData = await hydro.data.retrieve({
  params: {
    source: 'aorc',
    datatype: 'point-data'
  },
  args: {
    dataset: 'aorc-v1.1',
    variables: ['APCP_surface', 'TMP_2maboveground'],
    latitude: 40.7128,
    longitude: -74.0060,
    startDate: '2020-01-01T00:00:00Z',
    endDate: '2020-01-07T23:00:00Z'
  }
});
// 2. Retrieve Grid Data (NetCDF format)
const gridData = await hydro.data.retrieve({
  params: {
    source: 'aorc',
    datatype: 'grid-data'
  },
  args: {
    dataset: 'aorc-v1.1',
    variables: ['APCP_surface'],
    bbox: [-75.0, 40.0, -73.0, 42.0], // [west, south, east, north]
    startDate: '2020-01-01T00:00:00Z',
    endDate: '2020-01-01T06:00:00Z',
    format: 'netcdf'
  }
});

(static) BMKG :Object

BMKG (Indonesia): Open Data API. Provides access to weather forecasts, earthquake data, tsunami warnings, and air quality. For more information, visit: https://data.bmkg.go.id/

Type:
  • Object
Source:

(static) CHIRPS :Object

CHIRPS (Climate Hazards Group InfraRed Precipitation with Station data) A 30+ year quasi-global rainfall dataset. Spans 50°S-50°N. Useful for drought monitoring and trend analysis.

Data Information:

  • Source: UCSB Climate Hazards Center
  • Resolution: 0.05° (~5km) and 0.25° (~25km)
  • Format: GeoTIFF (compressed), NetCDF
  • Frequency: Daily, Pentad, Dekadal, Monthly

Available Data Types:

  • global-daily: Global daily rainfall.
  • global-monthly: Global monthly rainfall.
  • africa-*: Regional high-res for Africa.
Type:
  • Object
Source:
See:
Example
// 1. Retrieve Global Daily Rainfall (GeoTIFF)
const rainData = await hydro.data.retrieve({
  params: {
    source: 'chirps',
    datatype: 'global-daily'
  },
  args: {
    year: '2023',
    month: '01',
    day: '15',
    format: 'tiff',
    resolution: '0.05'
  }
});

(static) ClearCreek :Object

Data specific for the development of a case study for the implementation of BMI.js standard. This application has been developed and deployed using MRMS-Stage IV data obtained for the IFC HLM model for the Clear Creek in Iowa. The endpoints available are listed below. For more information,please visit: https://ifis.iowafloodcenter.org/ifis/sc/modelplus/ https://agu.confex.com/agu/fm21/meetingapp.cgi/Paper/897497

Type:
  • Object
Source:

(static) CMA :Object

China Meteorological Administration (CMA): Official Data Service. Provides access to meteorological data via data.cma.cn API. For more information, visit: https://data.cma.cn/en

Type:
  • Object
Source:

(static) CPTEC :Object

CPTEC (Centro de Previsão de Tempo e Estudos Climáticos) - INPE Provides weather forecasts and climate data for Brazil and South America. For more information: https://www.cptec.inpe.br/

Type:
  • Object
Source:

(static) 3DEP :Object

3D Elevation Program (3DEP) datasource Provides access to high-resolution elevation data from the USGS 3DEP service. Supports DEM (Digital Elevation Model) data in various resolutions.

Data Information:

  • Source: USGS National Map
  • Format: GeoTIFF
  • Resolutions: 1/3 arc-second (~10m), 1 arc-second (~30m), etc.
  • Coverage: CONUS
  • Coordinate System: EPSG:4326 (WGS84) for requests, often projected in response.

Available Data Types:

  • grid-data: Extract spatial DEM for a bounding box.
  • point-data: Extract single point elevation.

Key Variables:

  • elevation: Digital Elevation Model (meters)
Type:
  • Object
Author:
  • kento-sugiyama
Source:
See:
Examples
// 1. Retrieve 10m DEM for a bounding box
const demData = await hydro.data.retrieve({
  params: {
    source: 'threedep',
    datatype: 'grid-data'
  },
  args: {
    dataset: '3dep-dem',
    variables: ['elevation'],
    bbox: [-105.5, 40.0, -105.0, 40.5], // Colorado Rockies
    resolution: 10 // meters
  }
});
// 2. Retrieve Point Elevation
const ptElev = await hydro.data.retrieve({
  params: {
    source: 'threedep',
    datatype: 'point-data'
  },
  args: {
    latitude: 36.1699,
    longitude: -115.1398 // Las Vegas
  }
});

(static) DWD :Object

Deutscher Wetterdienst (DWD): Open Data Server for Germany. Provides access to ICON model data, MOSMIX forecasts, and Radar data. For more information, visit: https://opendata.dwd.de/

Type:
  • Object
Source:

(static) EAUK :Object

Data gov uk: provides API for free datasets from the UK and other parts of the world. For more information about the service, please visit: https://environment.data.gov.uk/apiportal Note: Different data sources may have different limitations Endpoints have a default limit of 500 items. The service does not require an API key, but, size limitations should be considered when downloading data. Moreover, its better to bulk on data if required. The files can be obtained in JSON, CSV or ZIP format. For more information on the historical flooding data, visit: https://environment.data.gov.uk/flood-monitoring/archive Coordinates in WGS84. Dates in format YYYY-MM-DDThh:mm:ss

Type:
  • Object
Source:

(static) ECMWF :Object

European Centre for Medium-Range Weather Forecasts (ECMWF) API This API provides access to various weather and climate data products including forecasts, reanalysis datasets, and climate projections.

Data Information:

  • Source: ECMWF & Copernicus Climate Data Store (CDS)
  • Format: GRIB2, NetCDF (requires conversion/processing)
  • Key Products: ERA5 (Reanalysis), Seasonal Forecasts, High-res Operations
  • Access: REQUIRES API KEY (See: https://cds.climate.copernicus.eu/api-how-to)

Available Data Types:

  • era5: ERA5 Reanalysis data (Hourly, Monthly).
  • seasonal-forecast: Seasonal long-range forecasts.
  • climate-projections: CMIP6 global climate projections.
  • forecast-grib2: Operational forecasts (Real-time).
  • point-data / grid-data: Spatial extractions.

Example Usage:

Type:
  • Object
Source:
See:
Examples
// 1. Retrieve ERA5 Reanalysis Data (Surface Temperature)
// Note: Response is often binary (GRIB/NetCDF), requires params.process=true or manual handling
const era5Data = await hydro.data.retrieve({
  params: {
    source: 'ecmwf',
    datatype: 'era5',
    key: 'YOUR_ECMWF_API_KEY'
  },
  args: {
    product_type: 'reanalysis',
    variable: ['2m_temperature'],
    year: '2022',
    month: '01',
    day: '01',
    time: ['12:00'],
    area: [50, -10, 40, 10], // Spatial subset
    format: 'netcdf'
  }
});
// 2. Retrieve Operational Forecast (GRIB2)
const forecast = await hydro.data.retrieve({
  params: {
    source: 'ecmwf',
    datatype: 'forecast-grib2'
  },
  args: {
    date: '20230101',
    time: '00',
    step: '24', // 24-hour forecast
    param: '167' // 2m Temperature parameter ID
  }
});

(static) EPA :Object

Data endpoints for the Hydrologic Micro Services from the EPA. HydroLang supports the requests through AJAX calls to the server. https://qed.epa.gov/hms/meteorology/precipitation/data_request/ Please check input/output parameters for more information on the selected requested datas services https://qed.epa.gov/hms/meteorology/precipitation/#output_parameters

Type:
  • Object
Source:

(static) FAO :Object

FAO Geospatial Data Provides access to FAO's extensive catalog via WMS/WFS. For more information: https://data.apps.fao.org/map/catalog/srv/eng/catalog.search

Type:
  • Object
Source:

(static) FEMA :Object

https://www.fema.gov/openfema-dataset-disaster-declarations-summaries-v2 This API just returns all disaster declarations for US since 1953 -> E.g., they may limit the # of queries per unit time

Type:
  • Object
Source:

(static) flooddamage_dt :Object

https://hydroinformatics.uiowa.edu/lab/fidas/data/functions This API returns community scope flood damage for Cedar Rapids, Cedar Falls and Waterloo. This is an example of the data retrieval for flood damage estimations to be set up in a map interface. This will/can be further expanded to accomodate to other locations and datatypes.

Type:
  • Object
Source:

(static) FMI :Object

Finnish Meteorological Institute (FMI): Open Data WFS. Provides access to weather observations, forecasts, air quality, and radiation data via OGC WFS. For more information, visit: https://en.ilmatieteenlaitos.fi/open-data

Type:
  • Object
Source:

(static) HRRR :Object

High Resolution Rapid Refresh (HRRR) Model Data Provides access to HRRR weather model forecasts and analysis data. HRRR is NOAA's high-resolution (3km) weather prediction model updated hourly.

Data Information:

  • Source: NOAA NCEP / NOMADS
  • Format: GRIB2 (Native resolution)
  • Resolution: 3km (CONUS)
  • Updates: Hourly
  • Forecast Horizon: 18h (standard), 48h (extended/00z/06z/12z/18z)

Available Products:

  • hrrr-operational: Real-time operational forecasts.
  • hrrr-analysis: Historical analysis (archive since 2014).

Key Variables:

  • TMP: Temperature
  • APCP: Total Precipitation
  • WIND: Wind Speed
  • VIS: Visibility
Type:
  • Object
Source:
See:
Examples
// 1. Retrieve operational Surface Temperature Forecast (Real-time)
const forecastData = await hydro.data.retrieve({
  params: {
    source: 'hrrr',
    datatype: 'point-data'
  },
  args: {
    dataset: 'hrrr-operational',
    product: 'sfc',
    variable: 'TMP',
    latitude: 40.7128,
    longitude: -74.0060,
    startDate: new Date().toISOString() // Or specific recent date
  }
});
// 2. Retrieve Historical Analysis (Grid) for significant event
const stormData = await hydro.data.retrieve({
  params: {
    source: 'hrrr',
    datatype: 'grid-data'
  },
  args: {
    dataset: 'hrrr-analysis',
    product: 'anl',
    variable: 'APCP',
    bbox: [-96.0, 29.0, -94.0, 31.0], // Houston area
    startDate: '2017-08-26T00:00:00Z' // Hurricane Harvey example
  }
});

(static) HydroGeospatial :Object

Hydro Geospatial Sources Aggregated global hydrology layers including HydroSHEDS and Global Surface Water.

Type:
  • Object
Source:

(static) IDEAM :Object

IDEAM (Instituto de Hidrología, Meteorología y Estudios Ambientales) - Colombia Provides hydrometeorological data. For more information: http://www.ideam.gov.co/

Type:
  • Object
Source:

(static) IFIS :Object

https://ifis.iowafloodcenter.org/ifis/ws/ This API returns data from the IFIS web service.

Type:
  • Object
Source:

(static) IMD :Object

India Meteorological Department (IMD): Open Government Data (OGD) Platform. Provides access to weather forecasts, climatological data, cyclones, and tourism forecasts. For more information, visit: https://data.gov.in/

Type:
  • Object
Source:

(static) ISRIC :Object

ISRIC SoilGrids Global gridded soil information. Provides WMS and WCS services for soil properties. For more information: https://www.isric.org/explore/soilgrids

Type:
  • Object
Source:

(static) JMA :Object

Japan Meteorological Agency (JMA): Public Atom Feeds. Provides high-frequency weather warnings, forecasts, tsunami, and typhoon info via XML feeds. For more information, visit: https://www.jma.go.jp/jma/indexe.html

Type:
  • Object
Source:

(static) KMA :Object

Korea Meteorological Administration (KMA): Open Data Portal. Provides access to weather, climate, model data, typhoon tracks, and dust info. For more information, visit: https://data.kma.go.kr/

Type:
  • Object
Source:

(static) KNMI :Object

KNMI (Royal Netherlands Meteorological Institute): Data Platform (KDP). Provides access to weather, climate, and seismological data. For more information, visit: https://developer.dataplatform.knmi.nl/

Type:
  • Object
Source:

(static) MeteoFrance :Object

Météo-France: Official API Portal. Provides access to AROME/ARPEGE models, observations, vigilance alerts, and radar data. For more information, visit: https://portail-api.meteofrance.fr/

Type:
  • Object
Source:

(static) MeteoIT :Object

MeteoNetwork API: free datasets from the italy and some surrounding places. For more information about the service, please visit: https://www.meteonetwork.it/ Note: Different data sources may have different limitations The service requires the creation of an account and the generation of a new token. For more information on the historical flooding data, visit: http://api.meteonetwork.it/docs/ Dates in format YYYY-MM-DDThh:mm:ss

Type:
  • Object
Source:

(static) MeteoSTAT :Object

Meteostat datasource Provides access to historical weather and climate data from thousands of stations worldwide. Note: Requires an API key (https://dev.meteostat.net/).

Data Information:

  • Source: Meteostat (aggregates NOAA, DWD, etc.)
  • Services: Hourly/Daily Data (Station & Point), Station Search
  • Coverage: Global

Available Data Types:

  • dailydata-station: Daily aggregate data for a specific station.
  • hourlydata-stations: Hourly data for a specific station.
  • dailydata-point: Daily interpolated data for a lat/lon.
  • hourlydata-point: Hourly interpolated data for a lat/lon.
  • find-stations / nearby-stations: Station meta-search.

Key Parameters:

  • station: Meteostat Station ID (e.g., "10637" for Frankfurt)
  • lat / lon: Coordinates for point data
  • start / end: Dates (YYYY-MM-DD)
  • key: API Key (Header x-api-key handling)
Type:
  • Object
Source:
See:
Examples
// 1. Retrieve Daily Data for a known Station
const dailyData = await hydro.data.retrieve({
  params: {
    source: 'meteostat',
    datatype: 'dailydata-station',
    key: 'YOUR_API_KEY'
  },
  args: {
    station: '10637', // Frankfurt
    start: '2023-01-01',
    end: '2023-01-31'
  }
});
// 2. Retrieve Hourly Data for a Geographic Point (Interpolated)
const hourlyPoint = await hydro.data.retrieve({
  params: {
    source: 'meteostat',
    datatype: 'hourlydata-point',
    key: 'YOUR_API_KEY'
  },
  args: {
    lat: 40.7128,
    lon: -74.0060,
    start: '2023-06-01',
    end: '2023-06-02',
    tz: 'America/New_York'
  }
});

(static) MetNo :Object

Meteorologisk institutt (Met.no): WeatherAPI for Norway and Global. Provides high-quality forecasts via Locationforecast 2.0, Oceanforecast, and Nowcast. For more information, visit: https://api.met.no/

Type:
  • Object
Source:

(static) mitigation_dt :Object

https://hydroinformatics.uiowa.edu/lab/midas/communities This API returns community scope flood damage for Cedar Rapids, Cedar Falls and Waterloo. . This is an example of the data retrieval for flood damage estimations to be set up in a map interface. This will/can be further expanded to accomodate to other locations and datatypes.

Type:
  • Object
Source:

(static) MRMS :Object

NOAA MRMS (Multi-Radar Multi-Sensor) datasource Provides access to high-resolution precipitation and radar data in GRIB2 format. Supports multiple MRMS products including Radar, QPE, QPF, and Severe Weather data.

Data Information:

  • Source: NOAA NCEP / NSSL
  • Format: GRIB2 (Compressed gz)
  • Resolution: 1km (0.01°)
  • Updates: 2-min (Radar), Hourly (QPE)
  • Coverage: CONUS
  • Type: Operational Real-time (Limited archive via HTTP)

Available Data Types:

  • mrms-radar: Real-time radar products (Reflectivity, Echo Tops).
  • mrms-qpe: Quantitative Precipitation Estimates (Radar-only, Multi-sensor).
  • mrms-qpf: Quantitative Precipitation Forecasts.

Key Variables:

  • REF / REFC: Reflectivity / Composite Reflectivity (dBZ)
  • PRATE / APCP: Precipitation Rate / Accumulation
  • VIL: Vertically Integrated Liquid
  • RQI: Radar Quality Index
Type:
  • Object
Source:
See:
Examples
// 1. Retrieve Real-time Composite Reflectivity (Grid)
const radarData = await hydro.data.retrieve({
  params: {
    source: 'mrms',
    datatype: 'grid-data'
  },
  args: {
    dataset: 'mrms-radar',
    product: 'MergedReflectivityQCComposite',
    variable: 'REFC',
    bbox: [-98.0, 30.0, -90.0, 38.0], // Midwest/South
    startDate: new Date().toISOString() // Current time (approx)
  }
});
// 2. Retrieve 1-hour Precipitation Accumulation (QPE) for a point
const precipData = await hydro.data.retrieve({
  params: {
    source: 'mrms',
    datatype: 'point-data'
  },
  args: {
    dataset: 'mrms-qpe',
    product: 'RadarOnly_QPE_01H',
    variable: 'APCP',
    latitude: 35.4676,
    longitude: -97.5164, // Oklahoma City
    startDate: '2023-05-15T18:00:00Z'
  }
});

(static) NASAPOWER :Object

NASA POWER (Prediction of Worldwide Energy Resource) API This API provides global meteorology and solar energy data including temperature, precipitation, humidity, solar energy, and more for agricultural, renewable energy, and sustainable building design.

Data Information:

  • Source: NASA Langley Research Center
  • Coverage: Global
  • Resolution: 0.5° x 0.5° (Meteorology), 1.0° x 1.0° (Solar)
  • Data Types: Daily, Monthly, Climatology

Available Data Types:

  • point-data: Time series for a single location.
  • regional-data: Data for a defined bounding box.
  • global-data: Global monthly averages.
  • climatology: Long-term averages.

Key Parameters:

  • parameters: Comma-separated list (e.g., "T2M,PRECTOTCORR")
  • community: "ag" (Agroclimatology), "re" (Renewable Energy), "sb" (Sustainable Buildings)
  • start / end: YYYYMMDD format
Type:
  • Object
Source:
See:
Example
// 1. Retrieve Daily Temperature and Precipitation for a Point
const powerData = await hydro.data.retrieve({
  params: {
    source: 'nasapower',
    datatype: 'point-data'
  },
  args: {
    parameters: 'T2M,PRECTOTCORR',
    community: 'ag',
    longitude: -76.3,
    latitude: 38.5,
    start: '20230101',
    end: '20230110',
    format: 'JSON'
  }
});

(static) NHDPlus :Object

USGS NHDPlus WFS Data API via GeoServer Provides stream networks, waterbodies, catchments, and gaging sites https://www.usgs.gov/national-hydrography/nhdplus-high

Type:
  • Object
Source:

(static) NLDAS :Object

NLDAS-3 (North American Land Data Assimilation System) Meteorological Forcing Data Provides high-resolution meteorological forcing data for hydrologic modeling. Data is stored in NetCDF format on AWS S3 with public access.

Data Information:

  • Source: NASA GSFC / WaterInsight
  • Format: NetCDF (beta release)
  • Resolution: ~1km (0.01°), Hourly/Daily/Monthly
  • Coverage: North America (CONUS, AK, HI, PR, Central America)
  • Time Range: 1979 - 2020+

Available Data Types:

  • point-data: Time series for single location.
  • grid-data: Spatial subset for specific time.
  • timeseries-data: Multi-location extraction.
  • raw-netcdf: Direct access to raw files.

Key Variables:

  • Rainf: Total precipitation rate (kg m⁻² = mm)
  • Tair: Near-surface air temperature (K)
  • Qair: Specific humidity (kg/kg)
  • Wind_N / Wind_E: Wind components (m/s)
Type:
  • Object
Source:
See:
Examples
// 1. Retrieve Hourly Precipitation & Temperature (Point Data)
const forcingData = await hydro.data.retrieve({
  params: {
    source: 'nldas',
    datatype: 'point-data'
  },
  args: {
    dataset: 'nldas-3-hourly',
    variables: ['Rainf', 'Tair'],
    latitude: 40.7128,
    longitude: -74.0060,
    startDate: '2015-06-01T00:00:00Z',
    endDate: '2015-06-07T23:00:00Z'
  }
});
// 2. Retrieve Daily Average Grid (NetCDF)
const dailyGrid = await hydro.data.retrieve({
  params: {
    source: 'nldas',
    datatype: 'grid-data'
  },
  args: {
    dataset: 'nldas-3-daily',
    variables: ['Tair_max', 'Tair_min'],
    bbox: [-85.0, 33.0, -83.0, 35.0], // Georgia region
    startDate: '2019-07-15T00:00:00Z',
    endDate: '2019-07-15T00:00:00Z'
  }
});

(static) NLDI :Object

USGS National Land Data Interoperability (NLDI) API that allows access to hydrological data. https://waterdata.usgs.gov/blog/nldi-intro/ The API's returns geoJSON, or JSON. Please verify each entry point BEFORE usage.

Type:
  • Object
Author:
  • kento-sugiyama
Source:

(static) NOAA :Object

NOAA Climate Data Online (CDO) datasource Provides access to global historical weather and climate data. Note: Requires a free API token from NOAA (https://www.ncdc.noaa.gov/cdo-web/token).

Data Information:

  • Source: NOAA NCDC / NCEI
  • Services: Daily Summaries (GHCND), Global Summary of Month (GSOM), Precipitation (15min/Hourly), Radar Imagery
  • Coverage: Global (depending on dataset)
  • Limits: Requests usually limited to 1 year of data per call; 5 calls/sec.

Available Data Types:

  • daily-summaries: GHCN Daily (Max/Min Temp, Precip, Snow).
  • global-summary: GSOM Monthly summaries.
  • prec-15min / prec-hourly: High-frequency precipitation.
  • weather-radar-imagery: NEXRAD Level 2/3 imagery checks.
  • availablestations: Search for stations.

Key Parameters:

  • stationid: Station ID (e.g., "GHCND:USW00014895")
  • locationid: Location ID (e.g., "FIPS:37")
  • datasetid: (Implicit in some types)
  • startdate / enddate: YYYY-MM-DD
  • token: NOAA API Token
Type:
  • Object
Source:
See:
Examples
// 1. Retrieve Daily Summaries (Temp/Precip) for a Station
const dailyData = await hydro.data.retrieve({
  params: {
    source: 'noaa',
    datatype: 'daily-summaries',
    token: 'YOUR_NOAA_TOKEN'
  },
  args: {
    stationid: 'GHCND:USW00094728', // NY Central Park
    startdate: '2020-01-01',
    enddate: '2020-01-31',
    limit: 1000
  }
});
// 2. Retrieve Hourly Precipitation
const hourlyPrecip = await hydro.data.retrieve({
  params: {
    source: 'noaa',
    datatype: 'prec-hourly',
    token: 'YOUR_NOAA_TOKEN'
  },
  args: {
    locationid: 'FIPS:11', // District of Columbia
    startdate: '2010-01-01',
    enddate: '2010-01-31',
    limit: 500
  }
});

(static) NWM :Object

National Water Model (NWM) Retrospective Data Provides access to historical streamflow data stored in Zarr format on S3.

Data Information:

  • Source: NOAA OWP
  • Format: Zarr (Release 2.1) & NetCDF types
  • Time Range: 1979 - 2020 (Retrospective 2.1)

Available Products:

  • chrtout: Channel Output (Streamflow, velocity at reach points) - Primary product.
  • lakeout: Reservoir/Lake Output.
  • ldasout: Land Surface Output (Soil moisture, etc.).
  • rtout: Routing Output (Ponded water).
  • gwout: Groundwater Output.

Available Data Types for Retrieval:

  • point-data: Extract data for specific stream reaches (COMID) or coordinates.
  • grid-data: Extract spatial subset.
  • timeseries-data: Extract time series for analysis.
Type:
  • Object
Source:
Examples
// 1. Retrieve Streamflow for a specific location (Auto-resolves COMID from lat/lon)
const flowData = await hydro.data.retrieve({
  params: {
    source: 'nwm',
    datatype: 'point-data'
  },
  args: {
    dataset: 'nwm-retrospective-2-1-zarr-pds',
    variables: ['streamflow'],
    latitude: 40.7128,
    longitude: -74.0060,
    startDate: '2010-01-01T00:00:00Z',
    endDate: '2010-01-07T00:00:00Z'
  }
});
// 2. Retrieve Soil Moisture (Grid) for a region
const soilData = await hydro.data.retrieve({
  params: {
    source: 'nwm',
    datatype: 'grid-data'
  },
  args: {
    dataset: 'nwm-retrospective-2-1-zarr-pds',
    variables: ['SOIL_M'], // From ldasout product
    bbox: [-90.0, 30.0, -88.0, 32.0],
    startDate: '2015-06-01T00:00:00Z',
    endDate: '2015-06-01T12:00:00Z'
  }
});

(static) NWPS :Object

National Weather Prediction Service (NWPS) API that allows access to forecasts, alerts, and observations and other weather data in hydrlogy. https://api.water.noaa.gov/nwps/v1/docs/#/Gauges/Gauges_GetStageFlowAll The API's returns geoJSON, or JSON. Please verify each entry point BEFORE usage.

Type:
  • Object
Source:

(static) NWS :Object

National Weather Service (NWS) API that allows access to forecasts, alerts, and observations and other weather data that allows JSON-LD machine data discovery. More information can be found here: https://www.weather.gov/documentation/services-web-api#/default/obs_stations The API's returns geoJSON, or JSON. Please verify each entry point BEFORE usage.

Type:
  • Object
Source:

(static) OpenMeteo :Object

Open-Meteo Free Weather API for non-commercial use. Provides global weather forecasts, historical data, and specific regional models.

Data Information:

  • Source: Open-Meteo (aggregates DWD, NOAA, ECMWF, BOM, etc.)
  • Coverage: Global
  • License: Free for non-commercial use (CC BY 4.0)

Available Data Types:

  • forecast: General weather forecast (hourly/daily).

Key Parameters:

  • latitude / longitude: Decimal coordinates
  • hourly: List of variables (e.g. "temperature_2m", "rain")
  • models: Optional specific model (e.g. "bom_access_global")
Type:
  • Object
Source:
See:
Example
// 1. Retrieve 7-day Forecast for Sydney (using BOM model)
const forecast = await hydro.data.retrieve({
  params: {
    source: 'openmeteo',
    datatype: 'forecast'
  },
  args: {
    latitude: -33.8688,
    longitude: 151.2093,
    hourly: 'temperature_2m,precipitation',
    models: 'bom_access_global'
  }
});

(static) PRISM :Object

PRISM (Parameter-elevation Relationships on Independent Slopes Model) datasource Provides access to high-resolution climate and weather data for the United States.

Data Information:

  • Source: Oregon State University / PRISM Climate Group
  • Format: GeoTIFF (New) / BIL (Legacy)
  • Resolution: 400m (15s), 800m (30s), 4km (2.5m)
  • Coverage: CONUS, AK, HI, PR
  • Time Range: 1895 - Present

Available Data Types:

  • prism-current: New format (GeoTIFF), covers US territories.
  • prism-legacy: Legacy format (BIL), CONUS only (Deprecated after Sept 2025).

Key Variables:

  • ppt: Total Precipitation (mm)
  • tmean / tmin / tmax: Temperature (°C)
  • tdmean: Mean Dewpoint
  • vpdmin / vpdmax: Vapor Pressure Deficit
Type:
  • Object
Source:
See:
Examples
// 1. Retrieve Recent Daily Max Temperature (New Format)
const tempData = await hydro.data.retrieve({
  params: {
    source: 'prism',
    datatype: 'grid-data'
  },
  args: {
    dataset: 'prism-current',
    variable: 'tmax',
    bbox: [-123.0, 44.0, -121.0, 46.0], // Oregon
    startDate: '2023-07-15T00:00:00Z',
    resolution: '30s' // 800m
  }
});
// 2. Retrieve Monthly Precipitation Normals (30-year)
const normals = await hydro.data.retrieve({
  params: {
    source: 'prism',
    datatype: 'grid-data'
  },
  args: {
    dataset: 'prism-current',
    variable: 'ppt',
    date: 'normals', // Special keyword for normals
    resolution: '25m', // 4km
    format: 'geotiff'
  }
});

(static) ProxyServers :Object

All proxy servers tried and working can be found here. It is a trial/error to see if a specific error might be working per resource.

Type:
  • Object
Source:

(static) SILO :Object

SILO (Scientific Information for Land Owners) Provides daily climate data for Australia (Queensland Government). For more information: https://www.longpaddock.qld.gov.au/silo/

Type:
  • Object
Source:

(static) SISSA :Object

SISSA (Sistema de Información sobre Sequías para el Sur de Sudamérica) Provides drought monitoring data for Southern South America. For more information: https://sissa.crc-sas.org/

Type:
  • Object
Source:

(static) SMHI :Object

SMHI (Swedish Meteorological and Hydrological Institute): Open Data API. Provides access to meteorological, hydrological, and oceanographic data. For more information, visit: https://opendata.smhi.se/

Type:
  • Object
Source:

(static) SMN :Object

SMN (Servicio Meteorológico Nacional) - Argentina Provides weather forecasts and observations for Argentina. For more information: https://www.smn.gob.ar/

Type:
  • Object
Source:

(static) soapEnv :function

Helper function to append SOAP 1.1 envelope to a request.

Type:
  • function
Source:

(static) TAMSAT :Object

TAMSAT (Tropical Applications of Meteorology using SATellite data) and ground-based observations Provides daily rainfall estimates for Africa. For more information: http://www.tamsat.org.uk/

Type:
  • Object
Source:

(static) TMD :Object

Thai Meteorological Department (TMD): TMDAPI. Provides access to weather forecasts, observations, earthquake data, and radar info. For more information, visit: https://data.tmd.go.th/api/index_en.php

Type:
  • Object
Source:

(static) USGS :Object

https://waterservices.usgs.gov/rest/IV-Service.html This API returns stream stages for US

Type:
  • Object
Source:

(static) USGS :Object

USGS Water Services (NWIS) datasource Provides access to water data for the United States, including streamflow, groundwater, and water quality.

Data Information:

  • Source: USGS National Water Information System (NWIS)
  • Services: Instant Values (IV), Daily Values (DV), Groundwater, Water Quality, Site Info

Available Data Types:

  • instant-values: Real-time/Instantaneous data (e.g., streamflow every 15 min).
  • daily-values: Daily aggregated data (e.g., daily mean discharge).
  • groundwater: Groundwater levels.
  • water-quality: Discrete water quality samples.
  • site-information: Metadata about measurement sites.

Key Parameters:

  • site: USGS Site Number (e.g., "05454500")
  • startDT / endDT: Start and End dates (YYYY-MM-DD)
  • parameterCd: (Implicit in some requests, 00060=Discharge, 00065=Gage Height)
Type:
  • Object
Source:
See:
Examples
// 1. Retrieve Instantaneous Streamflow (IV)
const flowData = await hydro.data.retrieve({
  params: {
    source: 'usgs',
    datatype: 'instant-values'
  },
  args: {
    format: 'json',
    sites: '05454500', // Iowa River at Iowa City
    startDT: '2023-01-01',
    endDT: '2023-01-07'
  }
});
// 2. Retrieve Daily Mean Values (DV)
const dailyData = await hydro.data.retrieve({
  params: {
    source: 'usgs',
    datatype: 'daily-values'
  },
  args: {
    format: 'json',
    sites: '05454500',
    startDT: '2020-01-01',
    endDT: '2020-12-31' // Full year
  }
});
// 3. Retrieve Site Information
const siteMeta = await hydro.data.retrieve({
  params: {
    source: 'usgs',
    datatype: 'site-information'
  },
  args: {
    format: 'rdb',
    sites: '05454500',
    siteOutput: 'expanded'
  }
});

(static) WBD :Object

USGS Watershed Boundary Dataset (WBD) via WFS Provides hierarchical watershed boundaries at multiple scales (HUC 2-12) https://www.usgs.gov/national-hydrography/watershed-boundary-dataset

Type:
  • Object
Author:
  • kento-sugiyama
Source:

(static) Worldbank :Object

World Bank API for data retrieval. Provides access to global climate data (precipitation/temperature) and development indicators.

Data Information:

  • Source: World Bank Climate Change Knowledge Portal & Indicators API
  • Coverage: Global (by Country or Basin)
  • Services: Historical Weather, Climate Projections, Development Indicators

Available Data Types:

  • monavgs-country / annualavgs-country: Historical averages by country.
  • monavgs-basin / annualavgs-basin: Historical averages by basin ID.
  • indicators: General development indicators (GDP, Pop, etc.).
  • country-indicators: Specific indicators for a country.

Key Parameters:

  • ISO3: Country code (e.g., "USA", "BRA")
  • start / end: Years (YYYY)
  • indicator: Indicator code (e.g., "NY.GDP.MKTP.CD")
Type:
  • Object
Source:
See:
Examples
// 1. Retrieve Historical Monthly Precipitation Averages for USA
const rainfall = await hydro.data.retrieve({
  params: {
    source: 'worldbank',
    datatype: 'monavgs-country'
  },
  args: {
    ISO3: 'USA',
    start: 1980,
    end: 1999
  }
});
// 2. Retrieve GDP Indicator for Brazil
const gdpData = await hydro.data.retrieve({
  params: {
    source: 'worldbank',
    datatype: 'country-indicators'
  },
  args: {
    country: 'BRA',
    indicator: 'NY.GDP.MKTP.CD',
    date: '2010:2020',
    format: 'json'
  }
});

(static) WQP :Object

https://www.waterqualitydata.us/webservices_documentation/#example-summary-service-call-geojson This API serves as a viewer for data quality monitoring in CONUS In collaboration with USGS/EPA data

Type:
  • Object
Source: