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(RequestOptionsoptions?): CalendarGetClockResponse { data }

GET/v1/clock

Get Market Hours Calendar.

client.v1.calendar.getMarketHoursCalendar(CalendarGetMarketHoursCalendarParams { date, market } query, RequestOptionsoptions?): CalendarGetMarketHoursCalendarResponse { data }

GET/v1/calendars/market-hours

ModelsExpand Collapse

ClockDetail { clock }

Current server time and market clock information

clock: string

Current server time in UTC

formatdate-time

DayType = "TRADING_DAY" | "EARLY_CLOSE" | "HOLIDAY" | "WEEKEND"

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

One of the following:

"TRADING_DAY"

"EARLY_CLOSE"

"HOLIDAY"

"WEEKEND"

MarketHoursDetail { current_time, date, market, 5 more }

Comprehensive market hours information for a specific market and date

current_time: string

Current time in market timezone with offset

formatdate-time

date: string

The date for which market hours are provided

formatdate

market: MarketType

Market type identifier

One of the following:

"us_equities"

"us_options"

market_name: string

Human-readable market name

next_sessions: TradingSessions { after_hours, pre_market, regular }

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

after_hours?: SessionSchedule { close, open, time_until_close, time_until_open } | null

After-hours session schedule, null if not available

close: string

Session close timestamp with timezone offset

formatdate-time

open: string

Session open timestamp with timezone offset

formatdate-time

time_until_close?: string | null

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

formatduration

time_until_open?: string | null

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

formatduration

pre_market?: SessionSchedule { close, open, time_until_close, time_until_open } | null

Pre-market session schedule, null if not available

close: string

Session close timestamp with timezone offset

formatdate-time

open: string

Session open timestamp with timezone offset

formatdate-time

time_until_close?: string | null

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

formatduration

time_until_open?: string | null

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

formatduration

regular?: SessionSchedule { close, open, time_until_close, time_until_open } | null

Regular trading session schedule, null if holiday/weekend

close: string

Session close timestamp with timezone offset

formatdate-time

open: string

Session open timestamp with timezone offset

formatdate-time

time_until_close?: string | null

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

formatduration

time_until_open?: string | null

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

formatduration

status: MarketStatus { day_type, is_open, current_session }

Market status information

day_type: DayType

The type of trading day

One of the following:

"TRADING_DAY"

"EARLY_CLOSE"

"HOLIDAY"

"WEEKEND"

is_open: boolean

Whether the market is currently open (real-time)

current_session?: MarketSessionType | null

Current session type if market is open, null if closed

One of the following:

"pre_market"

"regular"

"after_hours"

timezone: string

IANA timezone identifier for the market

today_sessions: TradingSessions { after_hours, pre_market, regular }

Trading session schedules for the requested date with time_until fields

after_hours?: SessionSchedule { close, open, time_until_close, time_until_open } | null

After-hours session schedule, null if not available

close: string

Session close timestamp with timezone offset

formatdate-time

open: string

Session open timestamp with timezone offset

formatdate-time

time_until_close?: string | null

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

formatduration

time_until_open?: string | null

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

formatduration

pre_market?: SessionSchedule { close, open, time_until_close, time_until_open } | null

Pre-market session schedule, null if not available

close: string

Session close timestamp with timezone offset

formatdate-time

open: string

Session open timestamp with timezone offset

formatdate-time

time_until_close?: string | null

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

formatduration

time_until_open?: string | null

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

formatduration

regular?: SessionSchedule { close, open, time_until_close, time_until_open } | null

Regular trading session schedule, null if holiday/weekend

close: string

Session close timestamp with timezone offset

formatdate-time

open: string

Session open timestamp with timezone offset

formatdate-time

time_until_close?: string | null

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

formatduration

time_until_open?: string | null

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

formatduration

MarketHoursDetailList = Array<MarketHoursDetail { current_time, date, market, 5 more } >

current_time: string

Current time in market timezone with offset

formatdate-time

date: string

The date for which market hours are provided

formatdate

market: MarketType

Market type identifier

One of the following:

"us_equities"

"us_options"

market_name: string

Human-readable market name

next_sessions: TradingSessions { after_hours, pre_market, regular }

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

after_hours?: SessionSchedule { close, open, time_until_close, time_until_open } | null

After-hours session schedule, null if not available

close: string

Session close timestamp with timezone offset

formatdate-time

open: string

Session open timestamp with timezone offset

formatdate-time

time_until_close?: string | null

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

formatduration

time_until_open?: string | null

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

formatduration

pre_market?: SessionSchedule { close, open, time_until_close, time_until_open } | null

Pre-market session schedule, null if not available

close: string

Session close timestamp with timezone offset

formatdate-time

open: string

Session open timestamp with timezone offset

formatdate-time

time_until_close?: string | null

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

formatduration

time_until_open?: string | null

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

formatduration

regular?: SessionSchedule { close, open, time_until_close, time_until_open } | null

Regular trading session schedule, null if holiday/weekend

close: string

Session close timestamp with timezone offset

formatdate-time

open: string

Session open timestamp with timezone offset

formatdate-time

time_until_close?: string | null

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

formatduration

time_until_open?: string | null

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

formatduration

status: MarketStatus { day_type, is_open, current_session }

Market status information

day_type: DayType

The type of trading day

One of the following:

"TRADING_DAY"

"EARLY_CLOSE"

"HOLIDAY"

"WEEKEND"

is_open: boolean

Whether the market is currently open (real-time)

current_session?: MarketSessionType | null

Current session type if market is open, null if closed

One of the following:

"pre_market"

"regular"

"after_hours"

timezone: string

IANA timezone identifier for the market

today_sessions: TradingSessions { after_hours, pre_market, regular }

Trading session schedules for the requested date with time_until fields

after_hours?: SessionSchedule { close, open, time_until_close, time_until_open } | null

After-hours session schedule, null if not available

close: string

Session close timestamp with timezone offset

formatdate-time

open: string

Session open timestamp with timezone offset

formatdate-time

time_until_close?: string | null

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

formatduration

time_until_open?: string | null

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

formatduration

pre_market?: SessionSchedule { close, open, time_until_close, time_until_open } | null

Pre-market session schedule, null if not available

close: string

Session close timestamp with timezone offset

formatdate-time

open: string

Session open timestamp with timezone offset

formatdate-time

time_until_close?: string | null

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

formatduration

time_until_open?: string | null

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

formatduration

regular?: SessionSchedule { close, open, time_until_close, time_until_open } | null

Regular trading session schedule, null if holiday/weekend

close: string

Session close timestamp with timezone offset

formatdate-time

open: string

Session open timestamp with timezone offset

formatdate-time

time_until_close?: string | null

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

formatduration

time_until_open?: string | null

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

formatduration

MarketSessionType = "pre_market" | "regular" | "after_hours"

Session type for market hours

One of the following:

"pre_market"

"regular"

"after_hours"

MarketStatus { day_type, is_open, current_session }

Market status information

day_type: DayType

The type of trading day

One of the following:

"TRADING_DAY"

"EARLY_CLOSE"

"HOLIDAY"

"WEEKEND"

is_open: boolean

Whether the market is currently open (real-time)

current_session?: MarketSessionType | null

Current session type if market is open, null if closed

One of the following:

"pre_market"

"regular"

"after_hours"

MarketType = "us_equities" | "us_options"

Market type for market hours calendar endpoint

One of the following:

"us_equities"

"us_options"

SessionSchedule { close, open, time_until_close, time_until_open }

Session schedule with open and close timestamps

close: string

Session close timestamp with timezone offset

formatdate-time

open: string

Session open timestamp with timezone offset

formatdate-time

time_until_close?: string | null

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

formatduration

time_until_open?: string | null

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

formatduration

TradingSessions { after_hours, pre_market, regular }

Trading sessions for a market day with full timestamps

after_hours?: SessionSchedule { close, open, time_until_close, time_until_open } | null

After-hours session schedule, null if not available

close: string

Session close timestamp with timezone offset

formatdate-time

open: string

Session open timestamp with timezone offset

formatdate-time

time_until_close?: string | null

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

formatduration

time_until_open?: string | null

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

formatduration

pre_market?: SessionSchedule { close, open, time_until_close, time_until_open } | null

Pre-market session schedule, null if not available

close: string

Session close timestamp with timezone offset

formatdate-time

open: string

Session open timestamp with timezone offset

formatdate-time

time_until_close?: string | null

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

formatduration

time_until_open?: string | null

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

formatduration

regular?: SessionSchedule { close, open, time_until_close, time_until_open } | null

Regular trading session schedule, null if holiday/weekend

close: string

Session close timestamp with timezone offset

formatdate-time

open: string

Session open timestamp with timezone offset

formatdate-time

time_until_close?: string | null

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

formatduration

time_until_open?: string | null

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

formatduration

CalendarGetClockResponse extends BaseResponse { metadata, error } { data }

data: ClockDetail { clock }

Current server time and market clock information

clock: string

Current server time in UTC

formatdate-time

CalendarGetMarketHoursCalendarResponse extends BaseResponse { metadata, error } { data }

data: MarketHoursDetailList { current_time, date, market, 5 more }

current_time: string

Current time in market timezone with offset

formatdate-time

date: string

The date for which market hours are provided

formatdate

market: MarketType

Market type identifier

One of the following:

"us_equities"

"us_options"

market_name: string

Human-readable market name

next_sessions: TradingSessions { after_hours, pre_market, regular }

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

after_hours?: SessionSchedule { close, open, time_until_close, time_until_open } | null

After-hours session schedule, null if not available

close: string

Session close timestamp with timezone offset

formatdate-time

open: string

Session open timestamp with timezone offset

formatdate-time

time_until_close?: string | null

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

formatduration

time_until_open?: string | null

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

formatduration

pre_market?: SessionSchedule { close, open, time_until_close, time_until_open } | null

Pre-market session schedule, null if not available

close: string

Session close timestamp with timezone offset

formatdate-time

open: string

Session open timestamp with timezone offset

formatdate-time

time_until_close?: string | null

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

formatduration

time_until_open?: string | null

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

formatduration

regular?: SessionSchedule { close, open, time_until_close, time_until_open } | null

Regular trading session schedule, null if holiday/weekend

close: string

Session close timestamp with timezone offset

formatdate-time

open: string

Session open timestamp with timezone offset

formatdate-time

time_until_close?: string | null

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

formatduration

time_until_open?: string | null

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

formatduration

status: MarketStatus { day_type, is_open, current_session }

Market status information

day_type: DayType

The type of trading day

One of the following:

"TRADING_DAY"

"EARLY_CLOSE"

"HOLIDAY"

"WEEKEND"

is_open: boolean

Whether the market is currently open (real-time)

current_session?: MarketSessionType | null

Current session type if market is open, null if closed

One of the following:

"pre_market"

"regular"

"after_hours"

timezone: string

IANA timezone identifier for the market

today_sessions: TradingSessions { after_hours, pre_market, regular }

Trading session schedules for the requested date with time_until fields

after_hours?: SessionSchedule { close, open, time_until_close, time_until_open } | null

After-hours session schedule, null if not available

close: string

Session close timestamp with timezone offset

formatdate-time

open: string

Session open timestamp with timezone offset

formatdate-time

time_until_close?: string | null

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

formatduration

time_until_open?: string | null

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

formatduration

pre_market?: SessionSchedule { close, open, time_until_close, time_until_open } | null

Pre-market session schedule, null if not available

close: string

Session close timestamp with timezone offset

formatdate-time

open: string

Session open timestamp with timezone offset

formatdate-time

time_until_close?: string | null

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

formatduration

time_until_open?: string | null

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

formatduration

regular?: SessionSchedule { close, open, time_until_close, time_until_open } | null

Regular trading session schedule, null if holiday/weekend

close: string

Session close timestamp with timezone offset

formatdate-time

open: string

Session open timestamp with timezone offset

formatdate-time

time_until_close?: string | null

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

formatduration

time_until_open?: string | null

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

formatduration