List Areas

Returns the area libraries the owner placed on the homepage or the footer. Each library holds neighborhood cards with search paths and live market counters.

GET/v1/areas

Authentication

Public key?key=pk_…

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

Edge cache: None (private, no-store)

Query Parameters

keystring

required

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

placementenum

optional

Where the libraries are shown. `homepage` returns up to 9 areas per library and `footer` up to 6.

Default:homepage

homepagefooter

Responses

200Success

application/json

placementenum

The placement that was requested: `homepage` or `footer`.

librariesarray

Area libraries in the order the owner created them. Empty when none is placed there.

Errors

400`placement` is not `homepage` or `footer`.

401Missing or invalid public key.

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

500Unexpected server error.

Notes

The owner curates these libraries, so the response is never cached at the edge. Cache it on your side.
Link a card to its `paths` or call the Property Search endpoints with the area as the location.

Request

curl --request GET \
  --url "https://api.pandaidx.com/v1/areas?key={{public_key}}&placement=homepage"

Response200 OK

{
  "placement": "homepage",
  "libraries": [
    {
      "title": "Miami Areas",
      "subtitle": "Explore Miami neighborhoods",
      "theme": "two",
      "slug": "miami-areas",
      "path": "/areas/miami-areas",
      "areas": [
        {
          "id": "62d07150ca8676650f0eaf84",
          "query": "BRICKELL",
          "name": "Brickell",
          "image": "https://media.pandaidx.com/areas/brickell.jpg",
          "paths": {
            "forSale": "/for-sale/brickell",
            "forRent": "/for-rent/brickell",
            "pending": "/for-sale-pending/brickell",
            "sold": "/sold/brickell"
          },
          "stats": {
            "forSale": {
              "today": 1320,
              "toLastWeek": -0.8
            },
            "forRent": {
              "today": 940,
              "toLastWeek": 1.4
            },
            "pending": {
              "today": 61,
              "toLastWeek": 0
            },
            "sold": {
              "today": 28,
              "toLastWeek": 3.7
            }
          }
        }
      ]
    }
  ]
}