@datafire/epa_gov_echo
v6.0.0
Published
DataFire integration for U.S. EPA Enforcement and Compliance History Online (ECHO) - All Data
Downloads
4
Readme
@datafire/epa_gov_echo
Client library for U.S. EPA Enforcement and Compliance History Online (ECHO) - All Data
Installation and Usage
npm install --save @datafire/epa_gov_echolet epa_gov_echo = require('@datafire/epa_gov_echo').create();
.then(data => {
console.log(data);
});Description
Enforcement and Compliance History Online (ECHO) is a tool developed and maintained by EPA's Office of Enforcement and Compliance Assurance for public use. ECHO provides integrated compliance and enforcement information for over 1 million regulated facilities nationwide.
ECHO Rest Services provide multiple service endpoints, each with specific capabilities, to search and retrieve data on facilities regulated as Clean Air Act (CAA) stationary sources, Clean Water Act (CWA) dischargers, Resource Conservation and Recovery Act (RCRA) hazardous waste generators/handlers, and Safe Drinking Water Act (SDWA) public water systems. Data of interest from other EPA sources, such as the Toxics Release Inventory, is also supplied for context.
The get_facilities, get_map, get_qid, and get_download end points are meant to be used together, while the enhanced get_facility_info end point is self contained.
The get_facility_info end point returns either an array of state, county or zip clusters with summary statistics per cluster or an array of facilities.
The recommended use scenario for get_facilities, get_qid, get_map, and get_downoad is:
1) Use get_facilities to validate passed query parameters, obtain summary statistics and to obtain a query_id (QID). QIDs are time sensitive and will be valid for approximately 30 minutes.
2) Use get_qid, with the returned QID, to paginate through arrays of facility results.
3) Use get_map, with the returned QID, to zoom in/out and pan on the clustered and individual facility coordinates that meet the QID query criteria.
4) Use get_download, with the returned QID, to generate a Comma Separated Value (CSV) file of facility information that meets the QID query criteria.
Use the qcolumns parameter to customize your search results. Use the Metadata service endpoint for a list of available output objects, their Column Ids, and their definitions to help you build your customized output.
Additional ECHO Resources: Web Services, About ECHO's Data, Data Downloads
Actions
echo_rest_services.get_download.get
Based on the QID obtained from a get_facilities or get_facility_info query, return a comma separated value (CSV) file of the facilities found.
epa_gov_echo.echo_rest_services.get_download.get({
"qid": ""
}, context)Input
- input
object- output
string: Output Format Flag. Enter one of the following keywords: - qid required
string: Query ID Selector. Enter the QueryID number from a previously run query. - qcolumns
string: Used to customize service output. A list of comma-separated column IDs of output objects that will be returned in the service query object or download. Use the metadata service endpoint for a complete list of Ids and definitions. - p_pretty_print
number: Optional flag to request GeoJSON formatted results to be pretty printed. Only provide a numeric value when the output needs to be human readable as pretty printing has a performance cost.
- output
Output
- output
file
echo_rest_services.get_download.post
Based on the QID obtained from a get_facilities or get_facility_info query, return a comma separated value (CSV) file of the facilities found.
epa_gov_echo.echo_rest_services.get_download.post({
"qid": ""
}, context)Input
- input
object- output
string: Output Format Flag. Enter one of the following keywords: - qid required
string: Query ID Selector. Enter the QueryID number from a previously run query. - qcolumns
string: Used to customize service output. A list of comma-separated column IDs of output objects that will be returned in the service query object or download. Use the metadata service endpoint for a complete list of Ids and definitions. - p_pretty_print
number: Optional flag to request GeoJSON formatted results to be pretty printed. Only provide a numeric value when the output needs to be human readable as pretty printing has a performance cost.
- output
Output
- output
file
echo_rest_services.get_facilities.get
Validates query search parameters and returns query identifier. Use the responseset parameter to set the page size
epa_gov_echo.echo_rest_services.get_facilities.get({}, context)Input
- input
object- output
string(values: JSONP, JSON, XML): Output Format Flag. Enter one of the following keywords: - p_fn
string: Facility Name Filter. Enter one or more case-insensitive facility names to filter results. Provide multiple values as a comma-delimited list. See p_fntype for additional modifiers. - p_sa
string: Facility street address. Enter a complete or partial street address. - p_sa1
string: Facility street address. Enter a complete or partial street address. Note that p_sa1 is culmulative with p_sa. - p_ct
string: Facility City Filter. Enter a single case-insensitive city name to filter results. - p_co
string: Facility County Filter. Provide a single county name in combination with a state value provided via p_st. - p_fips
string: FIPS Code Filter. Enter a single 5-character Federal Information Processing Standards (FIPS) state + county value to restrict results. E.g. to limit results to Kenosha County, Wisconsin, use 55059. - p_st
string: Facility State and State-Equivalent Filter. Provide one or more USPS postal abbreviations for states and state-equivalents to filter results. Provide multiple values as a comma-delimited list. - p_zip
string: 5-Digit ZIP Code Filter. Provide one or more 5-digit postal zip codes to filter results. May contain multiple comma-separated values. - p_frs
string: Facility Registry Service ID Filter. Enter a single 12-digit FRS identifier to filter results. - p_reg
string(values: 01, 02, 03, 04, 05, 06, 07, 08, 09, 10): EPA Region Filter. Provide a single value of 01 thru 10 to restrict results to a single EPA region. - p_sic
string: Standard Industrial Classification (SIC) Code Filter. Enter a single 4-digit SIC Code to filter results. If more complex filtering is required, use p_sic2 and p_sic4. - p_ncs
string: North American Industry Classification System Filter. Enter two to six digits to filter results to facilities having matching NAICS codes. Digits less than six will match to all codes beginning with the provided values. - p_pen
string: Last Penality Date Qualifier Filter. Enter one of the following: - p_c1lat
number: In decimal degrees. Latitude of 1st corner of box that bounds the resulting facilities. The latitude and longitude of both corners of the bounding box must be provided. - p_c1lon
number: In decimal degrees. Longitude of 1st corner of box that bounds the resulting facilities. The latitude and longitude of both corners of the bounding box must be provided. - p_c2lat
number: In decimal degrees. Latitude of 2nd corner of box that bounds the resulting facilities. The latitude and longitude of both corners of the bounding box must be provided. - p_c2lon
number: In decimal degrees. Longitude of 2nd corner of box that bounds the resulting facilities. The latitude and longitude of both corners of the bounding box must be provided. - p_usmex
string(values: Y, N): US-Mexico Border Flag. Enter Y/N to restrict searches to facilities located within 100KM of the border. - p_sic2
string: Standard Industrial Classification (SIC) Code Filter Alternate 2. Enter a wild-card search against SIC codes. A final wild-card is always present allowing "22" to match all SIC codes beginning with 22. Use the "%" character within strings to match any SIC values with the pattern. For example, "2%21" matches 2021, 2121, 2221, etc. - p_sic4
string: Standard Industrial Classification (SIC) Code Filter Alternate 3. Enter the first 2, 3 or 4 SIC code digits to filter results to facilities having those code prefixes. As this alternative does not utilize an index, p_sic2 will generally be quicker. - p_fa
string: Federal Agency. 1 character or 5-character values; may contain multiple comma-separated values. ALL will retrieve all facilities where the federal agency code is not null. Use the Federal Agencies lookup service to obtain a list of values. - p_ff
string(values: Y): Federal Facility Indicator Flag. Enter Y to restrict searches to federal facilities. - p_act
string(values: Y, N, A): Active Permits/Facilities Flag. Provide Y or N to filter results to facilities with active permits. - p_maj
string(values: Y, N): Major Facility Flag. Enter Y to restrict results to Major facilities only. - p_mact
string: CAA Maximum Achievable Control Technology (MACT) Subpart codes (alpha ID between 1 and 7 characters) applicable to the facility. - p_fea
string(values: W, N): Formal Enforcement Actions [within / not within] specified date range indicator. The date range is determined by parameters p_fead1 and p_fead2 or by parameter p_feay. - p_feay
number(values: 1, 2, 3, 4, 5): Years (1 to 5) Range. This value is used to create a date range for Formal Enforcement Actions (FEA). Used along with p_fea (which indicates whether to look within or outside of the date range) to find FEAs within (or not within) the number of years specified. - p_feaa
string(values: A, E, S): Agency associated with Formal Enforcement Actions: - p_feac
string: Formal Enforcment Action Last Case Date Limiter Flag. Enter a value of "Y" to additionally apply the p_feay year filter to the last formal enforcement action case date. Use the p_fea parameter to control if the filter is within or outside the date span provided. - p_fea_5yr
string: A Y value identifies facilities that have had a formal enforcement action within the last 5 years. - p_iea
string(values: W, N): Informal Enforcement Actions [within / not within] specified date range. The date range is determined by parameters p_iead1 and p_iead2 or by parameter p_ieay. - p_ieay
number(values: 1, 2, 3, 4, 5): Years (1 to 5) Range. This value is used to create a date range for Informal Enforcement Actions (IEA). Used along with p_iea (which indicates whether to look within or outside of the date range) to find IEAs within (or not within) the number of years specified. - p_ieaa
string(values: E, S): Agency associated with Informal Enforcement Actions. If left blank, both agencies are included. - p_iea_5yr
string: A Y value identifies facilities that have had an informal enforcement action within the last 5 years. - p_cs
number(values: 2, 3, 4): Facility Compliance Limiter. Enter 2, 3 or 4 to limit facilities returned. - p_qiv
string(values: 0, GT1, GT2, GT4, GT8, 12): Quarters in Noncompliance Limiter. Enter a coded value to limit results to facilities with given quarter of noncompliance. - p_naa
string: Non-Attainment Area Flag. Enter a Y or N to filter for or against facilities flagged as non-attainment areas. - p_impw
string(values: Y, N): Discharging into Impaired Waters Flag. Enter Y to limit results to facilities with discharge to waterbodies listed as impaired in the ATTAINS database. - p_trep
string(values: CURR, NOTCURR): Current Toxics Release Inventory (TRI) Reporter Limiter. Enter one of the following codes to limit results. - p_ocr
string: Toxics Release Inventory Pounds of On-Site Chemical Releases Limiter. Enter a keyword to filter results. - p_oct
string(values: Z, GT0, GT1000, GT5000, GT10000, GT20000, GT50000): Toxic Release Inventory Pounds of Off-Site Chemical Releases Limiter. Enter a keyword to filter results. - p_pm
string(values: NONE, GT5, GT10, GT25, GT50, GT75): Percent Minority Population Limiter. Enter a value to restrict results to facilities with a given percentage of minority population within 3-mile radius. - p_pd
string(values: NONE, GT100, GT500, GT1000, GT5000, GT10000, GT20000): Population Density Limiter (per sq mile). Enter a value to limit results to facilities located in area of a given population density. - p_ico
string(values: Y, N): Indian Country Flag. Enter a "Y" or "N" to restrict searches to facilities inside or outside Indian Country. - p_huc
string: 2-, 4-, 6-, or 8-character watershed code. May contain multiple comma-separated values. - p_pid
string: Nine-digit permit IDs. May contain up to 2000 comma-separated values. - p_med
string(values: A, C, E, G, M, R, S, T, TSCA, W, ALL): Filter Results by Media.- A = Air- C = CAMD (Clean Air Markets Division)- E = EIS (Emissions Inventory Systems)- G = GHG (Greenhouse Gases)- M = RMP (Risk Management Plan)- R = RCRA (Hazardous Waste)- S = SDWA (Public Drinking Water Systems)- T = TRI (Toxic Release Inventory)- TSCA = TSCA (Toxic Substances Control Act)- W = Water- ALL = Air and Water and RCRA - p_istatute
string: For use in identifying Facilities that have an inspection performed under the entered Statute. - p_ysl
string(values: W, N, NV): Last Facility Inspection [within / not within] Specified Date Range Indicator. The date range is determined by parameters p_idt1 and p_idt2 or by parameter p_ysly. - p_ysly
number(values: 1, 2, 3, 4, 5): Number of years (1 to 5) since last facility inspection. A value of 1 means that it has been inspected within the year. - p_ysla
string(values: E, S, A): Facility Last Inspection Code Filter. If left blank, both agencies are included. Enter a value to limit results: - p_qs
string: Quick Search. Allows entry for city, state, and/or zip code. - p_sfs
string: Single Facility Search Filter. Provide a facility name or program system identifier to limit results. For the all data search, the FRS registry identifier is also searched. - p_tribeid
number: Numeric code for tribe (or list of tribes). - p_tribename
string: Tribe Name Filter. Enter a single tribe name to filter results. - p_tribedist
number: Proximity to tribal land limiter. Enter an amount of mile between 0 and 25 to filter results. This parameter is only evaluated if p_tribeid is populated. - p_wbd
string: 2-, 4-, 6-, 8-, 10-, or 12-character watershed (WBD from the USGS Watershed Boundary Dataset). May contain multiple comma-separated values. Uses the FRS Best Pick Coordinate to obtain the WBD12 Huc value. - p_fntype
string(values: ALL, CONTAINS, EXACT, BEGINS): Controls type of text search performed on facility name with parameter p_fn. - p_icoo
string: Indian country search and/or flag. Enter "Y" to set indian country search conditions to return any results found using p_ico, p_fac_ico or p_fac_icoo. Otherwise only results matching all provided p_ico, p_fac_ico or p_fac_icoo conditions will be returned. - p_fac_icos
string: FRS tribal land spatial flag. Enter "Y" or "N" to include or exclude facilities based on FRS tribal land spatial flag. - p_ejscreen
string: Enter "Y" to limit facilities to Census block groups where one of more Environmental Justice indexes above 80th percentile. - p_limit_addr
string(values: Y, N): Limit Address Search Flag. Enter Y to restrict facility searches to native data source only. - p_lat
number: Latitude location in decimal degrees. - p_long
number: Longitude location in decimal degrees. - p_radius
number: Spatial Search Radius. Enter a radius up to 100 miles in which to spatially search for facilities. - p_ejscreen_over80cnt
string(values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11): The number of Environmenmt Justice Indicators above the 80th percentile. Valid values are 1 through 11. - p_agoo
string(values: AND, OR): Indicates whether to AND or OR the Owner/Operator parameter (p_owop) and the federal agency code (p_fa) parameters. - p_neiu
string - queryset
number: Query Limiter. Enter a value to limit the number of records returned for each query. Value cannot exceed 70,000. - responseset
number: Response Set Limiter. Enter a value to limit the number of records per page. Value cannot exceed 1,000. - tablelist
string(values: Y, N): Table List Flag. Enter a Y to display the first page of facility results. - maplist
string(values: Y, N): Map List Flag. Provide a Y to return mappable coordinates representing the full geographic extent of the queryset (all facilities that met the selection criteria). - summarylist
string(values: Y, N): Summary List Flag. Enter a Y to return a list of summary statistics based on the parameters submitted to the query service. - callback
string: JSONP Callback. For use with JSONP and GEOJSONP output only. Enter a name of the function in which to wrap the JSON response. - qcolumns
string: Used to customize service output. A list of comma-separated column IDs of output objects that will be returned in the service query object or download. Use the metadata service endpoint for a complete list of Ids and definitions.
- output
Output
- output
object: Root Object- Results required echo04
echo_rest_services.get_facilities.post
Validates query search parameters and returns query identifier. Use the responseset parameter to set the page size
epa_gov_echo.echo_rest_services.get_facilities.post({}, context)Input
- input
object- output
string(values: JSONP, JSON, XML): Output Format Flag. Enter one of the following keywords: - p_fn
string: Facility Name Filter. Enter one or more case-insensitive facility names to filter results. Provide multiple values as a comma-delimited list. See p_fntype for additional modifiers. - p_sa
string: Facility street address. Enter a complete or partial street address. - p_sa1
string: Facility street address. Enter a complete or partial street address. Note that p_sa1 is culmulative with p_sa. - p_ct
string: Facility City Filter. Enter a single case-insensitive city name to filter results. - p_co
string: Facility County Filter. Provide a single county name in combination with a state value provided via p_st. - p_fips
string: FIPS Code Filter. Enter a single 5-character Federal Information Processing Standards (FIPS) state + county value to restrict results. E.g. to limit results to Kenosha County, Wisconsin, use 55059. - p_st
string: Facility State and State-Equivalent Filter. Provide one or more USPS postal abbreviations for states and state-equivalents to filter results. Provide multiple values as a comma-delimited list. - p_zip
string: 5-Digit ZIP Code Filter. Provide one or more 5-digit postal zip codes to filter results. May contain multiple comma-separated values. - p_frs
string: Facility Registry Service ID Filter. Enter a single 12-digit FRS identifier to filter results. - p_reg
string(values: 01, 02, 03, 04, 05, 06, 07, 08, 09, 10): EPA Region Filter. Provide a single value of 01 thru 10 to restrict results to a single EPA region. - p_sic
string: Standard Industrial Classification (SIC) Code Filter. Enter a single 4-digit SIC Code to filter results. If more complex filtering is required, use p_sic2 and p_sic4. - p_ncs
string: North American Industry Classification System Filter. Enter two to six digits to filter results to facilities having matching NAICS codes. Digits less than six will match to all codes beginning with the provided values. - p_pen
string: Last Penality Date Qualifier Filter. Enter one of the following: - p_c1lat
number: In decimal degrees. Latitude of 1st corner of box that bounds the resulting facilities. The latitude and longitude of both corners of the bounding box must be provided. - p_c1lon
number: In decimal degrees. Longitude of 1st corner of box that bounds the resulting facilities. The latitude and longitude of both corners of the bounding box must be provided. - p_c2lat
number: In decimal degrees. Latitude of 2nd corner of box that bounds the resulting facilities. The latitude and longitude of both corners of the bounding box must be provided. - p_c2lon
number: In decimal degrees. Longitude of 2nd corner of box that bounds the resulting facilities. The latitude and longitude of both corners of the bounding box must be provided. - p_usmex
string(values: Y, N): US-Mexico Border Flag. Enter Y/N to restrict searches to facilities located within 100KM of the border. - p_sic2
string: Standard Industrial Classification (SIC) Code Filter Alternate 2. Enter a wild-card search against SIC codes. A final wild-card is always present allowing "22" to match all SIC codes beginning with 22. Use the "%" character within strings to match any SIC values with the pattern. For example, "2%21" matches 2021, 2121, 2221, etc. - p_sic4
string: Standard Industrial Classification (SIC) Code Filter Alternate 3. Enter the first 2, 3 or 4 SIC code digits to filter results to facilities having those code prefixes. As this alternative does not utilize an index, p_sic2 will generally be quicker. - p_fa
string: Federal Agency. 1 character or 5-character values; may contain multiple comma-separated values. ALL will retrieve all facilities where the federal agency code is not null. Use the Federal Agencies lookup service to obtain a list of values. - p_ff
string(values: Y): Federal Facility Indicator Flag. Enter Y to restrict searches to federal facilities. - p_act
string(values: Y, N, A): Active Permits/Facilities Flag. Provide Y or N to filter results to facilities with active permits. - p_maj
string(values: Y, N): Major Facility Flag. Enter Y to restrict results to Major facilities only. - p_mact
string: CAA Maximum Achievable Control Technology (MACT) Subpart codes (alpha ID between 1 and 7 characters) applicable to the facility. - p_fea
string(values: W, N): Formal Enforcement Actions [within / not within] specified date range indicator. The date range is determined by parameters p_fead1 and p_fead2 or by parameter p_feay. - p_feay
number(values: 1, 2, 3, 4, 5): Years (1 to 5) Range. This value is used to create a date range for Formal Enforcement Actions (FEA). Used along with p_fea (which indicates whether to look within or outside of the date range) to find FEAs within (or not within) the number of years specified. - p_feaa
string(values: A, E, S): Agency associated with Formal Enforcement Actions: - p_feac
string: Formal Enforcment Action Last Case Date Limiter Flag. Enter a value of "Y" to additionally apply the p_feay year filter to the last formal enforcement action case date. Use the p_fea parameter to control if the filter is within or outside the date span provided. - p_fea_5yr
string: A Y value identifies facilities that have had a formal enforcement action within the last 5 years. - p_iea
string(values: W, N): Informal Enforcement Actions [within / not within] specified date range. The date range is determined by parameters p_iead1 and p_iead2 or by parameter p_ieay. - p_ieay
number(values: 1, 2, 3, 4, 5): Years (1 to 5) Range. This value is used to create a date range for Informal Enforcement Actions (IEA). Used along with p_iea (which indicates whether to look within or outside of the date range) to find IEAs within (or not within) the number of years specified. - p_ieaa
string(values: E, S): Agency associated with Informal Enforcement Actions. If left blank, both agencies are included. - p_iea_5yr
string: A Y value identifies facilities that have had an informal enforcement action within the last 5 years. - p_cs
number(values: 2, 3, 4): Facility Compliance Limiter. Enter 2, 3 or 4 to limit facilities returned. - p_qiv
string(values: 0, GT1, GT2, GT4, GT8, 12): Quarters in Noncompliance Limiter. Enter a coded value to limit results to facilities with given quarter of noncompliance. - p_naa
string: Non-Attainment Area Flag. Enter a Y or N to filter for or against facilities flagged as non-attainment areas. - p_impw
string(values: Y, N): Discharging into Impaired Waters Flag. Enter Y to limit results to facilities with discharge to waterbodies listed as impaired in the ATTAINS database. - p_trep
string(values: CURR, NOTCURR): Current Toxics Release Inventory (TRI) Reporter Limiter. Enter one of the following codes to limit results. - p_ocr
string: Toxics Release Inventory Pounds of On-Site Chemical Releases Limiter. Enter a keyword to filter results. - p_oct
string(values: Z, GT0, GT1000, GT5000, GT10000, GT20000, GT50000): Toxic Release Inventory Pounds of Off-Site Chemical Releases Limiter. Enter a keyword to filter results. - p_pm
string(values: NONE, GT5, GT10, GT25, GT50, GT75): Percent Minority Population Limiter. Enter a value to restrict results to facilities with a given percentage of minority population within 3-mile radius. - p_pd
string(values: NONE, GT100, GT500, GT1000, GT5000, GT10000, GT20000): Population Density Limiter (per sq mile). Enter a value to limit results to facilities located in area of a given population density. - p_ico
string(values: Y, N): Indian Country Flag. Enter a "Y" or "N" to restrict searches to facilities inside or outside Indian Country. - p_huc
string: 2-, 4-, 6-, or 8-character watershed code. May contain multiple comma-separated values. - p_pid
string: Nine-digit permit IDs. May contain up to 2000 comma-separated values. - p_med
string(values: A, C, E, G, M, R, S, T, TSCA, W, ALL): Filter Results by Media.- A = Air- C = CAMD (Clean Air Markets Division)- E = EIS (Emissions Inventory Systems)- G = GHG (Greenhouse Gases)- M = RMP (Risk Management Plan)- R = RCRA (Hazardous Waste)- S = SDWA (Public Drinking Water Systems)- T = TRI (Toxic Release Inventory)- TSCA = TSCA (Toxic Substances Control Act)- W = Water- ALL = Air and Water and RCRA - p_istatute
string: For use in identifying Facilities that have an inspection performed under the entered Statute. - p_ysl
string(values: W, N, NV): Last Facility Inspection [within / not within] Specified Date Range Indicator. The date range is determined by parameters p_idt1 and p_idt2 or by parameter p_ysly. - p_ysly
number(values: 1, 2, 3, 4, 5): Number of years (1 to 5) since last facility inspection. A value of 1 means that it has been inspected within the year. - p_ysla
string(values: E, S, A): Facility Last Inspection Code Filter. If left blank, both agencies are included. Enter a value to limit results: - p_qs
string: Quick Search. Allows entry for city, state, and/or zip code. - p_sfs
string: Single Facility Search Filter. Provide a facility name or program system identifier to limit results. For the all data search, the FRS registry identifier is also searched. - p_tribeid
number: Numeric code for tribe (or list of tribes). - p_tribename
string: Tribe Name Filter. Enter a single tribe name to filter results. - p_tribedist
number: Proximity to tribal land limiter. Enter an amount of mile between 0 and 25 to filter results. This parameter is only evaluated if p_tribeid is populated. - p_wbd
string: 2-, 4-, 6-, 8-, 10-, or 12-character watershed (WBD from the USGS Watershed Boundary Dataset). May contain multiple comma-separated values. Uses the FRS Best Pick Coordinate to obtain the WBD12 Huc value. - p_fntype
string(values: ALL, CONTAINS, EXACT, BEGINS): Controls type of text search performed on facility name with parameter p_fn. - p_icoo
string: Indian country search and/or flag. Enter "Y" to set indian country search conditions to return any results found using p_ico, p_fac_ico or p_fac_icoo. Otherwise only results matching all provided p_ico, p_fac_ico or p_fac_icoo conditions will be returned. - p_fac_icos
string: FRS tribal land spatial flag. Enter "Y" or "N" to include or exclude facilities based on FRS tribal land spatial flag. - p_ejscreen
string: Enter "Y" to limit facilities to Census block groups where one of more Environmental Justice indexes above 80th percentile. - p_limit_addr
string(values: Y, N): Limit Address Search Flag. Enter Y to restrict facility searches to native data source only. - p_lat
number: Latitude location in decimal degrees. - p_long
number: Longitude location in decimal degrees. - p_radius
number: Spatial Search Radius. Enter a radius up to 100 miles in which to spatially search for facilities. - p_ejscreen_over80cnt
string(values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11): The number of Environmenmt Justice Indicators above the 80th percentile. Valid values are 1 through 11. - p_agoo
string(values: AND, OR): Indicates whether to AND or OR the Owner/Operator parameter (p_owop) and the federal agency code (p_fa) parameters. - p_neiu
string - queryset
number: Query Limiter. Enter a value to limit the number of records returned for each query. Value cannot exceed 70,000. - responseset
number: Response Set Limiter. Enter a value to limit the number of records per page. Value cannot exceed 1,000. - tablelist
string(values: Y, N): Table List Flag. Enter a Y to display the first page of facility results. - maplist
string(values: Y, N): Map List Flag. Provide a Y to return mappable coordinates representing the full geographic extent of the queryset (all facilities that met the selection criteria). - summarylist
string(values: Y, N): Summary List Flag. Enter a Y to return a list of summary statistics based on the parameters submitted to the query service. - callback
string: JSONP Callback. For use with JSONP and GEOJSONP output only. Enter a name of the function in which to wrap the JSON response. - qcolumns
string: Used to customize service output. A list of comma-separated column IDs of output objects that will be returned in the service query object or download. Use the metadata service endpoint for a complete list of Ids and definitions.
- output
Output
- output
object: Root Object- Results required echo04
echo_rest_services.get_facility_info.get
Returns either an array of Facilities or an array of Clusters that meet the specified search criteria.
epa_gov_echo.echo_rest_services.get_facility_info.get({}, context)Input
- input
object- output
string: Output Format Flag. Enter one of the following keywords: - p_fn
string: Facility Name Filter. Enter one or more case-insensitive facility names to filter results. Provide multiple values as a comma-delimited list. See p_fntype for additional modifiers. - p_sa
string: Facility street address. Enter a complete or partial street address. - p_sa1
string: Facility street address. Enter a complete or partial street address. Note that p_sa1 is culmulative with p_sa. - p_ct
string: Facility City Filter. Enter a single case-insensitive city name to filter results. - p_co
string: Facility County Filter. Provide a single county name in combination with a state value provided via p_st. - p_fips
string: FIPS Code Filter. Enter a single 5-character Federal Information Processing Standards (FIPS) state + county value to restrict results. E.g. to limit results to Kenosha County, Wisconsin, use 55059. - p_st
string: Facility State and State-Equivalent Filter. Provide one or more USPS postal abbreviations for states and state-equivalents to filter results. Provide multiple values as a comma-delimited list. - p_zip
string: 5-Digit ZIP Code Filter. Provide one or more 5-digit postal zip codes to filter results. May contain multiple comma-separated values. - p_frs
string: Facility Registry Service ID Filter. Enter a single 12-digit FRS identifier to filter results. - p_reg
string(values: 01, 02, 03, 04, 05, 06, 07, 08, 09, 10): EPA Region Filter. Provide a single value of 01 thru 10 to restrict results to a single EPA region. - p_sic
string: Standard Industrial Classification (SIC) Code Filter. Enter a single 4-digit SIC Code to filter results. If more complex filtering is required, use p_sic2 and p_sic4. - p_ncs
string: North American Industry Classification System Filter. Enter two to six digits to filter results to facilities having matching NAICS codes. Digits less than six will match to all codes beginning with the provided values. - p_pen
string: Last Penality Date Qualifier Filter. Enter one of the following: - xmin
number: Minimum longitude value in decimal degrees. - ymin
number: Minimum latitude value in decimal degrees. - xmax
number: Maximum longitude value in decimal degrees. - ymax
number: Maximum latitude value in decimal degrees. - p_usmex
string(values: Y, N): US-Mexico Border Flag. Enter Y/N to restrict searches to facilities located within 100KM of the border. - p_sic2
string: Standard Industrial Classification (SIC) Code Filter Alternate 2. Enter a wild-card search against SIC codes. A final wild-card is always present allowing "22" to match all SIC codes beginning with 22. Use the "%" character within strings to match any SIC values with the pattern. For example, "2%21" matches 2021, 2121, 2221, etc. - p_sic4
string: Standard Industrial Classification (SIC) Code Filter Alternate 3. Enter the first 2, 3 or 4 SIC code digits to filter results to facilities having those code prefixes. As this alternative does not utilize an index, p_sic2 will generally be quicker. - p_fa
string: Federal Agency. 1 character or 5-character values; may contain multiple comma-separated values. ALL will retrieve all facilities where the federal agency code is not null. Use the Federal Agencies lookup service to obtain a list of values. - p_ff
string(values: Y): Federal Facility Indicator Flag. Enter Y to restrict searches to federal facilities. - p_act
string(values: Y, N, A): Active Permits/Facilities Flag. Provide Y or N to filter results to facilities with active permits. - p_maj
string(values: Y, N): Major Facility Flag. Enter Y to restrict results to Major facilities only. - p_mact
string: CAA Maximum Achievable Control Technology (MACT) Subpart codes (alpha ID between 1 and 7 characters) applicable to the facility. - p_fea
string(values: W, N): Formal Enforcement Actions [within / not within] specified date range indicator. The date range is determined by parameters p_fead1 and p_fead2 or by parameter p_feay. - p_feay
number(values: 1, 2, 3, 4, 5): Years (1 to 5) Range. This value is used to create a date range for Formal Enforcement Actions (FEA). Used along with p_fea (which indicates whether to look within or outside of the date range) to find FEAs within (or not within) the number of years specified. - p_feaa
string(values: A, E, S): Agency associated with Formal Enforcement Actions: - p_feac
string: Formal Enforcment Action Last Case Date Limiter Flag. Enter a value of "Y" to additionally apply the p_feay year filter to the last formal enforcement action case date. Use the p_fea parameter to control if the filter is within or outside the date span provided. - p_feac_5yr
string - p_iea
string(values: W, N): Informal Enforcement Actions [within / not within] specified date range. The date range is determined by parameters p_iead1 and p_iead2 or by parameter p_ieay. - p_ieay
number(values: 1, 2, 3, 4, 5): Years (1 to 5) Range. This value is used to create a date range for Informal Enforcement Actions (IEA). Used along with p_iea (which indicates whether to look within or outside of the date range) to find IEAs within (or not within) the number of years specified. - p_ieaa
string(values: E, S): Agency associated with Informal Enforcement Actions. If left blank, both agencies are included. - p_iea_5yr
string: A Y value identifies facilities that have had an informal enforcement action within the last 5 years. - p_cs
number(values: 2, 3, 4): Facility Compliance Limiter. Enter 2, 3 or 4 to limit facilities returned. - p_qiv
string(values: 0, GT1, GT2, GT4, GT8, 12): Quarters in Noncompliance Limiter. Enter a coded value to limit results to facilities with given quarter of noncompliance. - p_naa
string: Non-Attainment Area Flag. Enter a Y or N to filter for or against facilities flagged as non-attainment areas. - p_impw
string(values: Y, N): Discharging into Impaired Waters Flag. Enter Y to limit results to facilities with discharge to waterbodies listed as impaired in the ATTAINS database. - p_trep
string(values: CURR, NOTCURR): Current Toxics Release Inventory (TRI) Reporter Limiter. Enter one of the following codes to limit results. - p_ocr
string: Toxics Release Inventory Pounds of On-Site Chemical Releases Limiter. Enter a keyword to filter results. - p_oct
string(values: Z, GT0, GT1000, GT5000, GT10000, GT20000, GT50000): Toxic Release Inventory Pounds of Off-Site Chemical Releases Limiter. Enter a keyword to filter results. - p_pm
string(values: NONE, GT5, GT10, GT25, GT50, GT75): Percent Minority Population Limiter. Enter a value to restrict results to facilities with a given percentage of minority population within 3-mile radius. - p_pd
string(values: NONE, GT100, GT500, GT1000, GT5000, GT10000, GT20000): Population Density Limiter (per sq mile). Enter a value to limit results to facilities located in area of a given population density. - p_ico
string(values: Y, N): Indian Country Flag. Enter a "Y" or "N" to restrict searches to facilities inside or outside Indian Country. - p_huc
string: 2-, 4-, 6-, or 8-character watershed code. May contain multiple comma-separated values. - p_pid
string: Nine-digit permit IDs. May contain up to 2000 comma-separated values. - p_med
string(values: A, C, E, G, M, R, S, T, TSCA, W, ALL): Filter Results by Media.- A = Air- C = CAMD (Clean Air Markets Division)- E = EIS (Emissions Inventory Systems)- G = GHG (Greenhouse Gases)- M = RMP (Risk Management Plan)- R = RCRA (Hazardous Waste)- S = SDWA (Public Drinking Water Systems)- T = TRI (Toxic Release Inventory)- TSCA = TSCA (Toxic Substances Control Act)- W = Water- ALL = Air and Water and RCRA - p_istatute
string: For use in identifying Facilities that have an inspection performed under the entered Statute. - p_ysl
string(values: W, N, NV): Last Facility Inspection [within / not within] Specified Date Range Indicator. The date range is determined by parameters p_idt1 and p_idt2 or by parameter p_ysly. - p_ysly
number(values: 1, 2, 3, 4, 5): Number of years (1 to 5) since last facility inspection. A value of 1 means that it has been inspected within the year. - p_ysla
string(values: E, S, A): Facility Last Inspection Code Filter. If left blank, both agencies are included. Enter a value to limit results: - p_qs
string: Quick Search. Allows entry for city, state, and/or zip code. - p_sfs
string: Single Facility Search Filter. Provide a facility name or program system identifier to limit results. For the all data search, the FRS registry identifier is also searched. - p_tribeid
number: Numeric code for tribe (or list of tribes). - p_tribename
string: Tribe Name Filter. Enter a single tribe name to filter results. - p_tribedist
number: Proximity to tribal land limiter. Enter an amount of mile between 0 and 25 to filter results. This parameter is only evaluated if p_tribeid is populated. - p_wbd
string: 2-, 4-, 6-, 8-, 10-, or 12-character watershed (WBD from the USGS Watershed Boundary Dataset). May contain multiple comma-separated values. Uses the FRS Best Pick Coordinate to obtain the WBD12 Huc value. - p_fntype
string(values: ALL, CONTAINS, EXACT, BEGINS): Controls type of text search performed on facility name with parameter p_fn. - p_icoo
string: Indian country search and/or flag. Enter "Y" to set indian country search conditions to return any results found using p_ico, p_fac_ico or p_fac_icoo. Otherwise only results matching all provided p_ico, p_fac_ico or p_fac_icoo conditions will be returned. - p_fac_icos
string: FRS tribal land spatial flag. Enter "Y" or "N" to include or exclude facilities based on FRS tribal land spatial flag. - p_ejscreen
string: Enter "Y" to limit facilities to Census block groups where one of more Environmental Justice indexes above 80th percentile. - p_limit_addr
string(values: Y, N): Limit Address Search Flag. Enter Y to restrict facility searches to native data source only. - p_lat
number: Latitude location in decimal degrees. - p_long
number: Longitude location in decimal degrees. - p_radius
number: Spatial Search Radius. Enter a radius up to 100 miles in which to spatially search for facilities. - p_ejscreen_over80cnt
string(values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11): The number of Environmenmt Justice Indicators above the 80th percentile. Valid values are 1 through 11. - p_agoo
string(values: AND, OR): Indicates whether to AND or OR the Owner/Operator parameter (p_owop) and the federal agency code (p_fa) parameters. - p_neiu
string - responseset
number: Response Set Limiter. Enter a value to limit the number of records per page. Value cannot exceed 1,000. - callback
string: JSONP Callback. For use with JSONP and GEOJSONP output only. Enter a name of the function in which to wrap the JSON response. - qcolumns
string: Used to customize service output. A list of comma-separated column IDs of output objects that will be returned in the service query object or download. Use the metadata service endpoint for a complete list of Ids and definitions. - p_pretty_print
number: Optional flag to request GeoJSON formatted results to be pretty printed. Only provide a numeric value when the output needs to be human readable as pretty printing has a performance cost.
- output
Output
- output
object: Root Object- Results required echo08
echo_rest_services.get_facility_info.post
Returns either an array of Facilities or an array of Clusters that meet the specified search criteria.
epa_gov_echo.echo_rest_services.get_facility_info.post({}, context)Input
- input
object- output
string: Output Format Flag. Enter one of the following keywords: - p_fn
string: Facility Name Filter. Enter one or more case-insensitive facility names to filter results. Provide multiple values as a comma-delimited list. See p_fntype for additional modifiers. - p_sa
string: Facility street address. Enter a complete or partial street address. - p_sa1
string: Facility street address. Enter a complete or partial street address. Note that p_sa1 is culmulative with p_sa. - p_ct
string: Facility City Filter. Enter a single case-insensitive city name to filter results. - p_co
string: Facility County Filter. Provide a single county name in combination with a state value provided via p_st. - p_fips
string: FIPS Code Filter. Enter a single 5-character Federal Information Processing Standards (FIPS) state + county value to restrict results. E.g. to limit results to Kenosha County, Wisconsin, use 55059. - p_st
string: Facility State and State-Equivalent Filter. Provide one or more USPS postal abbreviations for states and state-equivalents to filter results. Provide multiple values as a comma-delimited list. - p_zip
string: 5-Digit ZIP Code Filter. Provide one or more 5-digit postal zip codes to filter results. May contain multiple comma-separated values. - p_frs
string: Facility Registry Service ID Filter. Enter a single 12-digit FRS identifier to filter results. - p_reg
string(values: 01, 02, 03, 04, 05, 06, 07, 08, 09, 10): EPA Region Filter. Provide a single value of 01 thru 10 to restrict results to a single EPA region. - p_sic
string: Standard Industrial Classification (SIC) Code Filter. Enter a single 4-digit SIC Code to filter results. If more complex filtering is required, use p_sic2 and p_sic4. - p_ncs
string: North American Industry Classification System Filter. Enter two to six digits to filter results to facilities having matching NAICS codes. Digits less than six will match to all codes beginning with the provided values. - p_pen
string: Last Penality Date Qualifier Filter. Enter one of the following: - xmin
number: Minimum longitude value in decimal degrees. - ymin
number: Minimum latitude value in decimal degrees. - xmax
number: Maximum longitude value in decimal degrees. - ymax
number: Maximum latitude value in decimal degrees. - p_usmex
string(values: Y, N): US-Mexico Border Flag. Enter Y/N to restrict searches to facilities located within 100KM of the border. - p_sic2
string: Standard Industrial Classification (SIC) Code Filter Alternate 2. Enter a wild-card search against SIC codes. A final wild-card is always present allowing "22" to match all SIC codes beginning with 22. Use the "%" character within strings to match any SIC values with the pattern. For example, "2%21" matches 2021, 2121, 2221, etc. - p_sic4
string: Standard Industrial Classification (SIC) Code Filter Alternate 3. Enter the first 2, 3 or 4 SIC code digits to filter results to facilities having those code prefixes. As this alternative does not utilize an index, p_sic2 will generally be quicker. - p_fa
string: Federal Agency. 1 character or 5-character values; may contain multiple comma-separated values. ALL will retrieve all facilities where the federal agency code is not null. Use the Federal Agencies lookup service to obtain a list of values. - p_ff
string(values: Y): Federal Facility Indicator Flag. Enter Y to restrict searches to federal facilities. - p_act
string(values: Y, N, A): Active Permits/Facilities Flag. Provide Y or N to filter results to facilities with active permits. - p_maj
string(values: Y, N): Major Facility Flag. Enter Y to restrict results to Major facilities only. - p_mact
string: CAA Maximum Achievable Control Technology (MACT) Subpart codes (alpha ID between 1 and 7 characters) applicable to the facility. - p_fea
string(values: W, N): Formal Enforcement Actions [within / not within] specified date range indicator. The date range is determined by parameters p_fead1 and p_fead2 or by parameter p_feay. - p_feay
number(values: 1, 2, 3, 4, 5): Years (1 to 5) Range. This value is used to create a date range for Formal Enforcement Actions (FEA). Used along with p_fea (which indicates whether to look within or outside of the date range) to find FEAs within (or not within) the number of years specified. - p_feaa
string(values: A, E, S): Agency associated with Formal Enforcement Actions: - p_feac
string: Formal Enforcment Action Last Case Date Limiter Flag. Enter a value of "Y" to additionally apply the p_feay year filter to the last formal enforcement action case date. Use the p_fea parameter to control if the filter is within or outside the date span provided. - p_feac_5yr
string - p_iea
string(values: W, N): Informal Enforcement Actions [within / not within] specified date range. The date range is determined by parameters p_iead1 and p_iead2 or by parameter p_ieay. - p_ieay
number(values: 1, 2, 3, 4, 5): Years (1 to 5) Range. This value is used to create a date range for Informal Enforcement Actions (IEA). Used along with p_iea (which indicates whether to look within or outside of the date range) to find IEAs within (or not within) the number of years specified. - p_ieaa
string(values: E, S): Agency associated with Informal Enforcement Actions. If left blank, both agencies are included. - p_iea_5yr
string: A Y value identifies facilities that have had an informal enforcement action within the last 5 years. - p_cs
number(values: 2, 3, 4): Facility Compliance Limiter. Enter 2, 3 or 4 to limit facilities returned. - p_qiv
string(values: 0, GT1, GT2, GT4, GT8, 12): Quarters in Noncompliance Limiter. Enter a coded value to limit results to facilities with given quarter of noncompliance. - p_naa
string: Non-Attainment Area Flag. Enter a Y or N to filter for or against facilities flagged as non-attainment areas. - p_impw
string(values: Y, N): Discharging into Impaired Waters Flag. Enter Y to limit results to facilities with discharge to waterbodies listed as impaired in the ATTAINS database. - p_trep
string(values: CURR, NOTCURR): Current Toxics Release Inventory (TRI) Reporter Limiter. Enter one of the following codes to limit results. - p_ocr
string: Toxics Release Inventory Pounds of On-Site Chemical Releases Limiter. Enter a keyword to filter results. - p_oct
string(values: Z, GT0, GT1000, GT5000, GT10000, GT20000, GT50000): Toxic Release Inventory Pounds of Off-Site Chemical Releases Limiter. Enter a keyword to filter results. - p_pm
string(values: NONE, GT5, GT10, GT25, GT50, GT75): Percent Minority Population Limiter. Enter a value to restrict results to facilities with a given percentage of minority population within 3-mile radius. - p_pd
string(values: NONE, GT100, GT500, GT1000, GT5000, GT10000, GT20000): Population Density Limiter (per sq mile). Enter a value to limit results to facilities located in area of a given population density. - p_ico
string(values: Y, N): Indian Country Flag. Enter a "Y" or "N" to restrict searches to facilities inside or outside Indian Country. - p_huc
string: 2-, 4-, 6-, or 8-character watershed code. May contain multiple comma-separated values. - p_pid
string: Nine-digit permit IDs. May contain up to 2000 comma-separated values. - p_med
string(values: A, C, E, G, M, R, S, T, TSCA, W, ALL): Filter Results by Media.- A = Air- C = CAMD (Clean Air Markets Division)- E = EIS (Emissions Inventory Systems)- G = GHG (Greenhouse Gases)- M = RMP (Risk Management Plan)- R = RCRA (Hazardous Waste)- S = SDWA (Public Drinking Water Systems)- T = TRI (Toxic Release Inventory)- TSCA = TSCA (Toxic Substances Control Act)- W = Water- ALL = Air and Water and RCRA - p_istatute
string: For use in identifying Facilities that have an inspection performed under the entered Statute. - p_ysl
string(values: W, N, NV): Last Facility Inspection [within / not within] Specified Date Range Indicator. The date range is determined by parameters p_idt1 and p_idt2 or by parameter p_ysly. - p_ysly
number(values: 1, 2, 3, 4, 5): Number of years (1 to 5) since last facility inspection. A value of 1 means that it has been inspected within the year. - p_ysla
string(values: E, S, A): Facility Last Inspection Code Filter. If left blank, both agencies are included. Enter a value to limit results: - p_qs
string: Quick Search. Allows entry for city, state, and/or zip code. - p_sfs
string: Single Facility Search Filter. Provide a facility name or program system identifier to limit results. For the all data search, the FRS registry identifier is also searched. - p_tribeid
number: Numeric code for tribe (or list of tribes). - p_tribename
string: Tribe Name Filter. Enter a single tribe name to filter results. - p_tribedist
number: Proximity to tribal land limiter. Enter an amount of mile between 0 and 25 to filter results. This parameter is only evaluated if p_tribeid is populated. - p_wbd
string: 2-, 4-, 6-, 8-, 10-, or 12-character watershed (WBD from the USGS Watershed Boundary Dataset). May contain multiple comma-separated values. Uses the FRS Best Pick Coordinate to obtain the WBD12 Huc value. - p_fntype
string(values: ALL, CONTAINS, EXACT, BEGINS): Controls type of text search performed on facility name with parameter p_fn. - p_icoo
string: Indian country search and/or flag. Enter "Y" to set indian country search conditions to return any results found using p_ico, p_fac_ico or p_fac_icoo. Otherwise only results matching all provided p_ico, p_fac_ico or p_fac_icoo conditions will be returned. - p_fac_icos
string: FRS tribal land spatial flag. Enter "Y" or "N" to include or exclude facilities based on FRS tribal land spatial flag. - p_ejscreen
string: Enter "Y" to limit facilities to Census block groups where one of more Environmental Justice indexes above 80th percentile. - p_limit_addr
string(values: Y, N): Limit Address Search Flag. Enter Y to restrict facility searches to native data source only. - p_lat
number: Latitude location in decimal degrees. - p_long
number: Longitude location in decimal degrees. - p_radius
number: Spatial Search Radius. Enter a radius up to 100 miles in which to spatially search for facilities. - p_ejscreen_over80cnt
string(values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11): The number of Environmenmt Justice Indicators above the 80th percentile. Valid values are 1 through 11. - p_agoo
string(values: AND, OR): Indicates whether to AND or OR the Owner/Operator parameter (p_owop) and the federal agency code (p_fa) parameters. - p_neiu
string - responseset
number: Response Set Limiter. Enter a value to limit the number of records per page. Value cannot exceed 1,000. - callback
string: JSONP Callback. For use with JSONP and GEOJSONP output only. Enter a name of the function in which to wrap the JSON response. - qcolumns
string: Used to customize service output. A list of comma-separated column IDs of output objects that will be returned in the service query object or download. Use the metadata service endpoint for a complete list of Ids and definitions. - p_pretty_print
number: Optional flag to request GeoJSON formatted results to be pretty printed. Only provide a numeric value when the output needs to be human readable as pretty printing has a performance cost.
- output
Output
- output
object: Root Object- Results required echo08
echo_rest_services.get_geojson.get
Based on the QID obtained from a get_facilities or get_facility_info query, return GeoJSON of the facilities found.
epa_gov_echo.echo_rest_services.get_geojson.get({
"qid": ""
}, context)Input
- input
object- output
string: Output Format Flag. Enter one of the following keywords: - qid required
string: Query ID Selector. Enter the QueryID number from a previously run query. - callback
string: JSONP Callback. For use with JSONP and GEOJSONP output only. Enter a name of the function in which to wrap the JSON response. - newsort
number: Output Sort Column. Enter the number of the column on which the data will be sorted. If unpopulated results will sort on the first column. - descending
string(values: Y, N): Output Sort Column Descending Flag. Enter Y to column identified in the newsort parameter descending. Enter N to use ascending sort order. Used only when newsort parameter is populated. - qcolumns
string: Used to customize service output. A list of comma-separated column IDs of output objects that will be returned in the service query object or download. Use the metadata service endpoint for a complete list of Ids and definitions. - p_pretty_print
number: Optional flag to request GeoJSON formatted results to be pretty printed. Only provide a numeric value when the output needs to be human readable as pretty printing has a performance cost.
- output
Output
- output
object: GeoJSON Feature Collection Object- features required
array: Array of GeoJSON feature objects.- items echo09
- type required
string: Static marker indicating object is a GeoJSON Feature Collection.
- features required
echo_rest_services.get_geojson.post
Based on the QID obtained from a get_facilities or get_facility_info query, return GeoJSON of the facilities found.
epa_gov_echo.echo_rest_services.get_geojson.post({
"qid": ""
}, context)Input
- input
object- output
string: Output Format Flag. Enter one of the following keywords: - qid required
string: Query ID Selector. Enter the QueryID number from a previously run query. - callback
string: JSONP Callback. For use with JSONP and GEOJSONP output only. Enter a name of the function in which to wrap the JSON response. - newsort
number: Output Sort Column. Enter the number of the column on which the data will be sorted. If unpopulated results will sort on the first column. - descending
string(values: Y, N): Output Sort Column Descending Flag. Enter Y to column identified in the newsort parameter descending. Enter N to use ascending sort order. Used only when newsort parameter is populated. - qcolumns
string: Used to customize service output. A list of comma-separated column IDs of output objects that will be returned in the service query object or download. Use the metadata service endpoint for a complete list of Ids and definitions. - p_pretty_print
number: Optional flag to request GeoJSON formatted results to be pretty printed. Only provide a numeric value when the output needs to be human readable as pretty printing has a performance cost.
- output
Output
- output
object: GeoJSON Feature Collection Object- features required
array: Array of GeoJSON feature objects.- items echo09
- type required
string: Static marker indicating object is a GeoJSON Feature Collection.
- features required
echo_rest_services.get_info_clusters.get
Based on the QID obtained from a clustered get_facility_info query, download cluster facility information as either a CSV or GEOJSON file.
epa_gov_echo.echo_rest_services.get_info_clusters.get({
"p_qid": ""
}, context)Input
- input
object- output
string: Output Format Flag. Enter one of the following keywords: - p_qid required
string: Query ID Selector. Enter the QueryID number from a previously run query. - p_pretty_print
number: Optional flag to request GeoJSON formatted results to be pretty printed. Only provide a numeric value when the output needs to be human readable as pretty printing has a performance cost.
- output
Output
- output
file
echo_rest_services.get_info_clusters.post
Based on the QID obtained from a clustered get_facility_info query, download cluster facility information as either a CSV or GEOJSON file.
epa_gov_echo.echo_rest_services.get_info_clusters.post({
"p_qid": ""
}, context)Input
- input
object- output
string: Output Format Flag. Enter one of the following keywords: - p_qid required
string: Query ID Selector. Enter the QueryID number from a previously run query. - p_pretty_print
number: Optional flag to request GeoJSON formatted results to be pretty printed. Only provide a numeric value when the output needs to be human readable as pretty printing has a performance cost.
- output
Output
- output
file
echo_rest_services.get_map.get
The purpose of the GET_MAP service is to display facility coordinates and facility clusters related to a get_facilities facility query. Currently, the maximum number of coordinates returned is 500. GET_MAP performs automatic clustering at the state, county, and zip code levels to maximize the number of coordinates returned.
epa_gov_echo.echo_rest_services.get_map.get({
"qid": "",
"p_id": ""
}, context)Input
- input
object- output
string(values: JSONP, JSON, XML): Output Format Flag. Enter one of the following keywords: - qid required
string: Query ID Selector. Enter the QueryID number from a previously run query. - callback
string: JSONP Callback. For use with JSONP and GEOJSONP output only. Enter a name of the function in which to wrap the JSON response. - tablelist
string(values: Y, N): Table List Flag. Enter a Y to display the first page of facility results. - c1_lat
number: Latitude of 1st corner of box that bounds the resulting facilities. The latitude and longitude of both corners of the bounding box must be provided. - c1_long
number: Longitude of 1st corner of box that bounds the resulting facilities. The latitude and longitude of both corners of the bounding box must be provided. - c2_lat
number: Latitude of 2nd corner of box that bounds the resulting facilities. The latitude and longitude of both corners of the bounding box must be provided. - c2_long
number: Longitude of 2nd corner of box that bounds the resulting facilities. The latitude and longitude of both corners of the bounding box must be provided. - p_id required
string: Identifier for the service.
- output
Output
- output
object: Root Object- MapOutput required echo02
echo_rest_services.get_map.post
The purpose of the GET_MAP service is to display facility coordinates and facility clusters related to a get_facilities facility query. Currently, the maximum number of coordinates returned is 500. GET_MAP performs automatic clustering at the state, county, and zip code levels to maximize the number of coordinates returned.
epa_gov_echo.echo_rest_services.get_map.post({
"qid": "",
"p_id": ""
}, context)Input
- input
object- output
string(values: JSONP, JSON, XML): Output Format Flag. Enter one of the following keywords: - qid required
string: Query ID Selector. Enter the QueryID number from a previously run query. - callback
string: JSONP Callback. For use with JSONP and GEOJSONP output only. Enter a name of the function in which to wrap the JSON response. - tablelist
string(values: Y, N): Table List Flag. Enter a Y to display the first page of facility results. - c1_lat
number: Latitude of 1st corner of box that bounds the resulting facilities. The latitude and longitude of both corners of the bounding box must be provided. - c1_long
number: Longitude of 1st corner of box that bounds the resulting facilities. The latitude and longitude of both corners of the bounding box must be provided. - c2_lat
number: Latitude of 2nd corner of box that bounds the resulting facilities. The latitude and longitude of both corners of the bounding box must be provided. - c2_long
number: Longitude of 2nd corner of box that bounds the resulting facilities. The latitude and longitude of both corners of the bounding box must be provided. - p_id required
string: Identifier for the service.
- output
Output
- output
object: Root Object- MapOutput required echo02
echo_rest_services.get_qid.get
GET_QID is passed with a query ID corresponding to a previously run get_facilities query. It then returns a Facility object containing all matching facilities. The main purpose of GET_QID is for large querysets that contain multiple pages (responsesets) of output. GET_QID allows for pagination and for the selection and sorting of columns.
epa_gov_echo.echo_rest_services.get_qid.get({
"qid": ""
}, context)Input
- input
object- output
string(values: JSONP, JSON, XML): Output Format Flag. Enter one of the following keywords: - qid required
string: Query ID Selector. Enter the QueryID number from a previously run query. - pageno
number: Indicates the number of the page to display. It is used only when the results are paginated. - callback
string: JSONP Callback. For use with JSONP and GEOJSONP output only. Enter a name of the function in which to wrap the JSON response. - newsort
number: Output Sort Column. Enter the number of the column on which the data will be sorted. If unpopulated results will sort on the first column. - descending
string(values: Y, N): Output Sort Column Descending Flag. Enter Y to column identified in the newsort parameter descending. Enter N to use ascending sort order. Used only when newsort parameter is populated. - qcolumns
string: Used to customize service output. A list of comma-separated column IDs of output objects that will be returned in the service query object or download. Use the metadata service endpoint for a complete list of Ids and definitions.
- output
Output
- output
object: Root Object- Results required echo11
echo_rest_services.get_qid.post
GET_QID is passed with a query ID corresponding to a previously run get_facilities query. It then returns a Facility object containing all matching facilities. The main purpose of GET_QID is for large querysets that contain multiple pages (responsesets) of output. GET_QID allows for pagination and for the selection and sorting of columns.
epa_gov_echo.echo_rest_services.get_qid.post({
"qid": ""
}, context)Input
- input
object- output
string(values: JSONP, JSON, XML): Output Format Flag. Enter one of the following keywords: - qid required
string: Query ID Selector. Enter the QueryID number from a previously run query. - pageno
number: Indicates the number of the page to display. It is used only when the results are paginated. - callback
string: JSONP Callback. For use with JSONP and GEOJSONP output only. Enter a name of the function in which to wrap the JSON response. - newsort
number: Outpu
- output