Interface RestApiRateLimit

Represents the rate limit information for a REST API response.

interface RestApiRateLimit {
    limit?: number;
    remaining?: number;
    retryAfter?: number;
    usedWeight?: number;
}

Properties

limit?: number

The maximum number of requests allowed within the current window.

remaining?: number

The number of requests remaining in the current window.

retryAfter?: number

The time (in seconds) to wait before making another request after a rate limit response.

usedWeight?: number

The cumulative request weight consumed by the caller.