sources parameter in the request payload and provide a list of integration codes corresponding to the desired sources.
Integrations
Sources
Sources
PH - Ping HazardLB - LightboxPG - Ping GeocodingLBG - Lightbox Geocoding
full list coming soon...
Base Output Attributes
The following attributes are always present in responses and provide metadata about the request/response transaction:| Data Element | Response Values | Description |
|---|---|---|
| is_success ( boolean) | ValuesTrue, False | Indicates whether the data retrieval was successful or not. |
| error_message ( text) | Message returned when a request fails. | |
| raw_response ( object) | The unprocessed response data from the datasource, preserved for debugging or advanced use cases. | |
| persist_for ( object) | Duration for which this result should be cached before requiring a fresh fetch. | |
| confidence ( number) | Values0-100 | Confidence score indicating the reliability of the returned data for the given location. |
| status_code ( number) | HTTP status code indicating the result of the request. See https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Status for reference. | |
| fetch_time ( number) | Time taken to retrieve the data, in seconds. | |
| is_cache_hit ( boolean) | ValuesTrue, False | Indicates whether the result was served from cache or freshly computed. |
| worker_name ( text) | Identifier of the worker process that handled this request. |
Ping Hazard
Code: PH The following attributes will be available in theexternal_data key of the response.
Response Metadata
The following attributes describe the status, context, and quality of the hazard/risk data returned for the location.| Data Element | Response Values | Description |
|---|---|---|
| consulted_ datasources ( object) | List of data source codes used to generate the hazard and risk outputs for the location. | |
| state ( text) | The U.S. state where the location is found. | |
| county ( text) | Name of the county where the property is located. |
Flood Data
The following attributes describe flood-related hazard exposure, proximity to the coast, FEMA flood classification, and surge modeling.| Data Element | Response Values | Description |
|---|---|---|
| fema_flood_zone_ dfirm_id ( text) | FEMA Digital Flood Insurance Rate Map (DFIRM) panel identifier. | |
| fema_flood_zone_ version_id ( text) | Version identifier representing the specific FEMA flood zone data. | |
| fema_flood_zone_ version_date ( date) | Date of the FEMA flood zone data version used for this record. | |
| fema_flood_zone ( text) | ValuesA, AE, A1–A30, AO, AR, A99, V, VE, V1–V30, B, C, D, X | FEMA flood zone designation indicating the level of flood risk. |
| fema_flood_zone_ subtype ( text) | Additional description on the features within the primary FEMA flood zone. | |
| slosh_zone_category ( number) | Values1-5 | The SLOSH (Sea, Lake, and Overland Surges from Hurricanes) storm surge category assigned to this location. |
| slosh_zone_value ( number) | Estimated storm surge height in feet for the associated SLOSH category. | |
| distance_to_coast_ miles ( number) | Distance from the location to the coast, measured in miles. | |
| distance_to_coast_ feet ( number) | Distance from the location to the coast, measured in feet. | |
| distance_to_coast_ closest_point_ longitude ( number) | Longitude of the nearest point on the coast to the location. | |
| distance_to_coast_ closest_point_ latitude ( number) | Latitude of the nearest point on the coast to the location. | |
| distance_to_coast_ connected_lines ( list[text]) | WKT LineString connecting the location to the nearest point on the coast. |
Risk Data
The following attributes provide grade, numeric and textual ratings, and monetary values for different risk categories.Composite
| Data Element | Response Values | Description |
|---|---|---|
| risk_score ( number) | Values0-100 | FEMA’s National Risk Index (NRI) composite score for the location, a national percentile indicating relative risk from natural hazards. |
| risk_value ( currency) | Expected annual loss in USD used to derive the risk_score percentile. | |
| risk_ratng ( text) | ValuesNot Applicable, Very Low, Relatively Low, Relatively Moderate, Relatively High, Very High | Overall risk rating label. |
Avalanche
| Data Element | Response Values | Description |
|---|---|---|
| avln_riskv ( currency) | Expected annual loss in USD for avalanche hazards. | |
| avln_risks ( number) | Values0-100 | Avalanche hazard risk score (national percentile, 0-100). |
| avln_riskr ( text) | ValuesNot Applicable, Very Low, Relatively Low, Relatively Moderate, Relatively High, Very High | Avalanche hazard risk rating label. |
Coastal Flooding
| Data Element | Response Values | Description |
|---|---|---|
| cfld_riskv ( currency) | Expected annual loss in USD for coastal flood hazards. | |
| cfld_risks ( number) | Values0-100 | Coastal flood hazard risk score (national percentile, 0-100). |
| cfld_riskr ( text) | ValuesNot Applicable, Very Low, Relatively Low, Relatively Moderate, Relatively High, Very High | Coastal flood hazard risk rating label. |
Cold Wave
| Data Element | Response Values | Description |
|---|---|---|
| cwav_riskv ( currency) | Expected annual loss in USD for cold wave hazards. | |
| cwav_risks ( number) | Values0-100 | Cold wave hazard risk score (national percentile, 0-100). |
| cwav_riskr ( text) | ValuesNot Applicable, Very Low, Relatively Low, Relatively Moderate, Relatively High, Very High | Cold wave hazard risk rating label. |
Drought
| Data Element | Response Values | Description |
|---|---|---|
| drgt_riskv ( currency) | Expected annual loss in USD for drought hazards. | |
| drgt_risks ( number) | Values0-100 | Drought hazard risk score (national percentile, 0-100). |
| drgt_riskr ( text) | ValuesNot Applicable, Very Low, Relatively Low, Relatively Moderate, Relatively High, Very High | Drought hazard risk rating label. |
Earthquake
| Data Element | Response Values | Description |
|---|---|---|
| erqk_riskv ( currency) | Expected annual loss in USD for earthquake hazards. | |
| erqk_risks ( number) | Values0-100 | Earthquake hazard risk score (national percentile, 0-100). |
| erqk_riskr ( text) | ValuesNot Applicable, Very Low, Relatively Low, Relatively Moderate, Relatively High, Very High | Earthquake hazard risk rating label. |
Hail
| Data Element | Response Values | Description |
|---|---|---|
| hail_riskv ( currency) | Expected annual loss in USD for hail hazards. | |
| hail_risks ( number) | Values0-100 | Hail hazard risk score (national percentile, 0-100). |
| hail_riskr ( text) | ValuesNot Applicable, Very Low, Relatively Low, Relatively Moderate, Relatively High, Very High | Hail hazard risk rating label. |
Heat Wave
| Data Element | Response Values | Description |
|---|---|---|
| hwav_riskv ( currency) | Expected annual loss in USD for heat wave hazards. | |
| hwav_risks ( number) | Values0-100 | Heat wave hazard risk score (national percentile, 0-100). |
| hwav_riskr ( text) | ValuesNot Applicable, Very Low, Relatively Low, Relatively Moderate, Relatively High, Very High | Heat wave hazard risk rating label. |
Hurricane
| Data Element | Response Values | Description |
|---|---|---|
| hrcn_riskv ( currency) | Expected annual loss in USD for hurricane hazards. | |
| hrcn_risks ( number) | Values0-100 | Hurricane hazard risk score (national percentile, 0-100). |
| hrcn_riskr ( text) | ValuesNot Applicable, Very Low, Relatively Low, Relatively Moderate, Relatively High, Very High | Hurricane hazard risk rating label. |
Ice Storm
| Data Element | Response Values | Description |
|---|---|---|
| istm_riskv ( currency) | Expected annual loss in USD for ice storm hazards. | |
| istm_risks ( number) | Values0-100 | Ice storm hazard risk score (national percentile, 0-100). |
| istm_riskr ( text) | ValuesNot Applicable, Very Low, Relatively Low, Relatively Moderate, Relatively High, Very High | Ice storm hazard risk rating label. |
Landslide
| Data Element | Response Values | Description |
|---|---|---|
| lnds_riskv ( currency) | Expected annual loss in USD for landslide hazards. | |
| lnds_risks ( number) | Values0-100 | Landslide hazard risk score (national percentile, 0-100). |
| lnds_riskr ( text) | ValuesNot Applicable, Very Low, Relatively Low, Relatively Moderate, Relatively High, Very High | Landslide hazard risk rating label. |
Lightning
| Data Element | Response Values | Description |
|---|---|---|
| ltng_riskv ( currency) | Expected annual loss in USD for lightning hazards. | |
| ltng_risks ( number) | Values0-100 | Lightning hazard risk score (national percentile, 0-100). |
| ltng_riskr ( text) | ValuesNot Applicable, Very Low, Relatively Low, Relatively Moderate, Relatively High, Very High | Lightning hazard risk rating label. |
Riverine Flooding
| Data Element | Response Values | Description |
|---|---|---|
| rfld_riskv ( currency) | Expected annual loss in USD for riverine flood hazards. | |
| rfld_risks ( number) | Values0-100 | Riverine flood hazard risk score (national percentile, 0-100). |
| rfld_riskr ( text) | ValuesNot Applicable, Very Low, Relatively Low, Relatively Moderate, Relatively High, Very High | Riverine flood hazard risk rating label. |
Strong Wind
| Data Element | Response Values | Description |
|---|---|---|
| swnd_riskv ( currency) | Expected annual loss in USD for strong wind hazards. | |
| swnd_risks ( number) | Values0-100 | Strong wind hazard risk score (national percentile, 0-100). |
| swnd_riskr ( text) | ValuesNot Applicable, Very Low, Relatively Low, Relatively Moderate, Relatively High, Very High | Strong wind hazard risk rating label. |
Tornado
| Data Element | Response Values | Description |
|---|---|---|
| trnd_riskv ( currency) | Expected annual loss in USD for tornado hazards. | |
| trnd_risks ( number) | Values0-100 | Tornado hazard risk score (national percentile, 0-100). |
| trnd_riskr ( text) | ValuesNot Applicable, Very Low, Relatively Low, Relatively Moderate, Relatively High, Very High | Tornado hazard risk rating label. |
Tsunami
| Data Element | Response Values | Description |
|---|---|---|
| tsun_riskv ( currency) | Expected annual loss in USD for tsunami hazards. | |
| tsun_risks ( number) | Values0-100 | Tsunami hazard risk score (national percentile, 0-100). |
| tsun_riskr ( text) | ValuesNot Applicable, Very Low, Relatively Low, Relatively Moderate, Relatively High, Very High | Tsunami hazard risk rating label. |
Volcanic Activity
| Data Element | Response Values | Description |
|---|---|---|
| vlcn_riskv ( currency) | Expected annual loss in USD for volcanic activity hazards. | |
| vlcn_risks ( number) | Values0-100 | Volcanic activity hazard risk score (national percentile, 0-100). |
| vlcn_riskr ( text) | ValuesNot Applicable, Very Low, Relatively Low, Relatively Moderate, Relatively High, Very High | Volcanic activity hazard risk rating label. |
Wildfire
| Data Element | Response Values | Description |
|---|---|---|
| wfir_riskv ( currency) | Expected annual loss in USD for wildfire hazards. | |
| wfir_risks ( number) | Values0-100 | Wildfire hazard risk score (national percentile, 0-100). |
| wfir_riskr ( text) | ValuesNot Applicable, Very Low, Relatively Low, Relatively Moderate, Relatively High, Very High | Wildfire hazard risk rating label. |
Winter Weather
| Data Element | Response Values | Description |
|---|---|---|
| wntw_riskv ( number) | Expected annual loss in USD for winter weather hazards. | |
| wntw_risks ( number) | Values0-100 | Winter weather hazard risk score (national percentile, 0-100). |
| wntw_riskr ( text) | ValuesNot Applicable, Very Low, Relatively Low, Relatively Moderate, Relatively High, Very High | Winter weather hazard risk rating label. |
Fire Data
The following attributes describe wildfire hazard, fire protection, and proximity to fire response infrastructure.| Data Element | Response Values | Description |
|---|---|---|
| burn_probability ( percentage) | Values0.0-1.0 | Annual probability of a wildfire burning the location. |
| aais_classification ( text) | ValuesP1, P2, P3, P4, U1, U2 | Fire protection classification code and description from the AAIS system (e.g., ‘P1, PROTECTED 1’ indicates highest protection level). |
| ping_fire_protection_ class ( number) | Values1-10 | ISO/Ping Fire Protection Class (FPC) score; lower values indicate better fire protection. |
| distance_to_fire_ station_feet ( number) | Distance from the location to the nearest fire station, measured in feet. | |
| distance_to_fire_ hydrant_feet ( number) | Distance from the location to the nearest fire hydrant, measured in feet. | |
| fire_station_point ( text) | Geographic point representing the nearest fire station, in WKT format (e.g., POINT (longitude latitude)). | |
| fire_station_closest_ point_longitude ( number) | Longitude of the closest fire station to the property location. | |
| fire_station_closest_ point_latitude ( number) | Latitude of the closest fire station to the property location. | |
| fire_station_extra_ data ( object) | Extra data about the nearest fire station, including name, address, geographic coordinates, city, state, zip code, and whether it is staffed by volunteers. | |
| fire_hydrant_point ( text) | Geographic point representing the nearest fire hydrant, in WKT format (e.g., POINT (longitude latitude)). | |
| fire_hydrant_closest_ point_longitude ( number) | Longitude of the closest fire hydrant to the property location. | |
| fire_hydrant_closest_ point_latitude ( number) | Latitude of the closest fire hydrant to the property location. |
Crime Data
The following attributes describe crime statistics and safety metrics for the location.| Data Element | Response Values | Description |
|---|---|---|
| total_crime_grade ( text) | ValuesA-F | Overall crime grade for the property area. |
| murder_grade ( text) | ValuesA-F | Crime grade for murder/homicide rate in the area. |
| rape_grade ( text) | ValuesA-F | Crime grade for rape/sexual assault rate in the area. |
| robbery_grade ( text) | ValuesA-F | Crime grade for robbery rate in the area. |
| assault_grade ( text) | ValuesA-F | Crime grade for aggravated assault rate in the area. |
| burglary_grade ( text) | ValuesA-F | Crime grade for burglary rate in the area. |
| larceny_grade ( text) | ValuesA-F | Crime grade for larceny/theft rate in the area. |
| vehicle_theft_grade ( text) | ValuesA-F | Crime grade for motor vehicle theft rate in the area. |
Florida Sinkhole Data
The following attributes describe the proximity and characteristics of the nearest known sinkhole in Florida.| Data Element | Response Values | Description |
|---|---|---|
| distance_to_florida_ sinkhole_feet ( number) | Distance from the property to the nearest known Florida sinkhole, in feet. | |
| florida_sinkhole_ point ( text) | Geographic point representing the nearest known sinkhole in Florida, in WKT format (e.g., POINT (longitude latitude)). | |
| florida_sinkhole_ closest_point_ longitude ( number) | Longitude of the closest known sinkhole in Florida to the property location. | |
| florida_sinkhole_ closest_point_ latitude ( number) | Latitude of the closest known sinkhole in Florida to the property location. | |
| florida_sinkhole_ extra_data ( object) | Extra data about the closest Florida sinkhole, including coordinates, event dates, geological characteristics, damage reports, and other sinkhole-specific data. |
Elevation Data
The following attributes describe the elevation and topographic characteristics of the location.| Data Element | Response Values | Description |
|---|---|---|
| elevation_meters ( number) | Elevation of the location above sea level, in meters. | |
| resolution_meters ( number) | Size of each grid cell in the underlying risk data, in meters. Smaller values indicate higher spatial resolution. |
Lightbox
Code: LB The following attributes will be available in theexternal_data key of the response.
| Data Element | Response Values | Description |
|---|---|---|
| length_units ( text) | Units used for linear measurements (e.g., ‘m’). | |
| area_units ( text) | Units used to express area measurements (e.g., ‘sqm’). | |
| occupancy_type ( text) | Type of occupancy (e.g., ‘SINGLE FAMILY RESIDENTIAL’). | |
| land_use_category ( text) | Use classification for the land (e.g., residential, commercial, agricultural). | |
| bldg_year_built ( year) | The year the building was originally constructed. | |
| bldg_year_updated ( year) | The most recent year in which the building was updated or modified. | |
| construction_type ( text) | Category of building construction (e.g., wood frame, masonry, steel). | |
| num_stories ( text) | Number of stories / floors in the building (as text). | |
| num_buildings ( text) | The number of distinct buildings on the property (as text). | |
| has_basement ( boolean) | ValuesTrue, False | Whether the building has a basement (true / false). |
| num_stories_below_ gnd ( number) | How many levels / floors are below ground (basement levels). | |
| num_stories_desc ( text) | Description of the number of stories (e.g., ‘2+B’). | |
| bldg_area ( number) | The building’s footprint / gross floor area (in area units). | |
| wall_type ( text) | Wall construction type (e.g., masonry, wood frame). | |
| roof_covering ( text) | Material used for the roof covering (e.g., ‘ASPHALT’). | |
| roof_covering_code ( text) | Code representing the roof covering material. (e.g., ‘P’) | |
| roof_type ( text) | The structural type of roof (e.g., gable, flat, hip). | |
| lot_size ( number) | Size of the land / parcel (in area units). | |
| assessed_value_total ( currency) | Total assessed value of the property. | |
| assessed_value_land ( currency) | Assessed value of the land portion of the property. | |
| assessed_value_ improvements ( currency) | Assessed value of improvements (structures) on the property. | |
| assessed_value_year ( year) | The year for which the assessed value applies. | |
| market_value_total ( currency) | Market valuation of the property. | |
| market_value_land ( currency) | Market value of the land portion of the property. | |
| market_value_ improvements ( currency) | Market value of improvements (structures) on the property. | |
| market_value_year ( year) | The year for which the market value is estimated. | |
| bedrooms ( number) | Number of bedrooms. | |
| baths ( number) | Number of bathrooms. | |
| ownership_status_ code ( text) | Code for ownership status (e.g., ‘CO’). | |
| ownership_status_ code_desc ( text) | Description corresponding to the ownership status code (e.g., ‘COMPANY’ or ‘CORPORATION’). | |
| owner_names ( list[text]) | List of owner names. | |
| owner_street ( text) | Street address of the owner. | |
| owner_city ( text) | City of the property owner’s address. | |
| owner_state ( text) | State in the owner’s address. | |
| owner_zip ( text) | ZIP code of the owner’s address. | |
| owner_occupied ( boolean) | ValuesTrue, False | Whether the owner lives in the property (true / false). |
| heating_desc ( text) | Description of the heating system (e.g., ‘FORCED AIR UNIT’). | |
| heating_code ( text) | Code for the type of heating system installed. | |
| air_conditioning_ desc ( text) | A textual description of the air conditioning type (e.g., ‘Central / Forced air’). | |
| air_conditioning_ code ( text) | A code representing the type of air conditioning installed (if any). | |
| valuation_model_ value ( currency) | Valuation or predictive value of the property from LightBox’s model. | |
| valuation_model_ value_high ( currency) | Upper bound of the modeled value (confidence interval). | |
| valuation_model_ value_low ( currency) | Lower bound of the modeled value (confidence interval). | |
| valuation_model_ value_score ( number) | Values0-100 | Score or confidence metric for the valuation model result. |
| street ( text) | Street address of the property. | |
| city ( text) | The city or municipality where the property is located. | |
| state ( text) | The U.S. state where the location is found. | |
| zip ( text) | ZIP code of the property location. | |
| country ( text) | Country where the property is located. | |
| latitude ( number) | Latitude coordinate of the property. | |
| longitude ( number) | Longitude coordinate of the property. | |
| transaction_price_ per_area ( currency) | The sale price of the property divided by its area. | |
| transaction_value ( currency) | The total dollar amount paid in the most recent recorded sale of the property. | |
| transaction_date ( date) | The official recorded date of the most recent property sale or transfer. | |
| h3 ( text) | H3 geospatial index of the property location. |
Ping Geocoding
Code: PG The following attributes will be available in thelocation_data key of the response.
| Data Element | Response Values | Description |
|---|---|---|
| street_number ( text) | Street number component of the address. | |
| route ( text) | Street name or route component of the address. | |
| location_type ( text) | Indicates how precisely the coordinates represent the actual address (e.g., ‘ROOFTOP’) | |
| latitude ( number) | Latitude of the location. | |
| longitude ( number) | Longitude of the location. | |
| formatted_address ( text) | Human-readable full address (e.g., ‘123 Main St, Miami, FL 33133’). | |
| address_line_1 ( text) | Primary street address line of the location (e.g., ‘123 Main St’). | |
| address_line_2 ( text) | Secondary address information of the location (e.g., Apt. 33) | |
| city ( text) | City where the property is located (e.g., ‘Miami’). | |
| postal_code ( text) | Postal code (e.g., ZIP code in the US). | |
| county ( text) | County or equivalent region for the location (e.g., ‘Miami-Dade’). | |
| state ( text) | State abbreviation (e.g., ‘MA’). | |
| country ( text) | Country where the property is located (e.g., ‘US’). | |
| precision ( number) | Values0-100 | Precision score of the geocoding. |
| state_name ( text) | Full state name. | |
| state_code ( text) | Alternate field for state abbreviation. | |
| country_subdivision_ name ( text) | Full name of the state/province (e.g., ‘Florida’). | |
| country_subdivision_ code ( text) | Abbreviated code for the state/province (e.g., ‘FL’). | |
| source_desc ( text) | Source system that provided the geocoded data. | |
| consulted_ datasources ( list[text]) | List of data source codes used to generate the address result. | |
| version ( text) | Data source version identifier (e.g., ‘2.1’). | |
| candidate_countries ( list[text]) | ||
| match_level ( text) | Level of detail matched in the address (e.g., ‘street_imputed’). | |
| precision_ confidences ( object) | Map of precision scores to confidence values. | |
| match_confidence ( number) | Values0.0-1.0 | Confidence level of the address match (e.g., ‘0.57’). |
| constructed_address ( text) | The fully assembled address string built from the individual address components. | |
| used_point_ coordinates_from_ input ( boolean) | ValuesTrue, False | Whether the geocoding result used latitude/longitude coordinates provided in the input rather than geocoding from an address. |
Lightbox Geocoding
Code: LBGThe following attributes will be available in the
location_data key of the response.
| Data Element | Response Values | Description |
|---|---|---|
| street_number ( text) | Street number component of the address. | |
| route ( text) | Street name or route component of the address. | |
| location_type ( text) | Indicates how precisely the coordinates represent the actual address (e.g., ‘ROOFTOP’) | |
| latitude ( number) | Latitude of the location. | |
| longitude ( number) | Longitude of the location. | |
| formatted_address ( text) | Human-readable full address (e.g., ‘123 Main St, Miami, FL 33133’). | |
| address_line_1 ( text) | Primary street address line of the location (e.g., ‘123 Main St’). | |
| address_line_2 ( text) | Secondary address information of the location (e.g., Apt. 33) | |
| city ( text) | City where the property is located (e.g., ‘Miami’). | |
| postal_code ( text) | Postal code (e.g., ZIP code in the US). | |
| county ( text) | County or equivalent region for the location (e.g., ‘Miami-Dade’). | |
| state ( text) | State abbreviation (e.g., ‘MA’). | |
| country ( text) | Country where the property is located (e.g., ‘US’). | |
| precision ( number) | Values0-100 | Precision score of the geocoding. |
| state_name ( text) | Full state name. | |
| state_code ( text) | Alternate field for state abbreviation. | |
| country_subdivision_ name ( text) | Full name of the state/province (e.g., ‘Florida’). | |
| country_subdivision_ code ( text) | Abbreviated code for the state/province (e.g., ‘FL’). | |
| score ( number) | Overall confidence score for the geocoding match. | |
| street_number_score ( number) | Confidence score for the street number component match. | |
| route_score ( number) | Confidence score for the street name/route component match. | |
| address_line_1_score ( number) | Confidence score for the primary address line match. | |
| city_score ( number) | Confidence score for the city/locality component match. | |
| postal_code_score ( number) | Confidence score for the postal code component match. | |
| address_id ( text) | Unique Lightbox identifier for the geocoded address. | |
| parcel_id ( text) | Unique Lightbox identifier for the parcel associated with the address. | |
| assessment_id ( text) | Unique Lightbox identifier for the tax assessment record associated with the address. | |
| structure_id ( text) | Unique Lightbox identifier for the structure/building at the address. | |
| precision_code ( number) | ValuesPrecision Code List | Lightbox precision code indicating the level of geocoding accuracy (lower values indicate higher precision). |