Autocomplete

Returns search box suggestions for a typed text: cities, ZIP codes, buildings, MLS numbers and addresses. Use `type` and `query` of a row as `qtype` and `q` in `GET /v1/search`.

GET/v1/autocomplete

Authentication

Public key?key=pk_…

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

Edge cache: no-store

Query Parameters

keystring

required

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

qstring

optional

The text typed so far. Needs 3 or more characters for area and building matches. Also understands `mls 123456` and `unit 4A`.

variantenum

optional

Limits results for the condo directory: areas with buildings, and buildings (`condo-directory`) or new developments (`condo-directory-newdev`).

condo-directorycondo-directory-newdev

Responses

200Success

application/json

dataarray | false

Suggestion rows, or false when nothing matched. A row has `query`, `type` and extra fields by type (`image2`, `slug`, `city`, `placeId`, `subtitle`, `OriginatingSystemKey`).

originstring

`catalog` or `google` (address fallback). Absent for MLS number and unit answers.

aiSuggestionsarray

Always empty here. Smart suggestions come from `GET /v1/suggestions`.

typestring

Always `success`.

Errors

401Missing or invalid public key.

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

404MLS number lookups only: the account has no MLS data feed.

500Internal Server Error.

Notes

Row types: `city`, `postalCode`, `building`, `newdevelopment`, `adddress` (sic), `mlsNumber` and `unit`.
Only addresses that match no area or building call Google Places, and they return at most 2 rows.
It runs on every keystroke and is not rate limited. Debounce it on your side.

Request

curl --request GET \
  --url "https://api.pandaidx.com/v1/autocomplete?key={{public_key}}&q=Miami"

Response200 OK

{
  "data": [
    {
      "query": "MIAMI",
      "type": "city",
      "image2": "https://example.com/images/miami.jpg",
      "buildingCount": 412
    },
    {
      "query": "MIAMI BEACH",
      "type": "city",
      "image2": "https://example.com/images/miami-beach.jpg",
      "buildingCount": 268
    }
  ],
  "aiSuggestions": [],
  "origin": "catalog",
  "type": "success"
}