Get Condo Area

Returns one area of the condo directory with its profile, directory stats, market counters, neighborhood scores and a page of its buildings.

GET/v1/condos/areas/:slug

Authentication

Public key?key=pk_…

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

Edge cache: 5 s

Path Parameters

slugstring

required

The area slug, from `areas[].slug` of List Condos, such as `miami-beach`.

Query Parameters

keystring

required

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

pagenumber

optional

Page number, starting at 1. Values above 500 are clamped to 500.

Default:1

pageSizenumber

optional

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

Default:24

Responses

200Success

application/json

areaobject

The area profile.

statsobject | null

Directory stats: `totalBuildings`, `avgListPrice`, `avgPricePerSqft`, `avgRentPrice`, `avgRentPerSqft`, `minSalePrice`, `maxSalePrice`, `minRentPrice`, `maxRentPrice`, `condoCount`, `singleFamilyCount`, `townhouseCount`, `newDevCount`, `poolCount`, `gymCount`, `petFriendlyCount`, `waterfrontCount`, `gatedCount`. Each value can be `null`. The example shows a subset.

marketobject

Counters for `forSale`, `forRent`, `pending`, `sold`, `singleFamily` and `seasonalRentals`. Each is `{ today, change }`, where `change` is the percent change or `null`. The example shows a subset.

neighborhoodobject | null

Walk, bike and transit scores as `{ score, label }`, plus short text highlights: `groceries`, `restaurants`, `coffeeShops`, `nightLife`, `artsCulture`, `gyms`, `dogFriendly`, `familyFriendly`, `parks`. The example shows a subset.

buildingsarray

Buildings of the area sorted by name.

totalnumber

Buildings in the area.

pagenumber

pageSizenumber

totalPagesnumber

Errors

404The area does not exist or the slug is malformed. The body is `{ "message": "Area not found" }`.

401Missing or invalid public key.

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

500Unexpected server error.

Notes

The slug is turned into the stored area name by replacing hyphens with spaces, so `miami-beach` finds MIAMI BEACH.
`boundary` is `null` in the example. When known it is a GeoJSON polygon with many coordinates.

Request

curl --request GET \
  --url "https://api.pandaidx.com/v1/condos/areas/miami-beach?key={{public_key}}"

Response200 OK

{
  "area": {
    "id": "62d07150ca8676650f0eaf90",
    "query": "MIAMI BEACH",
    "name": "Miami Beach",
    "slug": "miami-beach",
    "path": "/area/miami-beach",
    "image": "https://media.pandaidx.com/areas/miami-beach.jpg",
    "state": "FL",
    "buildingCount": 214,
    "description": "A barrier island city between Biscayne Bay and the Atlantic Ocean.",
    "location": {
      "lat": 25.7907,
      "lng": -80.13
    },
    "boundary": null
  },
  "stats": {
    "totalBuildings": 214,
    "avgListPrice": 1150000,
    "avgRentPrice": 4800
  },
  "market": {
    "forSale": {
      "today": 2410,
      "change": -0.6
    }
  },
  "neighborhood": {
    "walkScore": {
      "score": 88,
      "label": "Very Walkable"
    }
  },
  "buildings": [
    {
      "id": "6a0b2f4e8c1d3a0012ab34c1",
      "slug": "ocean-drive-tower--miami-beach",
      "kind": "building",
      "name": "Ocean Drive Tower",
      "path": "/condos/ocean-drive-tower--miami-beach",
      "city": "Miami Beach",
      "image": "https://media.pandaidx.com/buildings/ocean-drive-tower/cover.jpg",
      "price": {
        "from": 485000,
        "to": 2250000
      },
      "beds": {
        "from": 0,
        "to": 3
      },
      "activeListings": {
        "forSale": 12,
        "forRent": 9,
        "pending": 2,
        "sold": 5
      }
    }
  ],
  "total": 214,
  "page": 1,
  "pageSize": 24,
  "totalPages": 9
}