@clear-street/clearstreet 0.99.0 → 0.101.0

package/resources/v1/watchlist.d.mts

@@ -92,11 +92,11 @@ export interface AddWatchlistItemData {
  */
 export interface WatchlistDetail {
     /**
-     * Watchlist ID
+     * The unique identifier for the watchlist.
      */
     id: string;
     /**
-     * Creation timestamp
+     * The timestamp when the watchlist was created.
      */
     created_at: string;
     /**
@@ -104,7 +104,7 @@ export interface WatchlistDetail {
      */
     items: Array<WatchlistItemEntry>;
     /**
-     * Watchlist name
+     * The user-provided watchlist name.
      */
     name: string;
 }

package/resources/v1/watchlist.d.ts

@@ -92,11 +92,11 @@ export interface AddWatchlistItemData {
  */
 export interface WatchlistDetail {
     /**
-     * Watchlist ID
+     * The unique identifier for the watchlist.
      */
     id: string;
     /**
-     * Creation timestamp
+     * The timestamp when the watchlist was created.
      */
     created_at: string;
     /**
@@ -104,7 +104,7 @@ export interface WatchlistDetail {
      */
     items: Array<WatchlistItemEntry>;
     /**
-     * Watchlist name
+     * The user-provided watchlist name.
      */
     name: string;
 }

package/src/resources/v1/index.ts

@@ -97,6 +97,7 @@ export {
   type OptionExpiryDate,
   type OptionsContract,
   type OptionsContractList,
+  type TickRule,
   type InstrumentGetInstrumentByIDResponse,
   type InstrumentGetInstrumentsResponse,
   type InstrumentGetOptionContractsResponse,
@@ -156,6 +157,7 @@ export {
   type Order,
   type OrderList,
   type OrderStatus,
+  type OrderStrategy,
   type OrderType,
   type QueueState,
   type ReplaceOrderRequest,
@@ -185,6 +187,7 @@ export {
   type Position,
   type PositionInstruction,
   type PositionInstructionList,
+  type PositionInstructionRejection,
   type PositionInstructionStatus,
   type PositionInstructionType,
   type PositionList,

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

@@ -11,6 +11,10 @@ import { RequestOptions } from '../../../internal/request-options';
  */
 export class MarketData extends APIResource {
   /**
+   * **Deprecated**: use `GET /market-data/snapshot` instead, which now reports the
+   * same open/high/low/volume/open-interest fields under `session` and top-level
+   * `open_interest`.
+   *
    * Returns the most recent open, high, low, volume (OHLV) and current price for the
    * requested instruments.
    *
@@ -20,13 +24,7 @@ export class MarketData extends APIResource {
    * fail to resolve are omitted from `data` and reported in `error` instead (see the
    * 207/404 responses below).
    *
-   * @example
-   * ```ts
-   * const response =
-   *   await client.v1.instrumentData.marketData.getDailySummaries(
-   *     { instrument_ids: 'instrument_ids' },
-   *   );
-   * ```
+   * @deprecated
    */
   getDailySummaries(
     query: MarketDataGetDailySummariesParams,
@@ -137,15 +135,42 @@ export interface MarketDataSnapshot {
    */
   instrument_id: string;
 
+  /**
+   * Session-level pricing and OHLV metrics. Always present; each inner field is
+   * independently nullable.
+   */
+  session: SnapshotSession;
+
+  /**
+   * Whether the SEC Rule 201 short-sale price test is currently restricting short
+   * sales in this security, from the trading-status feed.
+   *
+   * `true` restricts non-exempt short sales at or below the national best bid.
+   * `null` means we have no answer, either because no trading status has been seen
+   * for this security yet or because Rule 201 does not cover this security type. A
+   * `null` is not a statement that short selling is unrestricted, and must not be
+   * treated as clear to short.
+   *
+   * This is the current market condition, not a statement about whether Clear Street
+   * will reject your order. It is also distinct from `is_short_prohibited` on the
+   * instrument endpoints, which is a standing property of the security rather than a
+   * live circuit breaker. When a null/undefined value is observed, it indicates that
+   * there is no available data.
+   */
+  short_sale_restricted: boolean | null;
+
   /**
    * Display symbol for the security.
    */
   symbol: string;
 
   /**
-   * Cumulative traded volume reported on the most recent trade, in shares for
-   * equities or contracts for options. Absent when no trade is available. When a
-   * null/undefined value is observed, it indicates that there is no available data.
+   * @deprecated Cumulative traded volume reported on the most recent trade, in
+   * shares for equities or contracts for options. Absent when no trade is available.
+   *
+   * Deprecated: use `session.cumulative_volume`, the same value from the same
+   * source. When a null/undefined value is observed, it indicates that there is no
+   * available data.
    */
   cumulative_volume?: number | null;
 
@@ -177,11 +202,11 @@ export interface MarketDataSnapshot {
   name?: string | null;
 
   /**
-   * Session metrics computed from previous close and last trade, if available. When
-   * a null/undefined value is observed, it indicates that there is no available
-   * data.
+   * Open interest (outstanding contracts) as of the most recent OPRA Refresh.
+   * Populated for options only; absent for equities and indices. When a
+   * null/undefined value is observed, it indicates that there is no available data.
    */
-  session?: SnapshotSession | null;
+  open_interest?: number | null;
 }
 
 export type MarketDataSnapshotList = Array<MarketDataSnapshot>;
@@ -333,26 +358,78 @@ export interface SnapshotQuote {
 }
 
 /**
- * Session-level pricing metrics for a market data snapshot.
+ * Session-level pricing and OHLV metrics for a market data snapshot. Always
+ * present on the snapshot row; every field here is independently nullable except
+ * `ohlv_applicable`.
  */
 export interface SnapshotSession {
+  /**
+   * `false` only for instrument types with no OHLV by definition (e.g. an index
+   * instrument, whose price is a computed level rather than a traded security) --
+   * `open`/`high`/`low`/`ohlv_date`/`cumulative_volume` are then always absent.
+   * `true` otherwise, even when those fields simply haven't loaded yet. Always
+   * serialized.
+   */
+  ohlv_applicable: boolean;
+
   /**
    * Absolute change from previous close to the most recent last-sale-eligible trade.
+   * Absent when either side of the computation is unavailable. When a null/undefined
+   * value is observed, it indicates that there is no available data.
    */
-  change: string;
+  change?: string | null;
 
   /**
    * Percent change from previous close to the most recent last-sale-eligible trade.
+   * Absent under the same conditions as `change`. When a null/undefined value is
+   * observed, it indicates that there is no available data.
    */
-  change_percent: string;
+  change_percent?: string | null;
+
+  /**
+   * Cumulative traded volume for the current session, in shares for equities or
+   * contracts for options. Always reflects the current session, even when
+   * `ohlv_date` trails it. Absent when `ohlv_applicable` is `false`, or when no
+   * trade is available. When a null/undefined value is observed, it indicates that
+   * there is no available data.
+   */
+  cumulative_volume?: number | null;
+
+  /**
+   * Session high. When a null/undefined value is observed, it indicates that there
+   * is no available data.
+   */
+  high?: string | null;
+
+  /**
+   * Session low. When a null/undefined value is observed, it indicates that there is
+   * no available data.
+   */
+  low?: string | null;
+
+  /**
+   * Session date the open/high/low values represent, US/Eastern. May trail the
+   * current session until the upstream feed rolls. When a null/undefined value is
+   * observed, it indicates that there is no available data.
+   */
+  ohlv_date?: string | null;
+
+  /**
+   * Session opening price, from the day's OHLC bar. Absent when `ohlv_applicable` is
+   * `false`, or when the bar has not loaded yet. When a null/undefined value is
+   * observed, it indicates that there is no available data.
+   */
+  open?: string | null;
 
   /**
    * 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. An adjustment can carry the price beyond 2
-   * decimal places.
+   * decimal places. Absent when no previous close is on record (e.g. an instrument's
+   * first session). When a null/undefined value is observed, it indicates that there
+   * is no available data.
    */
-  previous_close: string;
+  previous_close?: string | null;
 
   /**
    * Unadjusted (raw) previous session close. Present only when a corporate-action
@@ -381,7 +458,8 @@ export interface MarketDataGetDailySummariesParams {
 export interface MarketDataGetSnapshotsParams {
   /**
    * Comma-separated instrument IDs (UUID) or symbols (equity tickers or OSI option
-   * symbols).
+   * symbols). Required; accepts 1 to 100 IDs. Duplicate resolved ids collapse to a
+   * single row.
    */
   instrument_ids?: Array<OrdersAPI.InstrumentIDOrSymbol>;
 }

package/src/resources/v1/instruments.ts

@@ -148,7 +148,9 @@ export interface Instrument {
   is_ptp: boolean;
 
   /**
-   * Indicates if short selling is prohibited for the instrument
+   * Indicates if short selling is prohibited for the instrument. This is a standing
+   * property of the security. For the live Rule 201 circuit breaker, see
+   * `short_sale_restricted` on the market-data snapshot.
    */
   is_short_prohibited: boolean;
 
@@ -239,6 +241,13 @@ export interface Instrument {
    * null/undefined value is observed, it indicates that there is no available data.
    */
   short_margin_rate?: string | null;
+
+  /**
+   * Price bands this instrument quotes on, ascending. Absent when we have no
+   * schedule for it, which includes an option whose penny-program status our
+   * reference data never supplied.
+   */
+  tick_rules?: Array<TickRule>;
 }
 
 export interface InstrumentCore {
@@ -284,7 +293,9 @@ export interface InstrumentCore {
   is_ptp: boolean;
 
   /**
-   * Indicates if short selling is prohibited for the instrument
+   * Indicates if short selling is prohibited for the instrument. This is a standing
+   * property of the security. For the live Rule 201 circuit breaker, see
+   * `short_sale_restricted` on the market-data snapshot.
    */
   is_short_prohibited: boolean;
 
@@ -357,6 +368,13 @@ export interface InstrumentCore {
    * null/undefined value is observed, it indicates that there is no available data.
    */
   short_margin_rate?: string | null;
+
+  /**
+   * Price bands this instrument quotes on, ascending. Absent when we have no
+   * schedule for it, which includes an option whose penny-program status our
+   * reference data never supplied.
+   */
+  tick_rules?: Array<TickRule>;
 }
 
 export type InstrumentCoreList = Array<InstrumentCore>;
@@ -479,6 +497,12 @@ export interface OptionsContract {
    */
   open_interest?: number | null;
 
+  /**
+   * Price bands this contract quotes on, ascending. Absent when our reference data
+   * never supplied the contract's penny-program status.
+   */
+  tick_rules?: Array<TickRule>;
+
   /**
    * Instrument ID of the underlying instrument, when available When a null/undefined
    * value is observed, it indicates that there is no available data.
@@ -488,6 +512,30 @@ export interface OptionsContract {
 
 export type OptionsContractList = Array<OptionsContract>;
 
+/**
+ * One band of an instrument's tick schedule. A price in the band is valid only if
+ * it is a whole multiple of `tick_size`. Bands describe the instrument itself: on
+ * an equity they say nothing about that equity's option chain.
+ */
+export interface TickRule {
+  /**
+   * Lowest price in the band, inclusive.
+   */
+  start_price: string;
+
+  /**
+   * Minimum price increment within the band.
+   */
+  tick_size: string;
+
+  /**
+   * Upper bound of the band, exclusive. Absent on the last band, which runs to
+   * infinity. When a null/undefined value is observed, it indicates it does not
+   * apply.
+   */
+  end_price?: string | null;
+}
+
 export interface InstrumentGetInstrumentByIDResponse extends Shared.BaseResponse {
   /**
    * Represents a tradable financial instrument.
@@ -675,6 +723,7 @@ export declare namespace Instruments {
     type OptionExpiryDate as OptionExpiryDate,
     type OptionsContract as OptionsContract,
     type OptionsContractList as OptionsContractList,
+    type TickRule as TickRule,
     type InstrumentGetInstrumentByIDResponse as InstrumentGetInstrumentByIDResponse,
     type InstrumentGetInstrumentsResponse as InstrumentGetInstrumentsResponse,
     type InstrumentGetOptionContractsResponse as InstrumentGetOptionContractsResponse,

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

@@ -67,6 +67,7 @@ export {
 } from './responses';
 export {
   Threads,
+  type ContextItem,
   type CreateMessageResponse,
   type CreateThreadResponse,
   type Message,
@@ -77,6 +78,7 @@ export {
   type MessageRole,
   type Thread,
   type ThreadList,
+  type TurnContext,
   type ThreadCreateMessageResponse,
   type ThreadCreateThreadResponse,
   type ThreadGetMessagesResponse,

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

@@ -12,42 +12,40 @@ import { path } from '../../../internal/utils/path';
  */
 export class Messages extends APIResource {
   /**
-   * Get a finalized message by ID.
-   *
-   * Returns a single finalized message. Returns **404** if the message belongs to an
-   * in-progress assistant turn (use the response endpoint for live output). Once the
-   * turn completes, the message becomes available here.
+   * Read a finalized message using its parent thread for ownership and
+   * linked-account authorization. In-progress assistant messages are not available
+   * here; use the response polling endpoint instead.
    *
    * @example
    * ```ts
    * const response =
    *   await client.v1.omniAI.messages.getMessageByID(
    *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
-   *     { account_id: 0 },
    *   );
    * ```
    */
   getMessageByID(
     messageID: string,
-    query: MessageGetMessageByIDParams,
+    query: MessageGetMessageByIDParams | null | undefined = {},
     options?: RequestOptions,
   ): APIPromise<MessageGetMessageByIDResponse> {
     return this._client.get(path`/v1/omni-ai/messages/${messageID}`, { query, ...options });
   }
 
   /**
-   * Submit feedback on a finalized assistant message.
-   *
-   * Attaches a score and optional comment to a finalized assistant message. Feedback
+   * Attach a score and optional comment to a finalized assistant message. Feedback
    * is only valid for messages with role `ASSISTANT` that have reached a terminal
    * outcome.
    *
+   * The current thread account governs access even when the message predates its
+   * account link.
+   *
    * @example
    * ```ts
    * const response =
    *   await client.v1.omniAI.messages.submitFeedback(
    *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
-   *     { account_id: 0, score: 0 },
+   *     { score: 0 },
    *   );
    * ```
    */
@@ -83,21 +81,23 @@ export interface MessageSubmitFeedbackResponse extends Shared.BaseResponse {
 
 export interface MessageGetMessageByIDParams {
   /**
-   * Account ID for the request
+   * Lists only conversations for this account, or unlinked conversations when
+   * omitted. Other reads authorize the resource's linked account. Omit when no
+   * account is selected; empty values and the string null are invalid.
    */
-  account_id: number;
+  account_id?: number;
 }
 
 export interface MessageSubmitFeedbackParams {
   /**
-   * Account ID for the request
+   * Feedback score (-1, 0, +1 or 1-5).
    */
-  account_id: number;
+  score: number;
 
   /**
-   * Feedback score (-1, 0, +1 or 1-5)
+   * Optional selection. Feedback always uses the thread's linked account.
    */
-  score: number;
+  account_id?: number | null;
 
   /**
    * Optional feedback comment

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

@@ -44,6 +44,7 @@ import {
 } from './responses';
 import * as ThreadsAPI from './threads';
 import {
+  ContextItem,
   CreateMessageResponse,
   CreateThreadResponse,
   Message,
@@ -67,6 +68,7 @@ import {
   ThreadGetThreadsResponse,
   ThreadList,
   Threads,
+  TurnContext,
 } from './threads';
 
 export class OmniAI extends APIResource {
@@ -454,7 +456,7 @@ export interface PrefillNewOrderAction {
 }
 
 /**
- * Request to submit a new order (PlaceOrderRequest from spec)
+ * Request to submit a new order
  */
 export interface PrefillNewOrderRequest {
   /**
@@ -530,6 +532,13 @@ export interface PrefillNewOrderRequest {
    */
   stop_price?: string | null;
 
+  /**
+   * Optional execution strategy. Omit to use standard routing. One of `SOR`, `VWAP`,
+   * or `TWAP`. Supported only on `MARKET` and `LIMIT` orders with `DAY`
+   * time-in-force, and not supported on OTC common-stock orders.
+   */
+  strategy?: OrdersAPI.OrderStrategy | null;
+
   /**
    * Trading symbol. For equities, use the ticker symbol (e.g., "TSLA"). For options,
    * use the OSI symbol (e.g., "TSLA 250117C00190000"). Either `symbol` or
@@ -749,6 +758,7 @@ export declare namespace OmniAI {
 
   export {
     Threads as Threads,
+    type ContextItem as ContextItem,
     type CreateMessageResponse as CreateMessageResponse,
     type CreateThreadResponse as CreateThreadResponse,
     type Message as Message,
@@ -759,6 +769,7 @@ export declare namespace OmniAI {
     type MessageRole as MessageRole,
     type Thread as Thread,
     type ThreadList as ThreadList,
+    type TurnContext as TurnContext,
     type ThreadCreateMessageResponse as ThreadCreateMessageResponse,
     type ThreadCreateThreadResponse as ThreadCreateThreadResponse,
     type ThreadGetMessagesResponse as ThreadGetMessagesResponse,

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

@@ -12,28 +12,26 @@ import { path } from '../../../internal/utils/path';
  */
 export class Responses extends APIResource {
   /**
-   * Cancel a response.
+   * Cancel a queued or running response. Cancellation is idempotent after the
+   * response becomes terminal. A canceled turn still produces a finalized assistant
+   * message with outcome `canceled` in the thread history.
    *
-   * Requests cancellation of a queued or running response. If the response has
-   * already reached a terminal status, this is an idempotent success. A canceled
-   * turn still produces a final assistant message with outcome `canceled` in the
-   * thread history.
+   * Authorization uses the linked account before any cancellation.
    *
    * @example
    * ```ts
    * const response =
    *   await client.v1.omniAI.responses.cancelResponse(
    *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
-   *     { account_id: 0 },
    *   );
    * ```
    */
   cancelResponse(
     responseID: string,
-    params: ResponseCancelResponseParams,
+    params: ResponseCancelResponseParams | null | undefined = {},
     options?: RequestOptions,
   ): APIPromise<ResponseCancelResponseResponse> {
-    const { account_id } = params;
+    const { account_id } = params ?? {};
     return this._client.delete(path`/v1/omni-ai/responses/${responseID}`, {
       query: { account_id },
       ...options,
@@ -41,28 +39,26 @@ export class Responses extends APIResource {
   }
 
   /**
-   * Poll a response for assistant output.
+   * Poll the current snapshot of an in-progress or completed assistant response.
+   * While its status is `queued` or `running`, content may be partial and include
+   * thinking parts. Continue polling until it becomes `succeeded`, `failed`, or
+   * `canceled`.
    *
-   * Returns the current snapshot of an in-progress or completed response. While the
-   * status is `queued` or `running`, the content may be partial and may include
-   * `thinking` parts. Poll this endpoint periodically until the status reaches a
-   * terminal value (`succeeded`, `failed`, or `canceled`).
-   *
-   * Once terminal, the finalized assistant message is available in thread history
-   * via `GET /omni-ai/threads/{thread_id}/messages`.
+   * Once terminal, the finalized message is available through
+   * `GET /omni-ai/threads/{thread_id}/messages`. Authorization uses the current
+   * parent thread account, including for responses created before the account link.
    *
    * @example
    * ```ts
    * const response =
    *   await client.v1.omniAI.responses.getResponseByID(
    *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
-   *     { account_id: 0 },
    *   );
    * ```
    */
   getResponseByID(
     responseID: string,
-    query: ResponseGetResponseByIDParams,
+    query: ResponseGetResponseByIDParams | null | undefined = {},
     options?: RequestOptions,
   ): APIPromise<ResponseGetResponseByIDResponse> {
     return this._client.get(path`/v1/omni-ai/responses/${responseID}`, { query, ...options });
@@ -199,16 +195,20 @@ export interface ResponseGetResponseByIDResponse extends Shared.BaseResponse {
 
 export interface ResponseCancelResponseParams {
   /**
-   * Account ID for the request
+   * Lists only conversations for this account, or unlinked conversations when
+   * omitted. Other reads authorize the resource's linked account. Omit when no
+   * account is selected; empty values and the string null are invalid.
    */
-  account_id: number;
+  account_id?: number;
 }
 
 export interface ResponseGetResponseByIDParams {
   /**
-   * Account ID for the request
+   * Lists only conversations for this account, or unlinked conversations when
+   * omitted. Other reads authorize the resource's linked account. Omit when no
+   * account is selected; empty values and the string null are invalid.
    */
-  account_id: number;
+  account_id?: number;
 }
 
 export declare namespace Responses {