API access

Manage API keys, scopes, and partner access.

Review your account’s rate limits, understand the scopes that each key can grant, and jump directly into the editors where scoped keys live.

Your API policy

Every key you generate—personal or scoped—shares these global limits. Request a higher tier when your integrations outgrow them.

Loading policy…

Need more throughput or write access? Contact us to talk through higher tiers.

Key type overview

Personal keys are tied to your user account. Scoped keys live inside the entity editors so you can limit what a partner sees.

Personal access keys

Ideal for server-to-server jobs, CLI tooling, or prototypes that only need the same read scopes you already have in the dashboard.

Scopes granted

  • matches.read

    Access the public match finder, match detail feeds, and supporting metadata while consuming your account's API rate limits.

  • clubs.read

    Read the club directory endpoints and metadata tied to the events you manage.

  • series.read

    Pull series listings, leaderboards, and standings that your account can view.

  • seasons.read

    Mirror season schedules and standings with the same permissions available in the dashboard.

Uses your account's shared rate limits.

Club scoped keys

Generate read-only keys for a single club when you need to sync private rosters, contact details, or unpublished schedules with partner tooling.

Scopes granted

  • clubs.read

    Read the standard club discovery endpoints and metadata while consuming your account's API rate limits.

  • clubs.read:{clubId}

    Access a club's protected profile fields—including private contact info and unpublished seasons or matches—for the integrations you trust.

Shares your account’s global rate limit (see policy card).

Paste the Firestore document ID for the club you manage to jump straight into its editor. Owners and admins can create keys.

Match scoped keys

Share private match schedules, squad assignments, unpublished documents, and push scoring data from trusted range devices—without exposing other events.

Scopes granted

  • matches.read

    Call the standard match finder and detail endpoints with your account's global rate limits.

  • matches.read:match:{matchId}

    Unlock protected metadata for a specific match, including unpublished stages, schedules, and documents that aren't visible publicly.

  • match:{matchId}:events.write

    Submit stage events and scoring updates for a specific match, enabling real-time integrations without broad match access.

Shares your account’s global rate limit (see policy card).

Enter the match's Firestore document ID from your admin list. You will land on the match editor with the API key panel ready.

Season scoped keys

Mirror a season's private schedule or standings in your own dashboards while keeping the rest of your organization's data locked down.

Scopes granted

  • seasons.read

    Access the season discovery endpoints and metadata while consuming your account's API rate limits.

  • seasons.read:{seasonId}

    Read unpublished matches, private notes, and other protected season data that only administrators can normally see.

Shares your account’s global rate limit (see policy card).

Provide the Firestore document ID for the season you administer to open its editor and manage scoped keys.

Series scoped keys

Give trusted partners access to private series notes, unpublished schedules, or custom scoring pipelines without broadening their permissions.

Scopes granted

  • series.read

    Call the series listing endpoints and metadata using the same rate limits as your account.

  • series.read:{seriesId}

    Expose protected series details—private notes, unpublished events, and admin-only metadata—for a specific series.

Shares your account’s global rate limit (see policy card).

Use the public slug or the Firestore document ID. The editor will resolve either one before showing the API key panel.

Personal access keys

Keys generated here use your personal scopes and inherit every rate limit shown above. Rotate or revoke them anytime without affecting your entity-specific keys.

Loading key policy…

API Keys

Keys generated here can access the protected endpoints for this entity. Treat them like passwords.

Granted scopes

  • matches.read – Access the public match finder, match detail feeds, and supporting metadata while consuming your account's API rate limits.
  • clubs.read – Read the club directory endpoints and metadata tied to the events you manage.
  • series.read – Pull series listings, leaderboards, and standings that your account can view.
  • seasons.read – Mirror season schedules and standings with the same permissions available in the dashboard.

Create a new key

The key will inherit the scopes listed above and be subject to the same rate limits.

Loading API keys…

API Keys — The Shooters Hub Developer Platform