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

v1.calendar.get_clock() -> CalendarGetClockResponse

GET/v1/clock

Get Market Hours Calendar.

v1.calendar.get_market_hours_calendar(CalendarGetMarketHoursCalendarParams**kwargs) -> CalendarGetMarketHoursCalendarResponse

GET/v1/calendars/market-hours

ModelsExpand Collapse

class ClockDetail: …

Current server time and market clock information

clock: datetime

Current server time in UTC

formatdate-time

Literal["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"

class MarketHoursDetail: …

Comprehensive market hours information for a specific market and date

current_time: datetime

Current time in market timezone with offset

formatdate-time

date: date

The date for which market hours are provided

formatdate

market: MarketType

Market type identifier

One of the following:

"us_equities"

"us_options"

market_name: str

Human-readable market name

next_sessions: TradingSessions

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

after_hours: Optional[SessionSchedule]

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

close: datetime

Session close timestamp with timezone offset

formatdate-time

open: datetime

Session open timestamp with timezone offset

formatdate-time

time_until_close: Optional[str]

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

time_until_open: Optional[str]

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

pre_market: Optional[SessionSchedule]

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

close: datetime

Session close timestamp with timezone offset

formatdate-time

open: datetime

Session open timestamp with timezone offset

formatdate-time

time_until_close: Optional[str]

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

time_until_open: Optional[str]

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

regular: Optional[SessionSchedule]

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

close: datetime

Session close timestamp with timezone offset

formatdate-time

open: datetime

Session open timestamp with timezone offset

formatdate-time

time_until_close: Optional[str]

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

time_until_open: Optional[str]

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

status: MarketStatus

Market status information

day_type: DayType

The type of trading day

One of the following:

"TRADING_DAY"

"EARLY_CLOSE"

"HOLIDAY"

"WEEKEND"

is_open: bool

Whether the market is currently open (real-time)

current_session: Optional[MarketSessionType]

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:

"pre_market"

"regular"

"after_hours"

timezone: str

IANA timezone identifier for the market

today_sessions: TradingSessions

Trading session schedules for the requested date with time_until fields

after_hours: Optional[SessionSchedule]

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

close: datetime

Session close timestamp with timezone offset

formatdate-time

open: datetime

Session open timestamp with timezone offset

formatdate-time

time_until_close: Optional[str]

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

time_until_open: Optional[str]

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

pre_market: Optional[SessionSchedule]

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

close: datetime

Session close timestamp with timezone offset

formatdate-time

open: datetime

Session open timestamp with timezone offset

formatdate-time

time_until_close: Optional[str]

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

time_until_open: Optional[str]

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

regular: Optional[SessionSchedule]

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

close: datetime

Session close timestamp with timezone offset

formatdate-time

open: datetime

Session open timestamp with timezone offset

formatdate-time

time_until_close: Optional[str]

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

time_until_open: Optional[str]

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

List[MarketHoursDetail]

current_time: datetime

Current time in market timezone with offset

formatdate-time

date: date

The date for which market hours are provided

formatdate

market: MarketType

Market type identifier

One of the following:

"us_equities"

"us_options"

market_name: str

Human-readable market name

next_sessions: TradingSessions

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

after_hours: Optional[SessionSchedule]

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

close: datetime

Session close timestamp with timezone offset

formatdate-time

open: datetime

Session open timestamp with timezone offset

formatdate-time

time_until_close: Optional[str]

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

time_until_open: Optional[str]

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

pre_market: Optional[SessionSchedule]

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

close: datetime

Session close timestamp with timezone offset

formatdate-time

open: datetime

Session open timestamp with timezone offset

formatdate-time

time_until_close: Optional[str]

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

time_until_open: Optional[str]

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

regular: Optional[SessionSchedule]

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

close: datetime

Session close timestamp with timezone offset

formatdate-time

open: datetime

Session open timestamp with timezone offset

formatdate-time

time_until_close: Optional[str]

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

time_until_open: Optional[str]

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

status: MarketStatus

Market status information

day_type: DayType

The type of trading day

One of the following:

"TRADING_DAY"

"EARLY_CLOSE"

"HOLIDAY"

"WEEKEND"

is_open: bool

Whether the market is currently open (real-time)

current_session: Optional[MarketSessionType]

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:

"pre_market"

"regular"

"after_hours"

timezone: str

IANA timezone identifier for the market

today_sessions: TradingSessions

Trading session schedules for the requested date with time_until fields

after_hours: Optional[SessionSchedule]

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

close: datetime

Session close timestamp with timezone offset

formatdate-time

open: datetime

Session open timestamp with timezone offset

formatdate-time

time_until_close: Optional[str]

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

time_until_open: Optional[str]

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

pre_market: Optional[SessionSchedule]

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

close: datetime

Session close timestamp with timezone offset

formatdate-time

open: datetime

Session open timestamp with timezone offset

formatdate-time

time_until_close: Optional[str]

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

time_until_open: Optional[str]

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

regular: Optional[SessionSchedule]

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

close: datetime

Session close timestamp with timezone offset

formatdate-time

open: datetime

Session open timestamp with timezone offset

formatdate-time

time_until_close: Optional[str]

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

time_until_open: Optional[str]

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

Literal["pre_market", "regular", "after_hours"]

Session type for market hours

One of the following:

"pre_market"

"regular"

"after_hours"

class MarketStatus: …

Market status information

day_type: DayType

The type of trading day

One of the following:

"TRADING_DAY"

"EARLY_CLOSE"

"HOLIDAY"

"WEEKEND"

is_open: bool

Whether the market is currently open (real-time)

current_session: Optional[MarketSessionType]

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:

"pre_market"

"regular"

"after_hours"

Literal["us_equities", "us_options"]

Market type for market hours calendar endpoint

One of the following:

"us_equities"

"us_options"

class SessionSchedule: …

Session schedule with open and close timestamps

close: datetime

Session close timestamp with timezone offset

formatdate-time

open: datetime

Session open timestamp with timezone offset

formatdate-time

time_until_close: Optional[str]

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

time_until_open: Optional[str]

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

after_hours: Optional[SessionSchedule]

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

close: datetime

Session close timestamp with timezone offset

formatdate-time

open: datetime

Session open timestamp with timezone offset

formatdate-time

time_until_close: Optional[str]

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

time_until_open: Optional[str]

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

pre_market: Optional[SessionSchedule]

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

close: datetime

Session close timestamp with timezone offset

formatdate-time

open: datetime

Session open timestamp with timezone offset

formatdate-time

time_until_close: Optional[str]

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

time_until_open: Optional[str]

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

regular: Optional[SessionSchedule]

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

close: datetime

Session close timestamp with timezone offset

formatdate-time

open: datetime

Session open timestamp with timezone offset

formatdate-time

time_until_close: Optional[str]

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

time_until_open: Optional[str]

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 CalendarGetClockResponse: …

data: ClockDetail

Current server time and market clock information

clock: datetime

Current server time in UTC

formatdate-time

class CalendarGetMarketHoursCalendarResponse: …

data: MarketHoursDetailList

current_time: datetime

Current time in market timezone with offset

formatdate-time

date: date

The date for which market hours are provided

formatdate

market: MarketType

Market type identifier

One of the following:

"us_equities"

"us_options"

market_name: str

Human-readable market name

next_sessions: TradingSessions

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

after_hours: Optional[SessionSchedule]

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

close: datetime

Session close timestamp with timezone offset

formatdate-time

open: datetime

Session open timestamp with timezone offset

formatdate-time

time_until_close: Optional[str]

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

time_until_open: Optional[str]

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

pre_market: Optional[SessionSchedule]

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

close: datetime

Session close timestamp with timezone offset

formatdate-time

open: datetime

Session open timestamp with timezone offset

formatdate-time

time_until_close: Optional[str]

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

time_until_open: Optional[str]

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

regular: Optional[SessionSchedule]

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

close: datetime

Session close timestamp with timezone offset

formatdate-time

open: datetime

Session open timestamp with timezone offset

formatdate-time

time_until_close: Optional[str]

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

time_until_open: Optional[str]

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

status: MarketStatus

Market status information

day_type: DayType

The type of trading day

One of the following:

"TRADING_DAY"

"EARLY_CLOSE"

"HOLIDAY"

"WEEKEND"

is_open: bool

Whether the market is currently open (real-time)

current_session: Optional[MarketSessionType]

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:

"pre_market"

"regular"

"after_hours"

timezone: str

IANA timezone identifier for the market

today_sessions: TradingSessions

Trading session schedules for the requested date with time_until fields

after_hours: Optional[SessionSchedule]

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

close: datetime

Session close timestamp with timezone offset

formatdate-time

open: datetime

Session open timestamp with timezone offset

formatdate-time

time_until_close: Optional[str]

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

time_until_open: Optional[str]

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

pre_market: Optional[SessionSchedule]

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

close: datetime

Session close timestamp with timezone offset

formatdate-time

open: datetime

Session open timestamp with timezone offset

formatdate-time

time_until_close: Optional[str]

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

time_until_open: Optional[str]

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

regular: Optional[SessionSchedule]

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

close: datetime

Session close timestamp with timezone offset

formatdate-time

open: datetime

Session open timestamp with timezone offset

formatdate-time

time_until_close: Optional[str]

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

time_until_open: Optional[str]

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