LightBox APN Lookup Documentation

Purpose

The purpose for this service is to locate properties based on an APN (Assessor Parcel Number)

Endpoints to support

• Search by APN alone
• Search by APN and County fips
• Autocomplete / Type ahead / Suggest
• Health check

API Requests

Lookup APN (Assessor Parcel Number)

Use this endpoint when a fips code is unavailable. This will return all APNs that match the APN.

GET /apns/us/{apn}

Example requests

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

https://api.lightboxre.com/v1/apns/us/120-591-02

Parameters

Response

Media type: application/json

Lookup APN (Assessor Parcel Number) within a county 

Use this endpoint when a fips code is available. This will return all APNs that match the APN within the county identified by the county fips code. 

GET /apns/us/{fips}/{apn}

Example requests

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

https://api.lightboxre.com/v1/apns/us/06059/120-591-02

Parameters

Response

Media type: application/json

APN Autocomplete (Type ahead / autocomplete / suggest)

Use this endpoint when implementing a type ahead service for your end users. 

GET /apns/us/_autocomplete?text=

Example requests

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

https://api.lightboxre.com/v1/apns/us/_autocomplete?text=120-591-02

Parameters

Response

Media type: application/json

API Response

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

{
  "$ref": "string",
  "$metadata": {
    "recordSet": {
      "totalRecords": 99
    }
  },
  "apnRefs": [
    {
      "fips": "06059",
      "apn": "120-591-02",
      "apnTrimmed": "12059102",
      "apnSource": "APN",
      "location": {
        "streetAddress": "23143 CHERRY AVE",
        "locality": "LAKE FOREST",
        "regionCode": "CA",
        "County": "Orange",
        "postalCode": "92630",
        "postalCodeExt": "4537",
        "countryCode": "US",
        "representativePoint": {
            "longitude": "-81.837226",
            "latitude": "31.561204",
            "geometry": {
                 "wkt": "POINT (-81.837226 31.561204)"
              }
          },
          "geometry": {
             "wkt": "POLYGON ((-81.8365421725088 31.5596747515072, -81.8355565061132 31.5610626320997, -81.8364392839369 31.5616482123836, -81.8357284404849 31.5626443382122, -81.836177340647 31.563062093173, -81.8362075467813 31.5630433905261, -81.8364970920146 31.5633371666179, -81.8372640580123 31.5619214017416, -81.8387065277034 31.5619493777545, -81.8388961980706 31.5611991216801, -81.8391036517067 31.5604310780129, -81.8365421725088 31.5596747515072))"
        }
      },
      "parcels": [
        {
          "$ref": "string",
          "id": "string"
        }
      ],
      "assessments": [
        {
          "$ref": "string",
          "id": "string"
        }
      ]
    }
  ]
}

HTTP Error Codes