@clear-street/clearstreet 0.76.0 → 0.78.0

package/src/resources/v1/instruments.ts

@@ -173,53 +173,63 @@ export interface Instrument {
   venue: string;
 
   /**
-   * Average daily share volume from the security definition.
+   * Average daily share volume from the security definition. When a null/undefined
+   * value is observed, it indicates that there is no available data.
    */
   adv?: string | null;
 
   /**
-   * The expiration date for options instruments
+   * @deprecated Deprecated. Always null. When a null/undefined value is observed, it
+   * indicates it does not apply.
    */
   expiry?: string | null;
 
   /**
-   * The type of security (e.g., Common Stock, ETF)
+   * The type of security (e.g., Common Stock, ETF) When a null/undefined value is
+   * observed, it indicates that there is no available data.
    */
   instrument_type?: V1API.SecurityType | null;
 
   /**
-   * The percent of a long position's value you must post as margin
+   * The percent of a long position's value you must post as margin When a
+   * null/undefined value is observed, it indicates that there is no available data.
    */
   long_margin_rate?: string | null;
 
   /**
-   * The full name of the instrument or its issuer
+   * The full name of the instrument or its issuer When a null/undefined value is
+   * observed, it indicates that there is no available data.
    */
   name?: string | null;
 
   /**
-   * Notional average daily volume (ADV multiplied by previous close price).
+   * 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_adv?: string | null;
 
   /**
    * Available options expiration dates for this instrument. Present only when
-   * `include_options_expiry_dates=true` in the request.
+   * `include_options_expiry_dates=true` in the request. When a null/undefined value
+   * is observed, it indicates it does not apply.
    */
   options_expiry_dates?: Array<string> | null;
 
   /**
-   * Last close price from the security definition.
+   * Last close price from the security definition. When a null/undefined value is
+   * observed, it indicates that there is no available data.
    */
   previous_close?: string | null;
 
   /**
-   * The percent of a short position's value you must post as margin
+   * The percent of a short position's value you must post as margin When a
+   * null/undefined value is observed, it indicates that there is no available data.
    */
   short_margin_rate?: string | null;
 
   /**
-   * The strike price for options instruments
+   * @deprecated Deprecated. Always null. When a null/undefined value is observed, it
+   * indicates it does not apply.
    */
   strike_price?: string | null;
 }
@@ -292,47 +302,56 @@ export interface InstrumentCore {
   venue: string;
 
   /**
-   * Average daily share volume from the security definition.
+   * Average daily share volume from the security definition. When a null/undefined
+   * value is observed, it indicates that there is no available data.
    */
   adv?: string | null;
 
   /**
-   * The expiration date for options instruments
+   * @deprecated Deprecated. Always null. When a null/undefined value is observed, it
+   * indicates it does not apply.
    */
   expiry?: string | null;
 
   /**
-   * The type of security (e.g., Common Stock, ETF)
+   * The type of security (e.g., Common Stock, ETF) When a null/undefined value is
+   * observed, it indicates that there is no available data.
    */
   instrument_type?: V1API.SecurityType | null;
 
   /**
-   * The percent of a long position's value you must post as margin
+   * The percent of a long position's value you must post as margin When a
+   * null/undefined value is observed, it indicates that there is no available data.
    */
   long_margin_rate?: string | null;
 
   /**
-   * The full name of the instrument or its issuer
+   * The full name of the instrument or its issuer When a null/undefined value is
+   * observed, it indicates that there is no available data.
    */
   name?: string | null;
 
   /**
-   * Notional average daily volume (ADV multiplied by previous close price).
+   * 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_adv?: string | null;
 
   /**
-   * Last close price from the security definition.
+   * Last close price from the security definition. When a null/undefined value is
+   * observed, it indicates that there is no available data.
    */
   previous_close?: string | null;
 
   /**
-   * The percent of a short position's value you must post as margin
+   * The percent of a short position's value you must post as margin When a
+   * null/undefined value is observed, it indicates that there is no available data.
    */
   short_margin_rate?: string | null;
 
   /**
-   * The strike price for options instruments
+   * @deprecated Deprecated. Always null. When a null/undefined value is observed, it
+   * indicates it does not apply.
    */
   strike_price?: string | null;
 }
@@ -409,12 +428,14 @@ export interface OptionsContract {
   symbol: string;
 
   /**
-   * Open interest (number of outstanding contracts), if available
+   * Open interest (number of outstanding contracts), if available When a
+   * null/undefined value is observed, it indicates that there is no available data.
    */
   open_interest?: number | null;
 
   /**
-   * Instrument ID of the underlying instrument, when available
+   * Instrument ID of the underlying instrument, when available When a null/undefined
+   * value is observed, it indicates that there is no available data.
    */
   underlying_instrument_id?: string | null;
 }
@@ -454,7 +475,8 @@ export interface InstrumentGetInstrumentsParams {
   easy_to_borrow?: boolean;
 
   /**
-   * Comma-separated instrument identifiers
+   * Comma-separated instrument identifiers: unique identifiers or symbols (symbol
+   * for equities, OSI for options)
    */
   instrument_ids?: Array<string>;
 

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

@@ -44,7 +44,6 @@ export {
   type PrefillNewOrderAction,
   type PrefillOrderAction,
   type PromptButtonAction,
-  type ScreenerFilter,
   type StructuredAction,
   type StructuredActionButtonAction,
   type SuggestedActionsPayload,

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

@@ -63,6 +63,10 @@ export class Messages extends APIResource {
 export interface CreateFeedbackResponse {
   created_at: string;
 
+  /**
+   * When a null/undefined value is observed, it indicates that there is no available
+   * data.
+   */
   feedback_id?: string | null;
 }
 

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

@@ -3,6 +3,7 @@
 import { APIResource } from '../../../core/resource';
 import * as OmniAIAPI from './omni-ai';
 import * as OrdersAPI from '../orders';
+import * as ScreenerAPI from '../screener';
 import * as EntitlementsAPI from './entitlements';
 import {
   DeleteEntitlementResponse,
@@ -90,12 +91,14 @@ export interface ActionButton {
   label: string;
 
   /**
-   * Follow-up prompt to submit as the next user message.
+   * Follow-up prompt to submit as the next user message. When a null/undefined value
+   * is observed, it indicates it does not apply.
    */
   prompt?: PromptButtonAction | null;
 
   /**
-   * Structured action in the same message to execute on click.
+   * Structured action in the same message to execute on click. When a null/undefined
+   * value is observed, it indicates it does not apply.
    */
   structuredAction?: StructuredActionButtonAction | null;
 }
@@ -115,7 +118,8 @@ export interface ChartPayload {
   actionButtons?: Array<ActionButton>;
 
   /**
-   * Explicit series-driven chart definition.
+   * Explicit series-driven chart definition. When a null/undefined value is
+   * observed, it indicates it does not apply.
    */
   dataChart?: DataChart | null;
 }
@@ -221,12 +225,14 @@ export interface OpenChartAction {
   symbol: string;
 
   /**
-   * Additional chart configuration (indicators, overlays, etc.)
+   * Additional chart configuration (indicators, overlays, etc.) When a
+   * null/undefined value is observed, it indicates it does not apply.
    */
   extras?: unknown;
 
   /**
-   * Chart timeframe (e.g., "1D", "1W", "1M", "3M", "1Y", "5Y")
+   * Chart timeframe (e.g., "1D", "1W", "1M", "3M", "1Y", "5Y") When a null/undefined
+   * value is observed, it indicates it does not apply.
    */
   timeframe?: string | null;
 }
@@ -254,25 +260,34 @@ export interface OpenScreenerAction {
   /**
    * Filter criteria for the screener
    */
-  filters: Array<ScreenerFilter>;
+  filters: Array<ScreenerAPI.ScreenerFilter>;
 
   /**
-   * Optional field/column selection for screener results.
+   * Optional field/column selection for screener results. When a null/undefined
+   * value is observed, it indicates it does not apply.
+   */
+  columns?: Array<string> | null;
+
+  /**
+   * @deprecated Deprecated: use `columns` instead. Mirrors `columns`.
    */
   field_filter?: Array<string> | null;
 
   /**
-   * Optional page size.
+   * Optional page size. When a null/undefined value is observed, it indicates it
+   * does not apply.
    */
   page_size?: number | null;
 
   /**
-   * Optional sort field for screener rows.
+   * Optional sort field for screener rows. When a null/undefined value is observed,
+   * it indicates it does not apply.
    */
   sort_by?: string | null;
 
   /**
-   * Optional sort direction (`ASC` or `DESC`).
+   * Optional sort direction (`ASC` or `DESC`). When a null/undefined value is
+   * observed, it indicates it does not apply.
    */
   sort_direction?: string | null;
 }
@@ -334,26 +349,6 @@ export interface PromptButtonAction {
   prompt: string;
 }
 
-/**
- * A single filter criterion for the screener.
- */
-export interface ScreenerFilter {
-  /**
-   * Field to filter on (e.g., "market_cap", "sector", "price")
-   */
-  field: string;
-
-  /**
-   * Comparison operator (e.g., "eq", "gte", "lte", "in")
-   */
-  operator: string;
-
-  /**
-   * Filter value
-   */
-  value: unknown;
-}
-
 /**
  * Structured actions that Omni AI can return to clients.
  *
@@ -413,7 +408,8 @@ export namespace StructuredAction {
  */
 export interface StructuredActionButtonAction {
   /**
-   * UUID of a `structured_action` content part in the same message.
+   * UUID of a `structured_action` content part in the same message. When a
+   * null/undefined value is observed, it indicates it does not apply.
    */
   actionId?: string | null;
 }
@@ -455,7 +451,6 @@ export declare namespace OmniAI {
     type PrefillNewOrderAction as PrefillNewOrderAction,
     type PrefillOrderAction as PrefillOrderAction,
     type PromptButtonAction as PromptButtonAction,
-    type ScreenerFilter as ScreenerFilter,
     type StructuredAction as StructuredAction,
     type StructuredActionButtonAction as StructuredActionButtonAction,
     type SuggestedActionsPayload as SuggestedActionsPayload,

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

@@ -81,6 +81,9 @@ export interface ErrorStatus {
 
   message: string;
 
+  /**
+   * When a null/undefined value is observed, it indicates it does not apply.
+   */
   details?: unknown | null;
 }
 
@@ -100,15 +103,19 @@ export interface Response {
   user_message_id: string;
 
   /**
-   * Dynamic response content container. May include thinking parts.
+   * When a null/undefined value is observed, it indicates that there is no available
+   * data.
    */
   content?: ResponseContent | null;
 
   /**
-   * Shared sanitized error payload.
+   * When a null/undefined value is observed, it indicates it does not apply.
    */
   error?: ErrorStatus | null;
 
+  /**
+   * When a null/undefined value is observed, it indicates it does not apply.
+   */
   output_message_id?: string | null;
 }
 

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

@@ -216,7 +216,7 @@ export interface Message {
   thread_id: string;
 
   /**
-   * Shared sanitized error payload.
+   * When a null/undefined value is observed, it indicates it does not apply.
    */
   error?: ResponsesAPI.ErrorStatus | null;
 }

package/src/resources/v1/orders.ts

@@ -414,7 +414,8 @@ export interface Order {
   venue: string;
 
   /**
-   * Average fill price across all executions
+   * Average fill price across all executions When a null/undefined value is
+   * observed, it indicates that there is no available data.
    */
   average_fill_price?: string | null;
 
@@ -425,7 +426,8 @@ export interface Order {
 
   /**
    * Timestamp when the order will expire (UTC). Present when time_in_force is
-   * GOOD_TILL_DATE.
+   * GOOD_TILL_DATE. When a null/undefined value is observed, it indicates it does
+   * not apply.
    */
   expires_at?: string | null;
 
@@ -435,65 +437,78 @@ export interface Order {
   extended_hours?: boolean | null;
 
   /**
-   * Limit offset for trailing stop-limit orders (signed)
+   * Limit offset for trailing stop-limit orders (signed) When a null/undefined value
+   * is observed, it indicates it does not apply.
    */
   limit_offset?: string | null;
 
   /**
-   * Limit price (for LIMIT and STOP_LIMIT orders)
+   * Limit price (for LIMIT and STOP_LIMIT orders) When a null/undefined value is
+   * observed, it indicates it does not apply.
    */
   limit_price?: string | null;
 
   /**
    * Parent order queue state, present when the order is awaiting release or
-   * released.
+   * released. When a null/undefined value is observed, it indicates it does not
+   * apply.
    */
   queue_state?: QueueState | null;
 
   /**
-   * Scheduled release time for orders awaiting release.
+   * Scheduled release time for orders awaiting release. When a null/undefined value
+   * is observed, it indicates it does not apply.
    */
   releases_at?: string | null;
 
   /**
-   * Stop price (for STOP and STOP_LIMIT orders)
+   * Stop price (for STOP and STOP_LIMIT orders) When a null/undefined value is
+   * observed, it indicates it does not apply.
    */
   stop_price?: string | null;
 
   /**
-   * Current trailing limit price computed by the trailing strategy
+   * Current trailing limit price computed by the trailing strategy When a
+   * null/undefined value is observed, it indicates it does not apply.
    */
   trailing_limit_px?: string | null;
 
   /**
-   * Trailing offset amount for trailing orders
+   * Trailing offset amount for trailing orders When a null/undefined value is
+   * observed, it indicates it does not apply.
    */
   trailing_offset?: string | null;
 
   /**
-   * Trailing offset type for trailing orders
+   * Trailing offset type for trailing orders When a null/undefined value is
+   * observed, it indicates it does not apply.
    */
   trailing_offset_type?: TrailingOffsetType | null;
 
   /**
-   * Current trailing stop price computed by the trailing strategy
+   * Current trailing stop price computed by the trailing strategy When a
+   * null/undefined value is observed, it indicates it does not apply.
    */
   trailing_stop_px?: string | null;
 
   /**
-   * Trailing watermark price for trailing orders
+   * Trailing watermark price for trailing orders When a null/undefined value is
+   * observed, it indicates it does not apply.
    */
   trailing_watermark_px?: string | null;
 
   /**
-   * Trailing watermark timestamp for trailing orders
+   * Trailing watermark timestamp for trailing orders When a null/undefined value is
+   * observed, it indicates it does not apply.
    */
   trailing_watermark_ts?: string | null;
 
   /**
    * Instrument ID of the option's underlying instrument. Populated only for options
-   * orders; `null` for non-options and for options whose underlier cannot be
-   * resolved.
+   * orders. A `null` means one of two things: the order is not an option, so the
+   * field does not apply; or the order is an option whose underlier has not yet been
+   * resolved. When a null/undefined value is observed, it indicates it does not
+   * apply.
    */
   underlying_instrument_id?: string | null;
 }

package/src/resources/v1/positions.ts

@@ -215,55 +215,72 @@ export interface Position {
   symbol: string;
 
   /**
-   * The average price paid per share or contract for this position
+   * The average price paid per share or contract for this position When a
+   * null/undefined value is observed, it indicates that there is no available data.
    */
   avg_price?: string | null;
 
   /**
-   * The closing price used to value the position for the last trading day
+   * The closing price used to value the position for the last trading day When a
+   * null/undefined value is observed, it indicates that there is no available data.
    */
   closing_price?: string | null;
 
   /**
-   * The market date associated with `closing_price`
+   * The market date associated with `closing_price` When a null/undefined value is
+   * observed, it indicates that there is no available data.
    */
   closing_price_date?: string | null;
 
   /**
-   * The total cost basis for this position
+   * The total cost basis for this position When a null/undefined value is observed,
+   * it indicates that there is no available data.
    */
   cost_basis?: string | null;
 
+  /**
+   * The realized profit or loss for this position for the current day When a
+   * null/undefined value is observed, it indicates that there is no available data.
+   */
+  daily_realized_pnl?: string | null;
+
   /**
    * The unrealized profit or loss for this position relative to the previous close
+   * When a null/undefined value is observed, it indicates that there is no available
+   * data.
    */
   daily_unrealized_pnl?: string | null;
 
   /**
    * The unrealized profit/loss for the position for the current day, expressed as a
-   * percentage of the baseline value (range: 0-100).
+   * percentage of the baseline value (range: 0-100). When a null/undefined value is
+   * observed, it indicates that there is no available data.
    */
   daily_unrealized_pnl_pct?: string | null;
 
   /**
-   * The current market price of the instrument
+   * The current market price of the instrument When a null/undefined value is
+   * observed, it indicates that there is no available data.
    */
   instrument_price?: string | null;
 
   /**
-   * Identifier of the underlying instrument, when available
+   * Identifier of the underlying instrument, when available When a null/undefined
+   * value is observed, it indicates it does not apply.
    */
   underlying_instrument_id?: string | null;
 
   /**
    * The total unrealized profit or loss for this position based on current market
-   * value
+   * value When a null/undefined value is observed, it indicates that there is no
+   * available data.
    */
   unrealized_pnl?: string | null;
 
   /**
    * The unrealized profit/loss for the position, expressed as a percentage of the
-   * position's cost basis (range: 0-100).
+   * position's cost basis (range: 0-100). When a null/undefined value is observed,
+   * it indicates that there is no available data.
    */
   unrealized_pnl_pct?: string | null;
 }
@@ -315,12 +332,14 @@ export interface PositionInstruction {
 
   /**
    * Number of contracts accepted by the clearing venue. Populated once the
-   * instruction reaches `ACCEPTED`.
+   * instruction reaches `ACCEPTED`. When a null/undefined value is observed, it
+   * indicates that there is no available data.
    */
   accepted_quantity?: string | null;
 
   /**
-   * When the instruction was first accepted by the service.
+   * When the instruction was first accepted by the service. When a null/undefined
+   * value is observed, it indicates that there is no available data.
    */
   created_at?: string | null;
 
@@ -328,12 +347,13 @@ export interface PositionInstruction {
    * Human-readable explanation populated on any non-success terminal status —
    * `REJECTED` or `CANCEL_FAILED`. On a `207 Multi-Status` batch submit the
    * top-level `error` field summarizes the batch; per-row detail continues to live
-   * here.
+   * here. When a null/undefined value is observed, it indicates it does not apply.
    */
   rejection_reason?: string | null;
 
   /**
-   * When the instruction's lifecycle state last changed.
+   * When the instruction's lifecycle state last changed. When a null/undefined value
+   * is observed, it indicates that there is no available data.
    */
   updated_at?: string | null;
 }
@@ -467,7 +487,8 @@ export interface PositionGetPositionsParams {
     | 'MARKET_VALUE'
     | 'POSITION_TYPE'
     | 'UNREALIZED_PNL'
-    | 'DAILY_UNREALIZED_PNL';
+    | 'DAILY_UNREALIZED_PNL'
+    | 'DAILY_REALIZED_PNL';
 
   /**
    * Sort direction