School athletics come from supplied games or the scores feed. Team codes tie each game to its sport and squad. Scores stay unknown until supplied, with finals shown only when marked final. In compact views, one game leads.
Live card
Category: Schools. Tags: Schools and campuses, Team sports, Schedules, Scoreboards.
Layouts
This fullscreen card fills the whole screen in landscape or portrait and is not placed as a corner, chip, or strip.
Layouts: full. Forms: landscape, portrait.
Card layouts, themes and publishing. Browse the cards.
Data and privacy
Feed: screenrig.scores/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 |
|---|---|---|---|---|
teamCode | string | "" | maxLength: 12 | |
hour12 | boolean | false | ||
staleMinutes | integer | 180 | minimum: 1; maximum: 10080 | |
teams | array | [] | maxItems: 24 | |
teams[].code | string | minLength: 1; maxLength: 12; Required | ||
teams[].name | string | minLength: 1; maxLength: 80; Required | ||
teams[].sport | string | "" | maxLength: 40 | |
teams[].level | string | "" | maxLength: 40 | |
count | integer | 5 | minimum: 2; maximum: 6 | |
pageSeconds | integer | 12 | minimum: 8; maximum: 120 |
Dynamic properties
| Name | Type | Default | Values and limits | Description |
|---|---|---|---|---|
title | string | "Varsity athletics" | maxLength: 80 | |
school | string | "" | maxLength: 80 | |
footnote | string | "" | maxLength: 240 | |
updatedAt | string | "" | maxLength: 40 | |
games | array | [] | maxItems: 100 | Supplied school games. The existing screenrig.scores/v1 feed wins when present; team codes match its home/away short codes. |
games[].id | string | "" | maxLength: 60 | |
games[].teamCode | string | "" | maxLength: 12 | |
games[].team | string | "" | maxLength: 80 | |
games[].opponent | string | minLength: 1; maxLength: 80; Required | ||
games[].sport | string | "" | maxLength: 40 | |
games[].level | string | "" | maxLength: 40 | |
games[].home | boolean | true | ||
games[].status | string | "scheduled" | "scheduled", "live", "final", "postponed", "cancelled" | |
games[].start | string | maxLength: 40; Required | ||
games[].teamScore | number, null | null | minimum: 0; maximum: 100000 | |
games[].opponentScore | number, null | null | minimum: 0; maximum: 100000 | |
games[].venue | string | "" | maxLength: 100 | |
games[].clock | string | "" | maxLength: 40 | |
games[].finalAt | string | "" | maxLength: 40 | Actual final-result instant, for the synchronized Primetime result moment. |
Canvas example
Add this item to a playlist page’s primitives. Publish the playlist and assign a screen.
{
"id": "varsity-schedule",
"primitive": "card",
"card": "varsity-schedule",
"major": 1,
"params": {
"theme": "neomustard"
},
"rect": {
"x": 0,
"y": 0,
"width": 1920,
"height": 1080
},
"layer": 0,
"content_fit": "fill",
"data": "example-key"
}
Write live data
The canvas example binds its data field to example-key. That value is a data key: a name this canvas item chooses, not the name of the card. Give each canvas item its own key when items should show different data, or share one key when they should show the same data. Keys are scoped to the project, follow the K/V key grammar, and cannot start with feed:.
Create this document before showing the card, then replace it to update the screen without republishing. Writes to a key that live canvas items bind are checked against each bound card’s dynamic properties. Use the same project as the playlist.
Save the document as card-data.json. The CLI reads the document itself, with no wrapper:
{
"title": "Varsity athletics",
"school": "",
"footnote": "",
"updatedAt": "",
"games": []
}
screenrig card-data put example-key --file card-data.json
Or call the API directly. The API wraps the same document in a document field. An agent token already names its project, so no project header is sent; if you send ScreenRig-Project, it must match the token’s project. Supply your API authorization through the environment; see API authentication.
curl --request PUT "https://api.screenrig.ai/api/card-data/example-key" \
--header "Authorization: Bearer $SCREENRIG_TOKEN" \
--header "Content-Type: application/json" \
--data '{"document":{"title":"Varsity athletics","school":"","footnote":"","updatedAt":"","games":[]}}'