API Documentation

[zkvvoob]

Hello,

Is there a documentation on the API? I couldn't find one, but maybe I missed it.

The reason I'm asking is this: SparkyFitness look terrific even right now and holds a lot of promise, so I would like to look into extending it to work with, say, Home Assistant, which automatically tracks my smart scale measurements and could, after receiving a new one, pass it on to SparkyFitness.

Thanks!

[CodeWithCJ]

I'll look into this..

[CodeWithCJ]

Could you tell me what sort of end points you are looking for? Currently I have one for Apple Health that helps to add Active calorie, Steps etc. Do you want end point for each & every data or anything particular. this will help me to speedup the API setup for you.

If you in Discord, connect with me there to chat in detail

[fbloemhof]

I might have it working with /api/measurements/check-in, but I think I can only add 1 checkin entry per day? I already entered the data manual this morning. Will try again tomorrow.

[CodeWithCJ]

Yes. they are meant for one per day. Custom measurements supports setting you frequency.

[fbloemhof]

What should the payload be to insert the weight using /api/healthj-data?

I tried [{"date": "2025-08-17", "type": "weight", "value": 10 }] but that seems incorrect

[CodeWithCJ]

try this. but not sure if the docker has the updated code for this. The one in github work for this sample data. if the docker one doesn't work, wait for next release.

[
{
"value": 70.5,
"type": "weight",
"date": "2025-08-19"
}
]

[fbloemhof]

Seems not to work, will wait for the release.

[CodeWithCJ]

These docs are mostly generated with AI. So use caution as I couldn't find time to complete manual review yet.

https://codewithcj.github.io/SparkyFitness/developer/api-reference

But still Docker is yet to be updated.