Control colors, names, layout and more using these url parameters. To set the serial to "99999" and the sport to "basketball", for example, you can use the following url:
Required
sport
(Required) The overlay sport
serial
(One of serial or schedule_id is Required) The 5-digit NeST serial number
schedule_id
(One of serial or schedule_id is Required) The unique Scorebird schedule id. The overlay will only render this specific game
Colors
border_color
(Optional - Hex number) The overlay background color
home_team_color
(Optional - Hex number) The home team background color
away_team_color
(Optional - Hex number) The away team background color
home_text_color
(Optional - Hex number) The home team text color
away_text_color
(Optional - Hex number) The away team text color
Display
home_player
(Optional - String) The name of the home player
away_player
(Optional - String) The name of the away player
home_name
(Optional - String - 15 characters max) Overrides the home team name
away_name
(Optional - String - 15 characters max) Overrides the away team name
court_number
(Optional - Number) The court number if the sport is "Tennis"
show_fields
(Optional - String/List) A comma-separated list of fields to display
Style
swap_home_away
(Optional - true/false) Swap the home and away team positions
render
(Optional - String - One of 'horizontal', or 'stacked') The overlay template
"Horizontal" Example (Supported for All Sports):
"Stacked" Example (Supported for Baseball, Basketball and Ice Hockey):
animate
(Optional - true/false) Whether the overlay shows animations
max_width
(Optional - Number) The maximum size of the overlay. Can be used to scale the overlay.
green_screen
(Optional - true/false) Whether to make the background of the overlay pure green
message_delay
(Optional - Decimal) The amount of time (in seconds) to delay the overlay's messages
template
(Optional - String - Either 'classic' or blank) - The template to render
"Classic" Example (Supported for Basketball and Football):
Single Fields
single_field_font_size
(Optional - Number) - The font size when rendering a single field
single_field
(Optional - String) - The single field to render (see the full list of fields below)
single_field_bg_color
(Optional - Hex number) - The single field background color
single_field_text_color
(Optional - Hex number) - The single field text color
single_field_primary_color
(Optional - Hex number) - The color for elements such as the "timeouts" dashes or dots
single_field_text_bold
(Optional - true/false) - Whether to render bold text
single_field_text_italic
(Optional - true/false) - Whether to render italic text