Live Time API

Document version 25.1

Requirements

• Must have a server on and the Presets Engine module enabled (via an In-App Purchase).
• Presets called by the API must exist on the same Mac that the Server is on. If using Preset built on another LiveTime Mac, please use the export/import Preset functions.
• The server password must be enabled.
• If using a Server-to-Server environment, please note that the API has not been fully validated. 
• API must be turned on in Live Time preferences.

Notes

• The HTTP Web server runs on port 1909 (TCP).
• Your server password must be used in your requests as an HTTP Header parameter.

  { "password": "mypassword" }

• HTTPS is not supported.

Endpoints

General 
# Shows all API routes
GET /api/info

# Disconnect from a server if you are a server. (Server to Server Mode)
POST /api/connection/disconnect


Timers
# Use main or aux for the different timer
# Example /api/timer/main/... or /api/timer/aux/..

POST /api/timer/<timerName>/start
POST /api/timer/<timerName>/stop

POST /api/timer/<timerName>/reset?start=true
POST /api/timer/<timerName>/reset?start=false

# Using entry as seconds:
POST /api/timer/<timerName>/start?time=90
POST /api/timer/<timerName>/start?time=90&countmode=up
POST /api/timer/<timerName>/start?time=90&countmode=down
POST /api/timer/<timerName>/add?time=90
POST /api/timer/<timerName>/subtract?time=90 

# Using entry as HH:MM::SS
# You must query URI encode the colon to %3A
# Example 15:30:00 becomes 15%3A30%3A00
POST /api/timer/<timerName>/start?time=15%3A30%3A00
POST /api/timer/<timerName>/start?time=15%3A30%3A00&countmode=up
POST /api/timer/<timerName>/start?time=15%3A30%3A00&countmode=down
POST /api/timer/<timerName>/add?time=15%3A30%3A00
POST /api/timer/<timerName>/subtract?time=15%3A30%3A00 

# Count to a specific time of day using count_to_time
POST /api/timer/<timerName>/start?countmode=count_to_time&time=15%3A30%3A00

# Shows current time of day
POST /api/timer/<timerName>/start?countmode=current_time


Overlay
POST /api/overlay/show 
POST /api/overlay/hide

Presets
POST /api/presets/:presetId/restore
POST /api/presets/previous
POST /api/presets/next

Examples

Restore a Preset number 4

POST http://localhost/api/presets/4/restore
Header: { "password": "mypassword" }

Curl:

curl -H "password: test" -X POST http://localhost:1909/api/presets/4/restore/

Rest Client

Bitfocus Companion

1. Add Generic HTTP Request 
   
   
   
   
2. Add your LiveTime Server's IP or hostname with port 1909.

3. Add your button / action configuration.

Questions?

Please reach out to us via a support ticket or [e-mail] for questions. We are here to help!