Search Suggestions

Returns the hero search dropdown: the autocomplete rows plus smart suggestions parsed from natural text, such as "2 beds miami condos".

GET/v1/suggestions

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. Trimmed and cut at 200 characters.

Responses

200Success

application/json

dataarray | false

The same rows as `GET /v1/autocomplete`, or false when nothing matched.

aiSuggestionsarray

Up to 10 smart suggestions, each with a ready `searchParams` object.

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

`searchParams` uses the AI search shape: send `autocomplete.query` as `q` and `autocomplete.type` as `qtype` in `GET /v1/search`, and the other keys as filters.
Not rate limited, like `GET /v1/autocomplete`.

Request

curl --request GET \
  --url "https://api.pandaidx.com/v1/suggestions?key={{public_key}}&q=2%20beds%20miami%20condos"

Response200 OK

{
  "type": "success",
  "data": false,
  "aiSuggestions": [
    {
      "query": "MIAMI",
      "type": "smartSuggestion",
      "displayText": "Miami FL 2 Beds Condos",
      "mainText": "Miami FL 2 Beds Condos",
      "secondaryText": "in MIAMI, FL",
      "searchParams": {
        "minbeds": 2,
        "maxbeds": 2,
        "subtypes": [
          "Condominium"
        ],
        "autocomplete": {
          "query": "MIAMI",
          "type": "city"
        }
      },
      "score": 100,
      "image2": "https://example.com/images/miami.jpg"
    }
  ]
}