read scope. Every response is JSON and every date parameter follows the YYYY-MM-DD format.
Dates default to today in UTC. If you know the user’s timezone, always pass an explicit date when calling near midnight. Otherwise you may silently query the wrong calendar day.
GET /v1: Route list
Returns the full list of routes available to your key, filtered by its scopes. This is the fastest way to confirm which endpoints your key can actually reach without consulting this page. Example requestGET /v1/me: Key scopes and budget
Returns the scopes attached to the current key and its hourly rate-limit budget. Use this to verify a key is alive and to check what it is allowed to do before making other calls. Example requestGET /v1/goals: Calorie and macro targets
Returns your configured nutrition targets, daily water goal, preferred weight unit, and stated training goal. These values are set inside the app and are read-only through the API. Example requestGET /v1/insights: Progression verdicts and monthly summaries
Returns computed analysis across your log history: per-lift progression verdicts, recovery status compared to your baseline, and up to six monthly summaries. You can anchor all analysis windows to a specific date with the optional?date= query parameter.
Query parameters
Example requestArray of per-lift progression verdicts. Each entry contains the exercise name, a verdict string, and a human-readable trend description.
Your current recovery status compared to your personal baseline, including days since your last rest day.
Up to six months of historical summaries, each containing workout count, average daily calories, and average body weight.
GET /v1/days/: Everything logged on one date
Returns the complete nutrition log, water intake, workout sessions, and body measurements recorded on a single calendar day. The{date} path parameter must be in YYYY-MM-DD format and defaults to today in UTC when omitted.
Path parameters
Example requestGET /v1/days: Per-day totals over a date range
Returns daily nutrition, water, and measurement totals for every calendar day between?start= and ?end= (inclusive). Both parameters are required. This is more efficient than calling GET /v1/days/{date} repeatedly: the entire range counts as one budget unit.
Query parameters
Example requestGET /v1/workouts: Recent workout sessions
Returns your most recent workout sessions, sorted newest first. Use the optional?limit= parameter to control how many sessions are returned, up to a maximum of 50.
Query parameters
Maximum number of sessions to return. Accepts values from
1 to 50. Defaults to the server’s built-in default when omitted.Array of exercises performed, each containing a name and an array of sets with
reps and optional weightKg.GET /v1/measurements: Recent weigh-ins and measurements
Returns your most recent body measurements and weigh-ins, sorted newest first. Use the optional?limit= parameter to control how many records are returned, up to a maximum of 100.
Query parameters
Maximum number of measurement records to return. Accepts values from
1 to 100. Defaults to the server’s built-in default when omitted.null rather than being omitted, so a client can tell the difference between “nothing recorded” and “not supported”.
Where the row came from.
"manual" for a check-in typed in the app or written through the API, "health" for one read from Apple Health or Health Connect.GET /v1/health/days: Synced daily health readings
Returns the sleep, steps, resting heart rate, HRV, and active energy stored for each day betweenstart and end (both required, both inclusive), as synced from Apple Health or Health Connect.
Example request
Where the day came from:
"apple_health", "health_connect", or "manual" for a day that only ever held a typed correction.Fields on this day the user corrected by hand. Those values are pinned: the phone no longer overwrites them, and
POST /v1/health/days/{date} with value: null is what releases one.GET /v1/custom-metrics: The user’s own tracked metrics
Returns the metrics the user defined for themselves, the ones the app has no built-in screen for, each with its definition and its recent daily values.Query parameters
Example requestHow the app draws it:
counter for whole things tallied through the day, number for a figure typed once, toggle for did-it-or-not.The catalogue signal this metric is bound to, or
null when the user types it in. A bound metric is filed onto the Health dial matching its catalogue group; an unbound one files by its tab.GET /v1/health/metrics: The bindable catalogue
Returns the Apple Health and Health Connect signals a custom metric can be bound to, with each one’s key, label, unit, aggregation, HealthKit identifier, Health Connect record, plausible range, and agap note where one platform cannot supply it.
Read this before creating a metric with a healthMetricKey. A key the catalogue does not know is rejected on the way in, so guessing costs you a 400.
Query parameters
Narrow to one category:
activity, vitals, body, nutrition, sleep, reproductive, or mindfulness.Pass
true to include the metrics OneRep already scores on and draws its own screens for. Those cannot be bound; by default they are left out.This route reads a constant, not your log. It is the same list documented on Health metrics by platform, and the same caveat applies: the 25 most recently catalogued signals are bindable but not yet readable from a phone.