Assessments Documentation

Purpose

The Assessments API provides access to the LightBox Assessment data, ownership information, sale transactions, taxes paid on a property, and attributes about the taxable land.  

Swagger: OAS Specification 3.1

Features

• Access assessment records by geometry, along with a buffer.
• Use the LightBox Assessment ID or LightBox Parcel ID to return assessment records.
• Add to your map using modern controls such as MapBox, Google, and Esri, using the Tile and BBox endpoints.
• Get Access to the Owner Portfolio by returning all assessment records with a common ownership. 

API Requests

Get By Geometry

Return assessment records by passing in a WKT geometry object.

GET /assessments/us/geometry

Example requests

curl -X GET -H ‘x-api-key: (api_key)’ https://api.lightboxre.com/v1/assessments/us/geometry?wtk=POINT(-122.40317865990883 45.585729937697515)&bufferUnit=ft&bufferDistance=10

https://api.lightboxre.com/v1/assessments/us/geometry?wtk=POINT(-122.40317865990883 45.585729937697515)&bufferUnit=ft&bufferDistance=10 

Parameters

Response

Media type: application/json

Get By Address

Return assessment records by an address string. This is an alternative to using the geocoder first. If the address is not related to an assessment records then a 404 (not found) will be returned. Using the geocoder first will allow business logic to be included if the address is not related to an assessment record. 

GET /assessments/address

Example requests

curl -X GET -H ‘x-api-key: (api_key)’ https://api.lightboxre.com/v1/assessemets/address?text=25481 Buckwood, Lake Forest, Ca, 92630

https://api.lightboxre.com/v1/assessments/address?text=25481 Buckwood, Lake Forest, Ca, 92630

Parameters

Response

Media type: application/json

Get By APN and FIPS

Query assessment records by APN and FIPS code. 

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

Example requests

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

https://api.lightboxre.com/v1/assessments/us/fips/06059/apn/111-111-111

Parameters

Response

Media type: application/json

Get Assessment records that are on/related to a parcel by geometry

Return assessment records that are related to a parcel using a geometry as input. The geometry is used to intersect a parcel then return related assessment records. In most cases, this is a one-to-one relationship, but in some cases, such as a condo complex or a mobile home complex where there are multiple owners, then multiple assessment records are returned.

GET /assessments/_on/parcel/us/geometry?wkt=POINT(-117.852723 33.63799)

Example requests

curl -X GET -H ‘x-api-key: (api_key)’ https://api.lightboxre.com/v1/assessments/_on/parcel/us/geometry?wkt=POINT(-117.852723 33.63799)

https://api.lightboxre.com/v1/assessments/_on/parcel/us/geometry?wkt=POINT(-117.852723 33.63799)

Parameters

Response

Media type: application/json

Get by LightBox Assessment ID

Return assessment records by the LightBox Assessment ID. 

GET /assessments/us/{id}

Example requests

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

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

Parameters

Response

Media type: application/json

Get Assessment records by LightBox Parcel ID

Return assessment records that are related to a parcel using a LightBox Parcel ID as input. Assessment records that are related to the identified parcel are returned. In most cases this is a one-to-one relationship, but in some cases, such as a condo complex or a mobile home complex where there are multiple owners, then multiple assessment records are returned. Note: Only the US is supported at this time.

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

Example requests

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

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

Parameters

Response

Media type: application/json

Get Assessment records by LightBox Address ID

Return assessment records that are related to an address using a LightBox Address ID as input. 

GET /assessments/_on/address/{countryCode}/{id}

Example requests

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

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

Parameters

Response

Media type: application/json

Get Assessment records by LightBox Structure ID

Return assessment records that are related to a structure using a LightBox Structure ID as input. 

GET /assessments/_on/structure/{countryCode}/{id}

Example requests

curl -X GET -H ‘x-api-key: (api_key)’ https://api.lightboxre.com/v1/assessments/_on/structure/us/050151K0AO2OYB14ZNWS7Q

https://api.lightboxre.com/v1/assessments/_on/structure/us/050151K0AO2OYB14ZNWS7Q

Parameters

Response

Media type: application/json

Get Assessment records by LightBox Site ID

Return assessment records that are related to a site using a LightBox Site ID as input. 

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

Example requests

curl -X GET -H ‘x-api-key: (api_key)’ https://api.lightboxre.com/v1/assessments/_on/site/us/0901R7OPQ4SLNLLG038WKA

https://api.lightboxre.com/v1/assessments/_on/site/us/0901R7OPQ4SLNLLG038WKA

Parameters

Response

Media type: application/json

Get Assessment records by LightBox Person ID

Return assessment records that are related to a person using a LightBox Person ID as input.

GET /assessments/_on/person/us/{id}

Example requests

curl -X GET -H ‘x-api-key: (api_key)’ https://api.lightboxre.com/v1/assessments/_on/person/us/12015F0KAZDG0POWRVM4GH

https://api.lightboxre.com/v1/assessments/_on/person/us/12015F0KAZDG0POWRVM4GH

Parameters

Response

Media type: application/json

Owner Portfolio

Return all assessment records owned by the owner of the property identified by the LightBox assessment ID.

GET /assessments/ownerportfolio/us/{id}

Example requests

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

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

Parameters

Response

Media type: application/json

Assessment Tile Endpoint

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

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

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

Parameters

Response

Media type: image/png

Assessment Tile Bounding Box Endpoint

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

GET /parcels/{countryCode}/tile

Example Requests

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

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

Parameters

Response

Media type: image/png

Assessment WMS Endpoint

Use within mapping systems that support OGC WMS Standard

GET /wms/assessment/us?apikey={your api key}

Example Requests

curl -X GET -H ‘x-api-key: (api_key)’ https://api.lightboxre.com/v1/wms/assessments/us?apikey={your api key}

https://api.lightboxre.com/v1/wms/assessments/us?apikey={your api key}

Parameters

Response

Media type: XML/json/image 

API Response

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

{
  "$ref": "string",
  "$metadata": {
    "currency": {
      "code": "USD"
    },
    "geogcs": {
      "epsg": 4326
    },
    "units": {
      "area": "sqm",
      "length": "m"
    },
    "recordSet": {
      "totalRecords": 99,
      "limit": 100,
      "offset": 0,
      "bbox": {
        "xMax": -105.250409,
        "xMin": -105.251916,
        "yMax": 40.023629,
        "yMin": 40.022576
      }
    }
  },
  "assessments": [
    {
      "$ref": "string",
      "apn": "string",
      "fips": "string",
      "id": "string",
      "parcel": {
        "$ref": "string",
        "id": "string"
      },
      "transactions": {
        "$ref": "string",
        "id": "string"
      },
      "$metadata": {
        "geocode": {
          "confidence": {
            "streetNumber": 1,
            "streetName": 1,
            "locality": 1,
            "postalCode": 1,
            "score": 1
          },
          "precisionCode": "10"
        }
      },
      "alternateApn": "string",
      "assessedValue": {
        "total": 0,
        "land": 0,
        "improvements": 0,
        "year": "string"
      },
      "marketValue": {
        "total": 0,
        "land": 0,
        "improvements": 0,
        "year": "string"
      },
      "improvementPercent": 0,
      "assessedLotSize": 0,
      "lot": {
        "lotNumber": "string",
        "blockNumber": "string",
        "depth": 0,
        "width": 0,
        "lotSize": 0
      },
      "poolIndicator": "A",
      "zoning": {
        "assessment": "string"
      },
      "book": "string",
      "page": "string",
      "landUse": {
        "code": "string",
        "description": "string",
        "normalized": {
          "code": "string",
          "description": "string",
          "categoryDescription": "string"
        }
      },
      "lastLoan": {
        "recordingDate": "string",
        "dueDate": "string",
        "lender": "string",
        "value": 0,
        "transactionId": "string",
        "interestRates": [
          {
            "code": "ADJ",
            "descripton": "ADJUSTABLE",
            "rate": 0
          }
        ]
      },
      "transaction": {
        "lastMarketSale": {
          "pricePerArea": 0,
          "value": 0,
          "seller": "string",
          "buyer": "string",
          "filingDate": "string",
          "transferDate": "string",
          "documentNumber": "string",
          "documentTypeCode": "AA",
          "documentTypeDescription": "Assignment of Sub Agreement of Sale (Hawaii)",
          "lender": "string",
          "loan": {
            "code": "string",
            "description": "string",
            "first": 0,
            "second": 0
          },
          "saleCode": "string",
          "saleCodeDescription": "string",
          "titleCompany": "string",
          "tdDocumentNumber": "string",
          "deedTransactionType": "string",
          "lenderType": "B"
        },
        "lastNoValueTransfer": {
          "documentNumber": "string",
          "documentType": "AA",
          "page": "string",
          "book": "string",
          "transferDate": "string"
        },
        "priorMarketSale": {
          "transferDate": "string",
          "lender": "string"
        },
        "priorSale": {
          "documentNumber": "string",
          "documentNumberRaw": "string",
          "seller": "string",
          "titleCompany": "string",
          "transactionType": "1",
          "value": 0
        },
        "multipleApnFlag": "string"
      },
      "legalDescription": [
        "string"
      ],
      "location": {
        "representativePoint": {
          "longitude": 0,
          "latitude": 0,
          "geometry": {
            "wkt": "string"
          }
        },
        "geometry": {
          "wkt": "string"
        }
      },
      "occupant": {
        "owner": true,
        "company": true
      },
      "owner": {
        "streetAddress": "string",
        "locality": "string",
        "regionCode": "AL",
        "postalCode": "string",
        "postalCodeExt": "string",
        "countryCode": "US",
        "ownerNameStd": "string",
        "ownershipStatus": {
          "code": "AB",
          "description": "Alternate Beneficiary"
        },
        "names": [
          {
            "fullName": "string",
            "firstName": "string",
            "middleName": "string",
            "lastName": "string"
          }
        ]
      },
      "primaryStructure": {
        "stories": {
          "count": "string"
        },
        "yearBuilt": "string",
        "yearRenovated": "string",
        "foundation": {
          "code": "A",
          "description": "Concrete"
        },
        "elevator": "B",
        "basement": {
          "code": "B",
          "description": "Basement (not specified)"
        },
        "buildingArea": 0,
        "exteriorWall": {
          "code": "1",
          "description": "EIFS / Synthetic Stucco"
        },
        "fireplace": "string",
        "heating": {
          "code": "A",
          "description": "Baseboard"
        },
        "construction": {
          "code": "A",
          "description": "Adobe"
        },
        "roof": {
          "code": "A",
          "description": "Asbestos"
        },
        "style": {
          "code": "2",
          "description": "Traditional/Old"
        },
        "airConditioning": {
          "code": "C",
          "description": "Evaporative Cooler"
        },
        "rooms": 0,
        "bedrooms": 0,
        "baths": 0,
        "units": 0,
        "livingArea": 0,
        "parkingSpaces": 0,
        "buildingLotRatio": "string",
        "garage": {
          "code": "A",
          "description": "Attached Garage"
        },
        "numberOfBuildings": 0
      },
      "tax": {
        "year": "string",
        "yearDelinquent": "string",
        "amount": 0,
        "rateAreaCode": "string",
        "exemption": "Agricultural"
      },
      "valuationModel": {
        "value": 0,
        "valueHigh": 0,
        "valueLow": 0,
        "date": "string",
        "propensityScore": "string",
        "score": 0,
        "label": "string"
      }
    }
  ]
}

Field Dictionary

HTTP Error Codes

• Assessments Overview
• Assessments Release Notes