Search for property by address
Search for property by address parameters. Returns basic property information including property_id, address, owner, and resident details. For comprehensive property details including physical characteristics, tax assessments, and mortgage history, use the returned property_id with the "Get property details by ID" endpoint (/v2/property/{property_id}). Search ranks by text relevance, so the closest match to an address that does not exist may be a different property on the same street. Pass `strict_match=true` to receive only the address supplied or an address in the same building; it needs a street to match against, so a request setting it without one is rejected.
Authorization
ApiKeyAuth API key for authentication. Get your key from the Whitepages developer portal.
In: header
Query Parameters
Street address including number and name
City name
Two-letter state code
5
Return only the address supplied or an address in the same building. Nearby and best-fit results are dropped and the response is a 404. Requires 'street'.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/v2/property/"{
"result": {
"property_id": "string",
"address_id": "string",
"apn": "string",
"property_address": {
"full_address": "string",
"line1": "string",
"city": "string",
"state": "string",
"zip": "string",
"house": "string",
"street": "string",
"street_type": "string",
"county": "string"
},
"mailing_address": {
"full_address": "string",
"line1": "string",
"city": "string",
"state": "string",
"zip": "string",
"house": "string",
"street": "string",
"street_type": "string",
"county": "string"
},
"property_purpose": "string",
"owner_occupied": "OwnerOccupied",
"is_vacant": true,
"geolocation": {
"lat": 0,
"lng": 0
},
"ownership_info": {
"owner_type": "string",
"sale_date": "string",
"business_owners": [],
"person_owners": []
},
"residents": [],
"property_metadata": {
"confidence_score": 0,
"match_type": "exact",
"details_url": "string"
}
}
}{
"error": {
"code": 400,
"message": "Bad Request",
"long_message": "Invalid person ID format: 'sdf'. Person ID must start with 'P' followed by exactly 10 alphanumeric characters. Example: 'PABcd12345e' or 'P1234567890'.",
"meta": null
},
"wp_trace_id": "3b0b537a60d84057817bb40563ca5c99"
}{
"message": "Forbidden"
}{
"error": {
"code": 422,
"message": "Unprocessable Entity",
"long_message": "The request contains semantic errors and cannot be processed",
"meta": null
},
"wp_trace_id": "7e5f2c9a1d8b4e6f9c0a3b5d7e1f2a4c"
}{
"error": {
"code": 500,
"message": "Internal Server Error",
"long_message": "An internal server error occurred",
"meta": null
},
"wp_trace_id": "9c1a4e7f2b8d4c6a9e0f3b5d7c1a2e4f"
}Related
Property Search API
Get ownership and resident data for any property
Capability Map
Map a user's intent to the exact endpoint and parameters that answer it.
Get property details by ID
Retrieve detailed property information by Whitepages property ID. Accepts either a Whitepages property ID (prefix `R`) or an address ID (prefix `A`). Address IDs are resolved to the associated property before lookup. This endpoint returns comprehensive property data including physical characteristics, tax assessment information, ownership details, mortgage history, predictive insights, and current residents. To obtain a property_id, first use the "Search for property by address" endpoint (/v2/property/), which returns basic property information including the property_id needed for this request.
Authentication
Learn how to authenticate your requests to the Whitepages Pro API.
Rate Limits
Understand the rate limiting policies for the Whitepages Pro API, including monthly query limits and trial exhaustion.
Get property details by ID GET
Retrieve detailed property information by Whitepages property ID. Accepts either a Whitepages property ID (prefix `R`) or an address ID (prefix `A`). Address IDs are resolved to the associated property before lookup. This endpoint returns comprehensive property data including physical characteristics, tax assessment information, ownership details, mortgage history, predictive insights, and current residents. To obtain a property_id, first use the "Search for property by address" endpoint (/v2/property/), which returns basic property information including the property_id needed for this request.
Look up what is known about a phone number GET
Retrieve the number's own facts and the parties associated with it. Several spellings of one number address this resource, so the canonical form goes out in `Content-Location` for a caller normalizing on their side. A path segment that is not a North American number is rejected before any upstream call.