EPA — U.S. Environmental Protection Agency Analysis Services API is one of 137 APIs that EPA — U.S. Environmental Protection Agency publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
This API exposes 1242 JSON Schema definitions.
Tagged areas include Analysis Services. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 1242 JSON Schemas.
This API exposes
5 operations
across 5 paths,
and defines 60 schemas.
It is described by OpenAPI 3.0.3, at version 1.0.
Requests are made against a single base URL, https://aqs.epa.gov/data/api.
5 operations5 paths60 schemas5 POST
Metadata
The identity and technical contract details declared by the specification.
EPA — U.S. Environmental Protection Agency Analysis Services API declares
1 security scheme
for authenticating requests.
An API key is passed in the query as key (emailKey).
By default, every request must be authenticated.
emailKey — AQS requires email and key query parameters on every request. Register at /signup?email=YOUREMAIL to receive a key by email.
Paths & Operations 5
Across 5 paths, the API surfaces 5 operations — 5 POST. Each is listed below with its method, path, parameters, and response codes.
Analysis Services 5
POST
/rpc/navigate
CIP-service Navigation
navigatebody→ 200
POST
/rpc/delineate
CIP-service Delineation
delineatebody→ 200
POST
/rpc/pointindexing
CIP-service Point Indexing
pointindexingbody→ 200
POST
/rpc/upstreamdownstream
CIP-service Upstream Downstream
upstreamdownstreambody→ 200
POST
/rpc/flow_accumulation
CIP-service Flow Accumulation
flow_accumulationbody→ 200
Schemas 60
The contract defines 60 schemas that model the data the API accepts and returns. The most detailed are upstreamdownstream_rb (49 properties), linked_data_wqp (41 properties), upstreamdownstream_resp (27 properties), navigated_flowline_properties (20 properties). Each schema is shown below with its type and property counts.
flow_accumulation_resp
object
11 properties
start_nhdplusid
integer
NHDPlus flowline NHDPlusID bigint value from which to begin the navigation.
globalid
string
fcode_deny
array
List of FCode values avoided in selecting a candidate reach measure.
measure
number
stop_measure
number
NHD flowline measure at which navigation will cease. Only used in point-to-point navigation.
start_hydroseq
integer
NHDPlus flowline hydro sequence bigint value from which to begin the navigation.
navigate_rb
object
17 properties
stop_reachcode
string
NHD flowline 14-byte reach code value from which navigation will cease. Only used in point-to-point navigation.
delineated_area_properties
object
4 properties
hydroseq
integer
NHDPlus int64 hydro sequence identifier.
flow_accumulation_rb
object
6 properties
return_flowline_geometry
boolean
Switch whether to return flowline geometry information with results.
reachcode
string
split_initial_catchment
boolean
Switch whether to split the initial catchment. Splitting has a cost overhead and if not needed should be avoided.
pointindexing_rb
object
13 properties
stop_permanent_identifier
string
NHD flowline permanent identifier string value from which navigation will cease. Only used in point-to-point navigation.
geojson_feature
objectnull
5 properties3 required
navigate_resp
object
5 properties
linked_data_wqp
object
41 properties
ordinate
number
search_type
string
Navigation methodolody for network discovery of events: - UT = upstream with tributaries navigation - UM = upstream mainstem navigation - DM = downstream mains…
geojson_bbox
array
stop_hydroseq
integer
NHDPlus flowline hydro sequence bigint value at which navigation will cease. Only used in point-to-point navigation.
navigated_flowline_properties
object
20 properties
fill_basin_holes
boolean
Switch whether remove all holes from the returned watershed polygon. This will remove isolated networks and sinks and may not be hydrologically correct.
return_delineation_geometry
boolean
Switch whether to return watershed or catchment geometry with results.
max_distancekm
number
Maximum distance traversed in kilometers for selecting features.
event_feature_properties
object
8 properties
start_permanent_identifier
string
NHD flowline permanent identifier string value from which to begin the navigation. Permanent Identifiers may manifest as text forms of the NHDPlusID or as 40-b…
known_region
string
Provided value to use to determine the proper spatial reference system to use in geometric analysis. Providing an SRID value such as 5070 or a US state code su…
indexing_line_properties
object
1 property
end_point_properties
object
3 properties
aggregation_engine
string
Aggregation engine used to combine (or not) catchments into a watershed.
upstreamdownstream_rb
object
49 properties
delineate_resp
object
7 properties
coordinates2
array
start_reachcode
string
NHD flowline 14-byte reach code value from which to begin the navigation. Provide a start measure to indicate a specific position on the reach.
nhdplus_version
string
NHDPlus version used in CIP indexing.
status_message
stringnull
Status message describing the results of processing. Null indicates success.
flowline_count
integer
Total count of flowlines returned from analysis.
return_flowline_details
boolean
Switch whether to return flowline details with results.
indexing_engine
string
Logic used to select a reach measure for indexing.
max_flowtimeday
number
Maximum flow time traversed in hours for selecting features. May not apply with all NHDPlus versions.
image_format
string
Desired output raster format.
stop_nhdplusid
integer
NHDPlus flowline NHDPlusID bigint value at which navigation will cease. Only used in point-to-point navigation.
indexed_catchment_properties
object
4 properties
linked_data_program
string
geojson_featurecollection
object
GeoJSon Feature collection
2 properties2 required
nhdplusid
integer
NHDPlus int64 nhdplus identifier.
return_code
integer
Status code for results. Zero indicates success.
start_measure
number
NHD flowline measure from which to begin the navigation.
fcode_allow
array
List of FCode values used for selecting a candidate reach measure.
delineate_rb
object
20 properties
geojson_geometry
objectnull
2 properties
coordinates1
array
indexed_flowline_properties
object
6 properties
upstreamdownstream_resp
object
27 properties
pointindexing_resp
object
11 properties
coordinates3
array
Specification
The full machine-readable OpenAPI contract behind this narrative.
