Documentation

Introduction

LightBox’s cloud-based APIs provide access to an extensive universe of location and property data to power your applications. You’ll always benefit from the latest data we have available, and do not need to worry about the hard work of normalizing, processing or hosting data into your own warehouses.

 

Our APIs were built with simplicity in mind and just need a few lines of code to run in your applications. You can easily discover and learn about our APIs through the LightBox Developer Portal and familiarize yourself with them in our sandbox environment before going into production.

 

Features

  • Based in the Cloud, agnostically integrate data for cloud-native or on-premise implementations
  • Best in class service and support with learning and testing APIs and access to content and technical experts
  • Available for all location and property data
  • Consistent look and feel for all APIs
  • LightBox identifiers for all core objects

LightBox Identifier

The LightBox identifier is a permanent and universal identifier for data that creates powerful connections to LightBox’s information model. LightBox IDs

  • Provide identification across a wide range of objects including parcels, structures, addresses and property records
  • Connect data across LightBox’s property graph helping gain comprehensive insights
  • Are unique and never reused allowing you to traverse object changes over time

 

LightBox APIs

The LightBox Data Platform provides simple REST API access to a wide range of content.

 

APIs

Overview

Addresses

Provides a comprehensive set of address points, built from our parcel, assessment and structure datasets.

Assessment

Detailed information about a property and associated property tax within a specific jurisdiction.

Builder Sites

Active directory of new and planned property locations from the top 350 builders in the US. Information which includes the builder, property type, price range, square footage range, city and zip code.

CBSA Boundaries

CBSA Boundaries API provides spatial demarcation of core-based statistical area (CBSA) boundaries.

Census Boundaries – Block

Census Block Boundaries are the smallest geographic unit used by the United States Census Bureau used to collect population data.

Census Boundaries – Block Group

Census Block Group boundaries are a geographical unit used by the United States Census Bureau which is between the Census Tract and the Census Block.

Census Boundaries – Tract

Census Tract Boundaries represent the smallest territorial entity for which population data are available in many countries. In the United States, census tracts are subdivided into block groups and census blocks.

City Boundaries

City boundaries provide spatial demarcations of U.S. cities. 

Country Boundaries

County boundaries provide spatial demarcations of U.S. counties.

Geocode

Standardize, verify and enrich addresses with geographic coordinates.

Historical Assessed Value

Historical assessed value information including total value, land value, improvement value and year.

Historical Tax

Historical tax history including property tax and year.

Opportunity Zones

Opportunity Zones are geospatial boundaries. They outline the distressed areas in the United States that are subject to qualified investment rules as defined by the U.S. Government.

Parcels

Comprehensive commercial and residential property characteristics linked to parcels.

Postal Code Boundaries

Postal Code Boundaries provide spatial demarcations of U.S. postal codes.

State Boundaries

State boundaries provide spatial demarcations of U.S. states.

Structures

Provides the outline of a building drawn along the exterior walls including height and ground elevation.

Transactions

Historical sales transactions from up to 28 years in the past. Includes arms and non-arms length transactions along with lender and loan information.

Getting Started

The LightBox Developer Portal provides an entry point for user registration, profile management, API documentation and administration. Registration to LightBox is required to generate an API key, which facilitates authentication to the LightBox APIs.

 

To access LightBox APIs, an API key is required. Your unique API key is generated when your LightBox user account is created. To sign up for a LightBox account and key, click here and enter the following:

  • First Name
  • Last Name
  • Title
  • Email
  • Contact Number
  • Company Name
  • Industry
  • Country
  • Area of Interest

Note you will be required to access the terms and conditions of the trial agreement to complete the registration.  

After you submit the form, you will receive an email with an activation link. Click the link and you are ready to go!

 

Requirements

The LightBox APIs are hosted in the cloud and therefore has 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

 

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:

  1. Log in to the LightBox Developer Portal at  https://developer.lightboxre.com  
  2. Select Apps from the menu bar
  3. 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/

 

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/

 

Going live

Once you have tested your application in our sandbox environment, you can submit a request to go live. By doing so, you will get a different API key, which you can use for your production environment. 

 

To request production access, submit your request and  contact us . Depending on the API, our support team might contact you to discuss the details of your request. 

 

Please check our  FAQ page for the answers to frequently asked questions. Cannot find the answer you need?  Contact us and we will get back to you as soon as possible.

  

API Reference

Our API reference is organized by API and endpoint. An endpoint represents a type of request to retrieve data.
 

Addresses API

The LightBox Core Addresses API autocompletes a user-entered address and matches it to a location. Results provide a rich dataset about the parcel associated with the address, including spatial, administrative, assessor, and recorder data. The API also provides access to other related datasets, such as structures on the property.

 

GET /addresses/_autocomplete

Return a set of address candidates based on autocompletion of the partial string ‘text’, where each result includes a representative point for the address and references to related parcels. The $ref value within each parcels object for a specific address can be used to get information about the parcel.

 

Example requests

 

curl -X GET -H ‘x-api-key: (api_key)’ https://api.lightboxre.com/v1/addresses/_autocomplete?text=5201%20California%20A

 

https://api.lightboxre.com/v1/addresses/_autocomplete?text=5201%20California%20A

 

Query parameters

 

Parameter

Type

Description

Usage

text

string

Partial address string for autocompletion

required

 

 

GET /addresses/search

Return an address based on the full text string ‘text’ where each result includes a representative point for the address and references to related parcels. If there is no exact match, this will return the best possible match. The $ref value within each parcels object for a specific address can be used to get information about the parcel.

 

Example requests

 

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

 

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

 

Query parameters

 

Parameter

Type

Description

Usage

text

string

Address string for matching

required

 

 

GET /addresses/{countryCode}/geometry

Query for address records based on a geometry string.

 

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

 

Query parameters

 

Parameter

Type

Description

Usage

countryCode

string

ISO 3166 alpha-2 country code (e.g., 'US' for the United States).

required

wkt

string

The geometry of the location expressed in WKT (well-known text) format.

required

bufferDistance

number

Buffer distance expressed in 'bufferUnits.'

optional

bufferUnit

string

The unit type to apply to the buffer (e.g., m=meters, km=kilometers, ft=feet, or mi=miles).

optional

 

 

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

Query for addresses related to a parcel by id. 

 

Example requests

 

curl -X GET -H ‘x-api-key: (api_key)’ https://api.lightboxre.com/v1/addresses/_on/parcels/US/51988594019999

 

https://api.lightboxre.com/v1/addresses/_on/parcels/US/51988594019999

 

Query parameters

 

Parameter

Type

Description

Usage

countryCode

string

ISO 3166 alpha-2 country code (e.g., 'US' for the United States).

required

id

string

The parcel ID for the specified parcel.

required

 

 

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

Query for addresses related to a structure using a structure id. 

 

Example requests

 

curl -X GET -H ‘x-api-key: (api_key)’ https://api.lightboxre.com/v1/addresses/_on/structures/US/ 8553WXR7+CJH-4-4-3-3

 

https://api.lightboxre.com/v1/addresses/_on/structures/US/ 8553WXR7+CJH-4-4-3-3

 

Query parameters

 

Parameter

Type

Description

Usage

countryCode

string

ISO 3166 alpha-2 country code (e.g., 'US' for the United States).

required

ubid

string

Primary structure id for a specified structure.

required

 

 

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

Generate a 256 x 256 tile using x, y and z values.

 

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/

 

Query parameters

 

Parameter

Type

Description

Usage

countryCode

string

ISO 3166 alpha-2 country code (e.g., 'US' for the United States).

required

zoom

string

Tile zoom level, which can be a minimum of '13' and a maximum of '21.'

required

x

integer

Tile column.

required

y

integer

Tile row.

required

 

 

GET /addresses/{countryCode}/tile

Return an image based on a bounding box, width and height.

 

Example requests

 

curl -X GET -H ‘x-api-key: (api_key)’ https://api.lightboxre.com/v1/addresses/US/tile?bbox=-122.39921484469761%2C45.572657942246956%2C-122.3705044794022%2C45.582382848556996&width=2676&height=1295

 

https://api.lightboxre.com/v1/addresses/US/tile?bbox=-122.39921484469761%2C45.572657942246956%2C-122.3705044794022%2C45.582382848556996&width=2676&height=1295

 

Query parameters

 

Parameter

Type

Description

Usage

countryCode

string

ISO 3166 alpha-2 country code (e.g., 'US' for the United States).

required

bbox

string

A bounding box expressed in the NAD83 projected coordinate system.

required

width

integer

Width of the image.

required

height

integer

Height of the image.

required


 

Assessment API

Official record of property, from the tax assessor, subject to property tax within a given jurisdiction. It lists detailed information about an individual's property and associated property tax.

 

GET /assessments/us/geometry

Query for property records based on a geometry represented as a well-known text (WKT) string.

 

Example requests

 

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

 

https://api.lightboxre.com/v1/assessments/us/geometry?wkt=POINT%28-117.852723%2033.63799%29&bufferDistance=0&bufferUnit=meters

 

Query parameters

 

Parameter

Type

Description

Usage

wkt

string

The geometry of the location expressed in WKT format.

required

bufferDistance

float

Buffer distance expressed in ‘bufferUnits’.

optional

bufferUnit

string

The unit type to apply to the buffer (eg meters, kilometers, feet or miles. 

optional

 

 

GET /assessments/US/address

Query properties by an address.

 

Example requests

 

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

 

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

 

Query parameters

 

Parameter

Type

Description

Usage

text

string

Address string for matching

required

 

 

GET /assessments/us/fips/{fips}/apn/{apn}

Query for a property using a FIPS (Federal Information Processing Standards) code and APN (Assessor's Parcel Number).

 

Example requests

 

curl -X GET -H ‘x-api-key: (api_key)’ https://api.lightboxre.com/v1/assessments/us/fips/06095/apn/120-591-02

 

https://api.lightboxre.com/v1/assessments/us/fips/06095/apn/120-591-02

 

Query parameters

 

Parameter

Type

Description

Usage

countryCode

string

ISO 3166 alpha-2 country code (e.g., 'US' for the United States).

required

fips

string

The five-digit FIPS (Federal Information Processing Standards) code for the county that the property is located within (e.g., '06059').

required

apn

string

The APN (Assessor's Parcel Number) for a property (e.g., 120-591-02).

required

 

 

GET /assessments/us/{id}

Query for a specific property using an id.

 

Example requests

 

curl -X GET -H ‘x-api-key: (api_key)’ https://api.lightboxre.com/v1/assessments/us/dmpId/542152604_50362

 

https://api.lightboxre.com/v1/assessments/us/dmpId/542152604_50362

 

Query parameters

 

Parameter

Type

Description

Usage

countryCode

string

ISO 3166 alpha-2 country code (e.g., 'US' for the United States).

required

id

string

The ID for the specified assessment record.

required

 

 

GET /assessments/us/tile/{zoom}/{x}/{y}

Generate a 256 x 256 tile using x, y and z values.

 

Example requests

 

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

 

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

 

Query parameters

 

Parameter

Type

Description

Usage

zoom

integer

Tile zoom level, which can be a minimum of '13' and a maximum of '21.'

required

x

integer

Tile column.

required

y

integer

Tile row.

required

 

 

GET /assessments/us/tile

Generate a 256 x 256 tile using x,y, and z values.

 

Example requests

 

curl -X GET -H ‘x-api-key: (api_key)’ https://api.lightboxre.com/v1/assessments/us/tile?bbox=-83.0434660625%2C40.0198659375%2C-83.04070793749999%2C40.0226240625&width=600&height=600

 

https://api.lightboxre.com/v1/assessments/us/tile?bbox=-83.0434660625%2C40.0198659375%2C-83.04070793749999%2C40.0226240625&width=600&height=600

 

Query parameters

 

Parameter

Type

Description

Usage

bbox

string

A bounding box expressed in the NAD83 projected coordinate system.

required

width

integer

Width of the image.

required

height

integer

Height of the image.

required

 

 

GET /assessments/us/{id}/history/assessedvalue

Query for a specific property using an id.

 

Example requests

 

curl -X GET -H ‘x-api-key: (api_key)’ https://api.lightboxre.com/v1/assessments/us/100660192236887580/history/assessedvalue

 

https://api.lightboxre.com/v1/assessments/us/100660192236887580/history/assessedvalue

 

Query parameters

 

Parameter

Type

Description

Usage

id

string

The id for the specified assessment record.

required

 

 

GET /assessments/us/{id}/history/tax

Return tax history records based on assessment id.

 

Example requests

 

curl -X GET -H ‘x-api-key: (api_key)’ https://api.lightboxre.com/v1/assessments/us/ 100660192236887580/history/tax

 

https://api.lightboxre.com/v1/assessments/us/tile?bbox=-83.0434660625%2C40.0198659375%2C-83.04070793749999%2C40.0226240625&width=600&height=600

 

Query parameters

 

Parameter

Type

Description

Usage

id

string

The id for the specified assessment record.

required

  

Builder Sites API

Use a geometry, or an ID to return builder sites. Add builder site locations to modern map controls or reports with tile and bounding box image requests. Builder sites are sourced from the top 350 builders in the United States. This dataset includes links back to the builder website and the community website as well as min and max square area, and low and high purchase price.

 

GET /buildersites/us/geometry

Query for builder sites records based on a geometry string.

 

Example requests

 

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

 

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

 

Query parameters

 

Parameter

Type

Description

Usage

wkt

string

The geometry of the location expressed in WKT format.

required

bufferDistance

float

Buffer distance expressed in ‘bufferUnits’.

optional

bufferUnit

string

The unit type to apply to the buffer (eg meters, kilometers, feet or miles. 

optional

 

 

GET /buildersites/us/tile/{zoom}/{x}/{y}

Generate a 256 x 256 tile using x, y and z values.

 

Example requests

 

curl -X GET -H ‘x-api-key: (api_key)’ https://api.lightboxre.com/v1/buildersites/us/tile/14/2835/6562

 

https://api.lightboxre.com/v1/buildersites/us/tile/14/2835/6562

 

Query parameters

 

Parameter

Type

Description

Usage

zoom

integer

Tile zoom level, which can be a minimum of '13' and a maximum of '21.'

required

x

integer

Tile column.

required

y

integer

Tile row.

required

 

 

GET /buildersites/us/tile

Return an image based on a bounding box, width and height.

 

Example requests

 

curl -X GET -H ‘x-api-key: (api_key)’ https://api.lightboxre.com/v1/buildersites/us/tile?bbox=-122.39921484469761%2C45.572657942246956%2C-122.3705044794022%2C45.582382848556996&width=2676&height=1295

 

https://api.lightboxre.com/v1/buildersites/us/tile?bbox=-122.39921484469761%2C45.572657942246956%2C-122.3705044794022%2C45.582382848556996&width=2676&height=1295

 

Query parameters

 

Parameter

Type

Description

Usage

bbox

string

A bounding box expressed in the NAD83 projected coordinate system.

required

width

integer

Width of the image.

required

height

integer

Height of the image.

required

 

 

GET /buildersites/us/{id}

Query for a specific builder site using an id.

 

Example requests

 

curl -X GET -H ‘x-api-key: (api_key)’ https://api.lightboxre.com/v1/buildersites/us/542183366_233

 

https://api.lightboxre.com/v1/buildersites/us/542183366_233

 

Query parameters

 

Parameter

Type

Description

Usage

id

string

The id for the specified builder site.

required

 

CBSA Boundaries API

The LightBox CBSA Boundaries API returns core-based statistical area (CBSA) boundaries. A CBSA is a U.S. geographic area defined by the Office of Management and Budget (OMB). CBSAs consists of one or more counties (or equivalents) anchored by an urban center of at least 10,000 people, plus adjacent counties that are socioeconomically tied to the urban center by commuting.

 

GET /cbsas/us/geometry

Query for CBSA records based on a geometry string.

 

Example requests

 

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

 

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

 

Query parameters

 

Parameter

Type

Description

Usage

wkt

string

The geometry of the location expressed in WKT format.

required

bufferDistance

float

Buffer distance expressed in ‘bufferUnits’.

optional

bufferUnit

string

The unit type to apply to the buffer (eg meters, kilometers, feet or miles. 

optional

 

 

GET /cbsas/us/tile/{zoom}/{x}/{y}

Generate a 256 x 256 tile using x, y and z values.

 

Example requests

 

curl -X GET -H ‘x-api-key: (api_key)’ https://api.lightboxre.com/v1/cbsas/us/tile/14/2835/6562

 

https://api.lightboxre.com/v1/cbsas/us/tile/14/2835/6562

 

Query parameters

 

Parameter

Type

Description

Usage

zoom

integer

Tile zoom level, which can be a minimum of '13' and a maximum of '21.'

required

x

integer

Tile column.

required

y

integer

Tile row.

required

 

 

GET /assessments/us/tile

Return an image based on a bounding box, width and height.

 

Example requests

 

curl -X GET -H ‘x-api-key: (api_key)’ https://api.lightboxre.com/v1/cbsas/us/tile?bbox=-122.39921484469761%2C45.572657942246956%2C-122.3705044794022%2C45.582382848556996&width=2676&height=1295

 

https://api.lightboxre.com/v1/cbsas/us/tile?bbox=-122.39921484469761%2C45.572657942246956%2C-122.3705044794022%2C45.582382848556996&width=2676&height=1295

 

Query parameters

 

Parameter

Type

Description

Usage

bbox

string

A bounding box expressed in the NAD83 projected coordinate system.

required

width

integer

Width of the image.

required

height

integer

Height of the image.

required

 

 

GET /cbsas/us/_autocomplete

Return a set of CBSA candidates based on autocompletion of the partial string ‘text’ where each result includes a representative point for the CBSA.

 

Example requests

 

curl -X GET -H ‘x-api-key: (api_key)’ https://api.lightboxre.com/v1/cbsas/us/_autocomplete?text=Fairbankd

 

https://api.lightboxre.com/v1/cbsas/us/_autocomplete?text=Fairbankd

 

Query parameters

 

Parameter

Type

Description

Usage

text

string

Partial CBSA name string for autocompletion.

required

 

 

GET /cbsas/us/{id}

Query for a specific CBSA using an id.

 

Example requests

 

curl -X GET -H ‘x-api-key: (api_key)’ https://api.lightboxre.com/v1/cbsas/us/542183366_233

 

https://api.lightboxre.com/v1/cbsas/us/542183366_233

 

Query parameters

 

Parameter

Type

Description

Usage

id

string

The primary id for the specified CBSA.

required

 

Census Boundaries – Block API

Use a geometry, or an ID to return relevant census block boundaries. Add census block boundaries to modern map controls or reports with tile and bounding box image requests. A census block is the smallest geographic unit used by the United States Census Bureau used to collect population data. census blocks are grouped into block groups, which are grouped into census tracts.

 

GET /census/us/blocks/geometry

Query for census block records based on a geometry string.

 

Example requests

 

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

 

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

 

Query parameters

 

Parameter

Type

Description

Usage

wkt

string

The geometry of the location expressed in WKT format.

required

bufferDistance

float

Buffer distance expressed in ‘bufferUnits’.

optional

bufferUnit

string

The unit type to apply to the buffer (eg meters, kilometers, feet or miles. 

optional

 

 

GET /census/us/blocks/tile/{zoom}/{x}/{y}

Generate a 256 x 256 tile using x, y and z values.

 

Example requests

 

curl -X GET -H ‘x-api-key: (api_key)’ https://api.lightboxre.com/v1/census/us/blocks/tile/14/2835/6562

 

https://api.lightboxre.com/v1/census/us/blocks/tile/14/2835/6562

 

Query parameters

 

Parameter

Type

Description

Usage

zoom

integer

Tile zoom level, which can be a minimum of '13' and a maximum of '21.'

required

x

integer

Tile column.

required

y

integer

Tile row.

required

 

 

GET /census/us/blocks/tile

Return an image based on a bounding box, width and height.

 

Example requests

 

curl -X GET -H ‘x-api-key: (api_key)’ https://api.lightboxre.com/v1/census/us/blocks/tile?bbox=-118.25001525986275%2C33.80799898619887%2C-118.02582550156197%2C33.88883457098606&width=1306&height=567

 

https://api.lightboxre.com/v1/census/us/blocks/tile?bbox=-118.25001525986275%2C33.80799898619887%2C-118.02582550156197%2C33.88883457098606&width=1306&height=567

 

Query parameters

 

Parameter

Type

Description

Usage

bbox

string

A bounding box expressed in the NAD83 projected coordinate system.

required

width

integer

Width of the image.

required

height

integer

Height of the image.

required

 

 

GET /census/us/blocks/{id}

Query for a specific census block using an id.

 

Example requests

 

curl -X GET -H ‘x-api-key: (api_key)’ https://api.lightboxre.com/v1/census/us/blocks/530110405091004

 

https://api.lightboxre.com/v1/census/us/blocks/530110405091004

 

Query parameters

 

Parameter

Type

Description

Usage

id

string

The geoid for the specified census block. Geoid is a concatenation of the current state FIPS code, county FIPS code and census block code.

required

 

Census Boundaries – Block Group API

Use a geometry, or an ID to return relevant census block group boundaries. Add census block group boundaries to modern map controls or reports with tile and bounding box image requests. A census block group is a geographical unit used by the United States Census Bureau which is between the census tract and the census block.

 

GET /census/us/blockgroups/geometry

Query for census block records based on a geometry string.

 

Example requests

 

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

 

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

 

Query parameters

 

Parameter

Type

Description

Usage

wkt

string

The geometry of the location expressed in WKT format.

required

bufferDistance

float

Buffer distance expressed in ‘bufferUnits’.

optional

bufferUnit

string

The unit type to apply to the buffer (eg meters, kilometers, feet or miles. 

optional

 

 

GET /census/us/blockgroups/tile/{zoom}/{x}/{y}

Generate a 256 x 256 tile using x, y and z values.

 

Example requests

 

curl -X GET -H ‘x-api-key: (api_key)’ https://api.lightboxre.com/v1/census/us/blockgroups/tile/14/2835/6562

 

https://api.lightboxre.com/v1/census/us/blockgroups/tile/14/2835/6562

 

Query parameters

 

Parameter

Type

Description

Usage

zoom

integer

Tile zoom level, which can be a minimum of '13' and a maximum of '21.'

required

x

integer

Tile column.

required

y

integer

Tile row.

required

 

 

GET /census/us/blockgroups/tile

Return an image based on a bounding box, width and height.

 

Example requests

 

curl -X GET -H ‘x-api-key: (api_key)’ https://api.lightboxre.com/v1/census/us/blockgroups/tile?bbox=-118.25001525986275%2C33.80799898619887%2C-118.02582550156197%2C33.88883457098606&width=1306&height=567

 

https://api.lightboxre.com/v1/census/us/blockgroups/tile?bbox=-118.25001525986275%2C33.80799898619887%2C-118.02582550156197%2C33.88883457098606&width=1306&height=567

 

Query parameters

 

Parameter

Type

Description

Usage

bbox

string

A bounding box expressed in the NAD83 projected coordinate system.

required

width

integer

Width of the image.

required

height

integer

Height of the image.

required

 

 

GET /census/us/blockgroups/{id}

Query for a specific census block using an id.

 

Example requests

 

curl -X GET -H ‘x-api-key: (api_key)’ https://api.lightboxre.com/v1/census/us/blockgroups/530110405091004

 

https://api.lightboxre.com/v1/census/us/blockgroups/530110405091004

 

Query parameters

 

Parameter

Type

Description

Usage

id

string

The geoid for the specified census block group. Geoid is a concatenation of the current state FIPS code, county FIPS code and census block group code.

required

 

Census Boundaries – Tract API

Use a geometry, or an ID to return a census tract boundary. Add census tract boundaries to modern map controls or reports with tile and bounding box image requests. A census tract is a geographic region defined for the purpose of taking a census. Census tracts represent the smallest territorial entity for which population data are available in many countries. In the United States, census tracts are subdivided into block groups and census blocks.

 

GET /census/us/tracts/geometry

Query for census tract based on a geometry string.

 

Example requests

 

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

 

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

 

Query parameters

 

Parameter

Type

Description

Usage

wkt

string

The geometry of the location expressed in WKT format.

required

bufferDistance

float

Buffer distance expressed in ‘bufferUnits’.

optional

bufferUnit

string

The unit type to apply to the buffer (eg meters, kilometers, feet or miles. 

optional

 

 

GET /census/us/tracts/tile/{zoom}/{x}/{y}

Generate a 256 x 256 tile using x, y and z values.

 

Example requests

 

curl -X GET -H ‘x-api-key: (api_key)’ https://api.lightboxre.com/v1/census/us/tracts/tile/14/2835/6562

 

https://api.lightboxre.com/v1/census/us/tracts/tile/14/2835/6562

 

Query parameters

 

Parameter

Type

Description

Usage

zoom

integer

Tile zoom level, which can be a minimum of '13' and a maximum of '21.'

required

x

integer

Tile column.

required

y

integer

Tile row.

required

 

 

GET /census/us/tracts/tile

Return an image based on a bounding box, width and height.

 

Example requests

 

curl -X GET -H ‘x-api-key: (api_key)’ https://api.lightboxre.com/v1/census/us/tracts/tile?bbox=-118.25001525986275%2C33.80799898619887%2C-118.02582550156197%2C33.88883457098606&width=1306&height=567

 

https://api.lightboxre.com/v1/census/us/tracts/tile?bbox=-118.25001525986275%2C33.80799898619887%2C-118.02582550156197%2C33.88883457098606&width=1306&height=567

 

Query parameters

 

Parameter

Type

Description

Usage

bbox

string

A bounding box expressed in the NAD83 projected coordinate system.

required

width

integer

Width of the image.

required

height

integer

Height of the image.

required

 

 

GET /census/us/tracts/{id}

Query for a specific census block using an id.

 

Example requests

 

curl -X GET -H ‘x-api-key: (api_key)’ https://api.lightboxre.com/v1/census/us/tracts/530110405091004

 

https://api.lightboxre.com/v1/census/us/blockgroups/530110405091004

 

Query parameters

 

Parameter

Type

Description

Usage

id

string

The geoid for the specified census tract. Geoid is a concatenation of the current state FIPS code, county FIPS code and census tract code.

required

 

City Boundaries API

The LightBox U.S. City Boundary API returns city boundaries. Users can add city boundaries to modern map controls or reports with tile and bounding box image requests. Fetch results using autocomplete, a geometry, or an ID.

 

GET /cities/us/geometry

Query for city records based on a geometry string.

 

Example requests

 

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

 

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

 

Query parameters

 

Parameter

Type

Description

Usage

wkt

string

The geometry of the location expressed in WKT format.

required

bufferDistance

float

Buffer distance expressed in ‘bufferUnits’.

optional

bufferUnit

string

The unit type to apply to the buffer (eg meters, kilometers, feet or miles. 

optional

 

 

GET /cities/us/tile/{zoom}/{x}/{y}

Generate a 256 x 256 tile using x, y and z values.

 

Example requests

 

curl -X GET -H ‘x-api-key: (api_key)’ https://api.lightboxre.com/v1/cities/us/tile/14/2835/6562

 

https://api.lightboxre.com/v1/cities/us/tile/14/2835/6562

 

Query parameters

 

Parameter

Type

Description

Usage

zoom

integer

Tile zoom level, which can be a minimum of '13' and a maximum of '21.'

required

x

integer

Tile column.

required

y

integer

Tile row.

required

 

 

GET /cities/us/tile

Return an image based on a bounding box, width and height.

 

Example requests

 

curl -X GET -H ‘x-api-key: (api_key)’ https://api.lightboxre.com/v1/cities/us/tile?bbox=-118.25001525986275%2C33.80799898619887%2C-118.02582550156197%2C33.88883457098606&width=1306&height=567

 

https://api.lightboxre.com/v1/cities/us/tile?bbox=-118.25001525986275%2C33.80799898619887%2C-118.02582550156197%2C33.88883457098606&width=1306&height=567

 

Query parameters

 

Parameter

Type

Description

Usage

bbox

string

A bounding box expressed in the NAD83 projected coordinate system.

required

width

integer

Width of the image.

required

height

integer

Height of the image.

required

 

 

GET /cities/us/_autocomplete

Get a set of city candidates based on autocompletion of the partial string ‘text’ where each result includes a representative point for the city.

 

Example requests

 

curl -X GET -H ‘x-api-key: (api_key)’ https://api.lightboxre.com/v1/cities/us/_autocomplete?text=Lake Fores

 

https://api.lightboxre.com/v1/cities/us/_autocomplete?text=Lake Fores

 

Query parameters

 

Parameter

Type

Description

Usage

text

string

Partial city string for autocompletion.

required

 

 

GET /cities/us/{id}

Query for a specific city block using an id.

 

Example requests

 

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

 

https://api.lightboxre.com/v1/cities/us/530110405091004

 

Query parameters

 

Parameter

Type

Description

Usage

id

string

The primary id for the specified city.

 

required


 

County Boundaries API

The LightBox US Counties API returns county boundaries. Users can add county boundaries to modern map controls or reports with tile and bounding box image requests. Fetch results using autocomplete, a geometry, or an ID.

 

GET /counties/us/geometry

Query for country records based on a geometry string.

 

Example requests

 

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

 

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

 

Query parameters

 

Parameter

Type

Description

Usage

wkt

string

The geometry of the location expressed in WKT format.

required

bufferDistance

float

Buffer distance expressed in ‘bufferUnits’.

optional

bufferUnit

string

The unit type to apply to the buffer (eg meters, kilometers, feet or miles. 

optional

 

 

GET /counties/us/tile/{zoom}/{x}/{y}

Generate a 256 x 256 tile using x, y and z values.

 

Example requests

 

curl -X GET -H ‘x-api-key: (api_key)’ https://api.lightboxre.com/v1/counties/us/tile/14/2835/6562

 

https://api.lightboxre.com/v1/counties/us/tile/14/2835/6562

 

Query parameters

 

Parameter

Type

Description

Usage

zoom

integer

Tile zoom level, which can be a minimum of '13' and a maximum of '21.'

required

x

integer

Tile column.

required

y

integer

Tile row.

required

 

 

GET /counties/us/tile

Return an image based on a bounding box, width and height.

 

Example requests

 

curl -X GET -H ‘x-api-key: (api_key)’ https://api.lightboxre.com/v1/counties/us/tile?bbox=-118.25001525986275%2C33.80799898619887%2C-118.02582550156197%2C33.88883457098606&width=1306&height=567

 

https://api.lightboxre.com/v1/counties/us/tile?bbox=-118.25001525986275%2C33.80799898619887%2C-118.02582550156197%2C33.88883457098606&width=1306&height=567

 

Query parameters

 

Parameter

Type

Description

Usage

bbox

string

A bounding box expressed in the NAD83 projected coordinate system.

required

width

integer

Width of the image.

required

height

integer

Height of the image.

required

 

 

GET /counties/us/_autocomplete

Get a set of city candidates based on autocompletion of the partial string ‘text’ where each result includes a representative point for the city.

 

Example requests

 

curl -X GET -H ‘x-api-key: (api_key)’ https://api.lightboxre.com/v1/counties/us/_autocomplete?text=Oran

 

https://api.lightboxre.com/v1/counties/us/_autocomplete?text=Oran

 

Query parameters

 

Parameter

Type

Description

Usage

text

string

Partial county string for autocompletion.

required

 

 

GET /counties/us/{id}

Query for a specific county using an id.

 

Example requests

 

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

 

https://api.lightboxre.com/v1/counties/us/06059

 

Query parameters

 

Parameter

Type

Description

Usage

id

string

The primary ID (5-digit FIPS code) for the specified county.

required

 

Geocoding API

The LightBox Geocoding API confirms an address as admissible and reliable. The API uses advanced logic and address-matching principles to standardize and correct the predominant majority of North American addresses, making adjustments to formatting, spelling, missing information, and component standardization so that an address can be matched against LightBox’s market-leading Master Address Repository for the United States and Canada. The service recognizes both civic and postal addresses, including rural routes, PO boxes, and postal station information, and cross-correlates them to ensure a high-quality result.

 

GET /addresses/_autocomplete

Return a set of address candidates based on autocompletion of the partial string ‘text’, where each result includes a representative point for the address and references to related parcels. The $ref value within each parcels object for a specific address can be used to get information about the parcel.

 

Example requests

 

curl -X GET -H ‘x-api-key: (api_key)’ https://api.lightboxre.com/v1/addresses/_autocomplete?text=5201%20California%20A

 

https://api.lightboxre.com/v1/addresses/_autocomplete?text=5201%20California%20A

 

Query parameters

 

Parameter

Type

Description

Usage

text

string

Partial address string for autocompletion

required

 

 

GET /addresses/search

Return an address based on the full text string ‘text’ where each result includes a representative point for the address and references to related parcels. If there is no exact match, this will return the best possible match. The $ref value within each parcels object for a specific address can be used to get information about the parcel.

 

Example requests

 

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

 

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

 

Query parameters

 

Parameter

Type

Description

Usage

text

string

Address string for matching

required

   

Historical Assessed Value API

The official record of property assessed value from previous years. This provided by the county tax assessor.

 

GET /assessments/us/{id}/history/assessedvalue

Query for a specific property using an id.

 

Example requests

 

curl -X GET -H ‘x-api-key: (api_key)’ https://api.lightboxre.com/v1/assessments/us/ 100660192236887580/history/assessedvalue

 

https://api.lightboxre.com/v1/assessments/us/ 100660192236887580/history/assessedvalue

 

Query parameters

 

Parameter

Type

Description

Usage

id

string

The id for the specified assessment record.

required

 

Historical Tax API

The official record of property tax information from previous years. This is provided by the county tax assessor.

 

GET /assessments/us/{id}/history/tax

Return tax history records based on assessment id.

 

Example requests

 

curl -X GET -H ‘x-api-key: (api_key)’ https://api.lightboxre.com/v1/assessments/us/ 100660192236887580/history/tax

 

https://api.lightboxre.com/v1/assessments/us/ 100660192236887580/history/tax

 

Query parameters

 

Parameter

Type

Description

Usage

id

string

The id for the specified assessment record.

required

 

Opportunity Zone Boundaries API

LightBox US Census opportunity zone boundary API. Use a geometry, or an ID to return relevant opportunity zone boundaries. Add opportunity zone boundaries to modern map controls or reports with tile and bounding box image requests. Opportunity zones generally represent economically distressed communities that are in need of investment and revitalization. Created under the Tax Cuts and Jobs Act of 2017, the purpose of opportunity zones is to spur economic growth and create jobs by incentivize investment in these regions.

 

GET /census/us/opportunityzones/geometry

Query for opportunity zone records based on a geometry string.

 

Example requests

 

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

 

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

 

Query parameters

 

Parameter

Type

Description

Usage

wkt

string

The geometry of the location expressed in WKT format.

required

bufferDistance

float

Buffer distance expressed in ‘bufferUnits’.

optional

bufferUnit

string

The unit type to apply to the buffer (eg meters, kilometers, feet or miles. 

optional

 

 

GET /census/us/opportunityzones/tile/{zoom}/{x}/{y}

Generate a 256 x 256 tile using x, y and z values.

 

Example requests

 

curl -X GET -H ‘x-api-key: (api_key)’ https://api.lightboxre.com/v1/census/us/opportunityzones/tile/14/2835/6562

 

https://api.lightboxre.com/v1/census/us/opportunityzones/tile/14/2835/6562

 

Query parameters

 

Parameter

Type

Description

Usage

zoom

integer

Tile zoom level, which can be a minimum of '13' and a maximum of '21.'

required

x

integer

Tile column.

required

y

integer

Tile row.

required

 

 

GET /census/us/opportunityzones/tile

Return an image based on a bounding box, width and height.

 

Example requests

 

curl -X GET -H ‘x-api-key: (api_key)’ https://api.lightboxre.com/v1/census/us/opportunityzones/tile?bbox=-118.25001525986275%2C33.80799898619887%2C-118.02582550156197%2C33.88883457098606&width=1306&height=567

 

https://api.lightboxre.com/v1/census/us/opportunityzones/tile?bbox=-118.25001525986275%2C33.80799898619887%2C-118.02582550156197%2C33.88883457098606&width=1306&height=567

 

Query parameters

 

Parameter

Type

Description

Usage

bbox

string

A bounding box expressed in the NAD83 projected coordinate system.

required

width

integer

Width of the image.

required

height

integer

Height of the image.

required

 

 

GET /census/us/opportunityzones/{id}

Query for a specific opportunity zone using an id.

 

Example requests

 

curl -X GET -H ‘x-api-key: (api_key)’ https://api.lightboxre.com/v1/census/us/opportunityzones/542148892_48

 

https://api.lightboxre.com/v1/census/us/opportunityzones/542148892_48

 

Query parameters

 

Parameter

Type

Description

Usage

id

string

The geoid for the specified opportunity zone. Geoid is a concatenation of the current state FIPS code, county FIPS code and opportunity zone code.

required

 

Parcels API

Access nationwide parcel boundaries with a large selection of property and tax attributes to help you make more confident decisions. Covers 3,100+ U.S. counties including territories, with over 150 million parcels with polygon geometry that is normalized across state and county boundaries.

 

GET /parcels/{countryCode}/geometry

Query for parcel records based on a geometry represented as a well-known text (WKT) string.

 

Example requests

 

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

 

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

 

Query parameters

 

Parameter

Type

Description

Usage

countryCode

string

ISO 3166 alpha-2 country code (e.g., 'US' for the United States).

required

wkt

string

The geometry of the location expressed in WKT format.

required

bufferDistance

float

Buffer distance expressed in ‘bufferUnits’.

optional

bufferUnit

string

The unit type to apply to the buffer (eg meters, kilometers, feet or miles. 

optional

 

 

GET /parcels/address

Query parcels by an address.

 

Example requests

 

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

 

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

 

Query parameters

 

Parameter

Type

Description

Usage

text

string

Address string for matching

required

 

 

GET /parcels/us/fips/{fips}/apn/{apn}

Query for a parcel using a FIPS (Federal Information Processing Standards) code and APN (Assessor's Parcel Number).

 

Example requests

 

curl -X GET -H ‘x-api-key: (api_key)’ https://api.lightboxre.com/v1/parcels/us/fips/06095/apn/120-591-02

 

https://api.lightboxre.com/v1/parcels/us/fips/06095/apn/120-591-02

 

Query parameters

 

Parameter

Type

Description

Usage

countryCode

string

ISO 3166 alpha-2 country code (e.g., 'US' for the United States).

required

fips

string

The five-digit FIPS (Federal Information Processing Standards) code for the county that the property is located within (e.g., '06059').

required

apn

string

The APN (Assessor's Parcel Number) for a property (e.g., 120-591-02).

required

 

 

GET /parcels/{countryCode}/{id}

Query for a specific parcel using an id.

 

Example requests

 

curl -X GET -H ‘x-api-key: (api_key)’ https://api.lightboxre.com/v1/parcels/US/100660192_159849481

 

https://api.lightboxre.com/v1/parcels/US/100660192_159849481

 

Query parameters

 

Parameter

Type

Description

Usage

countryCode

string

ISO 3166 alpha-2 country code (e.g., 'US' for the United States).

required

id

string

The ID for the specified assessment record.

required

 

 

GET /parcels/{countryCode}/structure/{id}

Query for parcels using an structure id.

 

Example requests

 

curl -X GET -H ‘x-api-key: (api_key)’ https://api.lightboxre.com/v1/parcels/US/structure/84QVJH3X%2BQQG-4-5-4-5

 

https://api.lightboxre.com/v1/parcels/US/structure/84QVJH3X%2BQQG-4-5-4-5

 

Query parameters

 

Parameter

Type

Description

Usage

countryCode

string

ISO 3166 alpha-2 country code (e.g., 'US' for the United States).

required

id

string

The ID for the specified assessment record.

required

 

 

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

Generate a 256 x 256 tile using x, y and z values.

 

Example requests

 

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

 

https://api.lightboxre.com/v1/parcels/US/tile/18/45050/104888

 

Query parameters

 

Parameter

Type

Description

Usage

countryCode

string

ISO 3166 alpha-2 country code (e.g., 'US' for the United States).

required

zoom

integer

Tile zoom level, which can be a minimum of '13' and a maximum of '21.'

required

x

integer

Tile column.

required

y

integer

Tile row.

required

 

 

GET /parcels/{countryCode}/tile

Generate a 256 x 256 tile using x,y, and z values.

 

Example requests

 

curl -X GET -H ‘x-api-key: (api_key)’ https://api.lightboxre.com/v1/parcels/US/tile?bbox=-83.0434660625%2C40.0198659375%2C-83.04070793749999%2C40.0226240625&width=600&height=600

 

https://api.lightboxre.com/v1/parcels/US/tile?bbox=-83.0434660625%2C40.0198659375%2C-83.04070793749999%2C40.0226240625&width=600&height=600

 

Query parameters

 

Parameter

Type

Description

Usage

countryCode

string

ISO 3166 alpha-2 country code (e.g., 'US' for the United States).

required

bbox

string

A bounding box expressed in the NAD83 projected coordinate system.

required

width

integer

Width of the image.

required

height

integer

Height of the image.

required

 

Postal Boundaries API

Postal Code Boundaries provide spatial demarcations of U.S. postal codes. This dataset also includes the centroid location for each ZIP code and over 60 million deliverable USPS ZIP +4 addresses.

 

GET /postalcodes/us/geometry

Query for postal code records based on a geometry string.

 

Example requests

 

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

 

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

 

Query parameters

 

Parameter

Type

Description

Usage

wkt

string

The geometry of the location expressed in WKT format.

required

bufferDistance

float

Buffer distance expressed in ‘bufferUnits’.

optional

bufferUnit

string

The unit type to apply to the buffer (eg meters, kilometers, feet or miles. 

optional

 

 

GET /postalcodes/us/tile/{zoom}/{x}/{y}

Generate a 256 x 256 tile using x, y and z values.

 

Example requests

 

curl -X GET -H ‘x-api-key: (api_key)’ https://api.lightboxre.com/v1/postalcodes/us/tile/14/2835/6562

 

https://api.lightboxre.com/v1/postalcodes/us/tile/14/2835/6562

 

Query parameters

 

Parameter

Type

Description

Usage

zoom

integer

Tile zoom level, which can be a minimum of '13' and a maximum of '21.'

required

x

integer

Tile column.

required

y

integer

Tile row.

required

 

 

GET /postalcodes/us/tile

Return an image based on a bounding box, width and height.

 

Example requests

 

curl -X GET -H ‘x-api-key: (api_key)’ https://api.lightboxre.com/v1/postalcodes/us/tile?bbox=-118.25001525986275%2C33.80799898619887%2C-118.02582550156197%2C33.88883457098606&width=1306&height=567

 

https://api.lightboxre.com/v1/postalcodes/us/tile?bbox=-118.25001525986275%2C33.80799898619887%2C-118.02582550156197%2C33.88883457098606&width=1306&height=567

 

Query parameters

 

Parameter

Type

Description

Usage

bbox

string

A bounding box expressed in the NAD83 projected coordinate system.

required

width

integer

Width of the image.

required

height

integer

Height of the image.

required

 

 

GET /postalcodes/us/_autocomplete

Get a set of postal code candidates based on autocompletion of the partial string ‘text’ where each result includes a representative point for the postal code.

 

Example requests

 

curl -X GET -H ‘x-api-key: (api_key)’ https://api.lightboxre.com/v1/postalcodes/us/_autocomplete?text=926

 

https://api.lightboxre.com/v1/postalcodes/us/_autocomplete?text=926

 

Query parameters

 

Parameter

Type

Description

Usage

text

string

Partial postal code string for autocompletion.

required

 

 

GET /postalcodes/us/{id}

Query for a specific postal code using an id.

 

Example requests

 

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

 

https://api.lightboxre.com/v1/postalcodes/us/92630

 

Query parameters

 

Parameter

Type

Description

Usage

id

string

The primary ID (postal code) for the specified postal code.

required

State Boundaries API

The LightBox US State Boundary API returns state boundaries. Users can add state boundaries to modern map controls or reports with tile and bounding box image requests. Fetch results using autocomplete, a geometry, or an ID.

 

GET /states/us/geometry

Query for state records based on a geometry string.

 

Example requests

 

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

 

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

 

Query parameters

 

Parameter

Type

Description

Usage

wkt

string

The geometry of the location expressed in WKT format.

required

bufferDistance

float

Buffer distance expressed in ‘bufferUnits’.

optional

bufferUnit

string

The unit type to apply to the buffer (eg meters, kilometers, feet or miles. 

optional

 

 

GET /states/us/tile/{zoom}/{x}/{y}

Generate a 256 x 256 tile using x, y and z values.

 

Example requests

 

curl -X GET -H ‘x-api-key: (api_key)’ https://api.lightboxre.com/v1/states/us/tile/14/2835/6562

 

https://api.lightboxre.com/v1/states/us/tile/14/2835/6562

 

Query parameters

 

Parameter

Type

Description

Usage

zoom

integer

Tile zoom level, which can be a minimum of '13' and a maximum of '21.'

required

x

integer

Tile column.

required

y

integer

Tile row.

required

 

 

GET /states/us/tile

Return an image based on a bounding box, width and height.

 

Example requests

 

curl -X GET -H ‘x-api-key: (api_key)’ https://api.lightboxre.com/v1/states/us/tile?bbox=-118.25001525986275%2C33.80799898619887%2C-118.02582550156197%2C33.88883457098606&width=1306&height=567

 

https://api.lightboxre.com/v1/states/us/tile?bbox=-118.25001525986275%2C33.80799898619887%2C-118.02582550156197%2C33.88883457098606&width=1306&height=567

 

Query parameters

 

Parameter

Type

Description

Usage

bbox

string

A bounding box expressed in the NAD83 projected coordinate system.

required

width

integer

Width of the image.

required

height

integer

Height of the image.

required

 

 

GET /states/us/_autocomplete

Get a set of state candidates based on autocompletion of the partial string ‘text’ where each result includes a representative point for the state.

 

Example requests

 

curl -X GET -H ‘x-api-key: (api_key)’ https://api.lightboxre.com/v1/states/us/_autocomplete?text=Califo

 

https://api.lightboxre.com/v1/states/us/_autocomplete?text=Califo

 

Query parameters

 

Parameter

Type

Description

Usage

text

string

Partial state string for autocompletion.

required

 

 

GET /states/us/{id}

Query for a specific state using an id.

 

Example requests

 

curl -X GET -H ‘x-api-key: (api_key)’ https://api.lightboxre.com/v1/states/us/ 542148892_48

 

https://api.lightboxre.com/v1/states/us/ 542148892_48

 

Query parameters

 

Parameter

Type

Description

Usage

id

string

The primary id for the specified state.

required

   

Structures API

Structure footprints are geo spatial boundaries that provide the outline of a building drawn along the exterior walls. Includes height and ground elevation measurements.

 

GET /structures/{countryCode}/geometry

Return structures based on a well-known text (WKT) geometry string.

 

Example requests

 

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

 

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

 

Query parameters

 

Parameter

Type

Description

Usage

countryCode

string

ISO 3166 alpha-2 country code (e.g., 'US' for the United States).

required

wkt

string

The geometry of the location expressed in WKT format.

required

bufferDistance

float

Buffer distance expressed in ‘bufferUnits’.

optional

bufferUnit

string

The unit type to apply to the buffer (eg meters, kilometers, feet or miles. 

optional

 

 

GET /structures/address

Query structures by an address.

 

Example requests

 

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

 

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

 

Query parameters

 

Parameter

Type

Description

Usage

text

string

Address string for matching

required

 

 

GET /structures/{countryCode}/ubid/{ubid}

Return a structure by its universal building id.

 

Example requests

 

curl -X GET -H ‘x-api-key: (api_key)’ https://api.lightboxre.com/v1/structures/us/ubid/8554J4QX%2B7F6-13-13-12-12

 

https://api.lightboxre.com/v1/structures/us/ubid/8554J4QX%2B7F6-13-13-12-12

 

Query parameters

 

Parameter

Type

Description

Usage

ubid

string

The Unique Building Identifier (UBID) of the primary structure on the property.

required

countryCode

string

ISO 3166 alpha-2 country code (e.g., 'US' for the United States).

required

 

 

GET /structures/{countryCode}/{id}

Return a structure by its unique id.

 

Example requests

 

curl -X GET -H ‘x-api-key: (api_key)’ https://api.lightboxre.com/v1/structures/us/542170041_141579

 

https://api.lightboxre.com/v1/structures/us/542170041_141579

 

Query parameters

 

Parameter

Type

Description

Usage

countryCode

string

ISO 3166 alpha-2 country code (e.g., 'US' for the United States).

required

id

string

Primary id for the specified structure.

required

 

 

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

Return all structures located on the parcel by ‘country code’ and id.

 

Example requests

 

curl -X GET -H ‘x-api-key: (api_key)’ https://api.lightboxre.com/v1/structures/_on/parcel/us/542170041_141579

 

https://api.lightboxre.com/v1/structures/_on/parcel/us/542170041_141579

 

Query parameters

 

Parameter

Type

Description

Usage

countryCode

string

ISO 3166 alpha-2 country code (e.g., 'US' for the United States).

required

id

string

Primary id for the specified structure.

required

 

 

GET /structures/us/tile/{zoom}/{x}/{y}

Generate a 256 x 256 tile using x, y and z values.

 

Example requests

 

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

 

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

 

Query parameters

 

Parameter

Type

Description

Usage

zoom

integer

Tile zoom level, which can be a minimum of '13' and a maximum of '21.'

required

x

integer

Tile column.

required

y

integer

Tile row.

required

 

 

GET /structures/us/tile

Generate a 256 x 256 tile using x,y, and z values.

 

Example requests

 

curl -X GET -H ‘x-api-key: (api_key)’ https://api.lightboxre.com/v1/structures/us/tile?bbox=-122.39921484469761%2C45.572657942246956%2C-122.3705044794022%2C45.582382848556996&width=2676&height=1295

 

https://api.lightboxre.com/v1/structures/us/tile?bbox=-122.39921484469761%2C45.572657942246956%2C-122.3705044794022%2C45.582382848556996&width=2676&height=1295

 

Query parameters

 

Parameter

Type

Description

Usage

bbox

string

A bounding box expressed in the NAD83 projected coordinate system.

required

width

integer

Width of the image.

required

height

integer

Height of the image.

required

 

Transactions API

The official record of property tax information from previous years. This is provided by the county tax assessor.

 

GET /transactions/us/{id}

Query for sales transaction records using the primary id.

 

Example requests

 

curl -X GET -H ‘x-api-key: (api_key)’ https://api.lightboxre.com/v1/transactions/us/ 100660192_236887580

 

https://api.lightboxre.com/v1/transactions/us/ 100660192_236887580

 

Query parameters

 

Parameter

Type

Description

Usage

assessmentId

string

The assessment id for the target assessment record.

required

 

 

GET /transactions/us/assessment/{assessmentId}

Query for sales transaction records using an assessment id.

 

Example requests

 

curl -X GET -H ‘x-api-key: (api_key)’ https://api.lightboxre.com/v1/transactions/us/ 100660192_236887580

 

https://api.lightboxre.com/v1/transactions/us/ 100660192_236887580

 

Query parameters

 

Parameter

Type

Description

Usage

assessmentId

string

The assessment id for the target assessment record.

required

 

API Error Handling

LightBox unifies error responses into a common format prior to propagating them into your application.

 

How LightBox handles errors

If LightBox encounters a server error by the upstream service, such as a response with status code over 499, LightBox will automatically retry the API request. However, if LightBox encounters any other type of error that the service indicates is the client’s fault, such as a response with status code between 400 and 499, then LightBox will return the error into the format described below. 

 

Error message format

The status code of an error, along with its JSON content, helps identify the type of error that occurred. A description of attributes present in an error from LightBox is provided below. 

 

Attributes always present:

  • code  (string)
  • message  (string)

 

Error codes

 

Code

Message

400

One or more input parameters are invalid.

404

Object not found matching provided parameters

500

An error was encountered

 

Receiving Support

Please check our  FAQ page for the answers to frequently asked questions. Cannot find the answer you need?  Contact us and we will get back to you as soon as possible.