TimeSeries — GET /timeseries
What it does
Retrieve time series values for a location and parameter over a selected time range.
When to use
Chart recent observations
Export values for analysis
Compare units or intervals
Parameter |
Description |
Required |
When to Use |
|---|---|---|---|
begin |
|||
datum |
The standardized reference system used for either vertical measurements. Examples: NAVD88, NGVD29, LOCAL, etc. |
To retrieve measurements in a specified system. |
|
end |
|||
format |
The desired response format. Usage differs between endpoints. See note below. |
Use this to force the format provided in the response. |
|
include-entry-date |
Include timestamps for when each data point was added to the CWMS database (true/false). |
To determine when each time series data point was stored. |
|
name |
The text representation of the unique time series identifier. |
Yes |
To differentiate the specific time series data you desire to retrieve. |
office |
|||
page |
|||
page-size |
|||
timezone |
To retrieve data points in a timezone that works best with your use case, such as your local timezone. |
||
trim |
Trim missing values from the beginning and end of the retrieved values (true/false). |
To leave out missing values to get only the stored values of the time series data set. |
|
unit |
Do not use this parameter, instead use the ‘units’ parameter below. |
||
units |
To convert the retrieved values into a desired unit, such as retrieving elevation data in feet (ft) instead of meters (m). |
||
version-date |
To limit results to a specific version, such as when multiple versions of a time series exist with different associated forecast dates. |
Note
Detailed documentation for Legacy Format Responses for the format parameter in CDA is currently in development and will be available at https://cwms-data.usace.army.mil/cwms-data/legacy-format in a future release.
Examples
- The user wants to retrieve flow data for STATION1 at 15-minute intervals from the time series:(name)
STATION1.Flow.Inst.15Minutes.0.CWMSfrom October 12, 2025 at 12:35 PM UTC onward:(begin)2025-10-12T12:35:00Zwith the values converted to cubic meters per second:(units)m3/s.GET /timeseries?name=STATION1.Flow.Inst.15Minutes.0.CWMS&begin=2025-10-12T12:35:00.000Z&units=m3/s
- The user wants to retrieve elevation data for STATION2 at 15-minute intervals from the time series:(name)
STATION2.Elev.Avg.15Minutes.1Day.CWMSwith the values converted to feet:(units)ftand using the NAVD88 datum:(datum)NAVD88GET /timeseries?name=STATION2.Elev.Avg.15Minutes.1Day.CWMS&datum=NAVD88&units=ft
- The user wants to retrieve temperature data for STATION3 at 12-hour intervals from the time series:(name)
STATION3.Temp.Inst.12Hour.1Month.CWMSusing the version date of October 1, 2025 at 12:00 PM UTC:(version-date)2025-10-01T12:00:00Zand limiting results to the office NWDP:(office)NWDPGET /timeseries?name=STATION3.Temp.Inst.12Hour.1Month.CWMS&version-date=2025-10-01T12:00:00Z&office=NWDP
- The user wants to retrieve area data for STATION4 at 1-day intervals from the time series:(name)
STATION4.Area.Total.1Day.1Week.Surface-CWMSwith 25 results per response:(page-size)25in the Pacific timezone (Los Angeles):(timezone)America/Los_Angelesand including the entry dates of each data point:(include-entry-date)TrueGET /timeseries?name=STATION4.Area.Total.1Day.1Week.Surface-CWMS&page-size=25&timezone=America/Los_Angeles&include-entry-date=True
The user wants to retrieve the following page of results for the above query with a page value of rGfes*720SJK provided by the response from the previous query (next-page):
(page)rGfes*720SJK(name)STATION4.Area.Total.1Day.1Week.Surface-CWMS(page-size)25(timezone)America/Los_Angeles(include-entry-date)TrueGET /timeseries?name=STATION4.Area.Total.1Day.1Week.Surface-CWMS&page-size=25&timezone=America/Los_Angeles&include-entry-date=True&page=rGfes*720SJK
See the consolidated API documentation: API References.