Property listings card

Category: Retail. Tags: Stores, Lobbies and reception.

Previews

Views and forms

Views: canvas, corner, chip. Canvas forms: landscape, portrait, square, strip.

Card views, themes and publishing. Browse the gallery.

Data and privacy

Feed: screenrig.listings/v1.

Feed documents carry source attribution. The Player supplies the feed to the card.

Properties

For theme, background, accent and position, see Common properties.

Set static properties in params. Bind data to a project card data key for live values; that document holds only dynamic properties. Without a data key, put the complete configuration in params. Nested rows describe the contents of their parent property.

Static properties

Name	Type	Default	Values and limits	Description
`title`	string	`"Listings"`	maxLength: `40`
`agency`	string	`""`	maxLength: `60`	The agency's name, when the feed carries none.
`layout`	string	`"spotlight"`	`"spotlight"`, `"grid"`	spotlight: one listing at a time with a rail of the rest. grid: a wall of tiles.
`currency`	string	`"$"`	maxLength: `4`	The currency symbol before a price.
`units`	string	`"imperial"`	`"imperial"`, `"metric"`	imperial: sq ft. metric: m2.
`rotateSeconds`	integer	`10`	minimum: `5`; maximum: `60`	How long each listing (or page of tiles) stays on screen.
`tiles`	integer	`6`	minimum: `2`; maximum: `9`	Tiles per page in the grid layout.
`hideSold`	boolean	`false`		Leave sold and leased listings out.
`showAgent`	boolean	`true`
`staleMinutes`	integer	`720`	minimum: `1`; maximum: `10080`
`hour12`	boolean	`false`

Dynamic properties

Name	Type	Default	Values and limits	Description
`listings`	array	`[]`	minItems: `0`; maxItems: `60`	The listings to show, in order. A feed (screenrig.listings/v1) wins when present; the data store supplies the same rows otherwise.
`listings[].id`	string		maxLength: `40`
`listings[].status`	string	`"for-sale"`	`"for-sale"`, `"for-rent"`, `"sold"`, `"pending"`, `"new"`, `"reduced"`, `"leased"`
`listings[].price`	number		minimum: `0`; maximum: `1000000000`; Required
`listings[].priceUnit`	string	`""`	`""`, `"week"`, `"month"`	For a rental: the price per week or month.
`listings[].address`	string		minLength: `1`; maxLength: `80`; Required
`listings[].locality`	string		maxLength: `60`
`listings[].type`	string		maxLength: `30`	For example Condo, House, Townhouse.
`listings[].beds`	number		minimum: `0`; maximum: `20`	0 is a studio.
`listings[].baths`	number		minimum: `0`; maximum: `20`
`listings[].areaSqft`	number		minimum: `0`; maximum: `200000`
`listings[].headline`	string		maxLength: `140`
`listings[].photo`	string		maxLength: `120`	A media reference (media:<id>).
`listings[].openHouse`	object		additionalProperties: `false`
`listings[].openHouse.start`	string		maxLength: `32`; Required	ISO 8601.
`listings[].openHouse.end`	string		maxLength: `32`	ISO 8601.
`listings[].agent`	string		maxLength: `60`
`listings[].brokerage`	string		maxLength: `60`	The listing firm; shown whenever present.
`listings[].mls`	string		maxLength: `30`
`updated`	string	`""`	maxLength: `32`	When the listings were fetched, ISO 8601 (data store only; a feed carries fetchedAt).

Canvas example

Add this item to a playlist page’s primitives. Publish the playlist and assign a screen.

{
  "id": "property-listings",
  "primitive": "card",
  "card": "property-listings",
  "major": 1,
  "params": {
    "theme": "neomustard"
  },
  "rect": {
    "x": 0,
    "y": 0,
    "width": 1920,
    "height": 1080
  },
  "layer": 0,
  "content_fit": "fill",
  "data": "property-listings-main"
}

Write live data

Create this document before showing the card, then replace it to update the screen without republishing. Use the same project as the playlist. Supply your API authorization through the environment; see API authentication.

curl --request PUT "https://api.screenrig.ai/api/card-data/property-listings-main" \
  --header "Authorization: Bearer $SCREENRIG_TOKEN" \
  --header "ScreenRig-Project: $SCREENRIG_PROJECT" \
  --header "Content-Type: application/json" \
  --data '{"document":{"listings":[],"updated":""}}'