Search for property by address
Changed onSearch 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.
Request
- Base URLhttps://api.whitepages.com
- AuthAPI key in header x-api-key
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
Street address including number and name
City name
Valid US State and Territory codes.
This enum contains all valid two-letter codes for US states and territories. Used for parameter validation in API requests.
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
Successful Response
Changes
- warning
added the new
landlineenum value to the///////response property for the response status - warning
added the new
landlineenum value to the/////response property for the response status - warning
added the new
mobileenum value to the///////response property for the response status - warning
added the new
mobileenum value to the/////response property for the response status - warning
added the new
tollfreeenum value to the///////response property for the response status - warning
added the new
tollfreeenum value to the/////response property for the response status - warning
added the new
unknownenum value to the///////response property for the response status - warning
added the new
unknownenum value to the/////response property for the response status - warning
added the new
voipenum value to the///////response property for the response status - warning
added the new
voipenum value to the/////response property for the response status - info
added the new optional
queryrequest parameterstrict_match - info
added the optional property
/to the response with the status - info
added the optional property
/to the response with the status - info
added the optional property
/to the response with the status - info
added the optional property
/////to the response with the status - info
added the optional property
/////to the response with the status - info
added the optional property
///////to the response with the status - info
added the optional property
/////to the response with the status - info
added the optional property
/////to the response with the status - info
added the optional property
///to the response with the status - info
added the optional property
/to the response with the status - info
added the optional property
/to the response with the status - info
added the optional property
///to the response with the status - info
added the optional property
///to the response with the status - info
added the optional property
/////to the response with the status - info
added the optional property
///to the response with the status - info
added the optional property
///to the response with the status - info
removed the
Landlineenum value from the///////response property for the response status - info
removed the
Landlineenum value from the/////response property for the response status - info
removed the
Mobileenum value from the///////response property for the response status - info
removed the
Mobileenum value from the/////response property for the response status - info
removed the
TollFreeenum value from the///////response property for the response status - info
removed the
TollFreeenum value from the/////response property for the response status - info
removed the
Unknownenum value from the///////response property for the response status - info
removed the
Unknownenum value from the/////response property for the response status - info
removed the
VOIPenum value from the///////response property for the response status - info
removed the
VOIPenum value from the/////response property for the response status - info
added the required property
///////to the response with the status - info
added the required property
/////to the response with the status
- warning
- breaking
the response property
/became nullable for the status - breaking
the response property
/became nullable for the status - breaking
the response property
/became optional for the status - breaking
the response property
/became optional for the status - breaking
the response property
/became optional for the status - breaking
the response property
/became optional for the status - info
removed the non-success response with the status
- info
removed
subschema #2from the/response propertyanyOflist for the response status - info
removed
subschema #2from the/response propertyanyOflist for the response status - info
the
response's property default value422was added for the status - info
the
response's property default value500was added for the status - info
the
response's property default valueInternal Server Errorwas added for the status - info
the
response's property default valueUnprocessable Entitywas added for the status - info
removed the
100.00enum value from the/response property for the response status - info
removed the
100.00enum value from the/response property for the response status - info
removed the
101.00enum value from the/response property for the response status - info
removed the
101.00enum value from the/response property for the response status - info
removed the
102.00enum value from the/response property for the response status - info
removed the
102.00enum value from the/response property for the response status - info
removed the
103.00enum value from the/response property for the response status - info
removed the
103.00enum value from the/response property for the response status - info
removed the
200.00enum value from the/response property for the response status - info
removed the
200.00enum value from the/response property for the response status - info
removed the
201.00enum value from the/response property for the response status - info
removed the
201.00enum value from the/response property for the response status - info
removed the
202.00enum value from the/response property for the response status - info
removed the
202.00enum value from the/response property for the response status - info
removed the
203.00enum value from the/response property for the response status - info
removed the
203.00enum value from the/response property for the response status - info
removed the
204.00enum value from the/response property for the response status - info
removed the
204.00enum value from the/response property for the response status - info
removed the
205.00enum value from the/response property for the response status - info
removed the
205.00enum value from the/response property for the response status - info
removed the
206.00enum value from the/response property for the response status - info
removed the
206.00enum value from the/response property for the response status - info
removed the
207.00enum value from the/response property for the response status - info
removed the
207.00enum value from the/response property for the response status - info
removed the
208.00enum value from the/response property for the response status - info
removed the
208.00enum value from the/response property for the response status - info
removed the
226.00enum value from the/response property for the response status - info
removed the
226.00enum value from the/response property for the response status - info
removed the
300.00enum value from the/response property for the response status - info
removed the
300.00enum value from the/response property for the response status - info
removed the
301.00enum value from the/response property for the response status - info
removed the
301.00enum value from the/response property for the response status - info
removed the
302.00enum value from the/response property for the response status - info
removed the
302.00enum value from the/response property for the response status - info
removed the
303.00enum value from the/response property for the response status - info
removed the
303.00enum value from the/response property for the response status - info
removed the
304.00enum value from the/response property for the response status - info
removed the
304.00enum value from the/response property for the response status - info
removed the
305.00enum value from the/response property for the response status - info
removed the
305.00enum value from the/response property for the response status - info
removed the
307.00enum value from the/response property for the response status - info
removed the
307.00enum value from the/response property for the response status - info
removed the
308.00enum value from the/response property for the response status - info
removed the
308.00enum value from the/response property for the response status - info
removed the
400.00enum value from the/response property for the response status - info
removed the
400.00enum value from the/response property for the response status - info
removed the
401.00enum value from the/response property for the response status - info
removed the
401.00enum value from the/response property for the response status - info
removed the
402.00enum value from the/response property for the response status - info
removed the
402.00enum value from the/response property for the response status - info
removed the
403.00enum value from the/response property for the response status - info
removed the
403.00enum value from the/response property for the response status - info
removed the
404.00enum value from the/response property for the response status - info
removed the
404.00enum value from the/response property for the response status - info
removed the
405.00enum value from the/response property for the response status - info
removed the
405.00enum value from the/response property for the response status - info
removed the
406.00enum value from the/response property for the response status - info
removed the
406.00enum value from the/response property for the response status - info
removed the
407.00enum value from the/response property for the response status - info
removed the
407.00enum value from the/response property for the response status - info
removed the
408.00enum value from the/response property for the response status - info
removed the
408.00enum value from the/response property for the response status - info
removed the
409.00enum value from the/response property for the response status - info
removed the
409.00enum value from the/response property for the response status - info
removed the
410.00enum value from the/response property for the response status - info
removed the
410.00enum value from the/response property for the response status - info
removed the
411.00enum value from the/response property for the response status - info
removed the
411.00enum value from the/response property for the response status - info
removed the
412.00enum value from the/response property for the response status - info
removed the
412.00enum value from the/response property for the response status - info
removed the
413.00enum value from the/response property for the response status - info
removed the
413.00enum value from the/response property for the response status - info
removed the
413.00enum value from the/response property for the response status - info
removed the
413.00enum value from the/response property for the response status - info
removed the
414.00enum value from the/response property for the response status - info
removed the
414.00enum value from the/response property for the response status - info
removed the
414.00enum value from the/response property for the response status - info
removed the
414.00enum value from the/response property for the response status - info
removed the
415.00enum value from the/response property for the response status - info
removed the
415.00enum value from the/response property for the response status - info
removed the
416.00enum value from the/response property for the response status - info
removed the
416.00enum value from the/response property for the response status - info
removed the
416.00enum value from the/response property for the response status - info
removed the
416.00enum value from the/response property for the response status - info
removed the
417.00enum value from the/response property for the response status - info
removed the
417.00enum value from the/response property for the response status - info
removed the
418.00enum value from the/response property for the response status - info
removed the
418.00enum value from the/response property for the response status - info
removed the
421.00enum value from the/response property for the response status - info
removed the
421.00enum value from the/response property for the response status - info
removed the
422.00enum value from the/response property for the response status - info
removed the
422.00enum value from the/response property for the response status - info
removed the
422.00enum value from the/response property for the response status - info
removed the
422.00enum value from the/response property for the response status - info
removed the
423.00enum value from the/response property for the response status - info
removed the
423.00enum value from the/response property for the response status - info
removed the
424.00enum value from the/response property for the response status - info
removed the
424.00enum value from the/response property for the response status - info
removed the
425.00enum value from the/response property for the response status - info
removed the
425.00enum value from the/response property for the response status - info
removed the
426.00enum value from the/response property for the response status - info
removed the
426.00enum value from the/response property for the response status - info
removed the
428.00enum value from the/response property for the response status - info
removed the
428.00enum value from the/response property for the response status - info
removed the
429.00enum value from the/response property for the response status - info
removed the
429.00enum value from the/response property for the response status - info
removed the
431.00enum value from the/response property for the response status - info
removed the
431.00enum value from the/response property for the response status - info
removed the
451.00enum value from the/response property for the response status - info
removed the
451.00enum value from the/response property for the response status - info
removed the
500.00enum value from the/response property for the response status - info
removed the
500.00enum value from the/response property for the response status - info
removed the
501.00enum value from the/response property for the response status - info
removed the
501.00enum value from the/response property for the response status - info
removed the
502.00enum value from the/response property for the response status - info
removed the
502.00enum value from the/response property for the response status - info
removed the
503.00enum value from the/response property for the response status - info
removed the
503.00enum value from the/response property for the response status - info
removed the
504.00enum value from the/response property for the response status - info
removed the
504.00enum value from the/response property for the response status - info
removed the
505.00enum value from the/response property for the response status - info
removed the
505.00enum value from the/response property for the response status - info
removed the
506.00enum value from the/response property for the response status - info
removed the
506.00enum value from the/response property for the response status - info
removed the
507.00enum value from the/response property for the response status - info
removed the
507.00enum value from the/response property for the response status - info
removed the
508.00enum value from the/response property for the response status - info
removed the
508.00enum value from the/response property for the response status - info
removed the
510.00enum value from the/response property for the response status - info
removed the
510.00enum value from the/response property for the response status - info
removed the
511.00enum value from the/response property for the response status - info
removed the
511.00enum value from the/response property for the response status
- breaking