Package markets.alpaca.client.rest

Class AlpacaRateLimit

java.lang.Object

markets.alpaca.client.rest.AlpacaRateLimit

public final class AlpacaRateLimit
extends Object

Parsed rate-limit metadata from Alpaca REST response headers.

Method Summary

Modifier and Type	Method	Description
static AlpacaRateLimit	from(Map<String,List<String>> headers)	Parses Alpaca's common rate-limit response headers, ignoring missing or invalid values.
OptionalLong	limit()	Maximum number of requests allowed in the current rate-limit window, when reported.
OptionalLong	remaining()	Remaining requests in the current rate-limit window, when reported.
Optional<Instant>	resetAt()	Reset time as an Instant, when reported.
OptionalLong	resetEpochSeconds()	Reset time as epoch seconds, when reported.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

from

public static AlpacaRateLimit from(Map<String,List<String>> headers)

Parses Alpaca's common rate-limit response headers, ignoring missing or invalid values.

limit

public OptionalLong limit()

Maximum number of requests allowed in the current rate-limit window, when reported.

remaining

public OptionalLong remaining()

Remaining requests in the current rate-limit window, when reported.

resetEpochSeconds

public OptionalLong resetEpochSeconds()

Reset time as epoch seconds, when reported.

resetAt

public Optional<Instant> resetAt()

Reset time as an Instant, when reported.