Property API
Description
Provides comprehensive homeowner and property details, including owner name and address, estimated home value, building size, property type, and more.
Request URL
https://api.rrdblive.com/DDM/WebService.cfc?method=process
Supported HTTP methods: GET or POST
Authentication Parameters
| ClientID | Your "Client ID" |
| CWSID | Your "Client Web Service ID" |
| Token | A token that is authorized to process this web service request |
Required Parameters
| MailAddress1 | Property's street address |
| PostalZipCode | Property's zip code |
Optional Parameters
| MailAddress2 | Property's street address line 2 (if applicable) |
| CityName | Property's city name |
| ProvinceStateName | Property's state name or code |
Parameters may be passed as either URL query parameters or posted as FORM fields
Response JSON
{
"success": true,
"errors": [],
"dataIn": [
{
"MailAddress1": "",
"MailAddress2": "",
"CityName": "",
"ProvinceStateName": "",
"PostalZipCode": ""
}
] ,
"dataOut": [
{
"CityName": "",
"MailAddress1": "",
"MailAddress2": "",
"PostalZipCode": "",
"PROP_BathroomsCount": "",
"PROP_BedroomsCount": "",
"PROP_BuildingSQFT": "",
"PROP_EstimatedValue": "",
"PROP_HVACHeating": "",
"PROP_LotSQFT": "",
"PROP_OwnerCityName": "",
"PROP_OwnerFullName": "",
"PROP_OwnerMailAddress1": "",
"PROP_OwnerPostalZipCode": "",
"PROP_OwnerProvinceStateName": "",
"PROP_PropertyType": "",
"PROP_StoriesCount": "",
"PROP_TaxAssessedValue": "",
"PROP_TaxAssessedYear": "",
"PROP_YearBuilt": "",
"ProvinceStateName": ""
}
]
}
Response Keys
| Key | Description |
|---|---|
| success | "true" if request was successful / "false" if errors occurred |
| errors | If "success" was "false", will contain an array of error objects. See below for sample error response. |
| dataIn | The original input data |
| dataOut | If "success" was "true", will return the phone validation results |
"dataOut" Fields
| Name | Description |
|---|---|
| CityName | Property's city name |
| MailAddress1 | Property's street address |
| MailAddress2 | Property's street address line 2 (if applicable) |
| PostalZipCode | Property's zip code |
| PROP_BathroomsCount | Property: Number of bathrooms (Integer) |
| PROP_BedroomsCount | Property: Number of bedrooms (Integer) |
| PROP_BuildingSQFT | Property: Square footage of all living areas (Integer) |
| PROP_EstimatedValue | Property: Estimated value of the property (Integer) |
| PROP_HVACHeating | Property: System used to provide heating (String 255) |
| PROP_LotSQFT | Property: Square footage of the property’s lot (Integer) |
| PROP_OwnerCityName | Property: Owner’s city name |
| PROP_OwnerFullName | Property: Owner’s full name |
| PROP_OwnerMailAddress1 | Property: Owner’s street address |
| PROP_OwnerPostalZipCode | Property: Owner’s zip code (may be zip+4) |
| PROP_OwnerProvinceStateName | Property: Owner’s state code |
| PROP_PropertyType | Property: Use type (String 255) |
| PROP_StoriesCount | Property: Number of stories (String) E.G. 1, 1.5, 2+B, B/L+B |
| PROP_TaxAssessedValue | Property: Tax assessment value (Integer) |
| PROP_TaxAssessedYear | Property: Tax assessment year (YYYY) |
| PROP_YearBuilt | Property: Year built (YYYY) |
| ProvinceStateName | Property's state name or code |
Sample Error Response JSON
{
"success": false,
"errors": [
{
"errorID": 1000,
"errorHeader": "Authentication Failed",
"errorMessage": "API user access denied"
}
]
}
4xx HTTP Status Code will be returned for all of the following:
| errorID | errorHeader | errorMessage |
|---|---|---|
| 400 | API Error | Depends on the cause of error |
| 403 | API Error | This API supports HTTPS only |
| 500 | Unexpected Error | Depends on the cause of error |
| 1000 | Authentication Failed | Depends on the cause of error |
| 2000 | Validation Error | Required fields are missing or blank |
| 35030 | Web Service Error | Active web service was not found |
| 35040 | Web Service Error | The supplied Token is not authorized for use with this CWSID |
| 35050 | Web Service Error | No data was submitted |
| 35060 | Web Service Error | Depends on the cause of error |
| 35070 | Web Service Error | This web service supports only one record at a time |