- Print
- DarkLight
- PDF
EPA Sites Documentation
- Print
- DarkLight
- PDF
Purpose
Access the location or locations of brownfield or superfund sites that are within proximity of a subject property. This is useful during property due diligence activities or understanding potential risk around a property.
Superfund sites
As per the EPA, Superfund sites or National Priorities List (NPL) sites with significant hazardous waste contamination that the EPA prioritizes for cleanup. The EPA's Superfund program manages cleanup and responds to environmental emergencies.
Brownfield sites
As per the EPA, Brownfield sites are underutilized properties that may be contaminated, hindering their reuse. Brownfields may be less contaminated than Superfund sites and are designated based on perceived contamination.
Features
- Return a superfund or brownfield site record by address.
- Return a superfund or brownfield site record using a geometry WKT with an optional buffer unit and distance.
- Return a superfund or brownfield site record using a LightBox Parcel {{glossary.LightBox ID}}.
- Return a superfund or brownfield site record using a LightBox Assessment {{glossary.LightBox ID}}.
- Return a superfund or brownfield site record using a LightBox Address {{glossary.LightBox ID}}.
- Return a superfund or brownfield site record using a LightBox Structure {{glossary.LightBox ID}}.
- Return a superfund or brownfield site record using a LightBox Site {{glossary.LightBox ID}}.
- This API supports tile and bounding box map display in addition to your favorite map control.
Requirements
The LightBox APIs are hosted in the cloud and therefore have no platform requirements. Application requirements include:- A network connection to the LightBox API server
- Ability to parse JavaScript Object Notation (JSON) API responses
- Secure HTTPS connection
- LightBox authentication key
- LightBox authentication key
Connecting your account
When your LightBox user account is created, a unique API key is also generated. The API key should be kept secret at all times and can only be used for API requests. The key is required in all API calls.
To retrieve your unique API key:
- Log in to the LightBox Developer Portal
- Select Apps from the menu bar
- In your approved App, note your API key (under Consumer Key)
Performing API requests
All API requests must be made over secure HTTPS connections. Requests made over HTTP will fail.
The base URL of the API server that all API requests will be made to is: https://api.lightboxre.com/ followed by a version number https://api.lightboxre.com/v1
Authentication
LightBox APIs uses a token-based authentication. All requests to the LightBox APIs must be authenticated. The token to be passed via an HTTP header with key 'x-api-key' and value <Your authentication token>
Pass your unique API key in the authorization header of every LightBox API call. LightBox uses this information to authenticate your identify and determine whether you have sufficient permissions to complete the operation. curl -X GET -H ‘x-api-key: (api_key)’ https://api.lightboxre.com/
API Requests
Query EPA Superfund or Brownfield Objects by 'ID.'
GET /epas/us/{type}/{id}
Example Requests
curl -X GET -H ‘x-api-key: (api_key)’ https://api.lightboxre.com/v1/epas/us/{type}/{id}
https://api.lightboxre.com/v1/epas/us/brownfield/NOATAK FORMER DUMPSITE
Parameters
Parameter | Type | Description | Usage |
---|---|---|---|
id | path | EPA site id by name example NOATAK FORMER DUMPSITE | required |
type | path | Possible values for type are brownfield or superfund. Denotes the type of EPA site to return. | required |
Response
Media type: application/json
Query by Geometry
Query for superfund or brownfield records based on a geometry represented as a well-known text (WKT) string.
- POINT(-122.40317865990883 45.585729937697515)
- LINESTRING (-122.40581795357949 45.58497908445598,-122.40325376176125 45.58627054581282)
- POLYGON ((-122.4032877944377 45.58629457984625,-122.40264406427413 45.585697658341736,-122.40184476598769 45.58610686936547,-122.40244558080703 45.586688769812724,-122.4032877944377 45.58629457984625))
GET /epas/us/{type}/geometry
Example requests
curl -X GET -H ‘x-api-key: (api_key)’ https://api.lightboxre.com/v1/epas/us/{type}/geometry?wkt=POINT%28-117.852723%2033.63799%29&bufferDistance=50&bufferUnit=m
https://api.lightboxre.com/v1/epas/us/brownfield/geometry?wkt=POINT%28-117.852723%2033.63799%29&bufferDistance=50&bufferUnit=m
Parameters
Parameter | Type | Description | Usage |
---|---|---|---|
type | path | Possible values for type are brownfield or superfund. Denotes the type of EPA site to return. | required |
wkt | query | The geometry of the location expressed in WKT format. | required |
status | query | Desired site status to filter results. All brownfields are considered active. Possible values Active, Pending, Archived, All Default: All | optional |
bufferDistance | query | Buffer distance expressed in 'bufferUnits'. | optional |
bufferUnit | query | The unit type to apply to the buffer (eg m, km, ft, mi). | optional |
Response
Media type: application/json
Query EPA Superfund or Brownfield Objects Related to a Structure Record.
Query EPA Superfund or Brownfield objects related to a structure using the LightBox Structure 'ID.'
GET /epas/_on/structure/us/{type}/{id}
Example Requests
curl -X GET -H ‘x-api-key: (api_key)’ https://api.lightboxre.com/v1/epas/_on/structure/us/{type}/{id}
https://api.lightboxre.com/v1/epas/_on/structure/us/brownfield/0500F9G87XG0NEK51ZQHJR
Parameters
Parameter | Type | Description | Usage |
---|---|---|---|
id | path | Structure LightBox ID | required |
type | path | Possible values for type are brownfield or superfund. Denotes the type of EPA site to return. | required |
status | query | Desired site status to filter results. All brownfields are considered active. Possible values Active, Pending, Archived, All Default: All | optional |
bufferDistance | query | Buffer distance expressed in 'bufferUnits'. | optional |
bufferUnit | query | The unit type to apply to the buffer (eg m, km, ft, mi). | optional |
Response
Media type: application/json
Query EPA Superfund or Brownfield Objects Related to an Assessment Record.
Query EPA Superfund or Brownfield objects related to as assessment using the LightBox Assessment 'ID.'
GET /epas/_on/assessment/us/{type}/{id}
Example Requests
curl -X GET -H ‘x-api-key: (api_key)’ https://api.lightboxre.com/v1/epas/_on/assessment/us/{type}/{id}
https://api.lightboxre.com/v1/epas/_on/assessment/us/brownfield/030022BT8WGISNVQJIEW54
Parameters
Parameter | Type | Description | Usage |
---|---|---|---|
id | path | Assessment LightBox ID | required |
type | path | Possible values for type are brownfield or superfund. Denotes the type of EPA site to return. | required |
status | query | Desired site status to filter results. All brownfields are considered active. Possible values Active, Pending, Archived, All Default: All | optional |
bufferDistance | query | Buffer distance expressed in 'bufferUnits'. | optional |
bufferUnit | query | The unit type to apply to the buffer (eg m, km, ft, mi). | optional |
Response
Media type: application/json
Query EPA Superfund or Brownfield Objects Related to an Address Record.
Query EPA Superfund or Brownfield objects related to an address using the LightBox Address 'ID.'
GET /epas/_on/address/us/{type}/{id}
Example Requests
curl -X GET -H ‘x-api-key: (api_key)’ https://api.lightboxre.com/v1/epas/_on/address/us/{type}/{id}
https://api.lightboxre.com/v1/epas/_on/address/us/brownfield/0606ZGPRLD5KGWFYRD7QH9
Parameters
Parameter | Type | Description | Usage |
---|---|---|---|
id | path | Address LightBox ID | required |
type | path | Possible values for type are brownfield or superfund. Denotes the type of EPA site to return. | required |
status | query | Desired site status to filter results. All brownfields are considered active. Possible values Active, Pending, Archived, All Default: All | optional |
bufferDistance | query | Buffer distance expressed in 'bufferUnits'. | optional |
bufferUnit | query | The unit type to apply to the buffer (eg m, km, ft, mi). | optional |
Response
Media type: application/json
Query EPA Superfund or Brownfield Objects Related to a Site Record.
Query EPA Superfund or Brownfield objects related to a site using the LightBox Site 'ID.'
GET /epas/_on/site/us/{type}/{id}
Example Requests
curl -X GET -H ‘x-api-key: (api_key)’ https://api.lightboxre.com/v1/epas/_on/site/us/{type}/{id}
https://api.lightboxre.com/v1/epas/_on/site/us/brownfield/09033U15BDJ3RUUOQWWNWV
Parameters
Parameter | Type | Description | Usage |
---|---|---|---|
id | path | Site LightBox ID | required |
type | path | Possible values for type are brownfield or superfund. Denotes the type of EPA site to return. | required |
status | query | Desired site status to filter results. All brownfields are considered active. Possible values Active, Pending, Archived, All Default: All | optional |
bufferDistance | query | Buffer distance expressed in 'bufferUnits'. | optional |
bufferUnit | query | The unit type to apply to the buffer (eg m, km, ft, mi). | optional |
Response
Media type: application/json
Query EPA Superfund or Brownfield Objects Related to a Parcel Record.
Query EPA Superfund or Brownfield objects related to a parcel using the LightBox Parcel 'ID.'
GET /epas/_on/parcel/us/{type}/{id}
Example Requests
curl -X GET -H ‘x-api-key: (api_key)’ https://api.lightboxre.com/v1/epas/_on/parcel/us/{type}/{id}
https://api.lightboxre.com/v1/epas/_on/parcel/us/brownfield/0201MABNPDBU5D2EGP08YA
Parameters
Parameter | Type | Description | Usage |
---|---|---|---|
id | path | Parcel LightBox ID | required |
type | path | Possible values for type are brownfield or superfund. Denotes the type of EPA site to return. | required |
status | query | Desired site status to filter results. All brownfields are considered active. Possible values Active, Pending, Archived, All Default: All | optional |
bufferDistance | query | Buffer distance expressed in 'bufferUnits'. | optional |
bufferUnit | query | The unit type to apply to the buffer (eg m, km, ft, mi). | optional |
Response
Media type: application/json
API Response
For each endpoint other than the tile requests the response will stay consistent.
{
"$ref": "string",
"$metadata": {
"geogcs": {
"epsg": "4326"
}
},
"epas": [
{
"$ref": "string",
"id": "AKD004904215",
"name": "NOATAK FORMER DUMPSITE",
"epaId": "AKD004904215",
"status": "Active",
"date": "string",
"location": {
"representativePoint": {
"longitude": 0,
"latitude": 0,
"geometry": {
"wkt": "POINT(-117.852723 33.63799)"
}
},
"geometry": {
"wkt": "POINT(-117.852723 33.63799)"
}
}
}
]
}
HTTP Error Codes
200 | The request succeeded. |
201 | The object was created successfully |
202 | Accepted, no content |
204 | Successful, no content |
204 | The server has successfully fulfilled the request and that there is no additional content to send in the response payload body. Typically returned on a DELETE |
400 | One or more of the request parameters were invalid. |
401 | The client must authenticate itself to get the requested response. Note: This could also be due to your trial key has expired. |
404 | The server cannot find the requested resource. This can also mean that the endpoint is valid but the resource itself does not exist. |
429 | Too many requests were made in a short period of time, or you have exceeded your request-lot pool. |
500 | The server has encountered an error it does not know how to handle. |
503 | Service Unavailable. |