PandaIDX

Condo Directory Landing Rows

Returns the landing rows of the directory: the first buildings of each eligible area. Use it to load the directory landing page with infinite scroll.

GET/v1/condos/directory/areas

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.

perAreanumber
optional

Buildings returned per area.

Default:6
offsetnumber
optional

Areas to skip.

Default:0
limitnumber
optional

Areas to return. Values above 200 are clamped to 200.

Default:5
statusenum
optional

Which price range the price filters read.

Default:forSale
forSaleforRent
forceNewdevstring
optional

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

excludeNewdevstring
optional

Send `1` to leave new developments out.

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.

Responses

200Success
application/json
dataarray

Landing rows. Areas with too few matching buildings are left out.

totalAreasnumber

Eligible areas before paging.

hasMoreboolean

True when more areas can be loaded with a higher `offset`.

Errors

401Missing or invalid public key.
403The account has no active subscription. The body also carries `code: "TENANT_INACTIVE"`.
500Unexpected server error.

Notes

  • Only areas with at least 7 buildings are eligible (2 new developments with `forceNewdev=1`).
  • Use `offset` and `limit` to page by area. The response does not take `page`.
Request
curl --request GET \
  --url "https://api.pandaidx.com/v1/condos/directory/areas?key={{public_key}}"
Response200 OK
{
  "data": [
    {
      "area": "Miami Beach",
      "totalCount": 214,
      "buildings": [
        {
          "_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",
          "forSaleMinPrice": 485000,
          "forSaleMaxPrice": 2250000
        }
      ]
    }
  ],
  "totalAreas": 18,
  "hasMore": true
}