API Reference

V1

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Calendar

Access clocks and financial calendars for market sessions and events.

Get Clock

CalendarGetClockResponse v1().calendar().getClock(CalendarGetClockParamsparams = CalendarGetClockParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

GET/v1/clock

Get Market Hours Calendar.

CalendarGetMarketHoursCalendarResponse v1().calendar().getMarketHoursCalendar(CalendarGetMarketHoursCalendarParamsparams = CalendarGetMarketHoursCalendarParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

GET/v1/calendars/market-hours

Get Economic Calendar Events

CalendarGetEconomicEventsCalendarResponse v1().calendar().getEconomicEventsCalendar(CalendarGetEconomicEventsCalendarParamsparams = CalendarGetEconomicEventsCalendarParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

GET/v1/calendars/economic-events

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 EconomicEvent:

A single economic calendar event.

Coverage spans roughly 365 days back to 90 days forward. estimate and actual are frequently absent for minor releases, speeches, and holidays. The calendar refreshes daily (around 7am ET), so actual can trail the real-world print by up to a day; a null actual before the print is expected, not missing data.

String country

ISO 3166-1 alpha-2 country code, or EU.

String name

Event name as reported by the provider.

LocalDateTime timestamp

UTC instant of the event.

formatdate-time

Optional<String> actual

Actual reported value. Null before the print, or if the provider never reports one for this event. When a null/undefined value is observed, it indicates that there is no available data.

Optional<String> change

Change from the previous value. When a null/undefined value is observed, it indicates that there is no available data.

Optional<String> changePercentage

Change from the previous value, as a percentage. When a null/undefined value is observed, it indicates that there is no available data.

Optional<String> currency

Currency associated with the event, if applicable. When a null/undefined value is observed, it indicates that there is no available data.

Optional<String> estimate

Analyst-estimated value. When a null/undefined value is observed, it indicates that there is no available data.

Optional<EconomicEventImpact> impact

Expected market impact, if known. When a null/undefined value is observed, it indicates that there is no available data.

One of the following:

NONE("NONE")

LOW("LOW")

MEDIUM("MEDIUM")

HIGH("HIGH")

Optional<String> previous

Previous period’s reported value. When a null/undefined value is observed, it indicates that there is no available data.

Optional<String> unit

Unit of the numeric value fields, if known. When a null/undefined value is observed, it indicates that there is no available data.

enum EconomicEventImpact:

Market impact of an economic calendar event.

NONE("NONE")

LOW("LOW")

MEDIUM("MEDIUM")

HIGH("HIGH")

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 When a null/undefined value is observed, it indicates it does not apply.

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. When a null/undefined value is observed, it indicates it does not apply.

formatduration

Optional<String> timeUntilOpen

ISO 8601 duration until session opens. Null if session has already started or closed. When a null/undefined value is observed, it indicates it does not apply.

formatduration

Optional<SessionSchedule> maintenance

Scheduled maintenance window. The market is closed inside it, even when it falls within another session. Null if none is scheduled for the day. When a null/undefined value is observed, it indicates it does not apply.

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. When a null/undefined value is observed, it indicates it does not apply.

formatduration

Optional<String> timeUntilOpen

ISO 8601 duration until session opens. Null if session has already started or closed. When a null/undefined value is observed, it indicates it does not apply.

formatduration

Optional<SessionSchedule> overnight

Overnight session schedule (prior evening through early morning), null if not available When a null/undefined value is observed, it indicates it does not apply.

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. When a null/undefined value is observed, it indicates it does not apply.

formatduration

Optional<String> timeUntilOpen

ISO 8601 duration until session opens. Null if session has already started or closed. When a null/undefined value is observed, it indicates it does not apply.

formatduration

Optional<SessionSchedule> preMarket

Pre-market session schedule, null if not available When a null/undefined value is observed, it indicates it does not apply.

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. When a null/undefined value is observed, it indicates it does not apply.

formatduration

Optional<String> timeUntilOpen

ISO 8601 duration until session opens. Null if session has already started or closed. When a null/undefined value is observed, it indicates it does not apply.

formatduration

Optional<SessionSchedule> regular

Regular trading session schedule, null if holiday/weekend When a null/undefined value is observed, it indicates it does not apply.

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. When a null/undefined value is observed, it indicates it does not apply.

formatduration

Optional<String> timeUntilOpen

ISO 8601 duration until session opens. Null if session has already started or closed. When a null/undefined value is observed, it indicates it does not apply.

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 When a null/undefined value is observed, it indicates it does not apply.

One of the following:

OVERNIGHT("overnight")

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 When a null/undefined value is observed, it indicates it does not apply.

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. When a null/undefined value is observed, it indicates it does not apply.

formatduration

Optional<String> timeUntilOpen

ISO 8601 duration until session opens. Null if session has already started or closed. When a null/undefined value is observed, it indicates it does not apply.

formatduration

Optional<SessionSchedule> maintenance

Scheduled maintenance window. The market is closed inside it, even when it falls within another session. Null if none is scheduled for the day. When a null/undefined value is observed, it indicates it does not apply.

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. When a null/undefined value is observed, it indicates it does not apply.

formatduration

Optional<String> timeUntilOpen

ISO 8601 duration until session opens. Null if session has already started or closed. When a null/undefined value is observed, it indicates it does not apply.

formatduration

Optional<SessionSchedule> overnight

Overnight session schedule (prior evening through early morning), null if not available When a null/undefined value is observed, it indicates it does not apply.

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. When a null/undefined value is observed, it indicates it does not apply.

formatduration

Optional<String> timeUntilOpen

ISO 8601 duration until session opens. Null if session has already started or closed. When a null/undefined value is observed, it indicates it does not apply.

formatduration

Optional<SessionSchedule> preMarket

Pre-market session schedule, null if not available When a null/undefined value is observed, it indicates it does not apply.

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. When a null/undefined value is observed, it indicates it does not apply.

formatduration

Optional<String> timeUntilOpen

ISO 8601 duration until session opens. Null if session has already started or closed. When a null/undefined value is observed, it indicates it does not apply.

formatduration

Optional<SessionSchedule> regular

Regular trading session schedule, null if holiday/weekend When a null/undefined value is observed, it indicates it does not apply.

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. When a null/undefined value is observed, it indicates it does not apply.

formatduration

Optional<String> timeUntilOpen

ISO 8601 duration until session opens. Null if session has already started or closed. When a null/undefined value is observed, it indicates it does not apply.

formatduration

enum MarketSessionType:

Session type for market hours

OVERNIGHT("overnight")

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 When a null/undefined value is observed, it indicates it does not apply.

One of the following:

OVERNIGHT("overnight")

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. When a null/undefined value is observed, it indicates it does not apply.

formatduration

Optional<String> timeUntilOpen

ISO 8601 duration until session opens. Null if session has already started or closed. When a null/undefined value is observed, it indicates it does not apply.

formatduration

class TradingSessions:

Trading sessions for a market day with full timestamps

Optional<SessionSchedule> afterHours

After-hours session schedule, null if not available When a null/undefined value is observed, it indicates it does not apply.

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. When a null/undefined value is observed, it indicates it does not apply.

formatduration

Optional<String> timeUntilOpen

ISO 8601 duration until session opens. Null if session has already started or closed. When a null/undefined value is observed, it indicates it does not apply.

formatduration

Optional<SessionSchedule> maintenance

Scheduled maintenance window. The market is closed inside it, even when it falls within another session. Null if none is scheduled for the day. When a null/undefined value is observed, it indicates it does not apply.

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. When a null/undefined value is observed, it indicates it does not apply.

formatduration

Optional<String> timeUntilOpen

ISO 8601 duration until session opens. Null if session has already started or closed. When a null/undefined value is observed, it indicates it does not apply.

formatduration

Optional<SessionSchedule> overnight

Overnight session schedule (prior evening through early morning), null if not available When a null/undefined value is observed, it indicates it does not apply.

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. When a null/undefined value is observed, it indicates it does not apply.

formatduration

Optional<String> timeUntilOpen

ISO 8601 duration until session opens. Null if session has already started or closed. When a null/undefined value is observed, it indicates it does not apply.

formatduration

Optional<SessionSchedule> preMarket

Pre-market session schedule, null if not available When a null/undefined value is observed, it indicates it does not apply.

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. When a null/undefined value is observed, it indicates it does not apply.

formatduration

Optional<String> timeUntilOpen

ISO 8601 duration until session opens. Null if session has already started or closed. When a null/undefined value is observed, it indicates it does not apply.

formatduration

Optional<SessionSchedule> regular

Regular trading session schedule, null if holiday/weekend When a null/undefined value is observed, it indicates it does not apply.

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. When a null/undefined value is observed, it indicates it does not apply.

formatduration

Optional<String> timeUntilOpen

ISO 8601 duration until session opens. Null if session has already started or closed. When a null/undefined value is observed, it indicates it does not apply.

formatduration