API Rate Limiter#
We are committed to providing you with the best possible experience when using our APIs. To ensure the stability, security, and performance of our services, we have implemented an API Rate Limiter for all of our SOAP API Endpoints.What is an API Rate Limiter?#
An API rate limiter is a mechanism that controls the number of API requests a user can make within a specific time frame. This helps prevent misuse and ensures that our system remains responsive and reliable for all users.Why Have We Implemented This?#
1.
Prevent Misuse: By limiting the number of requests, we can protect our APIs from being overwhelmed by excessive or malicious traffic.
2.
Maintain Performance: Ensuring that our services remain fast and responsive for everyone, even during peak usage times.
3.
Enhance Security: Reducing the risk of denial-of-service attacks and other security threats.
Rate Limits#
| webMethod | calls per min | calls per hour |
|---|
| getCustomer | 100 | 2000 |
| getCustomers | 50 | 500 |
| updateCustomer | 100 | 2000 |
| orderCreate | 100 | 2000 |
| orderQuery | 100 | 2000 |
| reserveResources | 50 | 500 |
| getServiceInstances | 50 | 500 |
| getServicesV2 | 50 | 500 |
| queryBalanceV3 | 100 | 2000 |
| getServiceDetail | 100 | 2000 |
| getUnbilledCallsDetail | 100 | 2000 |
| getGroupPlans | 50 | 500 |
What happens once an API Rate Limit is exceeded?#
You will receive an error as per below once the API limit has been exceeded for a SOAP API, blocking you from making any more API calls until the timer is reset:<soapenv:Fault>
<faultcode>233</faultcode>
<faultstring>API rate limit has been exceeded for this operation - please try again in: {time left until reset}
</soapenv:Fault>
Rate limits are tracked for individual API endpoints, so if you exceed the rate limit for calling a Customer API, this will only block the Customer API but not impact any other endpoints.
Support#
If you have any questions or need assistance, raise a ticket to our Support Team via Assist.