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

GET/v1/clock

Get Market Hours Calendar.

GET/v1/calendars/market-hours

Get Economic Calendar Events

GET/v1/calendars/economic-events

ModelsExpand Collapse

ClockDetail object { clock }

Current server time and market clock information

clock: string

Current server time in UTC

formatdate-time

DayType = "TRADING_DAY" or "EARLY_CLOSE" or "HOLIDAY" or "WEEKEND"

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

One of the following:

"TRADING_DAY"

"EARLY_CLOSE"

"HOLIDAY"

"WEEKEND"

EconomicEvent object { country, name, timestamp, 8 more }

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

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

name: string

Event name as reported by the provider.

timestamp: string

UTC instant of the event.

formatdate-time

actual: optional string

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 string

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

change_percentage: optional string

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 string

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

estimate: optional string

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 string

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.

EconomicEventImpact = "NONE" or "LOW" or "MEDIUM" or "HIGH"

Market impact of an economic calendar event.

One of the following:

"NONE"

"LOW"

"MEDIUM"

"HIGH"

EconomicEventList = array of EconomicEvent { country, name, timestamp, 8 more }

country: string

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

name: string

Event name as reported by the provider.

timestamp: string

UTC instant of the event.

formatdate-time

actual: optional string

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 string

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

change_percentage: optional string

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 string

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

estimate: optional string

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 string

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.

EconomicEventUnit = string

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.

MarketHoursDetail object { 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, maintenance, overnight, 2 more }

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

after_hours: optional SessionSchedule { close, open, time_until_close, time_until_open }

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

close: string

Session close timestamp with timezone offset

formatdate-time

open: string

Session open timestamp with timezone offset

formatdate-time

time_until_close: optional string

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 string

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 { close, open, time_until_close, time_until_open }

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

Session close timestamp with timezone offset

formatdate-time

open: string

Session open timestamp with timezone offset

formatdate-time

time_until_close: optional string

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 string

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 { close, open, time_until_close, time_until_open }

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

Session close timestamp with timezone offset

formatdate-time

open: string

Session open timestamp with timezone offset

formatdate-time

time_until_close: optional string

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 string

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 { close, open, time_until_close, time_until_open }

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

close: string

Session close timestamp with timezone offset

formatdate-time

open: string

Session open timestamp with timezone offset

formatdate-time

time_until_close: optional string

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 string

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 { close, open, time_until_close, time_until_open }

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

close: string

Session close timestamp with timezone offset

formatdate-time

open: string

Session open timestamp with timezone offset

formatdate-time

time_until_close: optional string

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 string

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 { 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: 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: string

IANA timezone identifier for the market

today_sessions: TradingSessions { after_hours, maintenance, overnight, 2 more }

Trading session schedules for the requested date with time_until fields

after_hours: optional SessionSchedule { close, open, time_until_close, time_until_open }

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

close: string

Session close timestamp with timezone offset

formatdate-time

open: string

Session open timestamp with timezone offset

formatdate-time

time_until_close: optional string

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 string

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 { close, open, time_until_close, time_until_open }

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

Session close timestamp with timezone offset

formatdate-time

open: string

Session open timestamp with timezone offset

formatdate-time

time_until_close: optional string

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 string

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 { close, open, time_until_close, time_until_open }

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

Session close timestamp with timezone offset

formatdate-time

open: string

Session open timestamp with timezone offset

formatdate-time

time_until_close: optional string

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 string

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 { close, open, time_until_close, time_until_open }

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

close: string

Session close timestamp with timezone offset

formatdate-time

open: string

Session open timestamp with timezone offset

formatdate-time

time_until_close: optional string

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 string

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 { close, open, time_until_close, time_until_open }

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

close: string

Session close timestamp with timezone offset

formatdate-time

open: string

Session open timestamp with timezone offset

formatdate-time

time_until_close: optional string

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 string

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

MarketHoursDetailList = array of 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, maintenance, overnight, 2 more }

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

after_hours: optional SessionSchedule { close, open, time_until_close, time_until_open }

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

close: string

Session close timestamp with timezone offset

formatdate-time

open: string

Session open timestamp with timezone offset

formatdate-time

time_until_close: optional string

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 string

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 { close, open, time_until_close, time_until_open }

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

Session close timestamp with timezone offset

formatdate-time

open: string

Session open timestamp with timezone offset

formatdate-time

time_until_close: optional string

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 string

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 { close, open, time_until_close, time_until_open }

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

Session close timestamp with timezone offset

formatdate-time

open: string

Session open timestamp with timezone offset

formatdate-time

time_until_close: optional string

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 string

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 { close, open, time_until_close, time_until_open }

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

close: string

Session close timestamp with timezone offset

formatdate-time

open: string

Session open timestamp with timezone offset

formatdate-time

time_until_close: optional string

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 string

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 { close, open, time_until_close, time_until_open }

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

close: string

Session close timestamp with timezone offset

formatdate-time

open: string

Session open timestamp with timezone offset

formatdate-time

time_until_close: optional string

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 string

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 { 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: 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: string

IANA timezone identifier for the market

today_sessions: TradingSessions { after_hours, maintenance, overnight, 2 more }

Trading session schedules for the requested date with time_until fields

after_hours: optional SessionSchedule { close, open, time_until_close, time_until_open }

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

close: string

Session close timestamp with timezone offset

formatdate-time

open: string

Session open timestamp with timezone offset

formatdate-time

time_until_close: optional string

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 string

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 { close, open, time_until_close, time_until_open }

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

Session close timestamp with timezone offset

formatdate-time

open: string

Session open timestamp with timezone offset

formatdate-time

time_until_close: optional string

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 string

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 { close, open, time_until_close, time_until_open }

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

Session close timestamp with timezone offset

formatdate-time

open: string

Session open timestamp with timezone offset

formatdate-time

time_until_close: optional string

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 string

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 { close, open, time_until_close, time_until_open }

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

close: string

Session close timestamp with timezone offset

formatdate-time

open: string

Session open timestamp with timezone offset

formatdate-time

time_until_close: optional string

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 string

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 { close, open, time_until_close, time_until_open }

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

close: string

Session close timestamp with timezone offset

formatdate-time

open: string

Session open timestamp with timezone offset

formatdate-time

time_until_close: optional string

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 string

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

MarketSessionType = "overnight" or "pre_market" or "regular" or "after_hours"

Session type for market hours

One of the following:

"overnight"

"pre_market"

"regular"

"after_hours"

MarketStatus object { 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: 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"

MarketType = "us_equities" or "us_options"

Market type for market hours calendar endpoint

One of the following:

"us_equities"

"us_options"

SessionSchedule object { 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: optional string

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 string

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

TradingSessions object { after_hours, maintenance, overnight, 2 more }

Trading sessions for a market day with full timestamps

after_hours: optional SessionSchedule { close, open, time_until_close, time_until_open }

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

close: string

Session close timestamp with timezone offset

formatdate-time

open: string

Session open timestamp with timezone offset

formatdate-time

time_until_close: optional string

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 string

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 { close, open, time_until_close, time_until_open }

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

Session close timestamp with timezone offset

formatdate-time

open: string

Session open timestamp with timezone offset

formatdate-time

time_until_close: optional string

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 string

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 { close, open, time_until_close, time_until_open }

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

Session close timestamp with timezone offset

formatdate-time

open: string

Session open timestamp with timezone offset

formatdate-time

time_until_close: optional string

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 string

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 { close, open, time_until_close, time_until_open }

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

close: string

Session close timestamp with timezone offset

formatdate-time

open: string

Session open timestamp with timezone offset

formatdate-time

time_until_close: optional string

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 string

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 { close, open, time_until_close, time_until_open }

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

close: string

Session close timestamp with timezone offset

formatdate-time

open: string

Session open timestamp with timezone offset

formatdate-time

time_until_close: optional string

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 string

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

CalendarGetClockResponse = BaseResponse { metadata, error }

data: ClockDetail { clock }

Current server time and market clock information

clock: string

Current server time in UTC

formatdate-time

CalendarGetMarketHoursCalendarResponse = BaseResponse { metadata, error }

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, maintenance, overnight, 2 more }

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

after_hours: optional SessionSchedule { close, open, time_until_close, time_until_open }

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

close: string

Session close timestamp with timezone offset

formatdate-time

open: string

Session open timestamp with timezone offset

formatdate-time

time_until_close: optional string

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 string

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 { close, open, time_until_close, time_until_open }

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

Session close timestamp with timezone offset

formatdate-time

open: string

Session open timestamp with timezone offset

formatdate-time

time_until_close: optional string

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 string

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 { close, open, time_until_close, time_until_open }

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

Session close timestamp with timezone offset

formatdate-time

open: string

Session open timestamp with timezone offset

formatdate-time

time_until_close: optional string

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 string

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 { close, open, time_until_close, time_until_open }

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

close: string

Session close timestamp with timezone offset

formatdate-time

open: string

Session open timestamp with timezone offset

formatdate-time

time_until_close: optional string

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 string

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 { close, open, time_until_close, time_until_open }

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

close: string

Session close timestamp with timezone offset

formatdate-time

open: string

Session open timestamp with timezone offset

formatdate-time

time_until_close: optional string

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 string

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 { 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: 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: string

IANA timezone identifier for the market

today_sessions: TradingSessions { after_hours, maintenance, overnight, 2 more }

Trading session schedules for the requested date with time_until fields

after_hours: optional SessionSchedule { close, open, time_until_close, time_until_open }

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

close: string

Session close timestamp with timezone offset

formatdate-time

open: string

Session open timestamp with timezone offset

formatdate-time

time_until_close: optional string

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 string

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 { close, open, time_until_close, time_until_open }

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

Session close timestamp with timezone offset

formatdate-time

open: string

Session open timestamp with timezone offset

formatdate-time

time_until_close: optional string

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 string

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 { close, open, time_until_close, time_until_open }

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

Session close timestamp with timezone offset

formatdate-time

open: string

Session open timestamp with timezone offset

formatdate-time

time_until_close: optional string

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 string

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 { close, open, time_until_close, time_until_open }

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

close: string

Session close timestamp with timezone offset

formatdate-time

open: string

Session open timestamp with timezone offset

formatdate-time

time_until_close: optional string

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 string

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 { close, open, time_until_close, time_until_open }

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

close: string

Session close timestamp with timezone offset

formatdate-time

open: string

Session open timestamp with timezone offset

formatdate-time

time_until_close: optional string

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 string

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

CalendarGetEconomicEventsCalendarResponse = BaseResponse { metadata, error }

data: EconomicEventList { country, name, timestamp, 8 more }

country: string

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

name: string

Event name as reported by the provider.

timestamp: string

UTC instant of the event.

formatdate-time

actual: optional string

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 string

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

change_percentage: optional string

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 string

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

estimate: optional string

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 string

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.