# Rate board card

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

Savings, certificate and mortgage rates in clear columns with the effective date and a disclosure line.

Category: Finance. Tags: Prices and rates, Stores.

## Previews

![Rate board](/cards/rate-board/v1/screenshots/canvas-bloom.webp?sha=ac9331b688141c2724fe21e5e39e468a2bcfa754f741ad53b631b2939372c966)

Canvas

![Rate board](/cards/rate-board/v1/screenshots/corner-bloom.webp?sha=5a8efd29c23ce6587ad850c26779940a77bcf54c0f72cff3e5b69f8f67a9497c)

Corner

![Rate board](/cards/rate-board/v1/screenshots/chip-bloom.webp?sha=eb1c5ab04e358c8ce6c03610a1649567a510b20d8e3a95f8cbdbda65466cf76f)

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 | `"Today's rates"` | maxLength: `40` |  |
| `decimals` | integer | `2` | minimum: `0`; maximum: `3` |  |

### Dynamic properties

| Name | Type | Default | Values and limits | Description |
| --- | --- | --- | --- | --- |
| `groups` | array | `[]` | minItems: `0`; maxItems: `4` |  |
| `groups[].name` | string |  | minLength: `1`; maxLength: `40`; Required |  |
| `groups[].rateLabel` | string | `"Rate"` | maxLength: `12` | What the big figure is called: APY, APR or Rate. |
| `groups[].secondLabel` | string | `"APR"` | maxLength: `12` | What the smaller figure under a rate is called. |
| `groups[].decimals` | integer |  | minimum: `0`; maximum: `3` | Decimal places for this group's figures; left out, the board's decimals. |
| `groups[].rates` | array |  | minItems: `0`; maxItems: `6`; Required |  |
| `groups[].rates[].name` | string |  | minLength: `1`; maxLength: `40`; Required |  |
| `groups[].rates[].rate` | number |  | minimum: `-100`; maximum: `1000`; Required | The rate in percent: 4.25 reads 4.25%. |
| `groups[].rates[].second` | number |  | minimum: `-100`; maximum: `1000` | A smaller figure under the rate, such as the APR. |
| `groups[].rates[].note` | string | `""` | maxLength: `50` | A line under the name: a minimum balance, a term, a condition. |
| `groups[].rates[].tag` | string | `""` | maxLength: `14` | A short flag beside the name: Special, Best rate, New. |
| `effective` | string | `""` | maxLength: `10` | The date the rates take effect, YYYY-MM-DD. |
| `footnote` | string | `""` | maxLength: `240` |  |

## 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": "rate-board",
  "primitive": "card",
  "card": "rate-board",
  "major": 1,
  "params": {
    "theme": "neomustard"
  },
  "rect": {
    "x": 0,
    "y": 0,
    "width": 1920,
    "height": 1080
  },
  "layer": 0,
  "content_fit": "fill",
  "data": "rate-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/rate-board-main" \
  --header "Authorization: Bearer $SCREENRIG_TOKEN" \
  --header "ScreenRig-Project: $SCREENRIG_PROJECT" \
  --header "Content-Type: application/json" \
  --data '{"document":{"groups":[],"effective":"","footnote":""}}'
```