PandaIDX

Condo Directory Bootstrap

Returns every directory area and, on request, the unfiltered first paint with landing rows and map pins. Documents keep the Panda website shape.

GET/v1/condos/directory

Authentication

Public key?key=pk_…

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

Edge cache: 5 s

Query Parameters

keystring
required

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

modeenum
optional

Which directory to load. Omit it to get `condo`.

Default:condo
condonewdev
initialstring
optional

Send `1` to also return `initial`: the landing rows per area and a sample of map pins. Any other value returns `initial: null`.

Responses

200Success
application/json
modeenum

`condo` or `newdev`.

allAreasarray

Every area of the directory, sorted by name. `query` is the uppercase name.

initialobject | null

With `initial=1`: `{ areasData, totalAreas, hasMore, mapPins }`. `areasData` holds the landing rows and `mapPins` a sample of building documents. Otherwise `null`.

countriesarray

In `newdev` mode, countries with projects as `{ countryShort, countryLong, count }`, US first. Empty in `condo` mode.

Errors

400`mode` is neither `condo` nor `newdev`.
401Missing or invalid public key.
403The account has no active subscription. The body also carries `code: "TENANT_INACTIVE"`.
500Unexpected server error.

Notes

  • The directory endpoints return the website's raw document shape (`buildingName`, `image2`, `reportData`). Use List Condos for a stable card contract.
  • Directory data is shared Panda data. The key only authorizes the call.
Request
curl --request GET \
  --url "https://api.pandaidx.com/v1/condos/directory?key={{public_key}}&mode=condo"
Response200 OK
{
  "mode": "condo",
  "allAreas": [
    {
      "_id": "62d07150ca8676650f0eaf90",
      "query": "MIAMI BEACH",
      "image2": "https://media.pandaidx.com/areas/miami-beach.jpg",
      "state": "FL",
      "buildingCount": 214
    }
  ],
  "initial": null,
  "countries": []
}