garth icon indicating copy to clipboard operation
garth copied to clipboard

Create docs with all known endpoints

Open matin opened this issue 2 years ago • 5 comments

While Garth will support some endpoints natively, it's impractical and slow to add all endpoints.

The faster method is to create a wiki with all known endpoints. The most popular can then be added directly into the library. Others can simply use garth.connectapi(path).

matin avatar Sep 29 '23 15:09 matin

This would actually be better solved by creating proper documentation outside of the README. We could use readthedocs or mkdocs.

matin avatar Sep 29 '23 15:09 matin

For the time being, I recommend the growing list of endpoints in cyberjunky/python-garminconnect.

matin avatar Oct 18 '23 21:10 matin

Where are these endpoints coming from? Is there some documentation from Garmin?

zimengzhou1 avatar Feb 04 '24 11:02 zimengzhou1

@zimengzhou1 the easiest way imho is to use the app with Charles Proxy and monitor what endpoints the app is using

matin avatar Feb 15 '24 03:02 matin

#48 outlines the Garmin Golf endpoints

matin avatar Feb 20 '24 14:02 matin

garminconnect appears to be the best documentation for a list of endpoints. I'd recommend reviewing it for anyone looking for what's available in the API.

matin avatar Apr 24 '25 18:04 matin