Endpoints
Enabling Local API
Following review of your submission, the owner of your Vestaboard will be emailed a token to enable the Local API and get your first key.
Path
http://vestaboard.local:7000/local-api/enablement
Method
POST
Headers
X-Vestaboard-Local-Api-Enablement-Token
Content-Type: application/json
Example Request
- CURL
- Javascript
curl -X POST -H "X-Vestaboard-Local-Api-Enablement-Token: YOUR_API_ENABLEMENT_TOKEN" http://vestaboard.local:7000/local-api/enablement
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());
Example Response
{
"message": "Local API enabled",
"apiKey": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
}
Sending a message via Local API
After following the steps above to enable the Local API, use the provided API Key to send messages locally.
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.
Flagship:
[
[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
[0, 0, 0, 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]
]
Vestaboard Note:
[
[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
[0, 0, 0, 0, 0, 0, 0, 62, 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
- Javascript
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]]"
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());
Reading the current message
You can also read the current message displayed on your Vestaboard.
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 Request
- CURL
- Javascript
curl -H "X-Vestaboard-Local-Api-Key: YOUR_API_KEY" http://vestaboard.local:7000/local-api/message
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());
Example Response
Flagship:
[
[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
[0, 0, 0, 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]
]
Vestaboard Note:
[
[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
[0, 0, 0, 0, 0, 0, 0, 62, 0, 0, 0, 0, 0, 0, 0],
[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]
]