Loading...
Searching...
No Matches
REST API

This is the complete list of PST REST API endpoints. Using this list of commands, the behavior of the PST Tracker can be controlled and information can be retrieved from the PST Tracker. For more general information on how to use the PST REST API, please refer to the Using PST SDK page.
GET Requests are meant to retrieve information from the tracker and the tracking results.
POST Requests send information (JSON formatted) and modify the PST tracker state.

PSTapi Endpoints: GET and POST Requests

Call | Request type | Description
--- | --- | ---
CloseDataStream | POST | Close all opened tracking result streams.
CloseImageStream | POST | Close all opened image streams.
CloseStreams | POST | Close all opened tracking result streams and image streams.
DisableFiltering | POST | Disable filtering of the tracking results.
DisableImageTransfer | POST | Disable image transfer from the PST Tracker.
DisableTremorFilter | POST | Disable the tremor filter.
EnableFiltering | POST | Enable filtering of the tracking results.
EnableImageTransfer | POST | Enable image transfer from the PST Tracker.
EnableTremorFilter | POST | Enable the tremor filter.
GetExposure | GET | Get the current exposure time.
GetExposureRange | GET | Get the allowed exposure range.
GetFramerate | GET | Get current frame rate.
GetMarkerDetectionRegion | GET | Gets the region of the tracking working space where markers are reported.
GetOrientationFilter | GET | Get the strength of the orientation filter.
GetPositionFilter | GET | Get the strength of the position filter.
GetReference | GET | Get the transformation matrix for the current reference system.
GetSingleMeasurement | GET | Get the latest TrackerData available from the connected PST Tracker.
GetSupportedFramerates | GET | Get a vector of available frame rates.
GetTargetInfo | GET | Get basic tracking target information.
GetTargetList | GET | Get TargetStatuses object containing all tracking targets and their status.
GetTargetMarkers | GET | Get 3D marker positions of stored tracking Target.
GetTargetStatus | GET | Get status of a single tracking Target.
GetUncalibratedCameraUrls | GET | Get download links for calibration files of the uncalibrated cameras.
GetVersionInfo | GET | Get version information of the SDK.
Pause | POST | Pause tracking.
SetDefaultReference | POST | Reset the reference system to the default reference system.
SetExposure | POST | Set the exposure time.
SetFramerate | POST | Set tracker frame rate.
SetMarkerDetectionRegion | POST | Sets the region of the tracking working space where markers are reported.
SetOrientationFilter | POST | Set the strength of the orientation filter.
SetPositionFilter | POST | Set the strength of the position filter.
SetReference | POST | Set the reference system in which tracking results are reported.
SetRelativeReference | POST | The current reference system matrix is transformed using the supplied transformation matrix.
SetTargetId | POST | Set the id of the tracking target.
SetTargetStatus | POST | Set status of a single tracking Target.
Start | POST | Start tracking.
StartRawImageDataStream | GET | Retrieve images from the connected PST Tracker.
StartTrackerDataStream | GET | Retrieve tracking results from the connected PST Tracker.
SupportsDetectionRegionPruning | GET | Get whether the connected PST tracker supports detection region-based pruning.
SystemCheck | GET | Check if the tracker is running correctly.