Autocomplete Catalog

Returns the compact catalog of cities, ZIP codes, buildings and new developments used by autocomplete, so a site can filter suggestions in the browser without a request per keystroke.

GET/v1/autocomplete-catalog

Authentication

Public key?key=pk_…

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

Edge cache: public, max-age=60, s-maxage=300, stale-while-revalidate=60

Query Parameters

keystring

required

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

Responses

200Success

application/json

versionnumber

Catalog format version. Currently 1.

generatedAtnumber

When the catalog was built, in milliseconds since the Unix epoch.

itemsarray

Suggestion rows of type `city`, `postalCode`, `building` or `newdevelopment`.

Errors

401Missing or invalid public key.

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

500Internal Server Error.

Notes

The catalog is the same for every account and holds no listing data. It still needs a valid public key.
Cache it for a few minutes and match typed text against `items[].query`. Use `GET /v1/autocomplete` for MLS numbers and addresses.
The response has the header `X-Autocomplete-Catalog: 1`.

Request

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

Response200 OK

{
  "version": 1,
  "generatedAt": 1760400000000,
  "items": [
    {
      "query": "MIAMI",
      "type": "city",
      "image2": "https://example.com/images/miami.jpg",
      "buildingCount": 412
    },
    {
      "query": "33131",
      "type": "postalCode"
    },
    {
      "query": "BAY HARBOR TOWERS",
      "type": "building",
      "address": "1200 BRICKELL BAY DR",
      "city": "MIAMI",
      "slug": "bay-harbor-towers",
      "postalCode": "33131"
    }
  ]
}