screeps-api
    Preparing search index...

    Interface RateLimit

    Rate limit state for an individual HTTP API endpoint.

    This relevant state for a given endpoint can be looked up via ScreepsRateLimitTracker.find.

    interface RateLimit {
        limit: number;
        period: RateLimitPeriod;
        remaining: number;
        reset: number;
        toReset: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    limit: number

    Maximum number of requests that can be sent within a given time period

    Time period to which the limit applies

    remaining: number

    Remaining number of requests that can be sent until reset

    reset: number

    UNIX timestamp (in seconds) indicating when the rate limit will automatically reset.

    toReset: number

    Time (in seconds) until reset