An official website of the United States government.

We've made some changes to EPA.gov. If the information you are looking for is not here, you may be able to find it on the EPA Web Archive or the January 19, 2017 Web Snapshot.

HMS: Hydrologic Micro Services

Hydrology - Soilmoisture

This page contains detailed information for the meteorology soilmoisture component.

On this page:

Description

Soil moisture is amount of water the soil retains. When the water holding capacity of the soil is exceeded by precipitation the excess water is defined as surface runoff.

Capabilities

Version - 0.1

  1. Capability 1.
  2. Capability 2.
  3. Capability 3.
  4. Capability 4.
  5. Capability 5.

Input Parameters

Attributes of the HMS soilmoisture input object
ParameterDataTypeDescriptionComments
SourceDrop-down listTime-series data sourceValid sources: nldas, gldas
Start DateStringStart date for the output timeseries. e.g., 01/01/2010
Data Availability

nldas: hourly 1/1/1979 – Present (~4-day lag); North America @ 0.125 deg resolution.
gldas: 3-hourly 1/1/2000-Present (~1-month lag); Global @ 0.250 deg resolution.
End DateStringEnd date for the output timeseries. e.g., 01/01/2010
Location OptionDrop-down listLocation of interest options.Valid options: Latitude/Longitude, Catchment Centroid. Output time-series is returned for the latitude/longitude at the centroid of the NHDPlusV2.1 catchment when 'catchment (COMID)' is selected.
LatitudeNumberLatitude coordinate for the output timeseries. e.g., 33.925575Used only when 'Latitude/Longitude' is selected for 'Location Option'.
LongitudeNumberLongitude coordinate for the output timeseries. e.g., -83.356893Used only when 'Latitude/Longitude' is selected for 'Location Option'.
Catchment COMIDStringNHDPlusV2.1 catchment COMID.Used only when 'catchment Centroid' is selected for 'Location Option'.
Local TimeDrop-down listTime zone for the timestamp in output time-series.Valid options: yes, GMT. All data sources can be returned in Greenwich Mean Time (GMT) but only ncei, nldas, gldas, and trmm time-series can be returned in local time.
Temporal ResolutionDrop-down listTemporal resolution/timestep of the output time-series.Valid options: hourly, 3-hourly, daily, monthly. Daily and Monthly resolution is available for all data sources. Hourly resolution is available only for nldas. 3-hourly resolution is available for gldas.
Output Date FormatStringFormat of the returned numeric values.Valid options: E E0, E1, E2, E3, e, e0, e1, e2, e3, F, F0, F1, F2, F3, G, G0, G1, G2, G3, N, N0, N1, N2, N3, R. Details are available in the table below.
Layer DepthStringDepth of the top layer of soil.Valid options: 0-10cm, 10-40cm, 40-100cm, 100-200cm, 0-100cm, 0-200cm.

Output Data Format Options
Format SpecifierNameExample
"E" or "e"Exponential (Scientific).
Exponential notation.
"E": 1052.0329112756 -> 1.052033E+003
"e": 1052.0329112756 -> 1.052033e+003
"E2": -1052.0329112756 -> -1.05E+003
"e2": -1052.0329112756 -> -1.05e+003
"F"Fixed-point.
Integral and decimal digits with optional negative sign.
"F": 1234.567 -> 1234.57
"F1": 1234 -> 1234.0
"F4": -1234.56 -> -1234.5600
"G"General.
The more compact of either fixed-point or scientific notation.
"G": -123.456 -> -123.456
"G4": 123.4546 -> 123.5
"G": -1.234567890e-25 -> -1.23456789E-25
"N"Number.
Integral and decimal digits, group separators, and a decimal separator with optional negative sign.
"N": 1234.567 -> 1, 234.57
"N1": 1234 -> 1, 234.0
"N3": -1234.56 -> -1, 234.560
"R"Round-trip.
A string that can round-trip to an identical number.
"R": 123456789.12345678 -> 123456789.12345678
"R": -1234567890.12345678 -> -1234567890.1234567

Output Parameters

Attributes of the HMS soilmoisture output object
ColumnDataTypeDescription
datasetStringPrimary dataset of the requested timeseries. Some API calls return more than one dataset, either for a workflow API or other relevent dataset.
dataSourceStringPrimary source of the requested timeseries.
metaDataDictionaryMetadata for the output timeseries, includes metadata from the source as well as HMS metadata.
dataDictionaryOutput timeseries data is returned as a dictionary, where the key is the datetime stamp and value is a list of values for the source/dataset.

Web Service Details

Swagger UI


HTTP API

MethodURL
POSThttps://qed.epa.gov/hms/rest/api/v3/hydrology/soilmoisture/

Change Log

Version: 0.1 Beta : May 29, 2019

  1. Production UI and documentation initial setup.

Code Samples

Usage Title 1

Problem Statement: NA 1.

Desired Information: NA 1.

Information Returned from Service: NA 1.

Sample code for accessing API