NAME

HTTP::API::Core::RateLimit - Normalized HTTP API rate-limit metadata

DESCRIPTION

Represents rate-limit information parsed from the RateLimit-Limit, RateLimit-Remaining, and RateLimit-Reset header family used by earlier IETF rate-limit drafts, plus the widely-used X-RateLimit-* family. Retry-After is also captured.

METHODS

limit, remaining, used, resource

Normalized quota metadata when present.

reset

Seconds until reset from RateLimit-Reset.

reset_epoch

UTC epoch reset timestamp from X-RateLimit-Reset.

wait_seconds

Returns the preferred delay before retrying. Retry-After takes precedence, then RateLimit-Reset, then X-RateLimit-Reset converted from epoch time.

exhausted

True when a numeric remaining value is present and is zero or less.