Addresses Documentation

Purpose

When you have an address, adding a location to that address or enriching it with the LightBox Geocoding API is a critical function. But there are situations in which you have a location and would like to find an address, or addresses, based on that location.

• Broadband and telco users need to understand the location, and the number of addresses in that location, for planning purposes. 
• Insurance and finance industry users need to understand each address that resides within a parcel, or even in a building, to help drive business decisions. The LightBox Address API provides the endpoints needed to help solve these challenges.

Swagger: OAS 3.1 Specification

Features

• Query addresses using a point to return the nearest address to that location.
• Pass in a LightBox parcel ID to return all addresses on a parcel.
• Pass in a LightBox structure ID to return all addresses on that parcel.
• Pass in a polygon, along with a buffer unit and buffer distance, to return all addresses that are within that buffer.
• Use the Address tile service to add addresses to a common map control. 

API Requests

Get Addresses by Geometry

Return address records based on a geometry WKT (Well Known Text) string. 

Note: Supports both US and Canada addresses

Examples:

• 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 /addresses/{countryCode}/geometry

Example requests

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

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

Parameters

Response

Media type: application/json

Get Address by ID

Return an address record using the LightBox Address ID or UAID.

Note: Supports both US and Canadian addresses.

GET /addresses/{countryCode/{id}

Example requests

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

https://api.lightboxre.com/v1/addresses/us/0606ZGPRLD5KGWFYRD7QH9

Response

Media type: application/json

Get Addresses by Parcel ID

Return address records that are on a parcel using the LightBox Parcel ID.

GET /addresses/_on/parcel/{countryCode/{id}

Example requests

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

https://api.lightboxre.com/v1/addresses/_on/parcel/us/0606ZGPRLD5KGWFYRD7QH9

Response

Media type: application/json

Get Addresses by Structure ID

Return address records that are on a structure using the LightBox Structure ID.

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

Example requests

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

https://api.lightboxre.com/v1/addresses/_on/structure/us/0606ZGPRLD5KGWFYRD7QH9

Response

Media type: application/json

Get Addresses by Assessment ID

Return address records that are on a structure using the LightBox Assessment ID.

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

Example requests

curl -X GET -H ‘x-api-key: (api_key)’ https://api.lightboxre.com/v1/addresses/_on/assessment/us/03029JH5KG17JF5Y10YBHT

https://api.lightboxre.com/v1/addresses/_on/assessment/us/03029JH5KG17JF5Y10YBHT

Response

Media type: application/json

Get Addresses by LocationInfo ID

Return address records that are on a structure using the LightBox LocationInfo ID.

GET /addresses/_on/locationinfo/us/{id}

Example requests

curl -X GET -H ‘x-api-key: (api_key)’ https://api.lightboxre.com/v1/addresses/_on/locationinfo/us/0703QF6CEZROTHV2Y37Z6F

https://api.lightboxre.com/v1/addresses/_on/locationinfo/us/0703QF6CEZROTHV2Y37Z6F

Response

Media type: application/json

Addresses by LightBox Site ID

Return addresses that contain the site object identified by the LightBox Site 'ID.'

GET /addresses/_on/site/us/{id}

Example Requests

curl -X GET -H ‘x-api-key: (api_key)’ https://api.lightboxre.com/v1/addresses/_on/site/us/0904YD6NQEZ3DPCJJG3E6U

https://api.lightboxre.com/v1/addresses/_on/site/us/0904YD6NQEZ3DPCJJG3E6U

Response

Media type: application/json

Address Tile Endpoint

Use within common map controls to show address points as a tile overlay.

GET /addresses/{countryCode}/tile/{zoom}/{x}/{y}

Example Requests

curl -X GET -H ‘x-api-key: (api_key)’ https://api.lightboxre.com/v1/addresses/us/tile/18/45050/104888

https://api.lightboxre.com/v1/addresses/us/tile/18/45050/104888

Parameters

Response

Media type: image/png

Addresses Tile Bounding Box Endpoint

Use within common map controls to show address points as a bounding box overlay.

GET /addresses/us/tile

Example Requests

curl -X GET -H ‘x-api-key: (api_key)’ https://api.lightboxre.com/v1/addresses/us/tile?bbox=-83.0434660625,40.0198659375,-83.04070793749999,40.0226240625&width=600&height=600

https://api.lightboxre.com/v1/addresses/us/tile?bbox=-83.0434660625,40.0198659375,-83.04070793749999,40.0226240625&width=600&height=600

Parameters

Response

Media type: image/png

API Response

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

{
  "$ref": "string",
  "$metadata": {
    "geogcs": {
      "epsg": 4326
    },
    "recordSet": {
      "totalRecords": 99,
      "limit": 100,
      "offset": 0,
      "bbox": {
        "xMax": -105.250409,
        "xMin": -105.251916,
        "yMax": 40.023629,
        "yMin": 40.022576
      }
    }
  },
  "addresses": [
    {
      "$ref": "string",
      "id": "string",
      "uaid": "0CECC2F1-E86E-D832-7D5C-8B819619FCD5",
      "uuaid": "0CECC2F1-E86E-D832-7D5C-8B819619FCD5",
      "$metadata": {
        "geocode": {
          "confidence": {
            "streetNumber": 1,
            "streetName": 1,
            "locality": 1,
            "postalCode": 1,
            "score": 1
          },
          "changeFlag": {
            "streetName": "Fuzzy",
            "streetType": "Added",
            "locality": "Changed",
            "postalCode": "Removed"
          },
          "addressComponents": {
            "prefixDirection": "string",
            "prefixType": "string",
            "streetNumber": "string",
            "streetName": "string",
            "suffixType": "string",
            "suffixDirection": "string",
            "unit": "string"
          },
          "precisionCode": 10
        }
      },
      "label": "string",
      "isPrimary": true,
      "type": "Residential",
      "postalCodeDerived": true,
      "corroborationIndex": true,
      "location": {
        "streetAddress": "string",
        "borough": "string",
        "locality": "string",
        "regionCode": "AL",
        "postalCode": "string",
        "postalCodeExt": "string",
        "unit": "string",
        "county": "Orange County",
        "countryCode": "US",
        "representativePoint": {
          "longitude": 0,
          "latitude": 0,
          "geometry": {
            "wkt": "string"
          }
        }
      },
      "parcels": [
        {
          "$ref": "string",
          "id": "string"
        }
      ],
      "structures": [
        {
          "$ref": "string",
          "id": "string"
        }
      ],
      "assessments": [
        {
          "$ref": "string",
          "id": "string"
        }
      ],
      "locationInfos": [
        {
          "$ref": "string",
          "id": "string"
        }
      ]
    }
  ]
}

Field Dictionary

Corroboration Index

What do the CI ranges represent?

Using our CI formula, we have definitions for CI values which can be used to help instruct your business processes.

HTTP Error Codes

• Addresses Overview
• Addresses Release Notes