# Auction board card

> Canonical HTML: https://screenrig.ai/docs/cards/auction-board/

A silent auction: the running total against the goal, and every lot with its high bid, bidder paddle and time left.

Category: Events. Tags: Events and venues, Numbers and metrics.

## Previews

![Auction board](/cards/auction-board/v1/screenshots/canvas-bloom.webp?sha=4467f0190acc470c2a523deca1e150dbdf6bd6e25faff1684756b5ccd4d55a88)

Canvas

![Auction board](/cards/auction-board/v1/screenshots/corner-bloom.webp?sha=9b7d1e5716226886bc8f6acbe4683fec53138c3636da88178f2c8b3105edc922)

Corner

![Auction board](/cards/auction-board/v1/screenshots/chip-bloom.webp?sha=c8b4d99688462b885c34411a6f4da7d65dc2cd5baf21e10dd9806ab3aeee94f1)

Chip

## Views and forms

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

[Card views, themes and publishing](/docs/cards/). [Browse the gallery](/apps/#cards).

## Data and privacy

This card uses its configured properties and live card data.

## Properties

For theme, background, accent and position, see [Common properties](/docs/cards/#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 | `"Silent auction"` | maxLength: `40` |  |
| `currency` | string | `"$"` | maxLength: `3` | The symbol before every amount. |
| `goal` | number | `0` | minimum: `0`; maximum: `1000000000` | The amount to raise. 0 shows the total without a goal. |
| `sort` | string | `"lot"` | `"lot"`, `"closing"`, `"bid"` | lot keeps the order given; closing puts the lot that closes next first and closed lots last; bid puts the highest bid first. |
| `perPage` | integer | `6` | minimum: `3`; maximum: `10` |  |
| `pageSeconds` | integer | `10` | minimum: `4`; maximum: `60` |  |
| `soonMinutes` | integer | `15` | minimum: `1`; maximum: `240` | A lot is closing soon this many minutes before it closes. |
| `showBidders` | boolean | `true` |  | Show the high bidder's paddle on each lot. |

### Dynamic properties

| Name | Type | Default | Values and limits | Description |
| --- | --- | --- | --- | --- |
| `raised` | number | `0` | minimum: `0`; maximum: `1000000000` | The running total, when it is more than the lots' high bids (tickets, donations). 0 uses the sum of the high bids. |
| `closesAt` | string | `""` | maxLength: `32` | When bidding closes, ISO 8601. A lot without its own closesAt closes then. |
| `items` | array | `[]` | minItems: `0`; maxItems: `60` |  |
| `items[].lot` | string, integer |  |  | The lot number or code; left out, the lot's place in the list. |
| `items[].name` | string |  | minLength: `1`; maxLength: `120`; Required |  |
| `items[].bid` | number | `0` | minimum: `0`; maximum: `1000000000` | The high bid. 0 means no bids yet. |
| `items[].opening` | number | `0` | minimum: `0`; maximum: `1000000000` | The opening bid, shown until the first bid. |
| `items[].bids` | integer | `0` | minimum: `0`; maximum: `100000` | How many bids the lot has. |
| `items[].bidder` | string | `""` | maxLength: `12` | The high bidder's paddle number or initials. |
| `items[].closesAt` | string | `""` | maxLength: `32` | When this lot closes, ISO 8601. |
| `items[].status` | string | `"open"` | `"open"`, `"closed"`, `"sold"`, `"withdrawn"` | Closed and sold end bidding; withdrawn hides the lot. |
| `items[].image` | string | `""` | maxLength: `200` | A project media reference for the lot's photo. |
| `footnote` | string | `""` | maxLength: `160` |  |

## Canvas example

Add this item to a playlist page’s `primitives`. [Publish the playlist and assign a screen](/docs/cards/#publish-a-card-canvas).

```json
{
  "id": "auction-board",
  "primitive": "card",
  "card": "auction-board",
  "major": 1,
  "params": {
    "theme": "neomustard"
  },
  "rect": {
    "x": 0,
    "y": 0,
    "width": 1920,
    "height": 1080
  },
  "layer": 0,
  "content_fit": "fill",
  "data": "auction-board-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](/docs/authentication/).

```console
curl --request PUT "https://api.screenrig.ai/api/card-data/auction-board-main" \
  --header "Authorization: Bearer $SCREENRIG_TOKEN" \
  --header "ScreenRig-Project: $SCREENRIG_PROJECT" \
  --header "Content-Type: application/json" \
  --data '{"document":{"raised":0,"closesAt":"","items":[],"footnote":""}}'
```