Live Time API

The LiveTime Server API is currently in beta available in version 1.18+.

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

Main Timer
POST /api/timer/main/start
POST /api/timer/main/start?time=90
POST /api/timer/main/start?time=90&countmode=up
POST /api/timer/main/start?time=90&countmode=down
POST /api/timer/main/start?countmode=time

POST /api/timer/main/stop

POST /api/timer/main/reset?start=true
POST /api/timer/main/reset?start=false

POST /api/timer/main/add?time=90
POST /api/timer/main/subtract?time=90

Aux Timer
POST /api/timer/aux/start
POST /api/timer/aux/start?time=90
POST /api/timer/aux/start?time=90&countmode=up
POST /api/timer/aux/start?time=90&countmode=down
POST /api/timer/aux/start?countmode=time

POST /api/timer/aux/stop

POST /api/timer/aux/reset?start=true
POST /api/timer/aux/reset?start=false

POST /api/timer/aux/add?time=90
POST /api/timer/aux/subtract?time=90

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!