Rate Limit
Rate Limit Object
Property | Type | Description | Writable |
---|---|---|---|
request_limit | integer | The maximum number of requests available in the current time frame. | No |
request_remaining | integer | The number of remaining requests in the current time frame. | No |
request_reset | integer | The number of seconds when the rate limit will reset. | No |
Get Your Rate Limit Status
GET /rate-limit
Returns your current rate limit status.
Note: Accessing this endpoint does not count against your REST API rate limit.
The following request returns your current rate limit status:
curl https://api.oberplan.com/v1/rate-limit \
-X GET \
-u user@oberplan.com:mypassword
Sample response:
{ "data": { "request_limit": 100, "request_remaining": 26, "request_reset": 185, }, "success": true }