Class CalendarContext

Financial calendar context — earnings, dividends, splits, IPOs, macro data.

Index

Constructors

Methods

new financeCalendar

Constructors

constructor

new CalendarContext(): CalendarContext
Returns CalendarContext

Methods

`Static`new

new(config: Config): CalendarContext
Create a new CalendarContext.
Parameters
- config: Config
Returns CalendarContext

financeCalendar

financeCalendar(
    category: CalendarCategory,
    start: string,
    end: string,
    market?: string | null,
): Promise<CalendarEventsResponse>
Get financial calendar events.

start and end are date strings in YYYY-MM-DD format. market is an optional market filter (e.g. "HK" or "US").
Parameters
- category: CalendarCategory
- start: string
- end: string
- Optionalmarket: string | null
Returns Promise<CalendarEventsResponse>