Historical Assessed Value Documentation

Print
Dark
Light
PDF

Article summary

Did you find this summary helpful?

Thank you for your feedback

Purpose

Understanding the assessed value of a property over the years can provide valuable insight on future trends. Rather than doing due diligence on a commercial property or displaying a residential property in a listing service, the LightBox Historical Assessed Value API will provide the necessary data.

Swagger: OAS 3.1 Specification

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

Get Historical Tax Records by Id

Return historical assessed value records based on the unique LightBox Assessment.

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

Example requests

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

https://api.lightboxre.com/v1/assessments/us/0306F25KSXL0JZ4RTLPP99/assessedvalue

Parameters

Parameter	Type	Description	Usage
id	path	Unique LightBox Assessment ID	required

Response

Media type: application/json

API Response

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

{
  "$ref": "string",
  "$metadata": {
    "currency": {
      "code": "USD"
    },
    "recordSet": {
      "totalRecords": 1
    }
  },
  "assessments": [
    {
      "$ref": "string",
      "apn": "933-100-03",
      "fips": "06059",
      "id": "string",
      "history": {
        "assessedValues": [
          {
            "total": 5000,
            "land": 3000,
            "improvements": 2000,
            "year": "1999"
          }
        ]
      }
    }
  ]
}

Field Dictionary

Field	Type	Description
fips	string	Federal Information Processing Code for the state, as well as the Federal Information Processing Code for the county. The first two digits are the state code; the last three digits are the county code.
id	string	Federal Information Processing Code for the state, as well as the Federal Information Processing Code for the county. The first two digits are the state code; the last three digits are county code.
history.assessedValues[].total	integer	Total value.
history.assessedValues[].land	integer	Total land value.
history.assessedValues[].improvements	integer	Total improvements value.
history.assessedValues[].year	string	Year in which value is determined.

HTTP Error Codes

HTTP Response status codes along with a brief summary of their commonly accepted usage. These status codes are returned by LightBox APIs for each request:

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.

Was this article helpful?

What's Next

Historical Assessed Value Release Notes

Table of contents

Purpose
API Requests
API Response
Field Dictionary
HTTP Error Codes