> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pingintel.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Data Integrations
Ping supports multiple third-party data integrations which can be accessed programmatically via API requests. To retrieve data from specific integrations, include the `sources` parameter in the request payload and provide a list of integration codes corresponding to the desired sources.
## Integrations
* `PH - Ping Hazard`
* `LB - Lightbox`
* `PG - Ping Geocoding`
* `LBG - 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`) | Values
True, False
(`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`) | Values
0-100
(`number`) | | HTTP status code indicating the result of the request. See [https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Status](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`) | Values
True, False
(`text`) | | Identifier of the worker process that handled this request. |
## Ping Hazard
**Code: PH**
The following attributes will be available in the `external_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`) | Values
A, AE, A1–A30, AO, AR, A99, V, VE, V1–V30, B, C, D, X
subtype
(`text`) | | Additional description on the features within the primary FEMA flood zone. |
| slosh\_zone\_category
(`number`) | Values
1-5
(`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`) | Values
0-100
(`currency`) | | Expected annual loss in USD used to derive the risk\_score percentile. |
| risk\_ratng
(`text`) | Values
Not Applicable, Very Low, Relatively Low, Relatively Moderate, Relatively High, Very High
(`currency`) | | Expected annual loss in USD for avalanche hazards. |
| avln\_risks
(`number`) | Values
0-100
(`text`) | Values
Not Applicable, Very Low, Relatively Low, Relatively Moderate, Relatively High, Very High
(`currency`) | | Expected annual loss in USD for coastal flood hazards. |
| cfld\_risks
(`number`) | Values
0-100
(`text`) | Values
Not Applicable, Very Low, Relatively Low, Relatively Moderate, Relatively High, Very High
(`currency`) | | Expected annual loss in USD for cold wave hazards. |
| cwav\_risks
(`number`) | Values
0-100
(`text`) | Values
Not Applicable, Very Low, Relatively Low, Relatively Moderate, Relatively High, Very High
(`currency`) | | Expected annual loss in USD for drought hazards. |
| drgt\_risks
(`number`) | Values
0-100
(`text`) | Values
Not Applicable, Very Low, Relatively Low, Relatively Moderate, Relatively High, Very High
(`currency`) | | Expected annual loss in USD for earthquake hazards. |
| erqk\_risks
(`number`) | Values
0-100
(`text`) | Values
Not Applicable, Very Low, Relatively Low, Relatively Moderate, Relatively High, Very High
(`currency`) | | Expected annual loss in USD for hail hazards. |
| hail\_risks
(`number`) | Values
0-100
(`text`) | Values
Not Applicable, Very Low, Relatively Low, Relatively Moderate, Relatively High, Very High
(`currency`) | | Expected annual loss in USD for heat wave hazards. |
| hwav\_risks
(`number`) | Values
0-100
(`text`) | Values
Not Applicable, Very Low, Relatively Low, Relatively Moderate, Relatively High, Very High
(`currency`) | | Expected annual loss in USD for hurricane hazards. |
| hrcn\_risks
(`number`) | Values
0-100
(`text`) | Values
Not Applicable, Very Low, Relatively Low, Relatively Moderate, Relatively High, Very High
(`currency`) | | Expected annual loss in USD for ice storm hazards. |
| istm\_risks
(`number`) | Values
0-100
(`text`) | Values
Not Applicable, Very Low, Relatively Low, Relatively Moderate, Relatively High, Very High
(`currency`) | | Expected annual loss in USD for landslide hazards. |
| lnds\_risks
(`number`) | Values
0-100
(`text`) | Values
Not Applicable, Very Low, Relatively Low, Relatively Moderate, Relatively High, Very High
(`currency`) | | Expected annual loss in USD for lightning hazards. |
| ltng\_risks
(`number`) | Values
0-100
(`text`) | Values
Not Applicable, Very Low, Relatively Low, Relatively Moderate, Relatively High, Very High
(`currency`) | | Expected annual loss in USD for riverine flood hazards. |
| rfld\_risks
(`number`) | Values
0-100
(`text`) | Values
Not Applicable, Very Low, Relatively Low, Relatively Moderate, Relatively High, Very High
(`currency`) | | Expected annual loss in USD for strong wind hazards. |
| swnd\_risks
(`number`) | Values
0-100
(`text`) | Values
Not Applicable, Very Low, Relatively Low, Relatively Moderate, Relatively High, Very High
(`currency`) | | Expected annual loss in USD for tornado hazards. |
| trnd\_risks
(`number`) | Values
0-100
(`text`) | Values
Not Applicable, Very Low, Relatively Low, Relatively Moderate, Relatively High, Very High
(`currency`) | | Expected annual loss in USD for tsunami hazards. |
| tsun\_risks
(`number`) | Values
0-100
(`text`) | Values
Not Applicable, Very Low, Relatively Low, Relatively Moderate, Relatively High, Very High
(`currency`) | | Expected annual loss in USD for volcanic activity hazards. |
| vlcn\_risks
(`number`) | Values
0-100
(`text`) | Values
Not Applicable, Very Low, Relatively Low, Relatively Moderate, Relatively High, Very High
(`currency`) | | Expected annual loss in USD for wildfire hazards. |
| wfir\_risks
(`number`) | Values
0-100
(`text`) | Values
Not Applicable, Very Low, Relatively Low, Relatively Moderate, Relatively High, Very High
(`number`) | | Expected annual loss in USD for winter weather hazards. |
| wntw\_risks
(`number`) | Values
0-100
(`text`) | Values
Not Applicable, Very Low, Relatively Low, Relatively Moderate, Relatively High, Very High
(`percentage`) | Values
0.0-1.0
(`text`) | Values
P1, P2, P3, P4, U1, U2
class
(`number`) | Values
1-10
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`) | Values
A-F
(`text`) | Values
A-F
(`text`) | Values
A-F
(`text`) | Values
A-F
(`text`) | Values
A-F
(`text`) | Values
A-F
(`text`) | Values
A-F
(`text`) | Values
A-F
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 the `external_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`) | Values
True, False
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`) | Values
True, False
(`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`) | Values
0-100
(`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 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`) | Values
0-100
(`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`) | Values
0.0-1.0
(`text`) | | The fully assembled address string built from the individual address components. |
| used\_point\_
coordinates\_from\_
input
(`boolean`) | Values
True, False
The 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`) | Values
0-100
(`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`) | Values
[Precision Code List](https://lightbox.document360.io/docs/geocode-precision-code)