New: look up a phone number on its own endpoint, businesses included. See what's changed →
Whitepages Pro API
DocumentationReferencesChangelog
Property

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.

GET
/v2/property/{property_id}

Authorization

ApiKeyAuth
x-api-key<token>

API key for authentication. Get your key from the Whitepages developer portal.

In: header

Path Parameters

property_id*Property or Address ID

Whitepages property identifier (capital 'R' prefix) or address identifier (capital 'A' prefix). Both are 11 characters long.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v2/property/RkzQlEj2kmg"
{
  "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"
    },
    "geolocation": {
      "lat": 0,
      "lng": 0
    },
    "year_built": 0,
    "effective_year_built": 0,
    "property_purpose": "string",
    "living_sqft": 0,
    "lot_sqft": 0,
    "ground_floor_sqft": 0,
    "basement_sqft": 0,
    "basement_type": "string",
    "stories": 0,
    "bedrooms": 0,
    "bathrooms": 0,
    "has_pool": true,
    "garage_type": "string",
    "roof_covering": "string",
    "heating_fuel": "string",
    "condition": "string",
    "build_quality": "string",
    "owner_occupied": "OwnerOccupied",
    "is_vacant": true,
    "assessed_info": {
      "market_value": 0,
      "assessed_value": 0,
      "property_tax_amount": 0,
      "property_tax_percent": 0
    },
    "ownership_info": {
      "owner_type": "string",
      "sale_date": "string",
      "last_sale_amount": 0,
      "mortgages": [],
      "business_owners": [],
      "person_owners": []
    },
    "residents": []
  }
}
{
  "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": 404,
    "message": "Not Found",
    "long_message": "Person id not found: PABcd12345e",
    "meta": null
  },
  "wp_trace_id": "0c57473114bd49b3b3c4b585df624f2f"
}
{
  "error": {
    "code": 422,
    "message": "Unprocessable Entity",
    "long_message": "The request contains semantic errors and cannot be processed",
    "meta": null
  },
  "wp_trace_id": "7e5f2c9a1d8b4e6f9c0a3b5d7e1f2a4c"
}
{
  "message": "Too Many Requests",
  "error": "usage_cap_exceeded",
  "error_instance_id": "1b9d6bcd-bbfd-4b2d-9b5d-ab8dfbbd4bed",
  "limit": 1000,
  "used": 1000,
  "reset_at": "2026-09-01T00:00:00+00:00",
  "upgrade_url": "https://www.whitepages.com/billing/manage-plan/pro-api"
}
{
  "error": {
    "code": 500,
    "message": "Internal Server Error",
    "long_message": "An internal server error occurred",
    "meta": null
  },
  "wp_trace_id": "9c1a4e7f2b8d4c6a9e0f3b5d7c1a2e4f"
}

Related

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.

Entity Shapes by Context

The same entity comes back in different shapes depending on the endpoint. Do not assume one shape.

Property Search API

Get ownership and resident data for any property

Authentication

Learn how to authenticate your requests to the Whitepages Pro API.

Gets person details by id GET

Retrieve detailed person information by Whitepages person ID.

Search for property by address GET

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.