Partner API: Overview
Read-only snapshots and live data for broadcast overlays and approved integrations. Base path: /api/partner/v1.
Attribution (required)
Display the exact text “Powered by Scorsync”, visible and legible wherever Scorsync data is shown. For overlays, keep it on screen while data is shown. Link to https://scorsync.com where the medium allows.
Getting access
- The pilot is invitation-only. Your account needs an active Stripe or Apple entitlement (admins are exempt), and pilot access enabled by Scorsync.
- Open Account → API access. Request a named project with its URL, use case, expected traffic and requested scopes. Describe any paid use and accept the API Terms and attribution requirement.
- Wait for admin approval and a signed partner pilot agreement to be recorded. Approval can narrow the scopes you requested.
- Create a key for an approved project. Copy it immediately; plaintext is shown once. Revoke and replace it if lost.
First request
curl 'https://scorsync.com/index.php/api/partner/v1/ping' \
-H 'Authorization: Bearer YOUR_PARTNER_KEY' \
-H 'Accept: application/json'
ping reports your project, key type, scopes and locked meet IDs. It needs no resource scope.
Snapshots and pagination
Collections return data and, where paginated, meta.next_cursor. Use ?limit=25 (1–100) and pass the next cursor unchanged as ?cursor=... until it is null. Empty collections return [].
Start with meets → sessions → flights → start lists or standings. Athlete search requires ?search= with at least two characters. Scores use decimal strings with three places; absent values remain null. Timestamps are ISO-8601 UTC.
REST snapshots, incremental since polling, presence channels, flight state (live scoring-desk pointer or derived) and athlete stats including hit rate are available. See the live data, flight state and scopes guides.