1import requests
2import json
3from typing import Dict
4
5
6# ----------------------------
7# Function Definitions
8# ----------------------------
9
10# Function to geocode a single address using the LightBox API.
11def geocode_address(lightbox_api_key: str, address: str) -> Dict:
12    """
13    Geocodes the provided address using the LightBox API.
14    
15    Args:
16        lightbox_api_key (str): The API key for accessing the LightBox API.
17        address (str): The address string for matching.
18    
19    Returns:
20        dict: The geocoded address information in JSON format.
21    """
22    # API endpoint configuration
23    BASE_URL = "https://api.lightboxre.com/v1"
24    ENDPOINT = "/addresses/search"
25    URL = BASE_URL + ENDPOINT
26
27    # Setting up request parameters and headers
28    params = {"text": address}
29    headers = {"x-api-key": lightbox_api_key}
30
31    # Sending request to the LightBox API
32    geocoder_data = requests.get(URL, params=params, headers=headers)
33    
34    # Returning the geocoded address information
35    return geocoder_data
36
37
38# Test for the get_parcel_from_lbx_address_id() function
39def get_parcel_data_from_address_coordinates(lightbox_api_key: str, country_code: str, address_wkt_coordinates: str) -> Dict:
40    """
41    Returns a dictionary containing the parcel data for the specified address.
42
43    Args:
44        lightbox_api_key (str): The API key for accessing the LightBox API.
45        country_code (str): The country code for the address.
46        address_wkt_coordinates (str): The address coordinates for the address.
47    """
48
49    # API endpoint configuration
50    BASE_URL = "https://api.lightboxre.com/v1"
51    ENDPOINT = f"/parcels/{country_code}/geometry"
52    URL = BASE_URL + ENDPOINT
53
54    # Setting up request parameters and headers
55    params = {"wkt": address_wkt_coordinates}
56    headers = {"x-api-key": lightbox_api_key}
57
58    # Make the request
59    parcel_data = requests.get(URL, params=params, headers=headers)
60    
61    # Return the parcel data
62    return parcel_data
63
64
65def get_assessment_data_from_lbx_parcel_id(lightbox_api_key: str, parcel_id: str) -> Dict:
66    """
67    Returns a dictionary containing the assessment data for the specified parcel.
68
69    Args:
70        lightbox_api_key (str): The LightBox API key.
71        parcel_id (str): The parcel ID.
72    """
73
74    # API endpoint configuration
75    BASE_URL = "https://api.lightboxre.com/v1"
76    ENDPOINT = f"/assessments/_on/parcel/us/{parcel_id}"
77    URL = BASE_URL + ENDPOINT
78
79    # Setting up request parameters and headers
80    headers = {"x-api-key": lightbox_api_key}
81
82    # Make the request
83    assessment_data = requests.get(URL, headers=headers)
84    
85    # Return the assessment data
86    return assessment_data
87
88
89# Function to test the response status of the geocode_address function.
90def test_geocode_address_response_status(lightbox_api_key: str) -> None:
91    """
92    Tests the response status for various scenarios using the geocode_address function.
93
94    Args:
95        lightbox_api_key (str): The API key for accessing the LightBox API.
96    """
97
98    # Test for a successful request (HTTP status code 200)
99    address = "25482 Buckwood Land Forest, Ca, 92630"
100    address_search_data = geocode_address(lightbox_api_key, address)
101    assert address_search_data.status_code == 200, f"Expected status code 200, but got {address_search_data.status_code}"
102
103    # Test for an unsuccessful request due to an empty address (HTTP status code 400)
104    address = ""  # No address specified
105    address_search_data = geocode_address(lightbox_api_key, address)
106    assert address_search_data.status_code == 400, f"Expected status code 400, but got {address_search_data.status_code}"
107
108    # Test for an unsuccessful request due to an invalid API key (HTTP status code 401)
109    address = "25482 Buckwood Land Forest, Ca, 92630"
110    address_search_data = geocode_address("My-LightBox-Key", address)  # Invalid API key
111    assert address_search_data.status_code == 401, f"Expected status code 401, but got {address_search_data.status_code}"
112
113    # Test for an unsuccessful request due to an incomplete address (HTTP status code 404)
114    address = "25482 Buckwood Land Forest"  # Incomplete address
115    address_search_data = geocode_address(lightbox_api_key, address)
116    assert address_search_data.status_code == 404, f"Expected status code 404, but got {address_search_data.status_code}"
117
118
119# Test the get_parcel_data_from_address_coordinates function
120def test_get_parcel_data_from_address_coordinates(lightbox_api_key):
121    """
122    Test the get_parcel_data_from_address_coordinates function
123    
124    Args:
125        lightbox_api_key (str): The LightBox API key
126    """
127
128    # Test for a successful request (HTTP status code 200)
129    address = "25482 Buckwood Land Forest, Ca, 92630"
130    country_code = "us"
131    address_search_data = geocode_address(lightbox_api_key, address)
132    address_coordinates = address_search_data.json()["addresses"][0]["location"]["representativePoint"]["geometry"]["wkt"]
133    parcel_data = get_parcel_data_from_address_coordinates(lightbox_api_key, country_code, address_coordinates)
134    assert parcel_data.status_code == 200, f"Expected status code 200, but got {parcel_data.status_code}"
135
136    # Test for an unsuccessful request due to an invalid address ID (HTTP status code 400)
137    address_coordinates = "foobar"
138    parcel_data = get_parcel_data_from_address_coordinates(lightbox_api_key, country_code, address_coordinates)
139    assert parcel_data.status_code == 400, f"Expected status code 400, but got {parcel_data.status_code}"
140
141    # Test for an unsuccessful request due to an invalid API key (HTTP status code 401)
142    parcel_data = get_parcel_data_from_address_coordinates(lightbox_api_key+"foobar", country_code, address_coordinates)
143    assert parcel_data.status_code == 401, f"Expected status code 401, but got {parcel_data.status_code}"
144
145
146# Test the get_parcel_data_from_lbx_parcel_id function
147def test_get_assessment_data_from_lbx_parcel_id(lightbox_api_key):
148    """
149    Test the get_assessment_data_from_lbx_parcel_id function
150    
151    Args:
152        lightbox_api_key (str): The LightBox API key
153    """
154
155    # Test for a successful request (HTTP status code 200)
156    address = "25482 Buckwood Land Forest, Ca, 92630"
157    country_code = "us"
158    address_search_data = geocode_address(lightbox_api_key, address)
159    address_coordinates = address_search_data.json()["addresses"][0]["location"]["representativePoint"]["geometry"]["wkt"]
160    parcel_data = get_parcel_data_from_address_coordinates(lightbox_api_key, country_code, address_coordinates)
161    parcel_id = parcel_data.json()["parcels"][0]["id"]
162    assessment_data = get_assessment_data_from_lbx_parcel_id(lightbox_api_key, parcel_id)
163    assert assessment_data.status_code == 200, f"Expected status code 200, but got {assessment_data.status_code}"
164
165    # Test for an unsuccessful request due to an invalid parcel ID (HTTP status code 400)
166    parcel_id = "1234567890"
167    assessment_data = get_assessment_data_from_lbx_parcel_id(lightbox_api_key, parcel_id)
168    assert assessment_data.status_code == 400, f"Expected status code 400, but got {assessment_data.status_code}"
169
170    # Test for an unsuccessful request (HTTP status code 401)
171    assessment_data = get_assessment_data_from_lbx_parcel_id(lightbox_api_key+"foobar", parcel_id)
172    assert assessment_data.status_code == 401, f"Expected status code 401, but got {assessment_data.status_code}"
173
174
175# ----------------------------
176# API Usage
177# ----------------------------
178
179# Assign your LightBox API key
180lightbox_api_key = ""
181
182# Specify the address to geocode
183address = "24299 Paseo De Valencia, Laguna Woods, CA 92637"
184country_code = "us" # 'us' for the United States
185
186# Geocode the specified address
187address_search_data = geocode_address(lightbox_api_key, address)
188
189# Get the parcel data from the geocoded address
190parcel_data = get_parcel_data_from_address_coordinates(lightbox_api_key, country_code, address_search_data.json()["addresses"][0]["location"]["representativePoint"]["geometry"]["wkt"])
191
192# Get the assessment data from the parcel ID
193assessment_data = get_assessment_data_from_lbx_parcel_id(lightbox_api_key, parcel_data.json()["parcels"][0]["id"])
194
195
196# --------------------
197# Print collected data
198# --------------------
199
200# Print the geocoded address data in a readable JSON format
201print(json.dumps(address_search_data.json(), indent=4))
202# Print the parcel data in a readable JSON format
203print(json.dumps(parcel_data.json(), indent=4))
204# Print the assessment data in a readable JSON format
205print(json.dumps(assessment_data.json(), indent=4))
206
207
208# ----------------------------
209# API Testing
210# ----------------------------
211
212# Perform tests to verify the response status of the geocode_address function
213test_geocode_address_response_status(lightbox_api_key)
214test_get_parcel_data_from_address_coordinates(lightbox_api_key)
215test_get_assessment_data_from_lbx_parcel_id(lightbox_api_key)
216
217