Elaborate on what data is available through the web interface

[rdvAndroid]

I see in the readme "Web server access to all the widgets" and the Sauce's Zwift insider article "S4Z includes a web server that spits out data in standard formats to a local URL".

Where can I find out what specific data is exposed and other details about this feature? Also direct me please to that code in this repository so I can answer further questions for myself and not bother you further? I am familiar with JS and get/post processing so that feature has sparked my curiosity.
Thanks

[mayfield]

Hi @rdvAndroid

The root /api resource responds to GETs with a directory of resources. For example...

:; curl http://127.0.0.1:1080/api
[
  {
    "athletes": "[GET] Information for all active athletes",
    "athletes/<id>": "[GET] Information for specific athlete",
    "athletes/self": "[GET] Information for the logged in athlete",
    "athletes/watching": "[GET] Information for athlete being watched",
    "nearby": "[GET] Information for all nearby athletes",
    "groups": "[GET] Information for all nearby groups",
    "rpc/<name>": "[POST] Make an RPC call into the backend. Content body should be JSON Array of arguments"
  }
]

And then...

:; curl http://127.0.0.1:1080/api/athletes/watching
{
  "athleteId": 5052891,
  "athlete": {
    "id": 5052891,
    "updated": 1665369864343,
    "name": [
      "J",
      "M"
    ],
    "fullname": "J M",
    "sanitizedName": [
      "J",
      "M"
    ],
    "sanitizedFullname": "J M",
    "initials": "JM",
    "firstName": "J",

<clipped>

The RPC calls are more complicated and I don't document the arguments but they work by POSTing a JSON array which corresponds to the arguments list of the respective function. You're best bet for those is to to poke around the UI code in /pages/src and just look for calls to common.rpc.<func here>.

The websocket is your friend too, but that's probably too complicated to try and unravel here. However I did write a simple python client that will hopefully be somewhat self explanatory: https://github.com/SauceLLC/sauce4zwift-python-client

And finally, the code you seek: The code you seek:

sauce4zwift/src/webserver.mjs

Lines 194 to 256 in 83a55a5

	const api = express.Router();
	api.use(express.json());
	api.use((req, res, next) => {
	res.on('finish', () => {
	const client = req.client.remoteAddress;
	console.debug(`Web API request: (${client}) [${req.method}] ${req.originalUrl} -> ${res.statusCode}`);
	});
	next();
	});
	api.get('/', (req, res) => {
	res.send([{
	'athletes': '[GET] Information for all active athletes',
	'athletes/<id>': '[GET] Information for specific athlete',
	'athletes/self': '[GET] Information for the logged in athlete',
	'athletes/watching': '[GET] Information for athlete being watched',
	'nearby': '[GET] Information for all nearby athletes',
	'groups': '[GET] Information for all nearby groups',
	'rpc/<name>': '[POST] Make an RPC call into the backend. ' +
	'Content body should be JSON Array of arguments',
	}]);
	});
	api.get('/rpc', (req, res) => {
	res.send(Array.from(rpc.handlers.keys()).map(name => `${name}: [POST]`));
	});
	const sp = statsProc;
	function getAthleteHandler(res, id) {
	const data = sp.getAthleteData(id);
	if (!data) {
	res.status(404);
	}
	res.json(data);
	}
	api.post('/rpc/:name', async (req, res) => {
	try {
	const replyEnvelope = await rpc.invoke.call(null, req.params.name, ...req.body);
	if (!replyEnvelope.success) {
	res.status(400);
	}
	res.send(replyEnvelope);
	} catch(e) {
	res.status(500);
	res.json({
	error: "internal error",
	message: e.message,
	});
	}
	});
	api.get('/athletes/self', (req, res) => getAthleteHandler(res, sp.athleteId));
	api.get('/athletes/watching', (req, res) => getAthleteHandler(res, sp.watching));
	api.get('/athletes/:id', (req, res) => getAthleteHandler(res, Number(req.params.id)));
	api.get('/athletes', (req, res) => res.send(sp.getAthletesData()));
	api.get('/nearby', (req, res) => res.send(sp.getNearbyData()));
	api.get('/groups', (req, res) => res.send(sp.getGroupsData()));
	api.use((e, req, res, next) => {
	res.status(500);
	res.json({
	error: "internal error",
	message: e.message,
	});
	});
	api.all('*', (req, res) => res.status(404).json(null));
	router.use('/api', api);
	router.all('*', (req, res) => res.status(404).send('Invalid URL'));