What to expect from /v1 over time, your key’s limits and the rules to follow.

Versions

/v1 only changes by additions: a new operation, a new response field, a new possible value. Nothing is removed or renamed.

Your code must therefore ignore fields it does not know. An added field must never make it fail.

Breaking changes and notice

A change that would break your code goes into a /v2. /v1 keeps answering during the notice period.

The notice is 6 months. You can read it in three places:

  • the Deprecation header on every response of the affected version;
  • the Sunset header, which gives the date it will stop answering;
  • an entry in the API changelog.

Limits per key

Each key can send 120 requests per minute and 3,000 per hour. Beyond that, the API answers 429: wait before retrying.

These limits may change. Any change is announced in the changelog, with notice.

Terms of use

By using the API, you agree to follow these rules.

  • Respect your key’s limits.
  • Do not resell the API’s data.
  • Rally may revoke a key at any time, for example if these rules are not followed.
  • Data about people (players, volunteers) falls under Quebec’s Law 25: treat it accordingly.

No sandbox

There is no test environment yet. An rk_live_ key acts on real data. Start with a read key, which cannot change anything.