GET /api/status
Returns a live snapshot of all read-only runtime stats — current tracking offsets, frame count, and inference performance.
Request
GET /api/status HTTP/1.1
Host: localhost:4242
No request body, no query parameters.
Response
200 OK
{
"trackingX": 12.5,
"trackingY": -3.2,
"frameCount": 84231,
"inferenceMs": 4.2,
"inferenceFps": 120.0,
"captureFps": 60.0
}
Fields
| Field | Type | Description |
|---|---|---|
trackingX |
float | Pixel offset from the model input centre. Positive = right. 0 when no detection is active. |
trackingY |
float | Pixel offset from the model input centre. Positive = down. 0 when no detection is active. |
frameCount |
long | Total frames processed since the pipeline started. |
inferenceMs |
double | Milliseconds the last neural-network inference pass took. |
inferenceFps |
double | Effective inference framerate (Hz). |
captureFps |
double | Screen capture framerate (Hz). |
Examples
curl
curl http://localhost:4242/api/status
JavaScript
const res = await fetch('http://localhost:4242/api/status');
const stats = await res.json();
console.log(`Inference: ${stats.inferenceMs.toFixed(2)}ms @ ${stats.inferenceFps}Hz`);
PowerShell
Invoke-RestMethod -Uri http://localhost:4242/api/status
Notes
- The endpoint is cheap to poll — call it as often as you like.
-
trackingXandtrackingYare pre-script values: they reflect the raw model output, not the post-script aim adjustment. - All response values are numeric. There are no nested objects or arrays.