Appearance
API Usage Limits
Managing Your API Usage
Manheim applies usage limits to each customer's API package key to maintain consistent quality. This document describes those limits and shows you how to track your API usage.
API Usage Limits
The limits are:
- 1,000 queries per second (QPS)
- 2,000,000 queries per day (Quota)
Tracking Usage
To help you keep track of your API usage, Manheim now returns usage information in response headers. This can help you make your applications more resilient. If your application is about to hit a per-second usage limit, for example, you could add a slight delay to the next call. This information can be very useful for developers building custom applications using Manheim APIs.
| Header | Description |
|---|---|
| X-Packagekey-Qps-Allotted | The maximum QPS (queries per second) capacity set on your API key. This is the maximum number of calls that can be made in any given second. |
| X-Packagekey-Qps-Current | The current count of calls being applied against the above limit; in this case, it is a representation of how many calls your key is making at that particular second in time. |
| X-Packagekey-Quota-Allotted | The maximum number of calls that can be made on a daily basis. |
| X-Packagekey-Quota-Current | The current count of calls made in the current limit period, i.e. the current day. |
| X-Plan-Quota-Reset | The time when the quota count will reset to 0. |
Example response headers are:
X-Plan-QPS-Allotted →1000
X-Plan-QPS-Current →28
X-Plan-Quota-Allotted →2000000
X-Plan-Quota-Current →12000
X-Plan-Quota-Reset →Thursday, May 18, 2017 12:00:00 AM GMT