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

Get Economic Calendar Events

v1.calendar.get_economic_events_calendar(CalendarGetEconomicEventsCalendarParams**kwargs) -> CalendarGetEconomicEventsCalendarResponse

GET/v1/calendars/economic-events

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 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.

country: str

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

name: str

Event name as reported by the provider.

timestamp: datetime

UTC instant of the event.

formatdate-time

actual: Optional[str]

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.

change: Optional[str]

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

change_percentage: Optional[str]

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

currency: Optional[str]

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

estimate: Optional[str]

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

impact: Optional[EconomicEventImpact]

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"

"LOW"

"MEDIUM"

"HIGH"

previous: Optional[str]

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

unit: Optional[EconomicEventUnit]

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

Literal["NONE", "LOW", "MEDIUM", "HIGH"]

Market impact of an economic calendar event.

One of the following:

"NONE"

"LOW"

"MEDIUM"

"HIGH"

List[EconomicEvent]

country: str

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

name: str

Event name as reported by the provider.

timestamp: datetime

UTC instant of the event.

formatdate-time

actual: Optional[str]

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.

change: Optional[str]

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

change_percentage: Optional[str]

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

currency: Optional[str]

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

estimate: Optional[str]

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

impact: Optional[EconomicEventImpact]

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"

"LOW"

"MEDIUM"

"HIGH"

previous: Optional[str]

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

unit: Optional[EconomicEventUnit]

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

str

Unit of an economic calendar event’s numeric values. Known values: %, K (thousand), M (million), B (billion), T (trillion), Points. Any other provider-supplied string passes through unchanged.

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

maintenance: Optional[SessionSchedule]

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.

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

overnight: Optional[SessionSchedule]

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.

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:

"overnight"

"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

maintenance: Optional[SessionSchedule]

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.

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

overnight: Optional[SessionSchedule]

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.

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

maintenance: Optional[SessionSchedule]

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.

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

overnight: Optional[SessionSchedule]

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.

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:

"overnight"

"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

maintenance: Optional[SessionSchedule]

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.

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

overnight: Optional[SessionSchedule]

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.

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["overnight", "pre_market", "regular", "after_hours"]

Session type for market hours

One of the following:

"overnight"

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

"overnight"

"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

maintenance: Optional[SessionSchedule]

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.

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

overnight: Optional[SessionSchedule]

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.

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

maintenance: Optional[SessionSchedule]

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.

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

overnight: Optional[SessionSchedule]

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.

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:

"overnight"

"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

maintenance: Optional[SessionSchedule]

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.

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

overnight: Optional[SessionSchedule]

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.

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

data: EconomicEventList

country: str

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

name: str

Event name as reported by the provider.

timestamp: datetime

UTC instant of the event.

formatdate-time

actual: Optional[str]

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.

change: Optional[str]

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

change_percentage: Optional[str]

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

currency: Optional[str]

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

estimate: Optional[str]

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

impact: Optional[EconomicEventImpact]

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"

"LOW"

"MEDIUM"

"HIGH"

previous: Optional[str]

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

unit: Optional[EconomicEventUnit]

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