LightBox Data API

https://lightbox.document360.io/data-and-api/docs/
Admin
LightBox Data API provides comprehensive property intelligence data including addresses, parcels,...
Tokens:156,954
Snippets:981
Trust Score:9.3
Update:7 months ago
Show doc for...
Tokens:
Raw
### LightBox API - Getting Started

Source: https://lightbox.document360.io/data-and-api/docs/core-package

Information on how to get started with the LightBox API, including registration, making your first request, and using the Swagger documentation.

```APIDOC
## LightBox API - Getting Started

### Description
This section covers the initial steps required to use the LightBox API, including account registration, making your first API call, and navigating the developer portal's Swagger documentation.

### Topics Covered
*   1. Introduction
*   2. Registering for a LightBox Account
*   3. Making Your First Request
*   4. Using the LightBox Developer Portal Swagger Documentation
*   API Conventions
```

--------------------------------

### API Request Example: Query by Address

Source: https://lightbox.document360.io/data-and-api/docs/zoning-documentation

Example of an API request to query zoning information by address. This GET request takes address-related parameters.

```http
GET /zoning/address
```

--------------------------------

### API Request Example: Query by Site ID

Source: https://lightbox.document360.io/data-and-api/docs/zoning-documentation

Example of an API request to query zoning information using a LightBox Site ID. This GET request requires country code and site ID as parameters.

```http
GET /zoning/_on/site/{countryCode}/{id}
```

--------------------------------

### API Request Example: Query by Property ID

Source: https://lightbox.document360.io/data-and-api/docs/zoning-documentation

Example of an API request to query zoning information using a LightBox Property ID. This GET request requires country code and property ID as parameters.

```http
GET /zoning/_on/property/{countryCode}/{id}
```

--------------------------------

### API Request Example: Tile Request

Source: https://lightbox.document360.io/data-and-api/docs/zoning-documentation

Example of an API request to retrieve zoning tiles based on zoom level and tile coordinates (x, y). This GET request is used for map-based visualizations.

```http
GET /zoning/us/tile/{zoom}/{x}/{y}
```

--------------------------------

### API Request Example: Bounding Box Request

Source: https://lightbox.document360.io/data-and-api/docs/zoning-documentation

Example of an API request to retrieve zoning information within a specified bounding box. This GET request includes coordinates, width, and height parameters for defining the area of interest.

```http
GET /zoning/us/tile?bbox=-83.0434660625,40.0198659375,-83.04070793749999,40.0226240625&width=600&height=600
```

--------------------------------

### API Request Example: Query by Parcel ID

Source: https://lightbox.document360.io/data-and-api/docs/zoning-documentation

Example of an API request to query zoning information using a LightBox Parcel ID. This GET request requires country code and parcel ID as parameters.

```http
GET /zoning/_on/parcel/{countryCode}/{id}
```

--------------------------------

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

Source: https://lightbox.document360.io/data-and-api/docs/addresses-documentation

Retrieves addresses associated with a specific LightBox Site ID.

```APIDOC
## GET /addresses/_on/site/us/{id}

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

### Method
GET

### Endpoint
/addresses/_on/site/us/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - Site LightBox ID.

### Request Example
```bash
curl -X GET -H ‘x-api-key: (api_key)’ https://api.lightboxre.com/v1/addresses/_on/site/us/0904YD6                         NQEZ3DPCJJG3E6U
```

### Response
#### Success Response (200)
Media type: application/json
- **[address fields]** (object) - Description of address fields.
```

--------------------------------

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

Source: https://lightbox.document360.io/data-and-api/docs/addresses-documentation

Retrieves address information based on the LightBox LocationInfo ID.

```APIDOC
## GET /addresses/_on/locationinfo/us/{id}

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

### Method
GET

### Endpoint
/addresses/_on/locationinfo/us/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The LightBox LocationInfo ID.

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

### Response
#### Success Response (200)
Media type: application/json
- **[address fields]** (object) - Description of address fields.
```

--------------------------------

### LightBox Assessments API Authentication Example (curl)

Source: https://lightbox.document360.io/data-and-api/docs/assessment-documentation

Demonstrates how to authenticate with the LightBox Assessments API using a curl command. It shows the correct HTTP method, header for authentication, and the base URL for API requests. Ensure you replace '(api_key)' with your actual authentication token.

```bash
curl -X GET -H 'x-api-key: (api_key)' https://api.lightboxre.com/v1
```

--------------------------------

### GET Parcel Tile Data using HTTP Request

Source: https://lightbox.document360.io/data-and-api/docs/assessments-documentation

This snippet shows how to retrieve a parcel tile image via a direct HTTP GET request. Similar to the cURL example, it requires country code, bounding box, and image dimensions, with optional parameters for further customization.

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

--------------------------------

### API Response Structure Example (JSON)

Source: https://lightbox.document360.io/data-and-api/docs/addresses-documentation

This JSON object represents a typical API response for endpoints in Lightbox Document360. It includes metadata about the request and a list of addresses, each with detailed information.

```json
{
  "$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"
        }
      ]
    }
  ]
}
```

--------------------------------

### GET /assessments/address

Source: https://lightbox.document360.io/data-and-api/docs/assessment-documentation

Retrieves assessment data for a given address.

```APIDOC
## GET /assessments/address

### Description
Retrieves assessment data for a given address.

### Method
GET

### Endpoint
`/assessments/address`

### Parameters
#### Query Parameters
*   **address** (string) - Required - The street address.
*   **city** (string) - Required - The city.
*   **state** (string) - Required - The state (e.g., 'US').
*   **zipcode** (string) - Required - The zip code.

### Request Example
```
GET /assessments/address?address=123%20Main%20St&city=Anytown&state=US&zipcode=12345
```

### Response
#### Success Response (200)
*   **assessments** (array) - An array of assessment objects matching the address.
    *   (See Response Example for structure of assessment objects)

#### Response Example
```json
{
  "assessments": [
    {
      "assessment_id": "a1b2c3d4e5f6",
      "parcel_id": "p1a2b3c4d5e6",
      "address_id": "ad1b2c3d4e5f",
      "property_id": "pr1a2b3c4d5e",
      "structure_id": "st1b2c3d4e5f",
      "site_id": "si1a2b3c4d5e",
      "person_id": "pe1b2c3d4e5f",
      "owner_name": "John Doe",
      "property_type": "Residential",
      "year_built": 2000,
      "sqft": 2500,
      "estimated_value": 500000.00,
      "latitude": 33.63799,
      "longitude": -117.852723
    }
  ]
}
```
```

--------------------------------

### LightBox API - Core Principles

Source: https://lightbox.document360.io/data-and-api/docs/core-package

Explains the core principles guiding the LightBox API, such as semantic versioning and common response structures.

```APIDOC
## LightBox API - Core Principles

### Description
This section details the fundamental principles that govern the LightBox API's design and behavior, ensuring consistency and predictability for developers.

### Topics Covered
*   Semantic Versioning
*   API Response Commonalities
```

--------------------------------

### GET /assessments/us/geometry

Source: https://lightbox.document360.io/data-and-api/docs/assessment-documentation

Retrieves assessment data based on a specified geometry.

```APIDOC
## GET /assessments/us/geometry

### Description
Retrieves assessment data based on a specified geometry.

### Method
GET

### Endpoint
`/assessments/us/geometry`

### Parameters
#### Query Parameters
*   **wkt** (string) - Required - Well-Known Text representation of the geometry.

### Request Example
```
GET /assessments/us/geometry?wkt=POINT(-117.852723 33.63799)
```

### Response
#### Success Response (200)
*   **assessments** (array) - An array of assessment objects.
    *   **assessment_id** (string) - The unique identifier for the assessment.
    *   **parcel_id** (string) - The identifier for the associated parcel.
    *   **address_id** (string) - The identifier for the associated address.
    *   **property_id** (string) - The identifier for the associated property.
    *   **structure_id** (string) - The identifier for the associated structure.
    *   **site_id** (string) - The identifier for the associated site.
    *   **person_id** (string) - The identifier for the associated person.
    *   **owner_name** (string) - The name of the owner.
    *   **property_type** (string) - The type of property.
    *   **year_built** (integer) - The year the property was built.
    *   **sqft** (integer) - The square footage of the property.
    *   **estimated_value** (number) - The estimated value of the property.
    *   **latitude** (number) - The latitude coordinate of the property.
    *   **longitude** (number) - The longitude coordinate of the property.

#### Response Example
```json
{
  "assessments": [
    {
      "assessment_id": "a1b2c3d4e5f6",
      "parcel_id": "p1a2b3c4d5e6",
      "address_id": "ad1b2c3d4e5f",
      "property_id": "pr1a2b3c4d5e",
      "structure_id": "st1b2c3d4e5f",
      "site_id": "si1a2b3c4d5e",
      "person_id": "pe1b2c3d4e5f",
      "owner_name": "John Doe",
      "property_type": "Residential",
      "year_built": 2000,
      "sqft": 2500,
      "estimated_value": 500000.00,
      "latitude": 33.63799,
      "longitude": -117.852723
    }
  ]
}
```
```

--------------------------------

### Authenticate LightBox API Request (cURL)

Source: https://lightbox.document360.io/data-and-api/docs/zoning-documentation

Demonstrates how to authenticate an API request to the LightBox API using a cURL command. It shows the necessary HTTP header 'x-api-key' with the user's authentication token. This is a fundamental step for all API interactions.

```shell
curl -X GET -H 'x-api-key: <Your authentication token>' https://api.lightboxre.com/v1
```

--------------------------------

### GET /assessments/owner-portfolio

Source: https://lightbox.document360.io/data-and-api/docs/assessment-documentation

Retrieves all assessment records associated with a common ownership.

```APIDOC
## GET /assessments/owner-portfolio

### Description
Retrieves all assessment records that share a common owner, effectively returning an owner's portfolio of properties.

### Method
GET

### Endpoint
https://api.lightboxre.com/v1/assessments/owner-portfolio

### Query Parameters
- **ownerName** (string) - Required - The name of the owner to retrieve the portfolio for.

### Request Example
```bash
curl -X GET \
  'https://api.lightboxre.com/v1/assessments/owner-portfolio?ownerName=John%20Doe' \
  -H 'x-api-key: YOUR_API_KEY'
```

### Response
#### Success Response (200)
- **assessments** (array) - An array of assessment record objects belonging to the specified owner.
  - **assessmentId** (string) - The unique identifier for the assessment.
  - **parcelId** (string) - The unique identifier for the parcel.
  - **ownerName** (string) - The name of the property owner.
  - **address** (object) - The property address details.
    - **streetNumber** (string)
    - **streetName** (string)
    - **city** (string)
    - **state** (string)
    - **zipCode** (string)

#### Response Example
```json
{
  "assessments": [
    {
      "assessmentId": "assess_123",
      "parcelId": "parcel_abc",
      "ownerName": "John Doe",
      "address": {
        "streetNumber": "123",
        "streetName": "Main St",
        "city": "Anytown",
        "state": "CA",
        "zipCode": "90210"
      }
    },
    {
      "assessmentId": "assess_456",
      "parcelId": "parcel_def",
      "ownerName": "John Doe",
      "address": {
        "streetNumber": "456",
        "streetName": "Oak Ave",
        "city": "Otherville",
        "state": "CA",
        "zipCode": "90211"
      }
    }
  ]
}
```
```

--------------------------------

### LightBox API - Geocoding

Source: https://lightbox.document360.io/data-and-api/docs/core-package

Documentation for the Geocoding API, including batch geocoding, overview, and data extension details.

```APIDOC
## LightBox API - Geocoding

### Description
This section provides comprehensive documentation for the Geocoding API, enabling developers to convert addresses into geographic coordinates and vice versa. It covers batch processing capabilities and data extension details.

### Endpoints
*   **Batching Geocoding**: Functionality for processing multiple geocoding requests simultaneously.
*   **Geocoding Overview**: General information about the geocoding service.
    *   Geocoding Documentation
    *   Geocoding Release Notes
*   **Geocoding Data Extension Overview**: Details on extended geocoding data attributes.
    *   Geocoding Data Extension Documentation
    *   Geocoding Data Extension Release Notes
```

--------------------------------

### GET /assessments/bbox

Source: https://lightbox.document360.io/data-and-api/docs/assessment-documentation

Retrieves assessment data within a specified bounding box.

```APIDOC
## GET /assessments/bbox

### Description
Retrieves assessment data for properties located within a given bounding box.

### Method
GET

### Endpoint
https://api.lightboxre.com/v1/assessments/bbox

### Query Parameters
- **minLon** (number) - Required - The minimum longitude of the bounding box.
- **minLat** (number) - Required - The minimum latitude of the bounding box.
- **maxLon** (number) - Required - The maximum longitude of the bounding box.
- **maxLat** (number) - Required - The maximum latitude of the bounding box.

### Request Example
```bash
curl -X GET \
  'https://api.lightboxre.com/v1/assessments/bbox?minLon=-74.01&minLat=40.70&maxLon=-73.99&maxLat=40.72' \
  -H 'x-api-key: YOUR_API_KEY'
```

### Response
#### Success Response (200)
- **features** (array) - An array of GeoJSON features representing assessment data within the bounding box.
  - **type** (string) - The GeoJSON type, typically 'Feature'.
  - **geometry** (object) - The GeoJSON geometry of the feature (e.g., Polygon, Point).
  - **properties** (object) - Properties associated with the feature, including assessment details.
    - **assessmentId** (string)
    - **parcelId** (string)
    - **ownerName** (string)
    - **address** (object)

#### Response Example
```json
{
  "features": [
    {
      "type": "Feature",
      "geometry": {
        "type": "Polygon",
        "coordinates": [
          [
            [-74.0060, 40.7128],
            [-74.0050, 40.7128],
            [-74.0050, 40.7118],
            [-74.0060, 40.7118],
            [-74.0060, 40.7128]
          ]
        ]
      },
      "properties": {
        "assessmentId": "assess_101",
        "parcelId": "parcel_jkl",
        "ownerName": "Alice Wonderland",
        "address": {
          "streetNumber": "101",
          "streetName": "Pine St",
          "city": "Metropolis",
          "state": "NY",
          "zipCode": "10002"
        }
      }
    }
  ]
}
```
```

--------------------------------

### GET /assessments/tile

Source: https://lightbox.document360.io/data-and-api/docs/assessment-documentation

Retrieves assessment data within a specified map tile.

```APIDOC
## GET /assessments/tile

### Description
Retrieves assessment data for a specific map tile, useful for rendering maps with property data.

### Method
GET

### Endpoint
https://api.lightboxre.com/v1/assessments/tile

### Query Parameters
- **x** (integer) - Required - The x-coordinate of the map tile.
- **y** (integer) - Required - The y-coordinate of the map tile.
- **z** (integer) - Required - The zoom level of the map tile.

### Request Example
```bash
curl -X GET \
  'https://api.lightboxre.com/v1/assessments/tile?x=10&y=20&z=12' \
  -H 'x-api-key: YOUR_API_KEY'
```

### Response
#### Success Response (200)
- **features** (array) - An array of GeoJSON features representing assessment data within the tile.
  - **type** (string) - The GeoJSON type, typically 'Feature'.
  - **geometry** (object) - The GeoJSON geometry of the feature (e.g., Polygon, Point).
  - **properties** (object) - Properties associated with the feature, including assessment details.
    - **assessmentId** (string)
    - **parcelId** (string)
    - **ownerName** (string)
    - **address** (object)

#### Response Example
```json
{
  "features": [
    {
      "type": "Feature",
      "geometry": {
        "type": "Polygon",
        "coordinates": [
          [
            [-74.0060, 40.7128],
            [-74.0050, 40.7128],
            [-74.0050, 40.7118],
            [-74.0060, 40.7118],
            [-74.0060, 40.7128]
          ]
        ]
      },
      "properties": {
        "assessmentId": "assess_789",
        "parcelId": "parcel_ghi",
        "ownerName": "Jane Smith",
        "address": {
          "streetNumber": "789",
          "streetName": "Elm St",
          "city": "Metropolis",
          "state": "NY",
          "zipCode": "10001"
        }
      }
    }
  ]
}
```
```

--------------------------------

### HTTP Error Codes

Source: https://lightbox.document360.io/data-and-api/docs/zoning-documentation

A reference guide to HTTP status codes returned by LightBox APIs, explaining their meaning and common usage.

```APIDOC
## HTTP Error Codes

### Description
This section details the HTTP response status codes returned by LightBox APIs.

### Status Codes
- **200 OK**: The request succeeded.
- **201 Created**: The object was created successfully.
- **202 Accepted**: Accepted, no content.
- **204 No Content**: Successful, no content. Typically returned on a DELETE request.
- **400 Bad Request**: One or more of the request parameters were invalid.
- **401 Unauthorized**: The client must authenticate itself to get the requested response. This could also be due to your trial key expiring.
- **404 Not Found**: 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**: Too many requests were made in a short period of time, or you have exceeded your request-lot pool.
- **500 Internal Server Error**: The server has encountered an error it does not know how to handle.
- **503 Service Unavailable**: The service is temporarily unavailable.
```

--------------------------------

### API Response Structure Example (JSON)

Source: https://lightbox.document360.io/data-and-api/docs/parcels-documentation

This JSON structure represents a typical API response from Lightbox Document360, detailing parcel information, metadata, owner details, and transaction history. It is used across various endpoints for data consistency.

```json
{
  "$ref": "string",
  "$metadata": {
    "currency": {
      "code": "AED"
    },
    "geogcs": {
      "epsg": "4326"
    },
    "units": {
      "length": "ft",
      "area": "sqft"
    },
    "recordSet": {
      "totalRecords": 99,
      "bbox": {
        "xMax": -105.250409,
        "xMin": -105.251916,
        "yMax": 40.023629,
        "yMin": 40.022576
      }
    }
  },
  "parcels": [
    {
      "$ref": "string",
      "id": "string",
      "parcelApn": "string",
      "fips": "string",
      "structures": [
        {
          "$ref": "string",
          "id": "string"
        }
      ],
      "$metadata": {
        "geocode": {
          "confidence": {
            "streetNumber": 1,
            "streetName": 1,
            "locality": 1,
            "postalCode": 1,
            "score": 1
          },
          "precisionCode": "10"
        }
      },
      "cbsa": {
        "code": "string"
      },
      "census": {
        "tract": "string",
        "blockGroup": "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": "string"
        },
        "priorMarketSale": {
          "transferDate": "string",
          "lender": "string"
        },
        "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"
          }
        ]
      },
      "related": {
        "commonOwnership": {
          "aggregateLotSize": 0,
          "id": "string",
          "count": 0,
          "subdivision": "string",
          "lotWidthMedian": 0,
          "lotWidthSummary": "string"
        },
        "associatePropertyCount": 0
      },
      "derived": {
        "calculatedLotArea": 0
      },
      "topography": "A",
      "tax": {
        "year": 0,
        "yearDelinquent": 0,
        "amount": 0,
        "taxRateAreaCode": "string",
        "id": "string",
        "taxAccountNumber": "string",
        "exemption": "Agricultural"
      },
      "opportunityZone": "string",
      "county": "string",
      "usplss": {
        "township": "string",
        "range": "string",
        "section": "string",
        "quarter": "string"
      },
      "neighborhood": "string",
      "subdivision": "string",
      "structures" : [
         {
             "$ref": "https://lightbox-preprod-dev.apigee.net/v1/structures/0503NRC6LE569C06ZL62IB",
            "id": "0503NRC6LE569C06ZL62IB",
            "isPrimary": true
         }
       ],
      "assessment": {
        "alternateApn": "string",
        "apn": "string",
        "assessedValue": {
          "total": 0,
          "land": 0,
          "improvements": 0,
          "year": "string"
        },
        "marketValue": {
          "total": 0,
          "land": 0,
          "improvements": 0,
          "year": "string"
        }
      }
    }
  ]
}
```

--------------------------------

### GET Assessment WMS Data using HTTP Request

Source: https://lightbox.document360.io/data-and-api/docs/assessments-documentation

This snippet shows a direct HTTP GET request to the Assessment WMS endpoint. It requires your API key for authentication and the country code to retrieve assessment data in various formats like XML, JSON, or image.

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

--------------------------------

### GET /assessments/ownerportfolio/us/{id}

Source: https://lightbox.document360.io/data-and-api/docs/assessment-documentation

Retrieves the owner portfolio for a given LightBox ID (US only).

```APIDOC
## GET /assessments/ownerportfolio/us/{id}

### Description
Retrieves the owner portfolio for a given LightBox ID (US only).

### Method
GET

### Endpoint
`/assessments/ownerportfolio/us/{id}`

### Parameters
#### Path Parameters
*   **id** (string) - Required - The LightBox ID (can be person, property, or parcel ID).

### Request Example
```
GET /assessments/ownerportfolio/us/pe1b2c3d4e5f
```

### Response
#### Success Response (200)
*   **owner_portfolio** (object) - An object containing the owner's portfolio information.
    *   **owner_name** (string) - The name of the owner.
    *   **total_properties** (integer) - The total number of properties owned.
    *   **total_assessed_value** (number) - The total assessed value of all properties.
    *   **properties** (array) - An array of property details.
        *   **assessment_id** (string) - The assessment ID.
        *   **parcel_id** (string) - The parcel ID.
        *   **address** (string) - The property address.
        *   **assessed_value** (number) - The assessed value of the property.

#### Response Example
```json
{
  "owner_portfolio": {
    "owner_name": "John Doe",
    "total_properties": 3,
    "total_assessed_value": 1500000.00,
    "properties": [
      {
        "assessment_id": "a1b2c3d4e5f6",
        "parcel_id": "p1a2b3c4d5e6",
        "address": "123 Main St, Anytown, US 12345",
        "assessed_value": 500000.00
      },
      {
        "assessment_id": "a7b8c9d0e1f2",
        "parcel_id": "p7a8b9c0d1e2",
        "address": "456 Oak Ave, Anytown, US 12345",
        "assessed_value": 700000.00
      },
      {
        "assessment_id": "a3b4c5d6e7f8",
        "parcel_id": "p3a4b5c6d7e8",
        "address": "789 Pine Ln, Anytown, US 12345",
        "assessed_value": 300000.00
      }
    ]
  }
}
```
```

--------------------------------

### Get Structure Tile by Path Parameters

Source: https://lightbox.document360.io/data-and-api/docs/structures-documentation

Retrieves a tile of structure data using path parameters for country code, zoom level, and tile coordinates (x, y). Optional query parameters allow for customization of color, fill, labels, border, size, weight, opacity, and specific IDs.

```curl
curl -X GET -H ‘x-api-key: (api_key)’ https://api.lightboxre.com/v1/structures/{countryCode}/tile?zoom={zoom}&x={x}&y={y}&color={color}&fill={fill}&label={label}&borderColor={borderColor}&size={size}&weight={weight}&opacity={opacity}&id={id}
```

--------------------------------

### Query By Address

Source: https://lightbox.document360.io/data-and-api/docs/structures-documentation

Find structures matching a given address.

```APIDOC
## GET /structures/address

### Description
Retrieves structures based on a provided address string.

### Method
GET

### Endpoint
`/structures/address`

### Parameters
#### Query Parameters
- **address** (string) - Required - The address to query.
- **countryCode** (string) - Optional - The ISO 3166-1 alpha-2 country code (e.g., 'us'). Defaults to 'us' if not provided.

### Request Example
```json
{
  "address": "1600 Pennsylvania Ave NW, Washington, DC"
}
```

### Response
#### Success Response (200)
- **type** (string) - The GeoJSON type of the response (e.g., 'FeatureCollection').
- **features** (array) - An array of structure features matching the address.
  - **type** (string) - The GeoJSON type of the feature (e.g., 'Feature').
  - **geometry** (object) - The GeoJSON geometry of the structure.
  - **properties** (object) - Properties of the structure.

#### Response Example
```json
{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "geometry": {
        "type": "Point",
        "coordinates": [-77.0365, 38.8977]
      },
      "properties": {
        "lightbox_id": "67890",
        "address": "1600 Pennsylvania Ave NW",
        "city": "Washington",
        "state": "DC"
      }
    }
  ]
}
```
```

--------------------------------

### GET /assessments/us/{id}

Source: https://lightbox.document360.io/data-and-api/docs/assessment-documentation

Retrieves a specific assessment record by its LightBox Assessment ID.

```APIDOC
## GET /assessments/us/{id}

### Description
Retrieves a specific assessment record by its LightBox Assessment ID.

### Method
GET

### Endpoint
`/assessments/us/{id}`

### Parameters
#### Path Parameters
*   **id** (string) - Required - The unique LightBox Assessment ID.

### Request Example
```
GET /assessments/us/a1b2c3d4e5f6
```

### Response
#### Success Response (200)
*   **assessment** (object) - The assessment object.
    *   (See Response Example for structure of assessment object)

#### Response Example
```json
{
  "assessment": {
    "assessment_id": "a1b2c3d4e5f6",
    "parcel_id": "p1a2b3c4d5e6",
    "address_id": "ad1b2c3d4e5f",
    "property_id": "pr1a2b3c4d5e",
    "structure_id": "st1b2c3d4e5f",
    "site_id": "si1a2b3c4d5e",
    "person_id": "pe1b2c3d4e5f",
    "owner_name": "John Doe",
    "property_type": "Residential",
    "year_built": 2000,
    "sqft": 2500,
    "estimated_value": 500000.00,
    "latitude": 33.63799,
    "longitude": -117.852723
  }
}
```
```

--------------------------------

### Zoning Data Dictionary

Source: https://lightbox.document360.io/data-and-api/docs/zoning-documentation

This section details the fields available for zoning information, including their types and descriptions.

```APIDOC
## GET /websites/lightbox_document360_io_data-and-api/zoning

### Description
Retrieves detailed zoning information for a specified parcel or jurisdiction.

### Method
GET

### Endpoint
/websites/lightbox_document360_io_data-and-api/zoning

### Parameters
#### Query Parameters
- **parcel_id** (string) - Required - The unique identifier for the parcel.
- **jurisdiction_id** (string) - Optional - The identifier for the zoning jurisdiction.

### Request Example
```json
{
  "example": "GET /websites/lightbox_document360_io_data-and-api/zoning?parcel_id=12345&jurisdiction_id=ABCDE"
}
```

### Response
#### Success Response (200)
- **$metadata.intersect** (float) - The percent of the parcel that is intersected by the zoning polygon.
- **$metadata.vintage.ordinance** (date) - Date when the ordinance information was last updated.
- **$metadata.vintage.zoning** (date) - Date when the zoning boundary information was last updated.
- **$metadata.ordinanceUrl** (URL) - URL to the original ordinance for the jurisdiction.
- **parcel.$ref** (string) - Parcel reference.
- **parcel.fips** (string) - Federal Information Processing Code for the state and county.
- **parcel.id** (string) - LightBox Parcel 'ID.'
- **jurisdiction.id** (string) - Zoning jurisdiction ID.
- **jurisdiction.type** (string) - Zoning jurisdiction type.
- **jurisdiction.name** (string) - Zoning jurisdiction name.
- **type** (string) - Zoning type.
- **category** (string) - LightBox applied zoning category.
- **subcategory** (string) - LightBox applied zoning subcategory.
- **permitted** (string) - Zoning permitted use.
- **code.value** (string) - Zoning code value.
- **code.valueUnformatted** (string) - Zoning code value unformatted.
- **code.label** (string) - Zoning code label.
- **district.value** (string) - District value.
- **district.label** (string) - District label.
- **description.value** (string) - Zoning description.
- **description.label** (string) - Zoning label.
- **summary.value** (string) - Zoning summary.
- **summary.label** (string) - Zoning summary label.
- **densityFloorArea.value** (string) - Zoning density floor area ratio value.
- **densityFloorArea.description** (string) - Zoning density floor area ratio full description.
- **densityFloorArea.label** (string) - Zoning density floor area ratio label.
- **maximumSiteCoverage.percent** (float) - Maximum site coverage percentage.
- **maximumSiteCoverage.description** (string) - Maximum site coverage percentage description.
- **maximumSiteCoverage.label** (string) - Maximum site coverage percentage label.
- **minimumLotArea.perUnit** (float) - Minimum lot area per dwelling unit.
- **minimumLotArea.perLot** (float) - Minimum lot area per lot.
- **minimumLotArea.description** (string) - Minimum lot area description.
- **minimumLotArea.label** (string) - Minimum lot area label.
- **frontSetback.distance** (integer) - Front setback distance.
- **frontSetback.description** (string) - Front setback description.
- **frontSetback.label** (string) - Front setback label.
- **sideSetback.distance** (integer) - Side setback distance.
- **sideSetback.description** (string) - Side setback description.
- **sideSetback.label** (string) - Side setback label.
- **rearSetback.distance** (integer) - Rear setback distance.
- **rearSetback.description** (string) - Rear setback description.
- **rearSetback.label** (string) - Rear setback label.
- **maximumBuildingHeight.height** (float) - Maximum building height.
- **maximumBuildingHeight.maxStories** (string) - Maximum building height in stories.
- **maximumBuildingHeight.timesBuildableArea** (integer) - Maximum building height in times buildable area.
- **maximumBuildingHeight.description** (string) - Maximum building height description.
- **maximumBuildingHeight.label** (string) - Maximum building height label.

#### Response Example
```json
{
  "example": {
    "$metadata": {
      "intersect": 0.85,
      "vintage": {
        "ordinance": "2023-01-15T00:00:00Z",
        "zoning": "2023-01-15T00:00:00Z"
      },
      "ordinanceUrl": "http://example.com/ordinance.pdf"
    },
    "parcel": {
      "$ref": "#",
      "fips": "0603712345",
      "id": "PARCEL123"
    },
    "jurisdiction": {
      "id": "JURIS001",
      "type": "City",
      "name": "Example City"
    },
    "type": "R1",
    "category": "Residential",
    "subcategory": "Single Family",
    "permitted": "Single Family Dwelling",
    "code": {
      "value": "R1-SF",
      "valueUnformatted": "R1SF",
      "label": "Single Family Residential"
    },
    "district": {
      "value": "DISTA",
      "label": "District A"
    },
    "description": {
      "value": "Single-family residential zone.",
      "label": "Single Family Residential Zone"
    },
    "summary": {
      "value": "Low density single family homes.",
      "label": "Low Density Single Family"
    },
    "densityFloorArea": {
      "value": "0.5",
      "description": "Floor area ratio of 0.5",
      "label": "FAR 0.5"
    },
    "maximumSiteCoverage": {
      "percent": 40.0,
      "description": "Maximum 40% site coverage",
      "label": "Max Site Coverage 40%"
    },
    "minimumLotArea": {
      "perUnit": 7200.0,
      "perLot": 7200.0,
      "description": "Minimum lot area of 7200 sq ft per unit or lot",
      "label": "Min Lot Area 7200 sq ft"
    },
    "frontSetback": {
      "distance": 20,
      "description": "Minimum 20 ft front setback",
      "label": "Front Setback 20 ft"
    },
    "sideSetback": {
      "distance": 5,
      "description": "Minimum 5 ft side setback",
      "label": "Side Setback 5 ft"
    },
    "rearSetback": {
      "distance": 15,
      "description": "Minimum 15 ft rear setback",
      "label": "Rear Setback 15 ft"
    },
    "maximumBuildingHeight": {
      "height": 35.0,
      "maxStories": "3",
      "timesBuildableArea": 2,
      "description": "Maximum building height of 35 ft or 3 stories",
      "label": "Max Height 35 ft / 3 Stories"
    }
  }
}
```
```

--------------------------------

### GET /assessments/us/{id}

Source: https://lightbox.document360.io/data-and-api/docs/assessment-documentation

Retrieves assessment records using the LightBox Assessment ID.

```APIDOC
## GET /assessments/us/{id}

### Description
Return assessment records by the LightBox Assessment ID.

### Method
GET

### Endpoint
/assessments/us/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - LightBox Assessment ID.

### Request Example
```json
{
  "example": "curl -X GET -H ‘x-api-key: (api_key)’ https://api.lightboxre.com/v1/assessments/0306F25KSXL0JZ4RTLPP99"
}
```

### Response
#### Success Response (200)
- **(structure not provided)** - Description of the assessment records returned.

#### Response Example
```json
{
  "example": "(response body not provided)"
}
```
```

--------------------------------

### Query Zoning by Site ID (curl)

Source: https://lightbox.document360.io/data-and-api/docs/zoning-documentation

Fetches zoning information for a given LightBox Site ID. This endpoint requires the two-digit country code and the site ID as path parameters. Authentication is handled via an API key in the request header.

```curl
curl -X GET -H ‘x-api-key: (api_key)’ https://api.lightboxre.com/v1/zoning/_on/site/us/09033U15BDJ3RUUOQWWNWV
```

--------------------------------

### Get Addresses by LocationInfo ID

Source: https://lightbox.document360.io/data-and-api/docs/addresses-documentation

Retrieves addresses associated with a specific LocationInfo ID.

```APIDOC
## GET /addresses/_on/locationinfo/us/{id}

### Description
Retrieves addresses associated with a LocationInfo ID.

### Method
GET

### Endpoint
`/addresses/_on/locationinfo/us/{id}`

### Parameters
#### Path Parameters
- **id** (string) - Required - The LocationInfo ID.

### Response
#### Success Response (200)
- **addresses** (array) - A list of address objects associated with the LocationInfo.

#### Response Example
```json
{
  "example": "{\"addresses\": [{\"address\": \"303 Cedar Ct, Locationton, USA\", \"latitude\": 40.7128, \"longitude\": -74.0060}]}"
}
```
```
Tokens:
Raw