Upgrading to Property API V4
The following outlines the series of steps necessary to upgrade applications from previous versions of Property API to Property API V4. It is important these changes be made as soon as possible as the older versions are being deprecated. It is likely that the older versions of Community API endpoints will stop working after June 30, 2023.
Endpoints Affected
Data Source Changes
The following Property API endpoints are likely to impact existing applications and care should be taken to follow the migration steps outlined.
These are the only endpoints in the Property API that are being upgraded to V4. These are considered breaking changes for these endpoints (ONLY) and customers are encouraged to migrate applications using these endpoints on or before June 30, 2023. All other endpoints will continue to use the same version number and existing applications should not be impacted by the changes.
GeoCode Search
The following is a list of Property API endpoints that support the use of a geocode as a search parameter (geoid). If your application is making calls to these endpoints using geoid as a search parameter, these will need to be modified to search using geoIdV4.
| Name | Endpoint |
| All Events Detail | /propertyapi/v1.0.0/allevents/detail |
| All Events Snapshot | /propertyapi/v1.0.0/allevents/snapshot |
| Assessment Detail | /propertyapi/v1.0.0/assessment/detail |
| Assessment Snapshot | /propertyapi/v1.0.0/assessment/snapshot |
| ATTOM AVM Detail | /propertyapi/v1.0.0/attomavm/detail |
| AVM Detail | /propertyapi/v1.0.0/avm/detail |
| AVM Snapshot | /propertyapi/v1.0.0/avm/snapshot |
| Property Address | /propertyapi/v1.0.0/property/address |
| Property Detail | /propertyapi/v1.0.0/property/detail |
| Property ID | /propertyapi/v1.0.0/property/id |
| Property Snapshot | /propertyapi/v1.0.0/property/snapshot |
| Sale Detail | /propertyapi/v1.0.0/sale/detail |
| Sale Snapshot | /propertyapi/v1.0.0/sale/snapshot |
| Sales Trend Snapshot | /propertyapi/v1.0.0/salestrend/snapshot |
| School Details | /propertyapi/v1.0.0/school/detail |
| School District Details | /propertyapi/v1.0.0/school/districtdetail |
| School Snapshot | /propertyapi/v1.0.0/school/snapshot |
See Geocodes for more information
New GeoCode
The following endpoints currently provide geocodes for each property (geoid). These geocodes can then be used to request information for the area defined by each geocode. These endpoints have been enhanced to support the new geocodes (geoIdV4). If your applications are making use of the old geocodes it will be necessary to convert these to use the new geocodes (geoIdV4).
| Name | Endpoint |
| All Events Detail | /propertyapi/v1.0.0/allevents/detail |
| All Events Snapshot | /propertyapi/v1.0.0/allevents/snapshot |
| Assessment Detail | /propertyapi/v1.0.0/assessment/detail |
| Assessment History Detail | /propertyapi/v1.0.0/assessmenthistory/detail |
| Assessment Snapshot | /propertyapi/v1.0.0/assessment/snapshot |
| ATTOM AVM Detail | /propertyapi/v1.0.0/attomavm/detail |
| AVM Detail | /propertyapi/v1.0.0/avm/detail |
| AVM History Detail | /propertyapi/v1.0.0/avmhistory/detail |
| AVM Snapshot | /propertyapi/v1.0.0/avm/snapshot |
| Home Equity | /propertyapi/v1.0.0/valuation/homeequity |
| Property Address | /propertyapi/v1.0.0/property/address |
| Property Basic Profile | /propertyapi/v1.0.0/property/basicprofile |
| Property Building Permits | /propertyapi/v1.0.0/property/buildingpermits |
| Property Detail Mortgage | /propertyapi/v1.0.0/property/detailmortgage |
| Property Detail Mortgage Owner | /propertyapi/v1.0.0/property/detailmortgageowner |
| Property Detail Owner | /propertyapi/v1.0.0/property/detailowner |
| Property Detail | /propertyapi/v1.0.0/property/detail |
| Property Details With Schools | /propertyapi/v1.0.0/property/detailwithschools |
| Property Expanded Profile | /propertyapi/v1.0.0/property/expandedprofile |
| Property Snapshot | /propertyapi/v1.0.0/property/snapshot |
| Rental AVM | /propertyapi/v1.0.0/valuation/rentalavm |
| Sale Detail | /propertyapi/v1.0.0/sale/detail |
| Sale Snapshot | /propertyapi/v1.0.0/sale/snapshot |
| Sales History Basic History | /propertyapi/v1.0.0/saleshistory/basichistory |
| Sales History Expanded History | /propertyapi/v1.0.0/saleshistory/expandedhistory |
| Sales History Detail | /propertyapi/v1.0.0/saleshistory/detail |
| Sales History Snapshot | /propertyapi/v1.0.0/saleshistory/snapshot |
| Sales Trend Snapshot | /propertyapi/v1.0.0/salestrend/snapshot |
| School Details | /propertyapi/v1.0.0/school/detail |
| School District Details | /propertyapi/v1.0.0/school/districtdetail |
| School Snapshot | /propertyapi/v1.0.0/school/snapshot |
| Valuation Rental AVM | /propertyapi/v1.0.0/valuation/rentalavm |
See Geocodes for more information