Skip to content

Getting Access

You need three things before you can open a feed: data feeds enabled on your Scorbit account, your agreement to the Developer Terms, and an API key.

1. Ask for Data Feeds

Contact your Scorbit representative to enable data feeds on your Scorbit account. Once they are enabled, a Developer page appears in the Account settings sidebar in Scorbit Console, at console.scorbit.io/accounts/developer/.

A feed only ever covers machines your account owns or operates.

2. Accept the Developer Terms

In Scorbit Console, open Account settings → Developer. The first time you click Generate new key, you are asked to accept the Scorbit Developer Terms. You can't generate a key without accepting them.

The terms cover how you may use feed data, how you must handle player information, and the Scorbit attribution you must show wherever feed data appears (see Branding and Media Kit).

When the terms change, your existing keys keep working, but you accept the new version before generating another key.

3. Generate an API Key

In the API keys section of the Developer page, click Generate new key, optionally name it (for example "OBS overlay"), and choose its scope:

Scope Covers
Venues Every machine at the venues you choose, including machines added to those venues later
Machines Only the specific machines you choose

The key starts with sb_live_. It is shown only once: copy it straight into a secure place, such as a password manager or your server's environment. Treat it like a password and never put it in a web page, a URL or a public repository (see Credentials and Security).

Your account can hold up to five active API keys, for example one per venue or one per project. The API keys list shows each key's name, a masked copy of the key, its scope, and when it was created and last used.

Which scope should I pick?

For an overlay or display that should always show everything at a venue, choose Venues: a feed opened without naming machines follows the venue, picking up machines as they are added and dropping them as they are removed. For a stream that always shows the same specific machines, choose Machines.

The Developer Page

The Developer page has three sections:

  • API keys: your keys, with Generate new key and Revoke key.
  • Live data feeds: every feed your account has running right now, with its machines, transport, the key that opened it and its age, and a Stop button for each. Stopping a feed ends it for whatever is connected to it.
  • Media and branding: Open brand kit shows the Scorbit logos you use to meet the attribution requirement, with Download all (.zip). See Branding and Media Kit.

Limits

Limit Value
Active API keys per account 5
Live feeds running at once per account 2
Machines in one feed 50
Venues or machines in one key's scope 500

Opening a feed beyond the live-feed limit is refused until another feed ends. A key whose scope covers more than 50 machines can still be used: open each feed with a list of up to 50 machines. See Lifecycle and Troubleshooting for the errors and request rate limits.

Revoking a Key

Revoke a key you no longer use, or one that may have been exposed, with Revoke key. Every feed that key opened ends, usually within seconds and always within about a minute. If you think a key has been compromised, revoke it and also report it to security@scorbit.io.

Scorbit can also revoke keys, suspend data feed access for an account, or switch data feeds off platform-wide. A feed affected by any of these ends with the reason withdrawn (see Lifecycle and Troubleshooting).

Next Steps