People Search

People Search finds people by name and demographic criteria rather than by property, which makes it the endpoint for list building and segmentation.

POST/v2/PeopleSearch

Search people

Request attributes

Name
first_name
Type
string
Description
First name to match.
Name
middle_name
Type
string
Description
Middle name to match.
Name
last_name
Type
string
Description
Last name to match.
Name
streetName
Type
string
Description
Street name to match.
Name
city
Type
string
Description
City to search.
Name
state
Type
string
Description
Two-character state code.
Name
zip
Type
string
Description
Five-digit ZIP code.
Name
age_range_min
Type
number
Description
Minimum age.
Name
age_range_max
Type
number
Description
Maximum age.
Name
gender
Type
string
Description
Gender to filter on.
Name
ethnicity_code
Type
string
Description
Ethnicity code to filter on.
Name
marital_status_code
Type
string
Description
Marital status code to filter on.
Name
occupationCode
Type
integer
Description
Occupation code to filter on.
Name
count
Type
string
Description
Return only the number of matches.
Name
size
Type
string
Description
Results per page.
Name
resultIndex
Type
string
Description
Offset to start from.

Request

POST

/v2/PeopleSearch

curl -X POST https://api.realestateapi.com/v2/PeopleSearch \
  -H "x-api-key: $REALESTATEAPI_KEY" \
  -H "Content-Type: application/json" \
  -d '{"city": "Austin", "state": "TX", "count": true}'

The full response schema for this endpoint — every field and enum — lives in the canonical reference. That content has not been ported to this site yet.