Endpoints

Looking for the deprecated V1 docs? They are still available here.

Read Current Message

Once you have a Read / Write API key, you can use it to get the current message.

Path

https://rw.vestaboard.com/

Method

GET

Headers

• X-Vestaboard-Read-Write-Key
• Content-Type : "application/json"

Example Request

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());

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"
  }
}

Send Message

With your Read / Write API key, you can also send a new message. Please note that the Read / Write API does not accept blank messages. Also note that if you send more than 1 message every 15 seconds, you are likely to have messages dropped as we rate-limit the volume of messages sent to the board.

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. For example:

{
  "text": "Hello World"
}

or

[
  [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
  [0, 0, 0, 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]
]

Example Request

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 Windows

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",
});

Example Request with Character Codes

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());

Example Response

{
  "status": "ok",
  "id": "9b4f13f0-4623-4fb9-8fbf-09ae13350da1",
  "created": 1681154452865
}

Format Message

This endpoint takes a string and formats it into an array of arrays with Vestaboard character codes.

Path

https://vbml.vestaboard.com/format

Method

POST

Body

• message

  • A string you want to format

Example Request

CURL

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

CURL Windows

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

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());

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]
]