HTTP API overview
AimForge V2 exposes a small HTTP API on the loopback interface, primarily for live introspection and remote settings tuning. It's the same data the in-app "API Reference" panel displays.
Server
| Property | Value |
|---|---|
| Base URL | http://localhost:4242/ |
| Transport | Plain HTTP (no TLS) |
| Implementation | Native Windows HttpListener |
| Authentication | None — loopback access only |
| CORS | Not configured |
| Content type | application/json; charset=utf-8 |
Because the server only binds to localhost and requires no auth, you can call it freely from local tools (browser DevTools, curl, Postman, a stream-deck plugin, an external GUI). External machines cannot reach it.
Endpoints
| Method | Path | Purpose |
|---|---|---|
GET |
/api/status |
Live snapshot of read-only runtime stats |
GET |
/api/settings |
Read all numeric script settings |
PATCH |
/api/settings |
Update one or more numeric script settings |
Any other path returns 404. Internal errors return 500 with a brief JSON error body.
Quick verification
curl http://localhost:4242/api/status
If AimForge is running and the API server has started, this returns a JSON object with the current tracking stats. If you get a connection refused, the app isn't running or the port is blocked.
What the API is good for
-
Stream overlays — pull
frameCount,inferenceFps,captureFpsinto OBS/Streamlabs widgets - External GUIs — build a remote control panel that reads/writes settings without touching the AimForge UI
-
Profiling — log
inferenceMsover time to spot model regressions -
Automation hooks — toggle
sensitivityorfovfrom a hotkey app, stream deck, or scheduled task - Macros — patch settings before a match starts and reset afterwards