Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

EPA — U.S. Environmental Protection Agency CIP Indexing Services API

The CIP Indexing Services API from EPA — U.S. Environmental Protection Agency — 3 operation(s) for cip indexing services.

EPA — U.S. Environmental Protection Agency CIP Indexing 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 CIP Indexing Services. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 1242 JSON Schemas.

This API exposes 3 operations across 3 paths, and defines 35 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.

3 operations 3 paths 35 schemas 2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0
Base URL
https://aqs.epa.gov/data/api
Authentication
API Key
Resource Areas
1

Authentication & Security 1

EPA — U.S. Environmental Protection Agency CIP Indexing 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 3

Across 3 paths, the API surfaces 3 operations — 2 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

CIP Indexing Services 3
POST
/rpc/cipsrv_index
CIP-service Indexing
cipsrv_index body → 200
GET
/rpc/cipsrv_domains
CIP-service Domains
cipsrv_domains → 200
GET
/rpc/cipsrv_registry
CIP-service Registry Summary of Resources
cipsrv_registry → 200

Schemas 35

The contract defines 35 schemas that model the data the API accepts and returns. The most detailed are cipsrv_index_rb (29 properties), navigated_flowline_properties (20 properties), cipsrv_index_resp (13 properties), event_feature_properties (8 properties). Each schema is shown below with its type and property counts.

wbd_version
string
WBD version used for CIP-service indexing.
globalid
string
measure
number
cipsrv_index_rb
object
29 properties 1 required
delineated_area_properties
object
4 properties
hydroseq
integer
NHDPlus int64 hydro sequence identifier.
cipsrv_domains_tribe
object
4 properties
reachcode
string
geojson_feature
objectnull
5 properties 3 required
cipsrv_domains_states
array
cipsrv_index_resp
object
13 properties
ordinate
number
geojson_bbox
array
cipsrv_registry
object
4 properties
navigated_flowline_properties
object
20 properties
event_feature_properties
object
8 properties
indexing_line_properties
object
1 property
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…
end_point_properties
object
3 properties
coordinates2
array
cipsrv_domains_state
object
3 properties
nhdplus_version
string
NHDPlus version used in CIP indexing.
status_message
stringnull
Status message describing the results of processing. Null indicates success.
indexed_catchment_properties
object
4 properties
cipsrv_domains
object
2 properties
geojson_featurecollection
object
GeoJSon Feature collection
2 properties 2 required
nhdplusid
integer
NHDPlus int64 nhdplus identifier.
return_code
integer
Status code for results. Zero indicates success.
geojson_geometry
objectnull
2 properties
coordinates1
array
indexed_flowline_properties
object
6 properties
indexing_summary
object
short summary report of indexing results.
1 property
cipsrv_domains_tribes
array
coordinates3
array
cipsrv_registry_components
object
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

epa-cip-indexing-services-api-openapi.yml Raw ↑

Other APIs EPA — U.S. Environmental Protection Agency publishes across the network.

EPA Facility Registry Service (FRS) API
EPA TRI (Toxics Release Inventory) Web Service
EPA ATTAINS Web Services
EPA WATERS — Watershed Assessment, Tracking & Environmental Results
EPA Grants API
EPA Insect Repellents API
EPA e-Manifest Hazardous Waste Tracking
EPA System of Registries (SoR)
CTX — Center for Computational Toxicology and Exposure APIs
EPA — U.S. Environmental Protection Agency Account Type Codes API
EPA — U.S. Environmental Protection Agency Accounts API
EPA — U.S. Environmental Protection Agency Air Emission Testing API