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

client.V1.Calendar.GetClock(ctx) (*V1CalendarGetClockResponse, error)

GET/v1/clock

Get Market Hours Calendar.

client.V1.Calendar.GetMarketHoursCalendar(ctx, query) (*V1CalendarGetMarketHoursCalendarResponse, error)

GET/v1/calendars/market-hours

ModelsExpand Collapse

type ClockDetail struct{…}

Current server time and market clock information

Clock Time

Current server time in UTC

formatdate-time

type DayType string

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

One of the following:

const DayTypeTradingDay DayType = "TRADING_DAY"

const DayTypeEarlyClose DayType = "EARLY_CLOSE"

const DayTypeHoliday DayType = "HOLIDAY"

const DayTypeWeekend DayType = "WEEKEND"

type MarketHoursDetail struct{…}

Comprehensive market hours information for a specific market and date

CurrentTime Time

Current time in market timezone with offset

formatdate-time

Date Time

The date for which market hours are provided

formatdate

Market MarketType

Market type identifier

One of the following:

const MarketTypeUsEquities MarketType = "us_equities"

const MarketTypeUsOptions MarketType = "us_options"

MarketName string

Human-readable market name

NextSessions TradingSessions

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

AfterHours SessionScheduleOptional

After-hours session schedule, null if not available

Close Time

Session close timestamp with timezone offset

formatdate-time

Open Time

Session open timestamp with timezone offset

formatdate-time

TimeUntilClose stringOptional

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

formatduration

TimeUntilOpen stringOptional

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

formatduration

PreMarket SessionScheduleOptional

Pre-market session schedule, null if not available

Close Time

Session close timestamp with timezone offset

formatdate-time

Open Time

Session open timestamp with timezone offset

formatdate-time

TimeUntilClose stringOptional

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

formatduration

TimeUntilOpen stringOptional

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

formatduration

Regular SessionScheduleOptional

Regular trading session schedule, null if holiday/weekend

Close Time

Session close timestamp with timezone offset

formatdate-time

Open Time

Session open timestamp with timezone offset

formatdate-time

TimeUntilClose stringOptional

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

formatduration

TimeUntilOpen stringOptional

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

formatduration

Status MarketStatus

Market status information

DayType DayType

The type of trading day

One of the following:

const DayTypeTradingDay DayType = "TRADING_DAY"

const DayTypeEarlyClose DayType = "EARLY_CLOSE"

const DayTypeHoliday DayType = "HOLIDAY"

const DayTypeWeekend DayType = "WEEKEND"

IsOpen bool

Whether the market is currently open (real-time)

CurrentSession MarketSessionTypeOptional

Current session type if market is open, null if closed

One of the following:

const MarketSessionTypePreMarket MarketSessionType = "pre_market"

const MarketSessionTypeRegular MarketSessionType = "regular"

const MarketSessionTypeAfterHours MarketSessionType = "after_hours"

Timezone string

IANA timezone identifier for the market

TodaySessions TradingSessions

Trading session schedules for the requested date with time_until fields

AfterHours SessionScheduleOptional

After-hours session schedule, null if not available

Close Time

Session close timestamp with timezone offset

formatdate-time

Open Time

Session open timestamp with timezone offset

formatdate-time

TimeUntilClose stringOptional

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

formatduration

TimeUntilOpen stringOptional

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

formatduration

PreMarket SessionScheduleOptional

Pre-market session schedule, null if not available

Close Time

Session close timestamp with timezone offset

formatdate-time

Open Time

Session open timestamp with timezone offset

formatdate-time

TimeUntilClose stringOptional

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

formatduration

TimeUntilOpen stringOptional

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

formatduration

Regular SessionScheduleOptional

Regular trading session schedule, null if holiday/weekend

Close Time

Session close timestamp with timezone offset

formatdate-time

Open Time

Session open timestamp with timezone offset

formatdate-time

TimeUntilClose stringOptional

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

formatduration

TimeUntilOpen stringOptional

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

formatduration

type MarketHoursDetailList []MarketHoursDetail

CurrentTime Time

Current time in market timezone with offset

formatdate-time

Date Time

The date for which market hours are provided

formatdate

Market MarketType

Market type identifier

One of the following:

const MarketTypeUsEquities MarketType = "us_equities"

const MarketTypeUsOptions MarketType = "us_options"

MarketName string

Human-readable market name

NextSessions TradingSessions

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

AfterHours SessionScheduleOptional

After-hours session schedule, null if not available

Close Time

Session close timestamp with timezone offset

formatdate-time

Open Time

Session open timestamp with timezone offset

formatdate-time

TimeUntilClose stringOptional

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

formatduration

TimeUntilOpen stringOptional

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

formatduration

PreMarket SessionScheduleOptional

Pre-market session schedule, null if not available

Close Time

Session close timestamp with timezone offset

formatdate-time

Open Time

Session open timestamp with timezone offset

formatdate-time

TimeUntilClose stringOptional

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

formatduration

TimeUntilOpen stringOptional

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

formatduration

Regular SessionScheduleOptional

Regular trading session schedule, null if holiday/weekend

Close Time

Session close timestamp with timezone offset

formatdate-time

Open Time

Session open timestamp with timezone offset

formatdate-time

TimeUntilClose stringOptional

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

formatduration

TimeUntilOpen stringOptional

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

formatduration

Status MarketStatus

Market status information

DayType DayType

The type of trading day

One of the following:

const DayTypeTradingDay DayType = "TRADING_DAY"

const DayTypeEarlyClose DayType = "EARLY_CLOSE"

const DayTypeHoliday DayType = "HOLIDAY"

const DayTypeWeekend DayType = "WEEKEND"

IsOpen bool

Whether the market is currently open (real-time)

CurrentSession MarketSessionTypeOptional

Current session type if market is open, null if closed

One of the following:

const MarketSessionTypePreMarket MarketSessionType = "pre_market"

const MarketSessionTypeRegular MarketSessionType = "regular"

const MarketSessionTypeAfterHours MarketSessionType = "after_hours"

Timezone string

IANA timezone identifier for the market

TodaySessions TradingSessions

Trading session schedules for the requested date with time_until fields

AfterHours SessionScheduleOptional

After-hours session schedule, null if not available

Close Time

Session close timestamp with timezone offset

formatdate-time

Open Time

Session open timestamp with timezone offset

formatdate-time

TimeUntilClose stringOptional

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

formatduration

TimeUntilOpen stringOptional

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

formatduration

PreMarket SessionScheduleOptional

Pre-market session schedule, null if not available

Close Time

Session close timestamp with timezone offset

formatdate-time

Open Time

Session open timestamp with timezone offset

formatdate-time

TimeUntilClose stringOptional

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

formatduration

TimeUntilOpen stringOptional

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

formatduration

Regular SessionScheduleOptional

Regular trading session schedule, null if holiday/weekend

Close Time

Session close timestamp with timezone offset

formatdate-time

Open Time

Session open timestamp with timezone offset

formatdate-time

TimeUntilClose stringOptional

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

formatduration

TimeUntilOpen stringOptional

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

formatduration

type MarketSessionType string

Session type for market hours

One of the following:

const MarketSessionTypePreMarket MarketSessionType = "pre_market"

const MarketSessionTypeRegular MarketSessionType = "regular"

const MarketSessionTypeAfterHours MarketSessionType = "after_hours"

type MarketStatus struct{…}

Market status information

DayType DayType

The type of trading day

One of the following:

const DayTypeTradingDay DayType = "TRADING_DAY"

const DayTypeEarlyClose DayType = "EARLY_CLOSE"

const DayTypeHoliday DayType = "HOLIDAY"

const DayTypeWeekend DayType = "WEEKEND"

IsOpen bool

Whether the market is currently open (real-time)

CurrentSession MarketSessionTypeOptional

Current session type if market is open, null if closed

One of the following:

const MarketSessionTypePreMarket MarketSessionType = "pre_market"

const MarketSessionTypeRegular MarketSessionType = "regular"

const MarketSessionTypeAfterHours MarketSessionType = "after_hours"

type MarketType string

Market type for market hours calendar endpoint

One of the following:

const MarketTypeUsEquities MarketType = "us_equities"

const MarketTypeUsOptions MarketType = "us_options"

type SessionSchedule struct{…}

Session schedule with open and close timestamps

Close Time

Session close timestamp with timezone offset

formatdate-time

Open Time

Session open timestamp with timezone offset

formatdate-time

TimeUntilClose stringOptional

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

formatduration

TimeUntilOpen stringOptional

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

formatduration

type TradingSessions struct{…}

Trading sessions for a market day with full timestamps

AfterHours SessionScheduleOptional

After-hours session schedule, null if not available

Close Time

Session close timestamp with timezone offset

formatdate-time

Open Time

Session open timestamp with timezone offset

formatdate-time

TimeUntilClose stringOptional

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

formatduration

TimeUntilOpen stringOptional

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

formatduration

PreMarket SessionScheduleOptional

Pre-market session schedule, null if not available

Close Time

Session close timestamp with timezone offset

formatdate-time

Open Time

Session open timestamp with timezone offset

formatdate-time

TimeUntilClose stringOptional

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

formatduration

TimeUntilOpen stringOptional

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

formatduration

Regular SessionScheduleOptional

Regular trading session schedule, null if holiday/weekend

Close Time

Session close timestamp with timezone offset

formatdate-time

Open Time

Session open timestamp with timezone offset

formatdate-time

TimeUntilClose stringOptional

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

formatduration

TimeUntilOpen stringOptional

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

formatduration