Places Autocomplete

Returns up to 5 US address predictions for a typed address. Pass a prediction's `placeId` to the home valuation endpoint.

GET/v1/places/autocomplete

Authentication

Public key?key=pk_…

Public key in the `key` query parameter. No OAuth, no secret.

Edge cache: public, max-age=3600, s-maxage=86400, stale-while-revalidate=604800

Query Parameters

keystring

required

The site's public key (pk_…). It selects the account. Safe to ship to the browser.

qstring

required

The address typed so far, 3 to 120 characters. Shorter text returns an empty list without a lookup.

Responses

200Success

application/json

dataarray

Up to 5 rows: `query` is the address text, `placeId` goes to `GET /v1/home-valuation`, `type` is always `adddress` (sic).

availableboolean

False when the address provider is down. `data` is then empty.

Errors

400`q` is longer than 120 characters.

401Missing or invalid public key.

403The account is not active. The body also has `code: "TENANT_INACTIVE"`.

429Too many requests. The limit is 60 per minute per visitor IP and account. `Retry-After` is 60 seconds.

500Internal Server Error.

Notes

Predictions drop the unit number. Keep what the visitor typed and send it as `unit` to the valuation.
Answers are cached per normalized query for a day. A provider failure answers 200 with `available: false`.

Request

curl --request GET \
  --url "https://api.pandaidx.com/v1/places/autocomplete?key={{public_key}}&q=1200%20Brickell%20Bay%20Dr"

Response200 OK

{
  "data": [
    {
      "query": "1200 Brickell Bay Dr, Miami, FL, USA",
      "placeId": "ChIJexample0000000000000001",
      "type": "adddress"
    },
    {
      "query": "1200 Brickell Bay Drive Unit 2504, Miami, FL, USA",
      "placeId": "ChIJexample0000000000000002",
      "type": "adddress"
    }
  ],
  "available": true
}