Partner API: Scopes
Each key is limited to its project’s granted scopes. Approval may grant fewer scopes than requested.
| Scope | Endpoints / access |
|---|---|
meets:read | Meets, sessions, flights and start lists |
results:read | Flight standings, meet routine scores, incremental changes and flight state |
athletes:read | Athlete search / show; opted-in profile fields in nested athlete records |
stats:read | Athlete season stats; event=TI|DM|TU|TS required, calendar-year season defaults to the current year, level optional |
live:subscribe | Authorize partner presence subscriptions via POST /live/auth (also requires results:read) |
Competition identity stays available in start lists and standings without athletes:read. Additional profile fields require that scope and disappear after a profile opt-out. Scopes never override meet visibility or locks.
Synchro (TS) has no personal-best record; personal_best is null with unsupported: synchro_has_no_personal_bests. avg_dd averages routines with a difficulty above zero and leaves out routines known to be interrupted (excludes: ["interrupted"]).
hit_rate is {value, n, since, method, excludes}: the share of routines the athlete completed, among routines whose completeness is known. For now a hit is a complete routine (method: "skills_completed"): every pass and skill performed. A later method will also compare the DD with the DD the athlete planned; it will use a new method value.
Completeness comes from the scoring desk's interruption mark (meets scored with Scorsync Local) or, for earlier meets, from per-judge skill deductions (meets scored with ProScore that send them). Routines with neither are left out, so n counts only routines with this data. HUGS routines are always left out (excludes: ["hugs"]). value is a three-place decimal string, null while n is below 5. since is the start date of the earliest meet in the sample (null when n is 0).