Get Area Library

Returns one area library page with its copy and every area in the owner's order. It also resolves the Panda template libraries, such as Miami Areas, by slug.

GET/v1/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 library slug, from `libraries[].slug` of List Areas or from the `slug` of an area library in List Libraries.

Query Parameters

keystring

required

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

Responses

200Success

application/json

libraryobject

The area library with all of its areas.

Errors

404No area library has that slug, or the slug is malformed. The body is `{ "message": "Area library 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 owner's own libraries win over a template library with the same slug.

Request

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

Response200 OK

{
  "library": {
    "title": "Miami Areas",
    "subtitle": "Explore Miami neighborhoods",
    "theme": null,
    "slug": "miami-areas",
    "path": "/areas/miami-areas",
    "description": "Condos, townhomes and single-family homes across Miami-Dade County.",
    "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
          }
        }
      }
    ]
  }
}