Wetlands Documentation

Purpose

LightBox Wetlands Layer API supports retrieving wetlands at the Property, Structure/Building Footprint, Assessment and the Address level. There is also an endpoint to pass in a WKT geometry when accessing a third party geocoder or a mouse click event within a mapping application. 

OAS 3.1 Specification

Features

• Return a National Wetlands record by address
• Return a National Wetlands record using a geometry with an optional buffer unit and distance
• Return a National Wetlands record using a LightBox Parcel {{glossary.LightBox ID}}.
• Return a National Wetlands record using a LightBox Assessment {{glossary.LightBox ID}}.
• Return a National Wetlands record using a LightBox Address {{glossary.LightBox ID}}.
• Return a National Wetlands record using a LightBox Structure {{glossary.LightBox ID}}.

API Requests

Query by Geometry

Query for wetland 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 /wetlands/us/geometry

Example requests

curl -X GET -H ‘x-api-key: (api_key)’ https://api.lightboxre.com/v1/wetlands/us/geometry?wkt=POINT%28-117.852723%2033.63799%29&bufferDistance=50&bufferUnit=m

https://api.lightboxre.com/v1/wetlands/us/geometry?wkt=POINT%28-117.852723%2033.63799%29&bufferDistance=50&bufferUnit=m

Parameters

Response

Media type: application/json

Query By Address

Query wetland records by address search.

GET /wetlands/address

 Example Requests

curl -X GET -H ‘x-api-key: (api_key)’ https://api.lightboxre.com/v1/wetlands/address?text=5201%20California%20Ave%2C%20Irvine%20CA

https://api.lightboxre.com/v1/wetlands/address?text=5201%20California%20Ave%2C%20Irvine%20CA

Parameters

Response

Media type: application/json

Query Wetland Object Related to a Parcel Record.

Query Wetland Object that are related to a parcel using the LightBox Parcel 'ID.'

GET /wetlands/_on/parcel/us/{id}

Example Requests

curl -X GET -H ‘x-api-key: (api_key)’ https://api.lightboxre.com/v1/wetlands/_on/parcel/us/0201MABNPDBU5D2EGP08YA

https://api.lightboxre.com/v1/wetlands/_on/parcel/us/0201MABNPDBU5D2EGP08YA

Parameters

Response

Media type: application/json

Query Wetlands Object Related to a Structure Record.

Query Wetland Object that are related to a structure using the LightBox Structure 'ID.'

GET /wetlands/_on/structure/us/{id}

Example Requests

curl -X GET -H ‘x-api-key: (api_key)’ https://api.lightboxre.com/v1/wetlands/_on/structure/us/0500F9G87XG0NEK51ZQHJR

https://api.lightboxre.com/v1/wetlands/_on/structure/us/0500F9G87XG0NEK51ZQHJR

Parameters

Response

Media type: application/json

Query Wetlands Object Related to a Assessment Record.

Query Wetlands Object that are related to a assessment record using the LightBox Assessment 'ID.'

GET /wetlands/_on/assessment/us/{id}

Example Requests

curl -X GET -H ‘x-api-key: (api_key)’ https://api.lightboxre.com/v1/wetlands/_on/assessment/us/030022BT8WGISNVQJIEW54

https://api.lightboxre.com/v1/wetlands/_on/assessment/us/030022BT8WGISNVQJIEW54

Parameters

Response

Media type: application/json

Query Wetlands Object Related to a Address Record.

Query Wetlands Object that are related to a address using the LightBox Address 'ID.'

GET /wetlands/_on/address/us/{id}

Example Requests

curl -X GET -H ‘x-api-key: (api_key)’ https://api.lightboxre.com/v1/wetlands/_on/address/us/0606ZGPRLD5KGWFYRD7QH9

https://api.lightboxre.com/v1/wetlands/_on/address/us/0606ZGPRLD5KGWFYRD7QH9

Parameters

Response

Media type: application/json

Health Check

Health Check is an endpoint used to determine the health of this service

GET /wetlands/health

Example Requests

curl -X GET -H ‘x-api-key: (api_key)’ https://api.lightboxre.com/v1/wetlands/health

https://api.lightboxre.com/v1/wetlands/health

Parameters

Response

Media type: application/json

Health Check HTTP Status Codes:

API Response

For each endpoint other then the tile requests the response will stay consistent. 

{
  "$ref": "string",
  "$metadata": {
    "geogcs": {
      "epsg": 4326
    },
    "recordSet": {
      "totalRecords": 99,
      "bbox": {
        "xMax": -105.250409,
        "xMin": -105.251916,
        "yMax": 40.023629,
        "yMin": 40.022576
      }
    },
    "units": {
      "area": "sqm",
      "length": "m"
    },
    "geocode": {
      "confidence": {
        "streetNumber": 1,
        "streetName": 1,
        "locality": 1,
        "postalCode": 1,
        "score": 1
      },
      "precisionCode": "10"
    }
  },
  "wetlands": [
    {
      "$ref": "string",
      "location": {
        "representativePoint": {
          "longitude": -111.8254699,
          "latitude": 33.3406772,
          "geometry": {
            "wkt": "POINT(-111.8254699 33.3406772)"
          }
        },
        "geometry": {
          "wkt": "POINT(-111.8254699 33.3406772)"
        },
        "countryCode": "US"
      },
      "type": "Estuarine and Marine Deepwater",
      "classificationCode": "E1UBLx",
      "wetlandArea": 2154.99078546
    }
  ]
}

Field Dictionary

HTTP Error Codes

• Wetlands Overview
• Wetlands Release Notes