ejscreen report api instructions report api instructions 2 august 2017 arbitrary shape, while...

EJSCREEN Report API Instructions

1 August 2017

1. Introduction

The EJSCREEN Report API is used to build queries to return the data in JSON for the

EJSCREEN report and a URL that can be used to hyperlink the EJSCREEN report. It is a

RESTful API. An interactive tool is also provided to make it easier to use the API and build the

necessary parameters to retrieve the data for an EJSCREEN report. Users can select the input

parameters and submit the request. The tool will display the returned EJSCREEN data as well as

the syntax that developers need for submitting requests directly to the API in applications.

EJSCREEN Report API tool: https://ejscreen.epa.gov/mapper/ejscreenapi.html

Follow these steps to build a query and retrieve EJSCREEN data and the report from the

interactive tool.

1. Select a location input type for the area of interest by selecting one of the radio buttons. The

input type can be a geometry or a known-geography. Geometry types allow input of any

Figure 1. EJSCREEN Report API tool

2 . Steps to Build a Query and Retrieve Data

https://ejscreen.epa.gov/mapper/ejscreenapi.html

https://ejscreen.epa.gov/mapper/ejscreenapi.html


2 August 2017

arbitrary shape, while known-geography types are census unit areas that are denoted by an

ID code.

• Geometry types: point, line, polygon, rectangle area

• Known-geography types: Census block group, Census tract, county

2. In the search box on the map, enter a location or address. Click the map to obtain values for

the input type chosen in the previous step, as follows:

• Point: Click the map to obtain a single latitude/longitude point location.

• Line: Click a series of points on the map to draw a line. Double-click to end the drawing.

• Polygon: Click a series of points on the map to draw a polygon. Double-click to end the

drawing.

• Rectangle: Click the map at the location of one corner of a rectangle and drag the mouse

to draw a box. Release the mouse at the opposite corner of the rectangle to finish.

• Blockgroup, Tract, or County: Click the map to retrieve the entity ID (FIPS Code) for

each type of selected known-geography.

3. Geometry parameter: When any input is finalized, the Geography text box will be

automatically populated with the correct values for the API parameters. Although this box

can be manually populated, it is recommended that the user interact with the map as

described in previous steps to obtain or update the geometry.

4. Buffer Size: Enter a size for the buffer, which is the distance from the input location that will

be included for the report. The buffered area plus the original location constitutes the study

area. For a Point or Line input, the Buffer Size cannot be zero (0). For all other types, a

Buffer Size of 0 can be entered; this will include the study area only, with no additional

buffer.

5. Buffer Unit: Choose the distance unit (mile or kilometer) represented by the Buffer Size.

6. Format: Two options are available for the results format, JSON and Report.

• Select json to return the EJSCREEN values for the study area in JSON format. This

format is typically used by other applications to read and display information as needed.

• Select report to generate a URL that can be used as a hyperlink to an EJSCREEN report

as if it would be generated by running the EJSCREEN application.

7. Submit: Click one of the Submit buttons to submit the parameters and return the data. Two

buttons are provided to send the parameters via the two standard HTTPS request methods,

GET and POST.

• Click Submit (GET) to send a single URL that includes all parameters. The URL will be

displayed in a box labeled API Url, and the JSON results will be displayed in a box

labeled Results.

• Click Submit (POST) to send all the parameters to the API endpoint as a POST method.

The endpoint and all parameters will be displayed in a box labeled API Url, and the

JSON results will be displayed in a box labeled Results.

8. Copy: Click a Copy button to copy the content in the box below to the clipboard.

Note: If the format type is report, the Results section will show a full EJSCREEN report. If the

format type is json, a link labeled Field Description will be displayed next to the Results header.

Clicking the link will display the field description page.


3 August 2017

3. Use Cases The following illustrate two examples of how to use the EJSCREEN Report API.

3.1. Use Case #1: Generate an EJSCREEN report around a point of interest using the JSON

option.

1. Select the radio button for input type of Point.

2. In the search box, type “Baton Rouge, Louisiana”. The map will zoom to the area of

Baton Rouge, Louisiana.

3. Click on the map to pinpoint the location. The Geometry text box below the map will

display the latitude and longitude coordinates for the point in JSON.

4. In the Buffer Size field, enter “1”.

5. From the Buffer Unit dropdown list, select mile.

6. From the Format dropdown list, select json.

Figure 2. Use Case #1 Steps

The results will be generated in JSON format and displayed in the Results section.

7. Click the Submit (GET) button.


4 August 2017

For the json format, click the Field Description hyperlink next to the Results header. The field

descriptions will be displayed.

The RESTful URL shown in the API Url box is what is needed to fetch the EJSCREEN report

data in JSON for the selected point location with one mile of buffer.

3.2. Use Case #2: Generate an EJSCREEN report for a Census block group using the report

option.

1. Select the radio button for input type of Blockgroup.

2. In the search box, type “Baton Rouge, Louisiana”. The map will zoom to the area of

Baton Rouge, Louisiana.

3. Click on the map to select a specific block group. The selected block group will be

highlighted on the map. The FIPS Code text box below the map will display the ID for

the selected block group.

4. From the Format dropdown list, select report.

5. Click the Submit (GET) button.

Figure 3. Use Case #1 Results


5 August 2017

Figure 4. Use Case #2 Steps

The results will be generated in report format and displayed in the Results section.


6 August 2017

Figure 5. Use Case #2 Results

The URL shown in the API Url box is what is needed to call the EJSCREEN report for the

selected Census block group, as shown in the Results box.


7 August 2017

Appendix A: Field Descriptions

An EJSCREEN report contain four sections of information: EJ Indexes, Sites Reporting to EPA,

Environmental Indicators, and Demographic Indicators. The table below lists all data elements

shown in the EJSCREEN report by section. JSON Variable Description Section

RAW_E_PM25 Raw data for Particulate Matter (PM 2.5 in ug/m3) Environmental Indicators

RAW_E_O3 Raw data for Ozone (ppb) Environmental Indicators

RAW_E_DIESEL Raw data for NATA Diesel PM (ug/m3) Environmental Indicators

RAW_E_CANCER Raw data for NATA Air Toxics Cancer Risk (risk

per MM) Environmental Indicators

RAW_E_RESP Raw data for NATA Respiratory Hazard Index Environmental Indicators

RAW_E_TRAFFIC Raw data for Traffic Proximity and Volume (daily

traffic count/distance to road) Environmental Indicators

RAW_E_LEAD Raw data for Lead Paint Indicator (% pre-1960s

housing) Environmental Indicators

RAW_E_NPL Raw data for Superfund Proximity (site count/km

distance) Environmental Indicators

RAW_E_RMP Raw data for RMP Proximity (facility count/km


RAW_E_TSDF Raw data for Hazardous Waste Proximity (facility

count/km distance) Environmental Indicators

RAW_E_NPDES Raw data for Wastewater Discharge Indicator

(toxicity-weighted concentration/m distance) Environmental Indicators

RAW_D_INDEX Raw data for Demographic Index Demographic Indicators

RAW_D_MINOR Raw data for Minority Population Demographic Indicators

RAW_D_INCOME Raw data for Low Income Population Demographic Indicators

RAW_D_LING Raw data for Linguistically Isolated Population Demographic Indicators

RAW_D_LESSHS Raw data for Population with Less Than High

School Education Demographic Indicators

RAW_D_UNDER5 Raw data for Population under Age 5 Demographic Indicators

RAW_D_OVER64 Raw data for Population over Age 64 Demographic Indicators

S_E_PM25 State average for Particulate Matter (PM 2.5 in

ug/m3) Environmental Indicators

S_E_O3 State average for Ozone (ppb) Environmental Indicators

S_E_DIESEL State average for NATA Diesel PM (ug/m3) Environmental Indicators

S_E_CANCER State average for NATA Air Toxics Cancer Risk (risk

per MM) Environmental Indicators

S_E_RESP State average for NATA Respiratory Hazard Index Environmental Indicators

S_E_TRAFFIC State average for Traffic Proximity and Volume

(daily traffic count/distance to road) Environmental Indicators

S_E_LEAD State average for Lead Paint Indicator (% pre1960s

housing) Environmental Indicators

S_E_NPL State average for Superfund Proximity (site


S_E_RMP State average for RMP Proximity (facility count/km



8 August 2017

JSON Variable Description Section

S_E_TSDF State average for Hazardous Waste Proximity

(facility count/km distance) Environmental Indicators

S_E_NPDES State average for Wastewater Discharge Indicator

(toxicity-weighted concentration/m distance) Environmental Indicators

S_D_INDEX State average for Demographic Index Demographic Indicators

S_D_MINOR State average for Minority Population Demographic Indicators

S_D_INCOME State average for Low Income Population Demographic Indicators

S_D_LING State average for Linguistically Isolated Population Demographic Indicators

S_D_LESSHS State average for Population with Less Than High

School Education Demographic Indicators

S_D_UNDER5 State average for Population under Age 5 Demographic Indicators

S_D_OVER64 State average for Population over Age 64 Demographic Indicators

S_P_PM25 State percentile for EJ Index for Particulate Matter

(PM 2.5) EJ Indexes

S_P_O3 State percentile for EJ Index for Ozone EJ Indexes

S_P_DIESEL State percentile for EJ Index for NATA Diesel PM EJ Indexes

S_P_CANCER State percentile for EJ Index for NATA Air Toxics

Cancer Risk EJ Indexes

S_P_RESP State percentile for EJ Index for NATA Respiratory

Hazard Index EJ Indexes

S_P_TRAFFIC State percentile for EJ Index for Traffic Proximity

and Volume EJ Indexes

S_P_LEAD State percentile for EJ Index for Lead Paint

Indicator EJ Indexes

S_P_NPL State percentile for EJ Index for Superfund

Proximity EJ Indexes

S_P_RMP State percentile for EJ Index for RMP Proximity EJ Indexes

S_P_TSDF State percentile for EJ Index for Hazardous Waste


S_P_NPDES State percentile for EJ Index for Wastewater

Discharge Indicator EJ Indexes

S_E_PM25_PER State percentile for Particulate Matter (PM 2.5 in


S_E_O3_PER State percentile for Ozone (ppb) Environmental Indicators

S_E_DIESEL_PER State percentile for NATA Diesel PM (ug/m3) Environmental Indicators

S_E_CANCER_PER State percentile for NATA Air Toxics Cancer Risk

(risk per MM) Environmental Indicators

S_E_RESP_PER State percentile for NATA Respiratory Hazard

Index Environmental Indicators

S_E_TRAFFIC_PER State percentile for Traffic Proximity and Volume


S_E_LEAD_PER State percentile for Lead Paint Indicator (%

pre1960s housing) Environmental Indicators

S_E_NPL_PER State percentile for Superfund Proximity (site


S_E_RMP_PER State percentile for RMP Proximity (facility count/km



9 August 2017


S_E_TSDF_PER State percentile for Hazardous Waste Proximity


S_E_NPDES_PER State percentile for Wastewater Discharge

Indicator Environmental Indicators

S_D_INDEX_PER State percentile for Demographic Index Demographic Indicators

S_D_MINOR_PER State percentile for Minority Population Demographic Indicators

S_D_INCOME_PER State percentile for Low Income Population Demographic Indicators

S_D_LING_PER State percentile for Linguistically Isolated

Population Demographic Indicators

S_D_LESSHS_PER State percentile for Population with Less Than

High School Education Demographic Indicators

S_D_UNDER5_PER State percentile for Population under Age 5 Demographic Indicators

S_D_OVER64_PER State percentile for Population over Age 64 Demographic Indicators

R_E_PM25 Regional average for Particulate Matter (PM 2.5 in


R_E_O3 Regional average for Ozone (ppb) Environmental Indicators

R_E_DIESEL Regional average for NATA Diesel PM (ug/m3) Environmental Indicators

R_E_CANCER Regional average for NATA Air Toxics Cancer Risk


R_E_RESP Regional average for NATA Respiratory Hazard


R_E_TRAFFIC Regional average for Traffic Proximity and Volume


R_E_LEAD Regional average for Lead Paint Indicator (%


R_E_NPL Regional average for Superfund Proximity (site


R_E_RMP Regional average for RMP Proximity (facility


R_E_TSDF Regional average for Hazardous Waste Proximity


R_E_NPDES Regional average for Wastewater Discharge


R_D_INDEX Regional average for Demographic Index Demographic Indicators

R_D_MINOR Regional average for Minority Population Demographic Indicators

R_D_INCOME Regional average for Low Income Population Demographic Indicators

R_D_LING Regional average for Linguistically Isolated


R_D_LESSHS Regional average for Population with Less Than


R_D_UNDER5 Regional average for Population under Age 5 Demographic Indicators

R_D_OVER64 Regional average for Population over Age 64 Demographic Indicators

R_P_PM25 Regional percentile for EJ Index for Particulate

Matter (PM 2.5) EJ Indexes

R_P_O3 Regional percentile for EJ Index for Ozone EJ Indexes


10 August 2017


R_P_DIESEL Regional percentile for EJ Index for NATA Diesel PM

EJ Indexes

R_P_CANCER Regional percentile for EJ Index for NATA Air

Toxics Cancer Risk EJ Indexes

R_P_RESP Regional percentile for EJ Index for NATA

Respiratory Hazard Index EJ Indexes

R_P_TRAFFIC Regional percentile for EJ Index for Traffic

Proximity and Volume EJ Indexes

R_P_LEAD Regional percentile for EJ Index for Lead Paint


R_P_NPL Regional percentile for EJ Index for Superfund


R_P_RMP Regional percentile for EJ Index for RMP Proximity EJ Indexes

R_P_TSDF Regional percentile for EJ Index for Hazardous

Waste Proximity EJ Indexes

R_P_NPDES Regional percentile for EJ Index for Wastewater


R_E_PM25_PER Regional percentile for Particulate Matter (PM 2.5

in ug/m3) Environmental Indicators

R_E_O3_PER Regional percentile for Ozone (ppb) Environmental Indicators

R_E_DIESEL_PER Regional percentile for NATA Diesel PM (ug/m3) Environmental Indicators

R_E_CANCER_PER Regional percentile for NATA Air Toxics Cancer Risk


R_E_RESP_PER Regional percentile for NATA Respiratory Hazard


R_E_TRAFFIC_PER Regional percentile for Traffic Proximity and

Volume (daily traffic count/distance to road) Environmental Indicators

R_E_LEAD_PER Regional percentile for Lead Paint Indicator (% pre-

1960s housing) Environmental Indicators

R_E_NPL_PER Regional percentile for Superfund Proximity (site


R_E_RMP_PER Regional percentile for RMP Proximity (facility


R_E_TSDF_PER Regional percentile for Hazardous Waste Proximity


R_E_NPDES_PER Regional percentile for Wastewater Discharge


R_D_INDEX_PER Regional percentile for Demographic Index Demographic Indicators

R_D_MINOR_PER Regional percentile for Minority Population Demographic Indicators

R_D_INCOME_PER Regional percentile for Low Income Population Demographic Indicators

R_D_LING_PER Regional percentile for Linguistically Isolated


R_D_LESSHS_PER Regional percentile for Population with Less Than


R_D_UNDER5_PER Regional percentile for Population under Age 5 Demographic Indicators

R_D_OVER64_PER Regional percentile for Population over Age 64 Demographic Indicators


11 August 2017


N_E_PM25 National average for Particulate Matter (PM 2.5 in


N_E_O3 National average for Ozone (ppb) Environmental Indicators

N_E_DIESEL National average for NATA Diesel PM (ug/m3) Environmental Indicators

N_E_CANCER National average for NATA Air Toxics Cancer Risk


N_E_RESP National average for NATA Respiratory Hazard


N_E_TRAFFIC National average for Traffic Proximity and Volume


N_E_LEAD National average for Lead Paint Indicator (%


N_E_NPL National average for Superfund Proximity (site


N_E_RMP National average for RMP Proximity (facility


N_E_TSDF National average for Hazardous Waste Proximity


N_E_NPDES National average for Wastewater Discharge


N_D_INDEX National average for Demographic Index Demographic Indicators

N_D_MINOR National average for Minority Population Demographic Indicators

N_D_INCOME National average for Low Income Population Demographic Indicators

N_D_LING National average for Linguistically Isolated


N_D_LESSHS National average for Population with Less Than


N_D_UNDER5 National average for Population under Age 5 Demographic Indicators

N_D_OVER64 National average for Population over Age 64 Demographic Indicators

N_P_PM25 National percentile for EJ Index for Particulate

Matter (PM 2.5) EJ Indexes

N_P_O3 National percentile for EJ Index for Ozone EJ Indexes

N_P_DIESEL National percentile for EJ Index for NATA Diesel PM

EJ Indexes

N_P_CANCER National percentile for EJ Index for NATA Air

Toxics Cancer Risk EJ Indexes

N_P_RESP National percentile for EJ Index for NATA

Respiratory Hazard Index EJ Indexes

N_P_TRAFFIC National percentile for EJ Index for Traffic Proximity

and Volume EJ Indexes

N_P_LEAD National percentile for EJ Index for Lead Paint


N_P_NPL National percentile for EJ Index for Superfund


N_P_RMP National percentile for EJ Index for RMP Proximity EJ Indexes

N_P_TSDF National percentile for EJ Index for Hazardous

Waste Proximity EJ Indexes


12 August 2017


N_P_NPDES National percentile for EJ Index for Wastewater


N_E_PM25_PER National percentile for Particulate Matter (PM 2.5 in


N_E_O3_PER National percentile for Ozone (ppb) Environmental Indicators

N_E_DIESEL_PER National percentile for NATA Diesel PM (ug/m3) Environmental Indicators

N_E_CANCER_PER National percentile for NATA Air Toxics Cancer Risk


N_E_RESP_PER National percentile for NATA Respiratory Hazard


N_E_TRAFFIC_PER National percentile for Traffic Proximity and

Volume (daily traffic count/distance to road) Environmental Indicators

N_E_LEAD_PER National percentile for Lead Paint Indicator (%


N_E_NPL_PER National percentile for Superfund Proximity (site


N_E_RMP_PER National percentile for RMP Proximity (facility


N_E_TSDF_PER National percentile for Hazardous Waste Proximity


N_E_NPDES_PER National percentile for Wastewater Discharge


N_D_INDEX_PER National percentile for Demographic Index Demographic Indicators

N_D_MINOR_PER National percentile for Minority Population Demographic Indicators

N_D_INCOME_PER National percentile for Low Income Population Demographic Indicators

N_D_LING_PER National percentile for Linguistically Isolated


N_D_LESSHS_PER National percentile for Population with Less Than


N_D_UNDER5_PER National percentile for Population under Age 5 Demographic Indicators

N_D_OVER64_PER National percentile for Population over Age 64 Demographic Indicators

stateAbbr State Abbreviation General information

stateName State Name General information

epaRegion EPA Region General information

totalPop Total Population ACS 2014 General information

NUM_NPL Number of Superfund NPL sites Sites

NUM_TSDF Number of Hazardous Waste Treatment, Storage,

and Disposal Facilities (TSDF) sites Sites

ejscreen report api instructions report api instructions 2 august 2017 arbitrary shape, while...

Documents