Calendar

Access clocks and financial calendars for market sessions and events.

Get Clock

CalendarGetClockResponse v1().calendar().getClock(, )

GET/v1/clock

Get Market Hours Calendar.

CalendarGetMarketHoursCalendarResponse v1().calendar().getMarketHoursCalendar(, )

GET/v1/calendars/market-hours

ModelsExpand Collapse

class ClockDetail:

Current server time and market clock information

LocalDateTime clock

Current server time in UTC

formatdate-time

enum DayType:

Day type for market hours - indicates the type of trading day

TRADING_DAY("TRADING_DAY")

EARLY_CLOSE("EARLY_CLOSE")

HOLIDAY("HOLIDAY")

WEEKEND("WEEKEND")

class MarketHoursDetail:

Comprehensive market hours information for a specific market and date

LocalDateTime currentTime

Current time in market timezone with offset

formatdate-time

LocalDate date

The date for which market hours are provided

formatdate

MarketType market

Market type identifier

One of the following:

US_EQUITIES("us_equities")

US_OPTIONS("us_options")

String marketName

Human-readable market name

TradingSessions nextSessions

Next trading day’s session schedules (without time_until fields)

Optional<SessionSchedule> afterHours

After-hours session schedule, null if not available

LocalDateTime close

Session close timestamp with timezone offset

formatdate-time

LocalDateTime open

Session open timestamp with timezone offset

formatdate-time

Optional<String> timeUntilClose

ISO 8601 duration until session closes. Null if session is not currently open.

formatduration

Optional<String> timeUntilOpen

ISO 8601 duration until session opens. Null if session has already started or closed.

formatduration

Optional<SessionSchedule> preMarket

Pre-market session schedule, null if not available

LocalDateTime close

Session close timestamp with timezone offset

formatdate-time

LocalDateTime open

Session open timestamp with timezone offset

formatdate-time

Optional<String> timeUntilClose

ISO 8601 duration until session closes. Null if session is not currently open.

formatduration

Optional<String> timeUntilOpen

ISO 8601 duration until session opens. Null if session has already started or closed.

formatduration

Optional<SessionSchedule> regular

Regular trading session schedule, null if holiday/weekend

LocalDateTime close

Session close timestamp with timezone offset

formatdate-time

LocalDateTime open

Session open timestamp with timezone offset

formatdate-time

Optional<String> timeUntilClose

ISO 8601 duration until session closes. Null if session is not currently open.

formatduration

Optional<String> timeUntilOpen

ISO 8601 duration until session opens. Null if session has already started or closed.

formatduration

MarketStatus status

Market status information

DayType dayType

The type of trading day

One of the following:

TRADING_DAY("TRADING_DAY")

EARLY_CLOSE("EARLY_CLOSE")

HOLIDAY("HOLIDAY")

WEEKEND("WEEKEND")

boolean isOpen

Whether the market is currently open (real-time)

Optional<MarketSessionType> currentSession

Current session type if market is open, null if closed

One of the following:

PRE_MARKET("pre_market")

REGULAR("regular")

AFTER_HOURS("after_hours")

String timezone

IANA timezone identifier for the market

TradingSessions todaySessions

Trading session schedules for the requested date with time_until fields

Optional<SessionSchedule> afterHours

After-hours session schedule, null if not available

LocalDateTime close

Session close timestamp with timezone offset

formatdate-time

LocalDateTime open

Session open timestamp with timezone offset

formatdate-time

Optional<String> timeUntilClose

ISO 8601 duration until session closes. Null if session is not currently open.

formatduration

Optional<String> timeUntilOpen

ISO 8601 duration until session opens. Null if session has already started or closed.

formatduration

Optional<SessionSchedule> preMarket

Pre-market session schedule, null if not available

LocalDateTime close

Session close timestamp with timezone offset

formatdate-time

LocalDateTime open

Session open timestamp with timezone offset

formatdate-time

Optional<String> timeUntilClose

ISO 8601 duration until session closes. Null if session is not currently open.

formatduration

Optional<String> timeUntilOpen

ISO 8601 duration until session opens. Null if session has already started or closed.

formatduration

Optional<SessionSchedule> regular

Regular trading session schedule, null if holiday/weekend

LocalDateTime close

Session close timestamp with timezone offset

formatdate-time

LocalDateTime open

Session open timestamp with timezone offset

formatdate-time

Optional<String> timeUntilClose

ISO 8601 duration until session closes. Null if session is not currently open.

formatduration

Optional<String> timeUntilOpen

ISO 8601 duration until session opens. Null if session has already started or closed.

formatduration

enum MarketSessionType:

Session type for market hours

PRE_MARKET("pre_market")

REGULAR("regular")

AFTER_HOURS("after_hours")

class MarketStatus:

Market status information

DayType dayType

The type of trading day

One of the following:

TRADING_DAY("TRADING_DAY")

EARLY_CLOSE("EARLY_CLOSE")

HOLIDAY("HOLIDAY")

WEEKEND("WEEKEND")

boolean isOpen

Whether the market is currently open (real-time)

Optional<MarketSessionType> currentSession

Current session type if market is open, null if closed

One of the following:

PRE_MARKET("pre_market")

REGULAR("regular")

AFTER_HOURS("after_hours")

enum MarketType:

Market type for market hours calendar endpoint

US_EQUITIES("us_equities")

US_OPTIONS("us_options")

class SessionSchedule:

Session schedule with open and close timestamps

LocalDateTime close

Session close timestamp with timezone offset

formatdate-time

LocalDateTime open

Session open timestamp with timezone offset

formatdate-time

Optional<String> timeUntilClose

ISO 8601 duration until session closes. Null if session is not currently open.

formatduration

Optional<String> timeUntilOpen

ISO 8601 duration until session opens. Null if session has already started or closed.

formatduration

class TradingSessions:

Trading sessions for a market day with full timestamps

Optional<SessionSchedule> afterHours

After-hours session schedule, null if not available

LocalDateTime close

Session close timestamp with timezone offset

formatdate-time

LocalDateTime open

Session open timestamp with timezone offset

formatdate-time

Optional<String> timeUntilClose

ISO 8601 duration until session closes. Null if session is not currently open.

formatduration

Optional<String> timeUntilOpen

ISO 8601 duration until session opens. Null if session has already started or closed.

formatduration

Optional<SessionSchedule> preMarket

Pre-market session schedule, null if not available

LocalDateTime close

Session close timestamp with timezone offset

formatdate-time

LocalDateTime open

Session open timestamp with timezone offset

formatdate-time

Optional<String> timeUntilClose

ISO 8601 duration until session closes. Null if session is not currently open.

formatduration

Optional<String> timeUntilOpen

ISO 8601 duration until session opens. Null if session has already started or closed.

formatduration

Optional<SessionSchedule> regular

Regular trading session schedule, null if holiday/weekend

LocalDateTime close

Session close timestamp with timezone offset

formatdate-time

LocalDateTime open

Session open timestamp with timezone offset

formatdate-time

Optional<String> timeUntilClose

ISO 8601 duration until session closes. Null if session is not currently open.

formatduration

Optional<String> timeUntilOpen

ISO 8601 duration until session opens. Null if session has already started or closed.

formatduration