reverse_address Search
Finds information based on an address.
Syntax
http://api.whitepages.com/reverse_address/1.0/?parameter_list;api_key=API_KEY
where parameter_list signifies one or more parameter=value entries separated by semicolons and API_KEY is the API key you received when you registered.
Parameters
Parameters can appear in any order. Parameter names are case-sensitive; parameter values case-insensitive. For example "state=wa" is equivalent to "state=WA", but "State=WA" is not a valid parameter assignment.
| Parameter | Required? | Notes | Example |
|---|---|---|---|
| house | No | Can take a range, in the form [start-end] | house=2468 house=[100-210] |
| apt | No | apt=2a | |
| street | Yes | street=maple%20st | |
| city | No | city=seattle | |
| state | See remarks | state=wa | |
| zip | See remarks | zip=98101 | |
| areacode | See remarks | areacode=206 |
Remarks
At least one of the state, zip, or areacode parameters must be specified.
Note that only the street parameter and one of the state, zip, or areacode parameters is required. However, we recommend providing as much information as you have as that will give better results and faster response.
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"
Limitations
A reverse_address search will return at most 10 listings using the WPAPI. Additional listings may be available by following one of the URLs returned as links with a successful search.
Example
The following example specifies a search for the address 2468 Main St, Seattle, Washington.
http://api.whitepages.com/reverse_address/1.0/?house=2468;street=main%20st;city=seattle;state=wa;api_key=API_KEYVAL
Return to the main documentation page
Copyright © 2008 WhitePages.com. All rights reserved.
Comments