Outscraper API Docs

/whitepages-addresses

Returns insights about addresses and their residents.

Others
↗ Open in API Explorer
GET

Whitepages Addresses Scraper

Others

Returns insights about addresses and their residents.

Request

Endpoint: GET https://api.outscraper.cloud/whitepages-addresses

Parameters

NameInTypeRequiredDescriptionExampleConstraints
query query array<string> Yes Addresses (e.g., 321 California Ave, Palo Alto, CA 94306). It supports batching by sending arrays with up to 1000 queries (e.g., query=text1&query=text2&query=text3). It allows multiple queries to be sent in one request and to save on network latency time. - -

Responses

200

application/json

The response contains the status of the request and data. Data is an array where each element represents a response for a single query from the request.

{
  "id": "your-request-id",
  "status": "Success",
  "data": [
    {
      "query": "321 California Ave, Palo Alto, CA 94306"
    }
  ]
}

202

application/json

The response contains a request ID that can be used to fetch results by using Request Results endpoint. Each response is available for 4 hours after a request has been completed.

{
  "id": "your-request-id",
  "status": "Pending",
  "results_location": "https://api.outscraper.cloud/requests/your-request-id"
}

401

application/json

Wrong or missing API Key (token).

{
  "error": true,
  "errorMessage": "401 Unauthorized: The server could not verify that you are authorized to access the URL requested. You either supplied the wrong credentials (e.g. a bad password), or your browser doesn't understand how to supply the credentials required."
}

402

application/json

Past due invoices or a payment method not connected.

{
  "error": true,
  "errorMessage": "Please close past due invoices or verify your card information is correct."
}

422

application/json

Wrong query url parameters.

{
  "error": true,
  "errorMessage": "422 Unprocessable Entity: The request was well-formed but was unable to be followed due to semantic errors."
}

Code Samples

cURL

curl -X GET "https://api.outscraper.cloud/whitepages-addresses?query=321%20California%20Ave%2C%20Palo%20Alto%2C%20CA%2094306" -H  "X-API-KEY: YOUR-API-KEY"

Related Endpoints