About the API

Rate Limiting

Overview

To ensure optimal use of the Propexo API, it’s important to understand and adhere to its rate limits. This guide elaborates on the best practices and mechanisms in place for managing data requests and interactions with the API.

Propexo API Rate Limits: A Detailed Look

Propexo’s standard contracted rate limit is typically set at 150 requests per minute, but this can be adjusted depending on your specific contract with us. The Propexo API imposes this rate limit to maintain system integrity and provide equal access to services for all users. Users are strongly advised against polling the API excessively. Instead, leveraging webhooks is recommended for receiving time-sensitive updates, which is far more efficient and reduces unnecessary load on the API.

The data cache of the Propexo API is refreshed with each synchronization request to your PMS integration or after successful write operations. Typically, these sync requests are scheduled every 12 hours, although this can be adjusted based on individual integration needs. Polling the API more frequently than the sync schedule will not yield new information, making such requests redundant.

To facilitate transparent usage monitoring, the API includes the X-RateLimit-Limit header, showing the current rate limit status for your account. When your usage nears the limit, reaching 80%, the API introduces a slight delay of 2 seconds to throttle the requests, aiming to prevent rate limit breaches. Should you hit the 100% threshold, the API will respond with a 429 error code, indicating that the rate limit has been exceeded, and requests will be blocked until the limit resets.

Adhering to these guidelines ensures a smooth and efficient interaction with the Propexo API, allowing users to optimize their data handling while preventing overutilization of resources.