Response Objects

This page defines the common objects returned by the GeoX API.

Parcel Object

Metadata about the land parcel itself. Returned in parcel-based extractions.

Field	Type	Description
parcel_id	string	The unique parcel ID assigned by GeoX.
pool_count	int	Total number of pools in the parcel.
pool_enclosure_count	int	Total number of pool enclosures in the parcel.
temporary_pool_count	int	Total number of temporary pools in the parcel.
trampoline_count	int	Total number of trampolines in the parcel.
number_of_buildings_in_parcel	int	Total number of buildings within the parcel.
geocoding_confidence	float	(V2 only) Geoconfidence of the match between the requested location and the extracted parcel.

---

Footprint Object

Detailed attributes for a specific building. In footprint-based extractions (V2), this object also includes parcel-level attributes at the same level.

Field	Type	Description
footprint_id	string	Footprint's unique ID.
parcel_id	string	The parcel ID assigned to this footprint.
center_long	float	Longitude of the center of the footprint.
center_lat	float	Latitude of the center of the footprint.
crs	int	Coordinate Reference System (e.g., 4326).
footprint_area	float	Building perimeter area in ft².
year_built	int	Year the building's construction was complete.
occupancy	string	Occupancy type (e.g., restaurant, hotel).
occupancy_of_closest_building	string	Occupancy of the adjacent buildings.
land_use_description	string	Land use classification (e.g., commercial, residential).
roof_type	string	Shape of the building's roof (e.g., gable, flat).
roof_material	string	Material of the building's roof.
roof_condition	string	Detected roof quality (e.g., excellent, fair, poor).
tarp_evidence	bool	Presence of a visible tarp (true/false).
flat_area	float	Total visible flat roof area (ft²).
hip_area	float	Total visible sloped/hip roof area (ft²).
rust_area	float	Total visible area of rust (ft²).
ponding_area	float	Total visible area of standing water (ft²).
discoloration_area	float	Total visible area of roof discoloration (ft²).
solar_panel_area	float	Total visible area of solar panels (ft²).
air_conditioner_count	int	Total number of air conditioners on the roof.
building_height	float	Maximum building height (ft).
ground_height_amsl	float	Ground height above mean sea level (ft).
number_of_stories	int	Total number of stories.
square_footage	float	Total building square footage in ft².
tree_overhang_percent	float	Percentage of roof covered by trees (%).
distance_to_tree	float	Distance to nearest tree (ft).
distance_to_shrub	float	Distance to nearest shrub (ft).
distance_to_vegetation	float	Distance to nearest vegetation (ft).
tree_zone_1/2/3/4	float	Tree density at various distances (0-5ft, 5-30ft, 30-50ft, 50-100ft).
shrub_zone_1/2/3/4	float	Shrub density at various distances.
vegetation_zone_1/2/3/4	float	Combined vegetation density at various distances.
distance_to_coast	float	Distance to coast (miles).
distance_to_water_body	float	Distance to water body (miles).
distance_to_fire_station	float	Distance to nearest fire station (miles).
distance_to_closest_building	float	Distance to closest building (ft).
image_date	date	Date of imagery used for analysis.
model_run_date	date	Date the model was processed.
state	string	U.S. state name.
county	string	U.S. county name.
geometry	string	WKB polygon of footprint geometry.
Parcel Fields		(Included in footprint-based extractions)
pool_count	int	Total number of pools in the parcel.
pool_enclosure_count	int	Total number of pool enclosures in the parcel.
temporary_pool_count	int	Total number of temporary pools in the parcel.
trampoline_count	int	Total number of trampolines in the parcel.

---

Meta Object (V2)

Summary of batch processing results.

Field	Type	Description
summary	object	Contains ok and failed counts.
summary.ok	int	Number of successfully extracted results.
summary.failed	int	Number of failed extraction requests.