Limits

In order to provide a high quality of service to all users, there are limits applied to the usage of the API.

There are currently two types of limit:

  • Throttle limit
  • Quota limit

All API endpoints share the same limits. For example, if you go over a limit by calling the Search endpoint, your access to the Get by Listing ID endpoint will also be restricted.

The values of the throttle and quota limits for each key type (see Authenticating) are:

Key Type Throttle Limit Quota Limit
Test 1 request per second 250 requests per day
Production 3 request per second 10,000 requests per day

Tip: If these limits are too restrictive for your application (or you go over your limit), please email us about increasing your usage threshold.

Throttle Limit

The throttle limit restricts the number of times your application can access the API per second. When your go over your throttle limit, subsequent requests (within the same second) will fail with:

  • An HTTP status code of 403 (Forbidden)
  • An HTTP header called X-Error-Detail containing the message 'Account Over Rate Limit'
  • The following JSON message:
    {
        "code": 403,
        "message": "Account over rate limit"
    }

Quota Limit

The quota limit restricts the number of times your application can access the API in a single day. When your go over your quota limit, subsequent requests (within the same day) will fail with:

  • An HTTP status code of 403 (Forbidden)
  • An HTTP header called X-Error-Detail containing the message 'Account Over Quota Limit'
  • The following JSON message:
    {
        "code": 403,
        "message": "Account over quota limit"
    }

Viewing Your Limits

To view your limits, and your current API usage, visit the My API Keys page on the Sensis® Developer Centre portal.

Select View Report for your API key. You should be able to see your current quota usage, your quota limit (calls per day) and your throttle limit (calls per second).