Introducing Webhooks — Get real-time property deed updates delivered to you. Learn more →
Whitepages
DocumentationReferences
Property V2

Search for property by address

Search for property by address parameters.

GET
/v2/property/

Authorization

ApiKeyAuth

x-api-key<token>

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

In: header

Query Parameters

street?Street Address|Street Address

Street address including number and name

Example"123 Main St"
Example"456 Oak Avenue"
city?City|City

City name

Example"Seattle"
Example"Portland"
Example"San Francisco"
state_code?StateCodeEnum|State Code

Two-letter state code

Example"WA"
Example"OR"
Example"CA"
zipcode?ZIP Code|ZIP Code

5

Example"98101"
Example"60616"

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://api.whitepages.com/v2/property/"
{
  "result": {
    "property_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
    },
    "ownership_info": {
      "owner_type": "string",
      "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": 400,
    "message": "Short error message",
    "long_message": "The request was malformed",
    "meta": {
      "field": "email",
      "validation_error": "Invalid email format"
    }
  },
  "wp_trace_id": "550e8400-e29b-41d4-a716-446655440000"
}
{
  "error": {
    "code": 400,
    "message": "Short error message",
    "long_message": "The request was malformed",
    "meta": {
      "field": "email",
      "validation_error": "Invalid email format"
    }
  },
  "wp_trace_id": "550e8400-e29b-41d4-a716-446655440000"
}
{
  "error": {
    "code": 400,
    "message": "Short error message",
    "long_message": "The request was malformed",
    "meta": {
      "field": "email",
      "validation_error": "Invalid email format"
    }
  },
  "wp_trace_id": "550e8400-e29b-41d4-a716-446655440000"
}

Get property details by ID GET

Retrieve detailed property information by Whitepages property ID. Returns comprehensive property data including physical characteristics, tax assessment information, ownership details, mortgage history, predictive insights, and current residents.

Retrieve usage data for a specific time range GET

Retrieve API usage data for a specified date range. Returns daily usage statistics including request counts for each day within the specified time period. The response includes both individual daily usage data and total usage for the entire period. - The request count is total number of requests made including 2xx, 4xx and 5xx responses. It is not the same as billable requests which is not available right now as part of API. - Maximum date range allowed: 90 days - Dates are in UTC format - Current day data when requested will be updated during the day - Usage data is updated approximately every 30 minutes - Usage data is returned only from the first date of actual usage in the specified duration