API Keys and Usage Plans
An API Key is required to access all Altrata APIs. The API key determines the usage plan associated to your requests.
Your API key should have been delivered to your via an email. If it has not, contact your Account Manager.
8kiHySX,0l-.bwlP=RC2m,I-wVU,b0fZ
Your API Key determines your Usage Plan and is not an authentication or authorization mechanism. Currently, only one Usage Plan is provided, with the following limits:
API keys have set limits on them. These limits will be determined by how you are making your requests to the the API endpoint.
You will need to provide your API key as a header value for the x-api-key header.
Service | Rate | Burst | Quota |
|---|---|---|---|
Profile API | 5 per second | 3 Requests | 100 requests per day |
Matching API | 100 per second | 50 Requests | 1,000,000 requests per day |
Exceeding these limits causes the following error messages to be returned:
429 Too Many Requests - when you have exceeded your rate limit. To resolve this error, use retries and an exponential backoff algorithm with jitter, and then resubmit your API request.
429 Limit Exceeded - when you have exceeded your daily quota.
If you require an increase in your rate limit, or quota, please reach out to your Account Manager.
API keys currently do not have a set expiration date and time. If you wish to rotate your API key, please contact Altrata support who will be able to assist in the matter.
