@clear-street/clearstreet 0.93.1 → 0.95.0

package/src/resources/v1/accounts.ts

@@ -165,7 +165,10 @@ export interface AccountBalances {
   account_id: number;
 
   /**
-   * The total buying power available in the account.
+   * The total buying power available in the account: base buying power plus the open
+   * order adjustment, where base buying power is maintenance margin excess times the
+   * multiplier for intraday and initial margin excess times the multiplier for
+   * overnight.
    */
   buying_power: string;
 
@@ -189,18 +192,14 @@ export interface AccountBalances {
    */
   daily_realized_pnl: string;
 
-  /**
-   * Total profit or loss since start of day.
-   */
-  daily_total_pnl: string;
-
   /**
    * Total unrealized profit or loss across all positions relative to prior close.
    */
   daily_unrealized_pnl: string;
 
   /**
-   * The total equity in the account.
+   * The total equity in the account: cash plus long market value plus short market
+   * value, where short market value is negative.
    */
   equity: string;
 
@@ -215,7 +214,9 @@ export interface AccountBalances {
   margin_type: MarginType;
 
   /**
-   * Signed buying-power correction from open orders.
+   * Buying power correction from open orders, computed as projected buying power
+   * minus actual buying power. A negative value means open orders are consuming
+   * buying power.
    */
   open_order_adjustment: string;
 
@@ -261,7 +262,8 @@ export interface AccountBalances {
   margin_details?: MarginDetails | null;
 
   /**
-   * Applied multiplier for margin calculations. When a null/undefined value is
+   * Margin multiplier: 4 during intraday sessions (pre-market, regular, and
+   * after-hours) and 2 during the overnight session. When a null/undefined value is
    * observed, it indicates it does not apply.
    */
   multiplier?: string | null;
@@ -301,20 +303,16 @@ export interface AccountBalancesSod {
   asof?: string | null;
 
   /**
-   * @deprecated Start-of-day day-trade buying power. When a null/undefined value is
-   * observed, it indicates it does not apply.
-   */
-  day_trade_buying_power?: string | null;
-
-  /**
-   * Start-of-day maintenance margin excess. When a null/undefined value is observed,
-   * it indicates it does not apply.
+   * Start-of-day maintenance margin excess: the difference between equity and the
+   * maintenance margin requirement. When a null/undefined value is observed, it
+   * indicates it does not apply.
    */
   maintenance_margin_excess?: string | null;
 
   /**
-   * Start-of-day maintenance margin requirement. When a null/undefined value is
-   * observed, it indicates it does not apply.
+   * Start-of-day maintenance margin requirement: the amount of equity required to
+   * maintain current positions. When a null/undefined value is observed, it
+   * indicates it does not apply.
    */
   maintenance_margin_requirement?: string | null;
 
@@ -473,18 +471,12 @@ export interface Address {
 
 export interface MarginDetails {
   /**
-   * @deprecated The number of day trades executed over the 5 most recent trading
-   * days.
-   */
-  day_trade_count: number;
-
-  /**
-   * Initial margin excess for trade-date balances.
+   * The difference between equity and the initial margin requirement.
    */
   initial_margin_excess: string;
 
   /**
-   * Initial margin requirement for trade-date balances.
+   * The amount of equity required to open new positions.
    */
   initial_margin_requirement: string;
 
@@ -494,12 +486,12 @@ export interface MarginDetails {
   intraday_details: MarginSessionDetails;
 
   /**
-   * Maintenance margin excess for trade-date balances.
+   * The difference between equity and the maintenance margin requirement.
    */
   maintenance_margin_excess: string;
 
   /**
-   * Maintenance margin requirement for trade-date balances.
+   * The amount of equity required to maintain current positions.
    */
   maintenance_margin_requirement: string;
 
@@ -508,19 +500,6 @@ export interface MarginDetails {
    */
   overnight_details: MarginSessionDetails;
 
-  /**
-   * @deprecated `true` if the account is currently flagged as a PDT, otherwise
-   * `false`.
-   */
-  pattern_day_trader: boolean;
-
-  /**
-   * @deprecated The amount of day-trade buying power used during the current trading
-   * day. When null/undefined, the value should be assumed to be zero. The field is
-   * omitted to simplify the response.
-   */
-  day_trade_buying_power_usage?: string | null;
-
   /**
    * Optional top margin contributors, returned only when explicitly requested.
    */
@@ -547,23 +526,21 @@ export interface MarginDetailsUsage {
 
 export interface MarginSessionDetails {
   /**
-   * Maximum buying power available in the account during the session.
+   * Maximum buying power available in the account during the session: base buying
+   * power plus the open order adjustment, where base buying power is maintenance
+   * margin excess times the multiplier for intraday and initial margin excess times
+   * the multiplier for overnight.
    */
   buying_power: string;
 
   /**
-   * Effective multiplier for margin calculations during the session.
+   * Margin multiplier for the session: 4 during intraday sessions (pre-market,
+   * regular, and after-hours) and 2 during the overnight session.
    */
   multiplier?: string | null;
 }
 
 export interface MarginTopContributor {
-  /**
-   * @deprecated Day-trade buying power consumed by fills against this underlying on
-   * the current trade date. Populated only for pattern day trader accounts.
-   */
-  day_trade_buying_power_usage: string;
-
   /**
    * Initial margin requirement attributable to this underlying.
    */

package/src/resources/v1/index.ts

@@ -67,6 +67,7 @@ export {
   type InstrumentFundamentals,
   type InstrumentIncomeStatement,
   type InstrumentIncomeStatementList,
+  type InstrumentIpoEvent,
   type InstrumentSplitEvent,
   type PriceTarget,
   type ReportTime,
@@ -92,6 +93,7 @@ export {
   type InstrumentCore,
   type InstrumentCoreList,
   type ListingType,
+  type OptionExpiryDate,
   type OptionsContract,
   type OptionsContractList,
   type InstrumentGetInstrumentByIDResponse,
@@ -122,9 +124,11 @@ export {
   type OpenEntitlementConsentAction,
   type OpenScreenerAction,
   type PrefillCancelOrderAction,
+  type PrefillCancelOrderRequest,
   type PrefillModifyOrderAction,
   type PrefillModifyOrderRequest,
   type PrefillNewOrderAction,
+  type PrefillNewOrderRequest,
   type PrefillOrderAction,
   type PromptButtonAction,
   type StructuredAction,
@@ -133,7 +137,6 @@ export {
 } from './omni-ai/index';
 export {
   Orders,
-  type CancelOrderRequest,
   type Execution,
   type ExecutionList,
   type InstrumentIDOrSymbol,
@@ -186,6 +189,7 @@ export {
   type PositionGetPositionsParams,
   type PositionSubmitPositionInstructionsParams,
 } from './positions';
+export { PrivateMarkets } from './private-markets/index';
 export {
   Screener,
   type FieldLookback,

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

@@ -21,6 +21,7 @@ export {
   type InstrumentFundamentals,
   type InstrumentIncomeStatement,
   type InstrumentIncomeStatementList,
+  type InstrumentIpoEvent,
   type InstrumentSplitEvent,
   type PriceTarget,
   type ReportTime,

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

@@ -41,13 +41,15 @@ export class InstrumentData extends APIResource {
   news: NewsAPI.News = new NewsAPI.News(this._client);
 
   /**
-   * List instrument events across all securities, grouped by date.
+   * List instrument events across all securities, grouped by date. Results are
+   * paginated via `page_size` / `page_token`; a date's events may span two pages.
    *
    * Date range defaults (anchored on the current trading day, or the next trading
    * day if today is a weekend or US market holiday):
    *
    * - Unfiltered (no `instrument_ids`): a single trading day (`from_date` =
-   *   `to_date` = anchor); the requested span is capped at 6 days.
+   *   `to_date` = anchor). If only one bound is given, the other defaults to 6 days
+   *   from it; there is no maximum span once both bounds are given.
    * - Filtered (with `instrument_ids`): a 30-day lookback ending on the anchor
    *   (`from_date` = anchor − 30 days, `to_date` = anchor).
    *
@@ -137,8 +139,8 @@ export class InstrumentData extends APIResource {
   }
 
   /**
-   * Retrieves corporate events (dividends, splits, etc.) for an instrument, grouped
-   * by event type.
+   * Retrieves corporate events (earnings, dividends, splits, IPO) for an instrument,
+   * grouped by event type. Filter to specific types via `event_types`.
    *
    * Date range defaults:
    *
@@ -1059,6 +1061,11 @@ export interface InstrumentEventsData {
    */
   instrument_id: string;
 
+  /**
+   * IPO events
+   */
+  ipos: Array<InstrumentIpoEvent>;
+
   /**
    * Stock split events
    */
@@ -1359,6 +1366,58 @@ export interface InstrumentIncomeStatement {
 
 export type InstrumentIncomeStatementList = Array<InstrumentIncomeStatement>;
 
+/**
+ * Represents an IPO event for an instrument
+ */
+export interface InstrumentIpoEvent {
+  /**
+   * The date of the IPO
+   */
+  date: string;
+
+  /**
+   * IPO action. When a null/undefined value is observed, it indicates that there is
+   * no available data.
+   */
+  actions?: string | null;
+
+  /**
+   * IPO announced timestamp. When a null/undefined value is observed, it indicates
+   * that there is no available data.
+   */
+  announced_at?: string | null;
+
+  /**
+   * IPO company name. When a null/undefined value is observed, it indicates that
+   * there is no available data.
+   */
+  company?: string | null;
+
+  /**
+   * IPO exchange. When a null/undefined value is observed, it indicates that there
+   * is no available data.
+   */
+  exchange?: string | null;
+
+  /**
+   * IPO market cap. When a null/undefined value is observed, it indicates that there
+   * is no available data.
+   */
+  market_cap?: string | null;
+
+  /**
+   * IPO price range. When a null/undefined value is observed, it indicates that
+   * there is no available data.
+   */
+  price_range?: string | null;
+
+  /**
+   * IPO shares offered. When a null/undefined value is observed, it indicates that
+   * there is no available data.
+   */
+  shares?: string | null;
+}
+
 /**
  * Represents a stock split event for an instrument
  */
@@ -1473,6 +1532,18 @@ export interface InstrumentDataGetAllInstrumentEventsParams {
    */
   instrument_ids?: Array<OrdersAPI.InstrumentIDOrSymbol>;
 
+  /**
+   * The number of items to return per page. Only used when page_token is not
+   * provided.
+   */
+  page_size?: number;
+
+  /**
+   * Token for retrieving the next or previous page of results. Contains encoded
+   * pagination state; when provided, page_size is ignored.
+   */
+  page_token?: string;
+
   /**
    * The end date for the query range, inclusive (YYYY-MM-DD).
    */
@@ -1540,6 +1611,12 @@ export interface InstrumentDataGetInstrumentCashFlowStatementsParams {
 }
 
 export interface InstrumentDataGetInstrumentEventsParams {
+  /**
+   * Filter by event type(s). Comma-delimited list. Example:
+   * `event_types=EARNINGS,IPO`.
+   */
+  event_types?: Array<AllEventsEventType>;
+
   /**
    * The start date for the query range, inclusive (YYYY-MM-DD).
    */
@@ -1599,6 +1676,7 @@ export declare namespace InstrumentData {
     type InstrumentFundamentals as InstrumentFundamentals,
     type InstrumentIncomeStatement as InstrumentIncomeStatement,
     type InstrumentIncomeStatementList as InstrumentIncomeStatementList,
+    type InstrumentIpoEvent as InstrumentIpoEvent,
     type InstrumentSplitEvent as InstrumentSplitEvent,
     type PriceTarget as PriceTarget,
     type ReportTime as ReportTime,

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

@@ -248,6 +248,22 @@ export interface SnapshotLastTrade {
    * instruments, whose level is computed rather than traded.
    */
   size: number;
+
+  /**
+   * Exchange timestamp of the most recent last-sale eligible trade. For index
+   * instruments, the time the index level was computed. Absent when the trade
+   * carries no timestamp. When a null/undefined value is observed, it indicates that
+   * there is no available data.
+   */
+  timestamp?: string | null;
+
+  /**
+   * ISO 10383 Market Identifier Code (MIC) of the venue where the most recent
+   * last-sale eligible trade took place. Absent when the trade carries no venue;
+   * index levels are computed rather than traded and have no venue. When a
+   * null/undefined value is observed, it indicates that there is no available data.
+   */
+  venue?: string | null;
 }
 
 /**
@@ -266,6 +282,20 @@ export interface SnapshotQuote {
    */
   ask_size?: number | null;
 
+  /**
+   * Exchange timestamp of the best ask. Absent when the ask side carries no
+   * timestamp. When a null/undefined value is observed, it indicates that there is
+   * no available data.
+   */
+  ask_timestamp?: string | null;
+
+  /**
+   * ISO 10383 Market Identifier Code (MIC) of the venue currently holding the
+   * national best offer (NBBO). Absent when the ask side carries no venue. When a
+   * null/undefined value is observed, it indicates that there is no available data.
+   */
+  ask_venue?: string | null;
+
   /**
    * Current best bid. Absent when no bid is available (one-sided quote). When a
    * null/undefined value is observed, it indicates that there is no available data.
@@ -278,6 +308,20 @@ export interface SnapshotQuote {
    */
   bid_size?: number | null;
 
+  /**
+   * Exchange timestamp of the best bid. Absent when the bid side carries no
+   * timestamp. When a null/undefined value is observed, it indicates that there is
+   * no available data.
+   */
+  bid_timestamp?: string | null;
+
+  /**
+   * ISO 10383 Market Identifier Code (MIC) of the venue currently holding the
+   * national best bid (NBBO). Absent when the bid side carries no venue. When a
+   * null/undefined value is observed, it indicates that there is no available data.
+   */
+  bid_venue?: string | null;
+
   /**
    * Midpoint of bid and ask. Absent when either side is missing. When a
    * null/undefined value is observed, it indicates that there is no available data.
@@ -300,9 +344,19 @@ export interface SnapshotSession {
   change_percent: string;
 
   /**
-   * Previous session close price.
+   * Previous session close price. Corporate-action-adjusted (stock dividends, cash
+   * dividends, and forward/reverse splits) when an adjustment exists for the close
+   * date; the raw close otherwise.
    */
   previous_close: string;
+
+  /**
+   * Unadjusted (raw) previous session close. Present only when a corporate-action
+   * adjustment exists for the previous close date; when no adjustment exists,
+   * `previous_close` is the raw close and this field is omitted. When a
+   * null/undefined value is observed, it indicates that there is no available data.
+   */
+  previous_close_unadjusted?: string | null;
 }
 
 export interface MarketDataGetDailySummariesResponse extends Shared.BaseResponse {

package/src/resources/v1/instruments.ts

@@ -2,6 +2,7 @@
 
 import { APIResource } from '../../core/resource';
 import * as Shared from '../shared';
+import * as OrdersAPI from './orders';
 import * as V1API from './v1';
 import { APIPromise } from '../../core/api-promise';
 import { RequestOptions } from '../../internal/request-options';
@@ -47,8 +48,10 @@ export class Instruments extends APIResource {
   /**
    * List options contracts.
    *
-   * Returns options contracts for a given underlier with options-specific metadata.
-   * Exactly one underlier identifier must be provided.
+   * Returns options contracts with options-specific metadata. Exactly one identifier
+   * must be provided: `underlier`/`underlying_instrument_id` (list all contracts for
+   * that underlier) or `contract_ids` (look up specific contracts directly).
+   * `expiry`/`contract_type` apply as filters in either case.
    *
    * @example
    * ```ts
@@ -175,6 +178,13 @@ export interface Instrument {
    */
   adv?: string | null;
 
+  /**
+   * Corporate-action-adjusted last close; present only when an adjustment exists for
+   * the previous_close date. When a null/undefined value is observed, it indicates
+   * that there is no available data.
+   */
+  cax_adjusted_previous_close?: string | null;
+
   /**
    * The type of security (e.g., Common Stock, ETF) When a null/undefined value is
    * observed, it indicates that there is no available data.
@@ -194,16 +204,28 @@ export interface Instrument {
   name?: string | null;
 
   /**
-   * Notional average daily volume (ADV multiplied by previous close price). When a
-   * null/undefined value is observed, it indicates that there is no available data.
+   * Notional average daily volume (ADV multiplied by the cax-adjusted close when
+   * present, the raw previous close otherwise). When a null/undefined value is
+   * observed, it indicates that there is no available data.
    */
   notional_adv?: string | null;
 
   /**
-   * Available options expiration dates for this instrument. Present only when
+   * Available options expiration dates for this instrument, each annotated with
+   * which settlement cycles have listed contracts on it. Present only when
    * `include_options_expiry_dates=true` in the request. When a null/undefined value
    * is observed, it indicates it does not apply.
    */
+  options_contract_expiry_dates?: Array<OptionExpiryDate> | null;
+
+  /**
+   * @deprecated Available options expiration dates for this instrument. Present only
+   * when `include_options_expiry_dates=true` in the request.
+   *
+   * Deprecated: use `options_contract_expiry_dates`, which carries the same dates
+   * annotated with settlement-cycle information. When a null/undefined value is
+   * observed, it indicates it does not apply.
+   */
   options_expiry_dates?: Array<string> | null;
 
   /**
@@ -292,6 +314,13 @@ export interface InstrumentCore {
    */
   adv?: string | null;
 
+  /**
+   * Corporate-action-adjusted last close; present only when an adjustment exists for
+   * the previous_close date. When a null/undefined value is observed, it indicates
+   * that there is no available data.
+   */
+  cax_adjusted_previous_close?: string | null;
+
   /**
    * The type of security (e.g., Common Stock, ETF) When a null/undefined value is
    * observed, it indicates that there is no available data.
@@ -311,8 +340,9 @@ export interface InstrumentCore {
   name?: string | null;
 
   /**
-   * Notional average daily volume (ADV multiplied by previous close price). When a
-   * null/undefined value is observed, it indicates that there is no available data.
+   * Notional average daily volume (ADV multiplied by the cax-adjusted close when
+   * present, the raw previous close otherwise). When a null/undefined value is
+   * observed, it indicates that there is no available data.
    */
   notional_adv?: string | null;
 
@@ -336,6 +366,29 @@ export type InstrumentCoreList = Array<InstrumentCore>;
  */
 export type ListingType = 'STANDARD' | 'FLEX' | 'OTC';
 
+/**
+ * An options expiry date, annotated with which settlement cycles have listed
+ * contracts on it.
+ */
+export interface OptionExpiryDate {
+  /**
+   * The expiration date.
+   */
+  date: string;
+
+  /**
+   * Whether this date has at least one listed contract that settles at the close (PM
+   * settlement) -- the standard cycle.
+   */
+  has_settles_on_close: boolean;
+
+  /**
+   * Whether this date has at least one listed contract that settles on the opening
+   * print (AM settlement).
+   */
+  has_settles_on_open: boolean;
+}
+
 /**
  * An options contract with options-specific metadata
  */
@@ -514,6 +567,13 @@ export interface InstrumentGetInstrumentsParams {
 }
 
 export interface InstrumentGetOptionContractsParams {
+  /**
+   * Comma-separated contract instrument IDs (UUID) or OSI option symbols to look up
+   * directly, bypassing underlier expansion. Mutually exclusive with
+   * underlier/underlying_instrument_id; up to 100 values.
+   */
+  contract_ids?: Array<OrdersAPI.InstrumentIDOrSymbol>;
+
   /**
    * Filter by contract type: CALL or PUT
    */
@@ -524,6 +584,12 @@ export interface InstrumentGetOptionContractsParams {
    */
   expiry?: string;
 
+  /**
+   * Filter by settlement cycle: true for early-settling (AM, settle-on-open)
+   * contracts, false for normal (PM) contracts. Omit to return both.
+   */
+  is_settle_on_open?: boolean;
+
   /**
    * The number of items to return per page. Only used when page_token is not
    * provided.
@@ -603,6 +669,7 @@ export declare namespace Instruments {
     type InstrumentCore as InstrumentCore,
     type InstrumentCoreList as InstrumentCoreList,
     type ListingType as ListingType,
+    type OptionExpiryDate as OptionExpiryDate,
     type OptionsContract as OptionsContract,
     type OptionsContractList as OptionsContractList,
     type InstrumentGetInstrumentByIDResponse as InstrumentGetInstrumentByIDResponse,

package/src/resources/v1/omni-ai/index.ts

@@ -41,9 +41,11 @@ export {
   type OpenEntitlementConsentAction,
   type OpenScreenerAction,
   type PrefillCancelOrderAction,
+  type PrefillCancelOrderRequest,
   type PrefillModifyOrderAction,
   type PrefillModifyOrderRequest,
   type PrefillNewOrderAction,
+  type PrefillNewOrderRequest,
   type PrefillOrderAction,
   type PromptButtonAction,
   type StructuredAction,