Finds contact information for a business, based on location and either name or category.
parameter_list signifies one or more parameter=value entries separated by semicolons and
API_KEYVAL is the API key value you received when you registered.
Parameters can appear in any order. Parameter names are case-sensitive; parameter values case-insensitive. For example "lastname=smith" matches "Smith", but "Lastname=smith" is not a valid parameter assignment, since the parameter name is (all lower case) lastname and not (capitalized) Lastname.
|| See Note about required parameters
|category||yes|| See Note about required parameters
directional prefix or suffix
|state||no||USPS two-character abbreviation||state=wa|
|zip||no||will accept 5 digit ZIP Code or 9 digit ZIP+4||zip=98101|
|metro||no||Whether to expand the search to the metro area. The default value is 0 (false) which means searches are not expanded to metro area by default.||metro=1|
Note that either the
businessname or the
category parameter is required. In most cases, we recommend providing as much information as you have since that will give better results and faster response. However, only one of the parameters
category should be supplied, as searches with both of these parameters will generally not produce results.
Note that the usual address line spans two parameters. The house number is separated from the street name. For a typical address such as 2468 East Main St, this would make the
house parameter 2468 and the
street parameter "East Main St". Of course, spaces in the street name should be encoded as %20 for passing over HTTP, so the
street parameter as passed to the API would be "East%20Main%20St"
metro parameter is a Boolean value where 1 signifies true or 0 signifies false. It specifies whether to expand the search to include the metropolitan area around the specified
city parameter value.
If a find_business search using a
categroy parameter is ambiguous, the return will be a picklist of possible categories.
A find_business search will return at most 20 listings using a WhitePages Pro API Test Account. Additional listings may be available by following one of the URLs returned as links with a successful search.
The following example specifies a search for Pizza businesses in Seattle, Washington.
Copyright © 2011 WhitePages.com. All rights reserved.
- WhitePages Pro API Test Account Documentation
- JSON Output
- Data Dictionary
- XML Schema Definition
- Frequently Asked Questions (FAQ)