Get Collection

Returns one collection of listings by slug, in the agent's order, with pagination. The slug can also be the collection ID.

GET/v1/collections/:slug

Authentication

Public key?key=pk_…

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

Edge cache: public, max-age=0, s-maxage=300, stale-while-revalidate=900

Path Parameters

slugstring

required

The collection slug, from `GET /v1/featured-listings`. The collection ID also works.

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 treated as 500.

Default:1

pageSizenumber

optional

Cards per page. Values above 100 are capped at 100.

Default:24

Responses

200Success

application/json

collectionobject

The collection and the listings of this page. `totalCount` counts listings still in the feed.

totalnumber

Listings still in the feed.

totalPagesnumber

`ceil(total / pageSize)`, at least 1.

Errors

401Missing or invalid public key.

403The account is not active. The body also has `code: "TENANT_INACTIVE"`.

404Collection not found, or the slug is malformed.

500Internal Server Error.

Notes

Listings that left the MLS feed are dropped from the page and from the totals.

Request

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

Response200 OK

{
  "collection": {
    "id": "693826b20d1c8d8f41bdf273",
    "name": "Waterfront Picks",
    "slug": "waterfront-picks",
    "path": "/collection/waterfront-picks",
    "description": null,
    "totalCount": 6,
    "listings": [
      {
        "_id": "6710a1b2c3d4e5f600000101",
        "ListingId": "A11855701",
        "OriginatingSystemKey": "miamire",
        "ListPrice": 725000,
        "LivingArea": 1180,
        "BedroomsTotal": 2,
        "BathroomsTotalInteger": 2,
        "StreetNumber": "1200",
        "StreetName": "Brickell Bay Dr",
        "UnitNumber": "2504",
        "City": "Miami",
        "StateOrProvince": "FL",
        "PostalCode": "33131",
        "StandardStatus": "Active",
        "PropertyType": "Residential",
        "PropertySubType": "Condominium",
        "image": "https://example.com/photos/A11855701/1.jpg",
        "Location": {
          "coordinates": [
            -80.1892,
            25.7651
          ]
        }
      }
    ]
  },
  "total": 6,
  "page": 1,
  "pageSize": 24,
  "totalPages": 1
}