HTTP

Base URL
The structure of the base URL will be:
http://ip-address-of-host-machine:4001/api/project-id/
For all requests to H2R Graphics, use the following base url, as seen in the Launcher window.
​
For example...
If the Rundown URL is http://192.168.8.153:4001/rundown/ABCD/
The base URL is http://192.168.8.153:4001/api/ABCD/
Companion
Learn how to take full advantage of this API here:
Companion
URIs
Most HTTP methods below will rely on a URI and a JSON object.
Keep in mind that the fastest way to to this information is within the Rundown, by right-clicking on any graphic that you want to show/hide/update.
Right-clicking on a graphic
post
http://base_url/
run
Run
post
http://base_url/
clear
Clear all graphics
post
http://base_url/
graphic/<graphic-id>/show
Show a graphic
post
http://base_url/
graphic/<graphic-id>/hide
Hide a graphic
post
http://base_url/
graphic/<graphic-id>/update
Update contents of a graphic
post
http://base_url/
graphic/<graphic-id>/updateScore/<team>/<level>/<type>/<amount>
Update score graphic
Text variables
post
http://base_url/
updateVariableText/<variable-text-id>
Update Variable Text
Example companion button for updating a Text variable
Variable list
post
http://base_url/
updateVariableList/1/selectRow/next
Select a row on a variable list
Outputs
post
http://base_url
/output/<output_number>/open
Open an output with HTTP
​

Last modified 1mo ago