@clear-street/clearstreet 0.0.0 → 0.72.0

package/src/resources/v1/calendar.ts

@@ -0,0 +1,221 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as Shared from '../shared';
+import { APIPromise } from '../../core/api-promise';
+import { RequestOptions } from '../../internal/request-options';
+
+/**
+ * Access clocks and financial calendars for market sessions and events.
+ */
+export class Calendar extends APIResource {
+  /**
+   * Returns the current server time in UTC.
+   *
+   * @example
+   * ```ts
+   * const response = await client.v1.calendar.getClock();
+   * ```
+   */
+  getClock(options?: RequestOptions): APIPromise<CalendarGetClockResponse> {
+    return this._client.get('/v1/clock', options);
+  }
+
+  /**
+   * Retrieves comprehensive trading hours including pre-market, regular, and
+   * after-hours sessions. Returns market status, session times, and next session
+   * schedules.
+   *
+   * @example
+   * ```ts
+   * const response =
+   *   await client.v1.calendar.getMarketHoursCalendar({
+   *     date: 'date',
+   *   });
+   * ```
+   */
+  getMarketHoursCalendar(
+    query: CalendarGetMarketHoursCalendarParams,
+    options?: RequestOptions,
+  ): APIPromise<CalendarGetMarketHoursCalendarResponse> {
+    return this._client.get('/v1/calendars/market-hours', { query, ...options });
+  }
+}
+
+/**
+ * Current server time and market clock information
+ */
+export interface ClockDetail {
+  /**
+   * Current server time in UTC
+   */
+  clock: string;
+}
+
+/**
+ * Day type for market hours - indicates the type of trading day
+ */
+export type DayType = 'TRADING_DAY' | 'EARLY_CLOSE' | 'HOLIDAY' | 'WEEKEND';
+
+/**
+ * Comprehensive market hours information for a specific market and date
+ */
+export interface MarketHoursDetail {
+  /**
+   * Current time in market timezone with offset
+   */
+  current_time: string;
+
+  /**
+   * The date for which market hours are provided
+   */
+  date: string;
+
+  /**
+   * Market type identifier
+   */
+  market: MarketType;
+
+  /**
+   * Human-readable market name
+   */
+  market_name: string;
+
+  /**
+   * Next trading day's session schedules (without time_until fields)
+   */
+  next_sessions: TradingSessions;
+
+  /**
+   * Market status information
+   */
+  status: MarketStatus;
+
+  /**
+   * IANA timezone identifier for the market
+   */
+  timezone: string;
+
+  /**
+   * Trading session schedules for the requested date with time_until fields
+   */
+  today_sessions: TradingSessions;
+}
+
+export type MarketHoursDetailList = Array<MarketHoursDetail>;
+
+/**
+ * Session type for market hours
+ */
+export type MarketSessionType = 'pre_market' | 'regular' | 'after_hours';
+
+/**
+ * Market status information
+ */
+export interface MarketStatus {
+  /**
+   * The type of trading day
+   */
+  day_type: DayType;
+
+  /**
+   * Whether the market is currently open (real-time)
+   */
+  is_open: boolean;
+
+  /**
+   * Current session type if market is open, null if closed
+   */
+  current_session?: MarketSessionType | null;
+}
+
+/**
+ * Market type for market hours calendar endpoint
+ */
+export type MarketType = 'us_equities' | 'us_options';
+
+/**
+ * Session schedule with open and close timestamps
+ */
+export interface SessionSchedule {
+  /**
+   * Session close timestamp with timezone offset
+   */
+  close: string;
+
+  /**
+   * Session open timestamp with timezone offset
+   */
+  open: string;
+
+  /**
+   * ISO 8601 duration until session closes. Null if session is not currently open.
+   */
+  time_until_close?: string | null;
+
+  /**
+   * ISO 8601 duration until session opens. Null if session has already started or
+   * closed.
+   */
+  time_until_open?: string | null;
+}
+
+/**
+ * Trading sessions for a market day with full timestamps
+ */
+export interface TradingSessions {
+  /**
+   * After-hours session schedule, null if not available
+   */
+  after_hours?: SessionSchedule | null;
+
+  /**
+   * Pre-market session schedule, null if not available
+   */
+  pre_market?: SessionSchedule | null;
+
+  /**
+   * Regular trading session schedule, null if holiday/weekend
+   */
+  regular?: SessionSchedule | null;
+}
+
+export interface CalendarGetClockResponse extends Shared.BaseResponse {
+  /**
+   * Current server time and market clock information
+   */
+  data: ClockDetail;
+}
+
+export interface CalendarGetMarketHoursCalendarResponse extends Shared.BaseResponse {
+  data: MarketHoursDetailList;
+}
+
+export interface CalendarGetMarketHoursCalendarParams {
+  /**
+   * The date to query market hours for (YYYY-MM-DD). Defaults to today.
+   */
+  date: string;
+
+  /**
+   * Market type to query (us_equities, us_options). If omitted, returns all markets.
+   */
+  market?: MarketType;
+}
+
+export declare namespace Calendar {
+  export {
+    type ClockDetail as ClockDetail,
+    type DayType as DayType,
+    type MarketHoursDetail as MarketHoursDetail,
+    type MarketHoursDetailList as MarketHoursDetailList,
+    type MarketSessionType as MarketSessionType,
+    type MarketStatus as MarketStatus,
+    type MarketType as MarketType,
+    type SessionSchedule as SessionSchedule,
+    type TradingSessions as TradingSessions,
+    type CalendarGetClockResponse as CalendarGetClockResponse,
+    type CalendarGetMarketHoursCalendarResponse as CalendarGetMarketHoursCalendarResponse,
+    type CalendarGetMarketHoursCalendarParams as CalendarGetMarketHoursCalendarParams,
+  };
+}

package/src/resources/v1/index.ts

@@ -0,0 +1,203 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export { APIVersion, type Version, type APIVersionGetVersionResponse } from './api-version';
+export {
+  Accounts,
+  type Account,
+  type AccountBalances,
+  type AccountBalancesSod,
+  type AccountList,
+  type AccountSettings,
+  type AccountStatus,
+  type AccountSubtype,
+  type AccountType,
+  type MarginDetails,
+  type MarginDetailsUsage,
+  type MarginTopContributor,
+  type MarginType,
+  type PortfolioHistoryResponse,
+  type PortfolioHistorySegment,
+  type RiskSettings,
+  type AccountGetAccountBalancesResponse,
+  type AccountGetAccountByIDResponse,
+  type AccountGetAccountsResponse,
+  type AccountGetPortfolioHistoryResponse,
+  type AccountPatchAccountByIDResponse,
+  type AccountGetAccountBalancesParams,
+  type AccountGetAccountsParams,
+  type AccountGetPortfolioHistoryParams,
+  type AccountPatchAccountByIDParams,
+} from './accounts';
+export {
+  Calendar,
+  type ClockDetail,
+  type DayType,
+  type MarketHoursDetail,
+  type MarketHoursDetailList,
+  type MarketSessionType,
+  type MarketStatus,
+  type MarketType,
+  type SessionSchedule,
+  type TradingSessions,
+  type CalendarGetClockResponse,
+  type CalendarGetMarketHoursCalendarResponse,
+  type CalendarGetMarketHoursCalendarParams,
+} from './calendar';
+export {
+  InstrumentData,
+  type AllEventsEventType,
+  type AnalystDistribution,
+  type AnalystRating,
+  type FiscalPeriodType,
+  type InstrumentAllEventsData,
+  type InstrumentAnalystConsensus,
+  type InstrumentBalanceSheetStatement,
+  type InstrumentBalanceSheetStatementList,
+  type InstrumentCashFlowStatement,
+  type InstrumentCashFlowStatementList,
+  type InstrumentDividendEvent,
+  type InstrumentEarnings,
+  type InstrumentEventEnvelope,
+  type InstrumentEventIpoItem,
+  type InstrumentEventsByDate,
+  type InstrumentEventsData,
+  type InstrumentFundamentals,
+  type InstrumentIncomeStatement,
+  type InstrumentIncomeStatementList,
+  type InstrumentSplitEvent,
+  type PriceTarget,
+  type InstrumentDataGetAllInstrumentEventsResponse,
+  type InstrumentDataGetInstrumentAnalystConsensusResponse,
+  type InstrumentDataGetInstrumentBalanceSheetStatementsResponse,
+  type InstrumentDataGetInstrumentCashFlowStatementsResponse,
+  type InstrumentDataGetInstrumentEventsResponse,
+  type InstrumentDataGetInstrumentFundamentalsResponse,
+  type InstrumentDataGetInstrumentIncomeStatementsResponse,
+  type InstrumentDataGetAllInstrumentEventsParams,
+  type InstrumentDataGetInstrumentAnalystConsensusParams,
+  type InstrumentDataGetInstrumentBalanceSheetStatementsParams,
+  type InstrumentDataGetInstrumentCashFlowStatementsParams,
+  type InstrumentDataGetInstrumentEventsParams,
+  type InstrumentDataGetInstrumentIncomeStatementsParams,
+} from './instrument-data/index';
+export {
+  Instruments,
+  type ContractType,
+  type ExerciseStyle,
+  type Instrument,
+  type InstrumentCore,
+  type InstrumentCoreList,
+  type ListingType,
+  type OptionsContract,
+  type OptionsContractList,
+  type InstrumentGetInstrumentByIDResponse,
+  type InstrumentGetInstrumentsResponse,
+  type InstrumentGetOptionContractsResponse,
+  type InstrumentSearchInstrumentsResponse,
+  type InstrumentGetInstrumentByIDParams,
+  type InstrumentGetInstrumentsParams,
+  type InstrumentGetOptionContractsParams,
+  type InstrumentSearchInstrumentsParams,
+} from './instruments';
+export {
+  OmniAI,
+  type ActionButton,
+  type ChartPayload,
+  type ChartPoint,
+  type ChartSeries,
+  type ContentPartChartPayload,
+  type ContentPartCustomPayload,
+  type ContentPartStructuredActionPayload,
+  type ContentPartSuggestedActionsPayload,
+  type ContentPartTextPayload,
+  type ContentPartThinkingPayload,
+  type DataChart,
+  type EntitlementAgreementKey,
+  type EntitlementCode,
+  type OpenChartAction,
+  type OpenEntitlementConsentAction,
+  type OpenScreenerAction,
+  type PrefillCancelOrderAction,
+  type PrefillNewOrderAction,
+  type PrefillOrderAction,
+  type PromptButtonAction,
+  type ScreenerFilter,
+  type StructuredAction,
+  type StructuredActionButtonAction,
+  type SuggestedActionsPayload,
+} from './omni-ai/index';
+export {
+  Orders,
+  type CancelOrderRequest,
+  type Execution,
+  type ExecutionList,
+  type InstrumentIDOrSymbol,
+  type NewOrderRequest,
+  type Order,
+  type OrderList,
+  type OrderStatus,
+  type OrderType,
+  type PositionEffect,
+  type QueueState,
+  type RequestOrderType,
+  type RequestTimeInForce,
+  type Side,
+  type TimeInForce,
+  type TrailingOffsetType,
+  type OrderCancelAllOpenOrdersResponse,
+  type OrderCancelOpenOrderResponse,
+  type OrderGetExecutionsResponse,
+  type OrderGetOrderByIDResponse,
+  type OrderGetOrdersResponse,
+  type OrderReplaceOrderResponse,
+  type OrderSubmitOrdersResponse,
+  type OrderCancelAllOpenOrdersParams,
+  type OrderCancelOpenOrderParams,
+  type OrderGetExecutionsParams,
+  type OrderGetOrderByIDParams,
+  type OrderGetOrdersParams,
+  type OrderReplaceOrderParams,
+  type OrderSubmitOrdersParams,
+} from './orders';
+export {
+  Positions,
+  type Position,
+  type PositionInstruction,
+  type PositionInstructionList,
+  type PositionInstructionStatus,
+  type PositionInstructionType,
+  type PositionList,
+  type PositionType,
+  type PositionCancelPositionInstructionResponse,
+  type PositionClosePositionResponse,
+  type PositionClosePositionsResponse,
+  type PositionGetPositionInstructionsResponse,
+  type PositionGetPositionsResponse,
+  type PositionSubmitPositionInstructionsResponse,
+  type PositionCancelPositionInstructionParams,
+  type PositionClosePositionParams,
+  type PositionClosePositionsParams,
+  type PositionGetPositionInstructionsParams,
+  type PositionGetPositionsParams,
+  type PositionSubmitPositionInstructionsParams,
+} from './positions';
+export { V1, type SecurityType } from './v1';
+export {
+  Watchlist,
+  type AddWatchlistItemData,
+  type WatchlistDetail,
+  type WatchlistEntry,
+  type WatchlistEntryList,
+  type WatchlistItemEntry,
+  type WatchlistAddWatchlistItemResponse,
+  type WatchlistCreateWatchlistResponse,
+  type WatchlistDeleteWatchlistResponse,
+  type WatchlistDeleteWatchlistItemResponse,
+  type WatchlistGetWatchlistByIDResponse,
+  type WatchlistGetWatchlistsResponse,
+  type WatchlistAddWatchlistItemParams,
+  type WatchlistCreateWatchlistParams,
+  type WatchlistDeleteWatchlistItemParams,
+  type WatchlistGetWatchlistsParams,
+} from './watchlist';
+export { Websocket } from './websocket';

package/src/resources/v1/instrument-data/index.ts

@@ -0,0 +1,63 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  InstrumentData,
+  type AllEventsEventType,
+  type AnalystDistribution,
+  type AnalystRating,
+  type FiscalPeriodType,
+  type InstrumentAllEventsData,
+  type InstrumentAnalystConsensus,
+  type InstrumentBalanceSheetStatement,
+  type InstrumentBalanceSheetStatementList,
+  type InstrumentCashFlowStatement,
+  type InstrumentCashFlowStatementList,
+  type InstrumentDividendEvent,
+  type InstrumentEarnings,
+  type InstrumentEventEnvelope,
+  type InstrumentEventIpoItem,
+  type InstrumentEventsByDate,
+  type InstrumentEventsData,
+  type InstrumentFundamentals,
+  type InstrumentIncomeStatement,
+  type InstrumentIncomeStatementList,
+  type InstrumentSplitEvent,
+  type PriceTarget,
+  type InstrumentDataGetAllInstrumentEventsResponse,
+  type InstrumentDataGetInstrumentAnalystConsensusResponse,
+  type InstrumentDataGetInstrumentBalanceSheetStatementsResponse,
+  type InstrumentDataGetInstrumentCashFlowStatementsResponse,
+  type InstrumentDataGetInstrumentEventsResponse,
+  type InstrumentDataGetInstrumentFundamentalsResponse,
+  type InstrumentDataGetInstrumentIncomeStatementsResponse,
+  type InstrumentDataGetAllInstrumentEventsParams,
+  type InstrumentDataGetInstrumentAnalystConsensusParams,
+  type InstrumentDataGetInstrumentBalanceSheetStatementsParams,
+  type InstrumentDataGetInstrumentCashFlowStatementsParams,
+  type InstrumentDataGetInstrumentEventsParams,
+  type InstrumentDataGetInstrumentIncomeStatementsParams,
+} from './instrument-data';
+export {
+  MarketData,
+  type DailySummary,
+  type DailySummaryList,
+  type MarketDataSnapshot,
+  type MarketDataSnapshotList,
+  type SnapshotGreeks,
+  type SnapshotLastTrade,
+  type SnapshotQuote,
+  type SnapshotSession,
+  type MarketDataGetDailySummariesResponse,
+  type MarketDataGetSnapshotsResponse,
+  type MarketDataGetDailySummariesParams,
+  type MarketDataGetSnapshotsParams,
+} from './market-data';
+export {
+  News,
+  type NewsInstrument,
+  type NewsItem,
+  type NewsItemList,
+  type NewsType,
+  type NewsGetNewsResponse,
+  type NewsGetNewsParams,
+} from './news';