Request limits

To ensure the smooth running of the API, Cardinus has applied limits on usage by client applications. These limits take the form of:

• A quota which is the total number of requests allowed over a period such as a month or day.
• A rate limit, which is a limit on the number of requests made within a short timespan.

Quota

Each customer has a limited amount of requests allocated to the PACE API on a daily or monthly basis. Once these are exceeded an HTTP status code of 429 Too Many Requests will result, and no more requests will be allowed until the next quota period rolls around. Unused API calls do not roll over to the next period. If you require a higher quota, please contact [email protected] to discuss options.

An example of the error message is below:

{
    "type": "https://docs.cardinus.com/articles/pace/api/http-codes.html#quotaexceeded",
    "title": "Maximum quota of requests exceeded",
    "status": 429,
    "detail": "The maximum number of daily requests is 500."
}

Rate limit

The API has a built in default rate limit across the system. This is to protect the system from having to process too many requests at any one time. If the client application exceeds the allowed rate then the message will state when a new request can be made.

The rate limit is typically a limit of five requests per ten seconds. This rate may be modified as the Cardinus infrastructure is developed.

An example of the error message is below:

{
    "type": "https://docs.cardinus.com/articles/pace/api/http-codes.html#rateexceeded",
    "title": "Request rate exceeded",
    "status": 429,
    "detail": "Maximum allowed request rate: 5 per 10s. Please try again in 7 second(s)."
}