Rate limits - Scoutworks API

Each key can make 120 requests a minute. Each IP address can also make 600 requests a minute, across all its keys. For most groups this is far more than enough. A sheet that reads 1,000 members at 200 a page needs 5 requests.

Headers

Every response carries three headers:

Header	Meaning
`RateLimit-Limit`	The number of requests allowed in the window.
`RateLimit-Remaining`	The number left in the current window.
`RateLimit-Reset`	Seconds until the window resets.

When you go over

The API answers 429 with the code rate_limited. The response has a Retry-After header, and retryAfter in the body. Both give the number of seconds to wait.

{
  "error": {
    "code": "rate_limited",
    "message": "This API key has made more than 120 requests in a minute. Please slow down and try again shortly."
  },
  "retryAfter": 23
}

Wait that long, then send the same request again. Do not retry at once in a loop. Every retry counts against the limit.

Tips

Use limit=200 to read a list in fewer requests.
Refresh a spreadsheet once a day or once an hour, not every minute.
One key per tool makes it easy to see which tool is busy, and to revoke only that one.