Get Library

Returns one library with its items resolved into uniform cards. Manual libraries keep the owner's order, and automatic libraries run their rule on every request.

GET/v1/libraries/:id

Authentication

Public key?key=pk_…

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

Edge cache: None (private, no-store)

Path Parameters

idstring

required

The library id, from `libraries[].id` of List Libraries or from a `variants[].id`. The example is a fictional id, replace it with one of your own.

Query Parameters

keystring

required

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

limitnumber

optional

Maximum number of items. Values above 48 are clamped to 48.

Default:16

Responses

200Success

application/json

libraryobject

The library summary, the same shape as one item of List Libraries.

itemsarray

Items as uniform cards, up to `limit`.

linkContractsobject

Optional. For each item type that was returned, the allowed link destinations, the receiving widget and `allowedUrl` examples. Paths belong to your site.

Errors

404The id is neither a library of the account nor a Panda template library, or it is not a valid id. The body is `{ "message": "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 example is trimmed. Every item has all the fields in the table, with `null` or an empty value where the type does not use them.
Only published stories and the site owner's own saved searches and collections are returned. Listing references and owner contacts are never exposed.
Link a card with `href` or with the destinations in `links`. Never build search URLs from a title or slug.

Request

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

Response200 OK

{
  "library": {
    "id": "6a0c4e2f9b1d3a0012ab34d2",
    "name": "Miami Areas",
    "type": "areas",
    "source": "tenant",
    "subtitle": "Explore Miami neighborhoods",
    "description": null,
    "previewImages": [
      "https://media.pandaidx.com/areas/brickell.jpg"
    ],
    "href": "/areas/miami-areas",
    "kind": "manual",
    "slug": "miami-areas",
    "placement": [
      "homepage"
    ],
    "itemCount": 8,
    "variants": []
  },
  "items": [
    {
      "id": "62d07150ca8676650f0eaf84",
      "type": "areas",
      "title": "Brickell",
      "subtitle": "FL",
      "image": "https://media.pandaidx.com/areas/brickell.jpg",
      "images": [
        "https://media.pandaidx.com/areas/brickell.jpg"
      ],
      "slug": "brickell",
      "path": "/for-sale/brickell",
      "href": "/search?q=BRICKELL&showPaths=1&mapReposition=1",
      "links": {
        "propertySearch": "/search?q=BRICKELL&showPaths=1&mapReposition=1",
        "condos": "/condos?area=brickell",
        "newDevelopments": "/new-developments?city=Brickell"
      },
      "query": "BRICKELL",
      "counts": {
        "forSale": 1320,
        "forRent": 940,
        "pending": 61,
        "sold": 28
      },
      "trends": {
        "forSale": -0.8,
        "forRent": 1.4,
        "pending": 0,
        "sold": 3.7
      },
      "listingCount": null,
      "listingCountCapped": false
    }
  ]
}