Web Service Information

Statistics by Threshold

---

A set of statistics can be obtained by minimum drought category and also minimum and maximum statistics values (i.e. 0 to 100 percent of area).

URL Structure

https://usdmdataservices.unl.edu/api/[area]/[statistics type]?aoi=[aoi]&dx=[drought level]&DxLevelThresholdFrom=[minimum threshold]&DxLevelThresholdTo=[maximum threshold]&startdate=[start date]&enddate=[end date]&statisticsType=[statistics format]

For HUC data, use the following structure for the URL:

https://usdmdataservices.unl.edu/api/[area]/[statistics type]?aoi=[aoi]&dx=[drought level]&DxLevelThresholdFrom=[minimum threshold]&DxLevelThresholdTo=[maximum threshold]&startdate=[start date]&enddate=[end date]&statisticsType=[statistics format]&hucLevel=[huc]

An explanation of each of the variables in the above URL is given below.

[area]

The following areas are available:

Area Type	Value
National	USStatistics
USDA Climate Hubs	ClimateHubStatistics
Regional Drought Early Warning Systems (RDEWS)	RegionalDroughtEarlyWarningSystemStatistics
Counties	CountyStatistics
States	StateStatistics
National Weather Service Weather Forecast Offices (WFOs)	WeatherForecastOfficeStatistics
U.S. Army Corps of Engineers Districts	USACEDistrictStatistics
U.S. Army Corps of Engineers Divisions	USACEDivisionStatistics
U.S. Urban Areas	UrbanAreaStatistics
River Forecast Centers	RiverForecastCenterStatistics
Regional Climate Center Regions	RegionStatistics
National Weather Service Regions	NWSRegionStatistics
Hydrologic Units (HUCs)	HUCStatistics
FEMA Regions	FEMARegionStatistics
Climate Divisions	ClimateDivisionStatistics
Tribal Areas	TribalStatistics

[statistics type]

Statistics Type	Value
Area	GetDroughtSeverityStatisticsByArea
Percent of Area	GetDroughtSeverityStatisticsByAreaPercent
Population	GetDroughtSeverityStatisticsByPopulation
Percent of Population	GetDroughtSeverityStatisticsByPopulationPercent

[aoi]

Select a specific area within the type of area (i.e. a single state or county).

National

• Use us for both the continental U.S. and total U.S.
• Use conus for the continental U.S. only
• Use total for the total U.S.

USDA Climate Hubs

• The climate hubs use an ID number

Regional Drought Early Warning Systems (RDEWS)

• Each RDEWS has been assigned an ID number

Counties

• Use the county’s five digit FIPS code or use the two letter abbreviation for a state in order to get all of the counties in that state

States

• Use the state’s two digit FIPS code

National Weather Service Weather Forecast Offices (WFOs)

• Use the three letter code for each WFO

U.S. Army Corps of Engineers Districts

• Use the three letter code for each district

U.S. Army Corps of Engineers Divisions

• Use the three letter code for each division

Urban Areas

• Use the geo ID for each urban area

River Forecast Centers

• Use the RFC code (i.e. CBRFC = Colorado Basin RFC)

Regional Climate Center Regions

• The regions are identified by an ID number

National Weather Service Regions

• Use the NWS region’s two letter code (i.e. CR for Central Region)

Hydrologic Units (HUCs)

• Use the HUC ID number (for 2, 4, 6 and 8 digit)

FEMA Regions

• Use the region’s number (1-10)

Climate Divisions

• Use the climate division’s ID number

Tribal Areas

• Use the tribal area's GEOID number

[start date] and [end date]

Use the following date format M/D/YYYY for the start date and end date

[drought level]

Drought Level	Value
D0	0
D1	1
D2	2
D3	3
D4	4

[minimum threshold]

The minimum percent of the area in the selected drought category to include (0-100)

[maximum threshold]

The maximum percent of the area in the selected drought category to include (0-100)

[statistics type]

Choose between traditional or categorical statistics. Use a value of 1 for traditional or 2 for categorical.

[huc]

Note: This parameter only applies to HUC area downloads.

Use the number 2, 4, 6, or 8 for the size of HUC that you want to use. You can use this parameter to grab all of the smaller HUCs within a larger HUC. For example if you wanted all of the 4-digit HUCs inside of a 2-digit HUCs, you would use the two digit HUC id for the aoi parameter and 4 for the huc parameter.

Output Format

By default the data are output in XML format. You can specify an output format in the ACCEPT request header. The format options are XML, CSV, and JSON.

Examples

If a person wanted to obtain statistics for the percent of area in drought for the total U.S. between the dates of January 1^st, 2012 and January 1^st, 2013 in traditional format where the minimum percent of D1 is 10% and the maximum percent of D1 is 70%, the URL would look like the following:

If a person wanted to obtain statistics for the percent of area in drought for the two digit HUC 01 between the dates of January 1^st, 2012 and January 1^st, 2013 in traditional format where the minimum percent of D1 is 10% and the maximum percent of D1 is 70%, the URL would look like the following:

Weeks in Drought

---

Get the number of weeks in drought greater than a selected threshold for selected U.S. counties. This can be done based either on consecutive weeks in drought or non-consecutive weeks in drought.

URL Structure

https://usdmdataservices.unl.edu/api/ConsecutiveNonConsecutiveStatistics/[consecutive or non-consecutive]?aoi=[aoi]&dx=[drought level]&minimumweeks=[threshold]&startdate=[start date]&enddate=[end date]

An explanation of each of the variables in the above URL is given below.

[consecutive or non-consecutive]

Data Type	Value
Consecutive Weeks in Drought	GetConsecutiveWeeksCounty
Non-consecutive Weeks in Drought	GetNonConsecutiveStatisticsCounty

[aoi]

Use the two letter abbreviation for the state(s) or leave blank to get data for all states. If you want to use multiple states, separate the abbreviations with a comma (AL,AZ).

Parameter = aoi

[start date] and [end date]

Use the following date format M/D/YYYY for the start date and end date

Use the following date format M/D/YYYY

[drought level]

Drought Level	Value
D0	0
D1	1
D2	2
D3	3
D4	4

[threshold]

The number of weeks in the specified drought category.

Output Format

By default the data are output in XML format. You can specify an output format in the ACCEPT request header. The format options are XML, CSV, and JSON.

Example

The example below will return the counties in Nebraska that were in drought for at least four weeks from January 1st 2013 to January 1st, 2013. In this case the four weeks did not have to occur consecutively.