Rate Limiting

The SCALAR APIs all apply rate limiting to ensure that undeliberate or deliberate calls cannot lead to bringing the platform down or causing high costs for the organization by a miscoding.

Each SCALAR API endpoint will have the appropriate high enough level for each normal use case. The rate limits are dependent on the bought SCALAR commercial product and the type of API endpoint. If you are constantly getting 'rate limit - too many requests' and the developer feels this is not warranted, then please contact your SCALAR representative.

If you exceed any of the rate limits, SCALAR will respond with an http response code 429 - Too many requests.

SCALAR Rate limits dimensions: organization & integrator

SCALAR applies for all Rest API endpoints throttling by default. The rate limiting is always applied per minute. Rate limits are defined on two dimensions: on the organization and on the integrator dimension. Both dimensions are always checked and if one dimension is exceeded, it will throw an HTTP response code 429 (too many requests).

An example to show this. Assume that on organization level the rate limit is 60 and on integrator level the rate limit is 40. Let's say that one organization has two integrators (A & B).

Case	Integrator A response	Integrator B response
Current rate limit counts: - 60 calls on organization - 35 calls by integrator A - 25 calls by integrator B	No call possible due to maximum calls reached on organization.	No call possible due to maximum calls reached on organization
Current rate limit counts: - 45 calls on organization - 40 calls by integrator A - 5 calls by integrator B	No call possible due to maximum calls reached to the organization A.	Call possible as organization limit is not reached 45<= 60 & integrator limit not reached 5 <= 40.

If you reached the limit when the minute is over, the integrator will again have the rights to make calls. If the developer is constantly hitting the limit then either the integration should be reviewed or the bought commercial product is not fitting the needs of the organization.

SCALAR Rate limits categories

All SCALAR Rest API have rate limits but the rate limit category will be different. Some Rest APIs will have a very low rate limit because it is not designed (or intended) to handle a huge amount of calls while other are really designed to be called almost continuously to constantly stream data. This is exactly why SCALAR uses rate limit categories.

SCALAR has today only 4 rate limit categories and each Rest API endpoint will be clearly described with the rate limit category. The categories are (from low to high rate limits):

small
normal
large
xlarge

SCALAR Rate limit category values

The developer might ask what are then the rate limit values attached to these categories. Good question ... there is however an additional factor that plays a role. The commercial products bought also define the value of the rate limits.

SCALAR commercial products come in different versions to fit the needs of the organization. A basic commercial product vs an enterprise commercial product will have different rate limit values per category. This level is expressed in a number - low numbers mean more basic version while high numbers mean more advanced products. One could see 10 = starter version --> 60 = enterprise version

Organization rate limit dimension (rates per minute!):

Rate limit category/version	10 (=starter)	20	40	60 (= enterprise)
small	6	10	20	60
normal	6	20	60	600
large	6	60	600	6000
xlarge	6	90	900	9000

Integrator rate limit dimension (rates per minute!):

Rate limit category/version	10 (=starter)	20	40	60 (=enterprise)
small	6	10	20	40
normal	6	20	40	400
large	6	40	400	4000
xlarge	6	60	600	6000