Condo Directory Search

Runs the Panda website directory search and returns a page of buildings, the map pins, the area outline and the total. Parameter names follow the website, not List Condos.

GET/v1/condos/directory/buildings

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.

citiesstring

optional

Comma-separated city names, such as `Miami,Miami Beach`. Case does not matter. Matched as OR.

areastring

optional

A single city name as stored, such as `Miami Beach`. Ignored when `cities` is sent. Prefer `cities`.

searchNamestring

optional

Building name. Ranked by relevance unless `exact=1`.

exactstring

optional

Send `1` to match `searchName` as an exact phrase.

postalCodestring

optional

A single postal code.

statusenum

optional

Which price range the price filters and price sorts read.

Default:forSale

forSaleforRent

minpricenumber

optional

USD. Building minimum asking price at least this value.

maxpricenumber

optional

USD. Building maximum asking price at most this value.

minbedsnumber

optional

Minimum bedrooms.

maxbedsnumber

optional

Maximum bedrooms.

minbathsnumber

optional

Minimum bathrooms.

maxbathsnumber

optional

Maximum bathrooms.

minareanumber

optional

Minimum living area in square feet.

maxareanumber

optional

Maximum living area in square feet.

typesstring

optional

Comma-separated property subtypes, matched as OR.

featuresstring

optional

Comma-separated boolean building fields that must be true, such as `petFriendly`, `gated`, `seniorCommunity`.

amenitiesstring

optional

Comma-separated amenity names: `Pool`, `Gym`, `Concierge`, `Valet Parking`, `Tennis`, `Spa`, `Sauna`, `Rooftop`, `Clubhouse`, `Business Center`, `Playground`, `BBQ Area`, `Marina`, `Golf`.

viewsstring

optional

Comma-separated views: `Ocean Front`, `Ocean Access`, `Ocean View`, `Bay`, `Intracoastal`, `Canal`, `Lake`, `Garden`.

minyearnumber

optional

Earliest year built.

maxyearnumber

optional

Latest year built.

minstoriesnumber

optional

Minimum stories.

maxstoriesnumber

optional

Maximum stories.

minunitsnumber

optional

Minimum units.

maxunitsnumber

optional

Maximum units.

communitystring

optional

Send `1` to include communities (groups of homes) next to the other `types` matches.

forceNewdevstring

optional

Send `1` to search new developments instead of resale condos.

countrystring

optional

ISO country code. Only used with `forceNewdev=1`. `US` also includes projects without a country.

pointsstring

optional

A drawn polygon or viewport as `lat,lng|lat,lng|...` with at least 3 points. Limits buildings and map pins to that shape.

sortstring

optional

Website sort value: `buildingName`, `-buildingName`, `newest`, `minPrice`, `-minPrice`, `maxPrice`, `-maxPrice`, `minBeds`, `minBaths`, `yearBuilt` or `-yearBuilt`.

Default:buildingName

offsetnumber

optional

Items to skip. Negative values become 0.

Default:0

limitnumber

optional

Items per page. Values above 200 are clamped to 200.

Default:40

skipMapstring

optional

Send `1` to skip the random map sample. `mapData` then only repeats the items of `data`.

skipBoundsstring

optional

Send `1` to skip the area outline and return `bounds: null`.

Responses

200Success

application/json

dataarray

Building documents for the requested page, in the website shape.

mapDataarray

Map pins: a random sample of up to 200 matches plus every item of `data`.

totalnumber

Buildings matching the filters.

boundsobject | null

GeoJSON outline of the single city or the drawn polygon, otherwise `null`.

offsetnumber

limitnumber

hasMoreboolean

True when `offset + limit` is below `total`.

Errors

401Missing or invalid public key.

403The account has no active subscription. The body also carries `code: "TENANT_INACTIVE"`.

500Unexpected server error.

Notes

Use `cities`, not `city`. This endpoint takes the website parameter names, which differ from List Condos.
Private admin fields such as the lead agent and data feeds are removed from every document.
Prefer List Condos for new work. It validates its input and returns a stable card shape.

Request

curl --request GET \
  --url "https://api.pandaidx.com/v1/condos/directory/buildings?key={{public_key}}&cities=Miami"

Response200 OK

{
  "data": [
    {
      "_id": "6a0b2f4e8c1d3a0012ab34c1",
      "type": "building",
      "buildingName": "OCEAN DRIVE TOWER",
      "city": "Miami Beach",
      "address": "1200 Ocean Dr",
      "image2": "https://media.pandaidx.com/buildings/ocean-drive-tower/cover.jpg",
      "location": {
        "type": "Point",
        "coordinates": [
          -80.1301,
          25.7807
        ]
      },
      "forSaleMinPrice": 485000,
      "forSaleMaxPrice": 2250000,
      "reportData": {
        "forSaleResidential": {
          "today": 12
        },
        "forRentResidential": {
          "today": 9
        }
      }
    }
  ],
  "mapData": [
    {
      "_id": "6a0b2f4e8c1d3a0012ab34c1",
      "buildingName": "OCEAN DRIVE TOWER",
      "city": "Miami Beach",
      "location": {
        "type": "Point",
        "coordinates": [
          -80.1301,
          25.7807
        ]
      }
    }
  ],
  "total": 96,
  "bounds": null,
  "offset": 0,
  "limit": 40,
  "hasMore": true
}