Vestaboard

https://docs.vestaboard.com/docs/
Admin
Vestaboard is a smart display board that provides an API for users to programmatically read from and...
Tokens:15,972
Snippets:37
Trust Score:9.4
Update:1 year ago
Show doc for...
Tokens:
Raw
### VBML Multiple Components with Styling

Source: https://docs.vestaboard.com/docs/vbml

VBML example using multiple components, each with specified height and width, allowing for distinct styling and layout on the Vestaboard.

```JSON
{
"props":{
"hours":"{36}{33}",
"minutes":"{29}{31}",
"quote":"The world is too much with us",
"author":"William Wordsworth"
},
"components":[
{
"style":{
"justify":"center",
"align":"center",
"height":4,
"width":22
},
"template":"{{quote}}"
},
{
"style":{
"justify":"center",
"align":"center",
"height":2,
"width":22
},
"template":"{{author}}"
}
]
}
```

--------------------------------

### Vestaboard Subscription API Introduction

Source: https://docs.vestaboard.com/docs/subscription-api/introduction

Provides an overview of the Vestaboard Subscription API, highlighting its capability to send messages to multiple Vestaboard subscriptions simultaneously. It also includes a note about deprecated V1 documentation and a warning regarding the security of JavaScript code examples and credentials.

```APIDOC
Subscription API:
  Purpose: Send messages to multiple Vestaboard subscriptions at once.
  Note: Deprecated V1 docs are available separately.
  Security: Keep credentials safe. JavaScript examples are not for direct HTML embedding.
```

--------------------------------

### Vestaboard Local API Enablement Response

Source: https://docs.vestaboard.com/docs/local-api/authentication

This is an example of the JSON response received after successfully enabling the Vestaboard Local API. It includes a confirmation message and the generated API key.

```json
{
"message":"Local API enabled",
"apiKey":"XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
}
```

--------------------------------

### Vestaboard Local API Introduction

Source: https://docs.vestaboard.com/docs/local-api/introduction

This section introduces the Vestaboard Local API, explaining its purpose for local network interaction and potential decoupling from cloud services. It highlights prerequisites such as the Vestaboard being paired and online, the requirement for an IPv4 address for consistent results, and a note about JavaScript examples not being intended for direct HTML script tags. Future firmware updates may necessitate cloud connectivity.

```APIDOC
Local API Introduction:
  Purpose: Enables parallel or decoupled interaction with Vestaboard on a local network.
  Prerequisites:
    - Vestaboard must be paired and online.
    - IPv4 address required for consistent results (IPv6 may cause inconsistencies).
  Notes:
    - JavaScript examples are not for direct use in HTML <script> tags.
    - Keep credentials safe.
  Future Considerations:
    - Future firmware updates may require cloud connectivity.
```

--------------------------------

### Format Message with CURL

Source: https://docs.vestaboard.com/docs/read-write-api/endpoints

Demonstrates how to send a POST request to the Vestaboard /format endpoint using CURL to format a message. Includes examples for both Unix-like systems and Windows.

```curl
curl \
     -X POST \
     -d '{"message": "Hello World"}' \
     -H "Content-Type: application/json" \
     https://vbml.vestaboard.com/format
```

```curl
curl \
     -X POST \
     -d "{\"message\": \"Hello World\"}" \
     -H "Content-Type: application/json" \
     https://vbml.vestaboard.com/format
```

--------------------------------

### Vestaboard Read / Write API Introduction

Source: https://docs.vestaboard.com/docs/read-write-api/introduction

This section introduces the Vestaboard Read / Write API, which allows users to read from and write to their Vestaboard. It explains how to obtain an API key through the mobile or web app, noting that the key is unique to each Vestaboard and only one key is permitted at a time. It also includes a warning about keeping credentials safe and that JavaScript examples are not meant for direct HTML embedding.

```APIDOC
Vestaboard Read / Write API:
  Purpose: Read from and write to your Vestaboard.
  Authentication: Obtain API key via mobile app (Settings) or web app (Developer section).
  Key Properties:
    - Specific to your Vestaboard.
    - Only one key allowed at a time.
    - Can be disabled or regenerated.
  Security Note: Keep credentials safe. JavaScript examples are not for direct HTML embedding.
  Related Sections:
    - Authentication
    - Endpoints
    - Subscription API
    - Local API
    - Character Codes
    - VBML
    - Community
```

--------------------------------

### Format Message Request (JavaScript)

Source: https://docs.vestaboard.com/docs/subscription-api/endpoints

Example JavaScript fetch request to the format message API endpoint. It sends a POST request with a JSON payload containing the message 'Hello World' and handles the JSON response.

```javascript
await fetch("https://vbml.vestaboard.com/format",{
headers:{
"Content-Type":"application/json",
},
method:"POST",
body:JSON.stringify({
message:"Hello World",
}),
}).then((res)=> res.json());
```

--------------------------------

### Format Message Request (cURL)

Source: https://docs.vestaboard.com/docs/subscription-api/endpoints

Example cURL request to the format message API endpoint. It sends a POST request with a JSON payload containing the message 'Hello World' and specifies the content type as application/json.

```curl
curl \
     -X POST \
     -d '{"message": "Hello World"}' \
     -H "Content-Type: application/json" \
     https://vbml.vestaboard.com/format
```

```curl
curl \
     -X POST \
     -d "{\"message\": \"Hello World\"}" \
     -H "Content-Type: application/json" \
     https://vbml.vestaboard.com/format
```

--------------------------------

### Read Current Message from Vestaboard Local API

Source: https://docs.vestaboard.com/docs/local-api/endpoints

Retrieves the current message displayed on the Vestaboard using a GET request with the API key. Returns the message as an array of character codes.

```APIDOC
Path:
http://vestaboard.local:7000/local-api/message
Method:
GET
Headers:
  X-Vestaboard-Local-Api-Key
    The Local API key provided when you enabled the Local API
Example Response:
[
[0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
[0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
[0,0,0,0,0,8,5,12,12,15,0,23,15,18,12,4,0,0,0,0,0,0],
[0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
[0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
[0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0]
]
```

```curl
curl -H "X-Vestaboard-Local-Api-Key: YOUR_API_KEY" http://vestaboard.local:7000/local-api/message
```

```javascript
await fetch("http://vestaboard.local:7000/local-api/message",{
headers:{
"Content-Type":"application/json",
"X-Vestaboard-Local-Api-Key":"YOUR_API_KEY",
},
method:"GET",
}).then((res)=> res.json());
```

--------------------------------

### Vestaboard API Documentation Overview

Source: https://docs.vestaboard.com/docs/community

This section outlines the different APIs available for Vestaboard, including Read/Write, Subscription, and Local APIs. It also references Character Codes and VBML for Vestaboard development.

```APIDOC
Vestaboard APIs:
  - Read / Write API
  - Subscription API
  - Local API

Related Topics:
  - Character Codes
  - VBML (Vestaboard Markup Language)
```

--------------------------------

### Vestaboard Officially Supported Libraries

Source: https://docs.vestaboard.com/docs/community

Lists the official libraries and kits provided by Vestaboard for developers. This includes React Components for easy integration and VBML for markup.

```APIDOC
Officially Supported Libraries:
  - Installable Kit (React Components for Vestaboard)
  - VBML (Vestaboard Markup Language)
```

--------------------------------

### Enable Vestaboard Local API

Source: https://docs.vestaboard.com/docs/local-api/authentication

This snippet shows how to enable the Vestaboard Local API using a POST request with an enablement token. The API responds with a message and an API key upon successful enablement.

```curl
curl -X POST -H "X-Vestaboard-Local-Api-Enablement-Token: YOUR_API_ENABLEMENT_TOKEN" http://vestaboard.local:7000/local-api/enablement
```

```javascript
await fetch("http://vestaboard.local:7000/local-api/enablement",{
headers:{
"Content-Type":"application/json",
"X-Vestaboard-Local-Api-Enablement-Token":"YOUR_API_ENABLEMENT_TOKEN",
},
method:"POST",
}).then((res)=> res.json());
```

--------------------------------

### Vestaboard Community Repos and Libraries

Source: https://docs.vestaboard.com/docs/community

Showcases a collection of libraries and repositories created by the Vestaboard developer community. These projects extend Vestaboard functionality across various languages and platforms.

```APIDOC
Community Repos and Libraries:
  - VestaboardJS (Typescript)
  - Vestaboard (Python)
  - VBPoll (Event Polling System for Vestaboard)
  - vesta-weather
  - @sebbo2002/vestaboard (Typescript)
  - vestaboard-api (Typescript)
  - @sebbo2002/vestaboard2mqtt
  - multi-vesta
```

--------------------------------

### Format Message with Javascript Fetch API

Source: https://docs.vestaboard.com/docs/read-write-api/endpoints

Shows how to format a message using the Javascript Fetch API by sending a POST request to the Vestaboard /format endpoint with a JSON payload.

```javascript
await fetch("https://vbml.vestaboard.com/format",{
headers:{
"Content-Type":"application/json",
},
method:"POST",
body:JSON.stringify({
message:"Hello World",
}),
}).then((res)=> res.json());
```

--------------------------------

### Enable Vestaboard Local API

Source: https://docs.vestaboard.com/docs/local-api/endpoints

Enables the Local API for your Vestaboard by sending a POST request with an enablement token. Returns a message and an API key upon success.

```APIDOC
Path:
http://vestaboard.local:7000/local-api/enablement
Method:
POST
Headers:
  X-Vestaboard-Local-Api-Enablement-Token
  Content-Type: application/json
Example Response:
{
"message":"Local API enabled",
"apiKey":"XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
}
```

```curl
curl -X POST -H "X-Vestaboard-Local-Api-Enablement-Token: YOUR_API_ENABLEMENT_TOKEN" http://vestaboard.local:7000/local-api/enablement
```

```javascript
await fetch("http://vestaboard.local:7000/local-api/enablement",{
headers:{
"Content-Type":"application/json",
"X-Vestaboard-Local-Api-Enablement-Token":"YOUR_API_ENABLEMENT_TOKEN",
},
method:"POST",
}).then((res)=> res.json());
```

--------------------------------

### Vestaboard Read/Write API Authentication

Source: https://docs.vestaboard.com/docs/read-write-api/authentication

Details the process of obtaining and using the API key for the Vestaboard Read/Write API. The key is obtained from the API tab on web.vestaboard.com and must be included in the 'X-Vestaboard-Read-Write-Key' header for all requests.

```APIDOC
Endpoint: All Vestaboard Read/Write API endpoints

Authentication Method:
  - Obtain API Key: Enable the Read / Write API in the API tab on web.vestaboard.com.
  - Use API Key: Include the obtained key in the 'X-Vestaboard-Read-Write-Key' header for all requests.

Header Format:
  X-Vestaboard-Read-Write-Key: YOUR_API_KEY

Example Request Header:
  GET /api/v1/current-message HTTP/1.1
  Host: api.vestaboard.com
  X-Vestaboard-Read-Write-Key: YOUR_API_KEY
```

--------------------------------

### Vestaboard Local API Networking

Source: https://docs.vestaboard.com/docs/local-api/networking

This section details how to connect to a Vestaboard's local API, particularly when internet access is limited. It covers using mDNS names for direct communication and managing multiple Vestaboards on a local network.

```APIDOC
Connecting to Vestaboard Without External Internet Access:
  - If your network lacks external internet access, Vestaboard gets a link-local IPv6 address (e.g., fe80::).
  - Interact with the Vestaboard API using its mDNS name: http://vestaboard.local.
  - For IPv4 and internet functionality, connect to a network with internet access (WiFi or internet sharing).
  - Vestaboard MAC addresses can be found in the mobile app's Advanced Settings.

Managing Multiple Vestaboards on the Same Local Network:
  - When multiple Vestaboards are on the same local network via Ethernet, mDNS names resolve based on connection order.
  - To verify Vestaboards are online, ping their mDNS names:
    - Vestaboard 1 (first connected): ping http://vestaboard.local
    - Vestaboard 2 (second connected): ping http://vestaboard-2.local
    - Vestaboard 3 (third connected): ping http://vestaboard-3.local
  - These mDNS names work with all local API endpoints for individual Vestaboard interaction.
```

--------------------------------

### VBML API Compose Endpoint

Source: https://docs.vestaboard.com/docs/vbml

Demonstrates how to use the VBML API endpoint to format messages by POSTing JSON data. The API returns an array of Vestaboard character codes.

```Shell
curl -X POST -H "Content-Type: application/json" -d '{"components":[{"template":"Hello World!"}]}' https://vbml.vestaboard.com/compose
```

```JavaScript
await fetch("https://vbml.vestaboard.com/compose",{
headers:{
"Content-Type":"application/json",
},
method:"POST",
body:JSON.stringify({
components:[
{
template:"Hello World!",
},
],
}),
}).then((res)=> res.json());
```

--------------------------------

### VBML Centered Text Message

Source: https://docs.vestaboard.com/docs/vbml

VBML component demonstrating text justification and alignment to center the message.

```JSON
{
"components":[
{
"style":{
"justify":"center",
"align":"center"
},
"template":"Hello World!"
}
]
}
```

--------------------------------

### VBML Dynamic Props with Character Codes

Source: https://docs.vestaboard.com/docs/vbml

VBML component where dynamic prop values themselves contain Vestaboard character codes, demonstrating injection order.

```JSON
{
"props":{
"hours":"{36}{33}",
"minutes":"{29}{31}"
},
"components":[
{
"style":{
"justify":"center",
"align":"center"
},
"template":"{{hours}}:{{minutes}}"
}
]
}
```

--------------------------------

### Vestaboard API Authentication

Source: https://docs.vestaboard.com/docs/subscription-api/authentication

Access to the Vestaboard Platform is authenticated by providing an API key and secret in the HTTP request headers. These credentials are generated via the Vestaboard web application.

```APIDOC
Authentication:
  - Provide API Key in `X-Vestaboard-Api-Key` header.
  - Provide API Secret in `X-Vestaboard-Api-Secret` header.

Credential Generation:
  1. Navigate to the API tab on web.vestaboard.com.
  2. Click "Create new Installable" and provide a name.
  3. Click "Create an API Credential".
  4. Select the target Vestaboard.
  5. Copy the generated API secret and key. The secret will not be shown again.
```

--------------------------------

### Vestaboard Message Configuration

Source: https://docs.vestaboard.com/docs/vbml

Defines the structure for a Vestaboard message payload, including dynamic props and an array of components. Each component can have a template, raw characters, and styling options like height, width, alignment, and positioning.

```JSON
{
  "props": {
    // "key": "value"
  },
  "components": [
    {
      "template": "{1}ll you need is love",
      "rawCharacters": [[1,2,3]],
      "style": {
        "height": 6,
        "width": 22,
        "justify": "left",
        "align": "top",
        "absolutePosition": {
          "x": 0,
          "y": 0
        }
      }
    }
  ]
}
```

--------------------------------

### VBML Dynamic Props Injection

Source: https://docs.vestaboard.com/docs/vbml

VBML component using dynamic props (e.g., {{hours}}) that are injected into the template. Props are defined in a separate 'props' object.

```JSON
{
"props":{
"hours":"07",
"minutes":"35"
},
"components":[
{
"style":{
"justify":"center",
"align":"center"
},
"template":"{{hours}}:{{minutes}}"
}
]
}
```

--------------------------------

### List Subscriptions API

Source: https://docs.vestaboard.com/docs/subscription-api/endpoints

Retrieves a list of all subscriptions accessible by the authenticated API key and secret. Requires specific headers for authentication.

```APIDOC
Path:
  https://subscriptions.vestaboard.com/subscriptions
Method:
  GET
Headers:
  - x-vestaboard-api-key
  - x-vestaboard-api-secret
Example Request (cURL):
  curl \
       -H "x-vestaboard-api-key: YOUR_KEY" \
       -H "x-vestaboard-api-secret: YOUR_SECRET" \
       https://subscriptions.vestaboard.com/subscriptions
Example Request (Javascript):
  await fetch("https://subscriptions.vestaboard.com/subscriptions",{
  headers:{
  "Content-Type":"application/json",
  "x-vestaboard-api-key":"YOUR_KEY",
  "x-vestaboard-api-secret":"YOUR_SECRET",
  },
  method:"GET",
  }).then((res)=> res.json());
Example Response:
  [
  {
  "id":"e599aa61-8e3d-4f90-a5f1-826983a3d67a",
  "boardId":"46c06290-7961-49e0-a6fd-7874bb40a0de"
  }
  ]
```

--------------------------------

### Vestaboard Message Formatting Response

Source: https://docs.vestaboard.com/docs/read-write-api/endpoints

Illustrates the expected response format when successfully formatting a message using the Vestaboard API. The response is a 2D array of integers.

```APIDOC
[
[0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
[0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
[0,0,0,0,0,8,5,12,12,15,0,23,15,18,12,4,0,0,0,0,0,0],
[0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
[0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
[0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0]
]
```

--------------------------------

### Format Message with VBML

Source: https://docs.vestaboard.com/docs/read-write-api/endpoints

Formats a given string into Vestaboard character codes using the VBML API. This allows for custom message layouts.

```APIDOC
Path:
https://vbml.vestaboard.com/format
Method:
POST
Body:
  * message
    * A string you want to format
```

--------------------------------

### Send Message API

Source: https://docs.vestaboard.com/docs/subscription-api/endpoints

Allows sending a new message to a specific subscription. Supports sending plain text or pre-formatted character data. Requires subscription ID and authentication headers.

```APIDOC
Path:
  https://subscriptions.vestaboard.com/subscriptions/{SUBSCRIPTION_ID}/message
Method:
  POST
Headers:
  - x-vestaboard-api-key
  - x-vestaboard-api-secret
  - Content-Type: application/json
Body:
  All requests must either contain unformatted `text` or formatted `characters`
  - `text`
    * A string to be formatted and sent to the subscriptions
  - `characters`
    * An array of arrays that is already formatted using the Vestaboard character codes
Example Request (cURL):
  curl \
       -X POST \
       -H "x-vestaboard-api-key: YOUR_KEY" \
       -H "x-vestaboard-api-secret: YOUR_SECRET" \
       -H "Content-Type: application/json" \
       -d '{"text": "Hello World"}' \
       https://subscriptions.vestaboard.com/subscriptions/YOUR_SUBSCRIPTION_ID/message
Example Request (Javascript):
  await fetch(
  "https://subscriptions.vestaboard.com/subscriptions/YOUR_SUBSCRIPTION_ID/message",
  {
  headers:{
  "Content-Type":"application/json",
  "x-vestaboard-api-key":"YOUR_KEY",
  "x-vestaboard-api-secret":"YOUR_SECRET",
  },
  method:"POST",
  body:JSON.stringify({text:"Hello World"}),
  }
  ).then((res)=> res.json());
Example Request with Character Codes (cURL):
  curl \
       -X POST \
       -H "x-vestaboard-api-key: YOUR_KEY" \
       -H "x-vestaboard-api-secret: YOUR_SECRET" \
       -H "Content-Type: application/json" \
       -d '{"characters": [[0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],[0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],[0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],[0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],[0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],[0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0]]}' \
       https://subscriptions.vestaboard.com/subscriptions/YOUR_SUBSCRIPTION_ID/message
Example Request with Character Codes (Javascript):
  await fetch(
  "https://subscriptions.vestaboard.com/subscriptions/YOUR_SUBSCRIPTION_ID/message",
  {
  headers:{
  "Content-Type":"application/json",
  "x-vestaboard-api-key":"YOUR_KEY",
  "x-vestaboard-api-secret":"YOUR_SECRET",
  },
  method:"POST",
  body:JSON.stringify({
  characters:[
  [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
  [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
  [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
  [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
  [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
  [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
  ],
  }),
  }
  ).then((res)=> res.json());
Example Response:
  {
  "id":"1125e36d-4e3a-40fb-a87b-1aa90f0997a1",
  "text":"Test",
  "created":"1577839720478",
  "muted":false
  }
```

--------------------------------

### VBML Mixed Text and Character Codes

Source: https://docs.vestaboard.com/docs/vbml

VBML component demonstrating the combination of regular text and Vestaboard character codes within a single template.

```JSON
{
"components":[
{
"template":"{63} First\n{64} Second\n{65} Third\n{66} Fourth\n{67} Fifth\n{68} Sixth"
}
]
}
```

--------------------------------

### VBML Plain Text Message

Source: https://docs.vestaboard.com/docs/vbml

Basic VBML component with a plain text template. Lowercase letters are automatically converted to uppercase.

```JSON
{
"components":[
{
"template":"Hello World!"
}
]
}
```

--------------------------------

### Send Message via Vestaboard Local API

Source: https://docs.vestaboard.com/docs/local-api/endpoints

Sends a message to the Vestaboard by providing an array of character codes in the request body. Requires the API key for authentication.

```APIDOC
Path:
http://vestaboard.local:7000/local-api/message
Method:
POST
Headers:
  X-Vestaboard-Local-Api-Key
    The Local API token provided when you enabled the Local API
Body:
The request body should be an array of arrays containing the Vestaboard character codes for your message.
Example Body:
[
[0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
[0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
[0,0,0,0,0,8,5,12,12,15,0,23,15,18,12,4,0,0,0,0,0,0],
[0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
[0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
[0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0]
]
```

```curl
curl -X POST -H "X-Vestaboard-Local-Api-Key: YOUR_API_KEY" -H "Content-Type: application/json" http://vestaboard.local:7000/local-api/message -d "[[0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],[0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],[0,0,0,0,0,8,5,12,12,15,0,23,15,18,12,4,0,0,0,0,0,0],[0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],[0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],[0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0]]"
```

```javascript
await fetch("http://vestaboard.local:7000/local-api/message",{
headers:{
"Content-Type":"application/json",
"X-Vestaboard-Local-Api-Key":"YOUR_API_KEY",
},
method:"POST",
body:JSON.stringfy([
[0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
[0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
[0,0,0,0,0,8,5,12,12,15,0,23,15,18,12,4,0,0,0,0,0,0],
[0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
[0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
[0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
]),
}).then((res)=> res.json());
```

--------------------------------

### Read Current Vestaboard Message

Source: https://docs.vestaboard.com/docs/read-write-api/endpoints

Retrieves the current message displayed on the Vestaboard using the Read / Write API. Requires an API key for authentication.

```APIDOC
Path:
https://rw.vestaboard.com/
Method:
GET
Headers:
  X-Vestaboard-Read-Write-Key
  Content-Type : "application/json"
Example Response:
{
"currentMessage":{
"layout":"[[0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],[0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],[0,0,0,0,0,8,5,12,12,15,0,23,15,18,12,4,0,0,0,0,0,0],[0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],[0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],[0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0]]",
"id":"172c7808-52db-4eb9-9ecf-505bd00436bc"
}
}
```

```curl
curl -H "X-Vestaboard-Read-Write-Key: YOUR_API_KEY" -H "Content-Type: application/json" https://rw.vestaboard.com/
```

```javascript
await fetch("https://rw.vestaboard.com/",{
headers:{
"Content-Type":"application/json",
"X-Vestaboard-Read-Write-Key":"YOUR_API_KEY",
},
method:"GET",
}).then((res)=> res.json());
```

--------------------------------

### Send Message to Vestaboard

Source: https://docs.vestaboard.com/docs/read-write-api/endpoints

Sends a new message to the Vestaboard. Supports sending text or a custom board layout. Rate limiting applies (max 1 message per 15 seconds).

```APIDOC
Path:
https://rw.vestaboard.com/
Method:
POST
Headers:
  X-Vestaboard-Read-Write-Key
  Content-Type : "application/json"
Body:
You can provide text or an array of 6 arrays with 22 numbers each representing the new state of the board.
Example Response:
{
"status":"ok",
"id":"9b4f13f0-4623-4fb9-8fbf-09ae13350da1",
"created":1681154452865
}
```

```curl
curl -X POST -H "X-Vestaboard-Read-Write-Key: YOUR_API_KEY" -H "Content-Type: application/json" -d '{"text": "Hello World"}' https://rw.vestaboard.com/
```

```curl
curl -X POST -H "X-Vestaboard-Read-Write-Key: YOUR_API_KEY" -H "Content-Type: application/json" -d "{\"text\": \"Hello World\"}" https://rw.vestaboard.com/
```

```javascript
await fetch("https://rw.vestaboard.com/",{
body:JSON.stringify({text:"Hello World"}),
headers:{
"Content-Type":"application/json",
"X-Vestaboard-Read-Write-Key":"YOUR_API_KEY",
},
method:"POST",
});
```

```curl
curl -X POST -H "X-Vestaboard-Read-Write-Key: YOUR_API_KEY" -H "Content-Type: application/json" -d "[[0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],[0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],[0,0,0,0,0,8,5,12,12,15,0,23,15,18,12,4,0,0,0,0,0,0],[0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],[0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],[0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0]]" https://rw.vestaboard.com/
```

```javascript
await fetch("https://rw.vestaboard.com/",{
body:JSON.stringify([
[0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
[0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
[0,0,0,0,0,8,5,12,12,15,0,23,15,18,12,4,0,0,0,0,0,0],
[0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
[0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
[0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
]),
headers:{
"Content-Type":"application/json",
"X-Vestaboard-Read-Write-Key":"YOUR_API_KEY",
},
method:"POST",
}).then((res)=> res.json());
```

--------------------------------

### Vestaboard Character Codes

Source: https://docs.vestaboard.com/docs/charactercodes

Lists all characters that can be displayed on a Vestaboard, along with their corresponding integer character codes and any relevant notes. This includes letters, digits, punctuation, and special color chips.

```APIDOC
Character Codes:
  All characters that can be shown on a Vestaboard, including letters, digits, punctuation, and color chips, are encoded by an integer character code.

  Format:
    Preview | Name | Code | Notes

  Examples:
    Blank: Code 0 (Black on black Vestaboard / white on white Vestaboard)
    A: Code 1
    Z: Code 26
    One: Code 27
    Zero: Code 36
    Exclamation Mark: Code 37
    Red Color Chip: Code 63
    White Color Chip: Code 69 (For the local API this is black on a white Vestaboard)
    Black Color Chip: Code 70 (For the local API this is white on a white Vestaboard)
    Filled Color Chip: Code 71 (White on black Vestaboard / black on white Vestaboard, not available for the local API)
```

--------------------------------

### Vestaboard Character Codes

Source: https://docs.vestaboard.com/docs/characterCodes

Lists all characters that can be displayed on a Vestaboard, along with their corresponding integer character codes and any relevant notes. This includes letters, digits, punctuation, and special color chips.

```APIDOC
Character Codes:
  All characters that can be shown on a Vestaboard, including letters, digits, punctuation, and color chips, are encoded by an integer character code.

  Format:
    Preview | Name | Code | Notes

  Examples:
    Blank: Code 0 (Black on black Vestaboard / white on white Vestaboard)
    A: Code 1
    Z: Code 26
    One: Code 27
    Zero: Code 36
    Exclamation Mark: Code 37
    Red Color Chip: Code 63
    White Color Chip: Code 69 (For the local API this is black on a white Vestaboard)
    Black Color Chip: Code 70 (For the local API this is white on a white Vestaboard)
    Filled Color Chip: Code 71 (White on black Vestaboard / black on white Vestaboard, not available for the local API)
```

--------------------------------

### VBML Newline in Text

Source: https://docs.vestaboard.com/docs/vbml

VBML component showing how to force a new row within a template using the newline character (\n).

```JSON
{
"components":[
{
"style":{
"justify":"center",
"align":"center"
},
"template":"Hello\nWorld!"
}
]
}
```
Tokens:
Raw