@clear-street/clearstreet 0.89.0 → 0.91.0

package/src/resources/v1/accounts.ts

@@ -28,7 +28,8 @@ export class Accounts extends APIResource {
   }
 
   /**
-   * Fetch account details by ID
+   * Fetch account details by ID, including the mailing address, date of birth, phone
+   * number, and country of tax residency of the account-holder entity when on file.
    *
    * @example
    * ```ts
@@ -349,6 +350,127 @@ export type AccountSubtype = 'CASH' | 'MARGIN' | 'OTHER';
  */
 export type AccountType = 'CUSTOMER' | 'OTHER';
 
+/**
+ * Represents a trading account
+ */
+export interface AccountWithPersonalDetails {
+  /**
+   * The unique identifier for the account
+   */
+  id: number;
+
+  /**
+   * The account holder entity identifier
+   */
+  account_holder_entity_id: number;
+
+  /**
+   * The full legal name of the account
+   */
+  full_name: string;
+
+  /**
+   * The date the account was opened
+   */
+  open_date: string;
+
+  /**
+   * The options level of the account
+   */
+  options_level: number;
+
+  /**
+   * The short name of the account
+   */
+  short_name: string;
+
+  /**
+   * The current status of the account
+   */
+  status: AccountStatus;
+
+  /**
+   * The sub-type of account
+   */
+  subtype: AccountSubtype;
+
+  /**
+   * The type of account
+   */
+  type: AccountType;
+
+  /**
+   * The date the account was closed, if applicable When a null/undefined value is
+   * observed, it indicates it does not apply.
+   */
+  close_date?: string | null;
+
+  /**
+   * The country of tax residency of the account-holder entity. `null` when not on
+   * file or entity reference data is unavailable. When a null/undefined value is
+   * observed, it indicates that there is no available data.
+   */
+  country_of_tax_residency?: string | null;
+
+  /**
+   * The date of birth of the account holder's primary contact. `null` when not on
+   * file or entity reference data is unavailable. When a null/undefined value is
+   * observed, it indicates that there is no available data.
+   */
+  date_of_birth?: string | null;
+
+  /**
+   * The mailing address of the account-holder entity. `null` when no mailing address
+   * is on file or entity reference data is unavailable. When a null/undefined value
+   * is observed, it indicates that there is no available data.
+   */
+  mailing_address?: Address | null;
+
+  /**
+   * The phone number of the account holder's primary contact. `null` when not on
+   * file or entity reference data is unavailable. When a null/undefined value is
+   * observed, it indicates that there is no available data.
+   */
+  phone_number?: string | null;
+}
+
+/**
+ * A postal address.
+ */
+export interface Address {
+  /**
+   * City
+   */
+  city: string;
+
+  /**
+   * Country
+   */
+  country: string;
+
+  /**
+   * First street address line
+   */
+  line1: string;
+
+  /**
+   * Postal code
+   */
+  postal_code: string;
+
+  /**
+   * Second street address line When a null/undefined value is observed, it indicates
+   * it does not apply.
+   */
+  line2?: string | null;
+
+  /**
+   * State or province When a null/undefined value is observed, it indicates it does
+   * not apply.
+   */
+  state?: string | null;
+}
+
 export interface MarginDetails {
   /**
    * @deprecated The number of day trades executed over the 5 most recent trading
@@ -557,7 +679,7 @@ export interface AccountGetAccountByIDResponse extends Shared.BaseResponse {
   /**
    * Represents a trading account
    */
-  data: Account;
+  data: AccountWithPersonalDetails;
 }
 
 export interface AccountGetAccountsResponse extends Shared.BaseResponse {
@@ -634,6 +756,8 @@ export declare namespace Accounts {
     type AccountStatus as AccountStatus,
     type AccountSubtype as AccountSubtype,
     type AccountType as AccountType,
+    type AccountWithPersonalDetails as AccountWithPersonalDetails,
+    type Address as Address,
     type MarginDetails as MarginDetails,
     type MarginDetailsUsage as MarginDetailsUsage,
     type MarginSessionDetails as MarginSessionDetails,

package/src/resources/v1/index.ts

@@ -11,6 +11,8 @@ export {
   type AccountStatus,
   type AccountSubtype,
   type AccountType,
+  type AccountWithPersonalDetails,
+  type Address,
   type MarginDetails,
   type MarginDetailsUsage,
   type MarginSessionDetails,
@@ -120,6 +122,8 @@ export {
   type OpenEntitlementConsentAction,
   type OpenScreenerAction,
   type PrefillCancelOrderAction,
+  type PrefillModifyOrderAction,
+  type PrefillModifyOrderRequest,
   type PrefillNewOrderAction,
   type PrefillOrderAction,
   type PromptButtonAction,
@@ -139,6 +143,7 @@ export {
   type OrderStatus,
   type OrderType,
   type QueueState,
+  type ReplaceOrderRequest,
   type RequestOrderType,
   type RequestTimeInForce,
   type Side,

package/src/resources/v1/instruments.ts

@@ -178,12 +178,6 @@ export interface Instrument {
    */
   adv?: string | null;
 
-  /**
-   * @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) When a null/undefined value is
    * observed, it indicates that there is no available data.
@@ -226,12 +220,6 @@ export interface Instrument {
    * null/undefined value is observed, it indicates that there is no available data.
    */
   short_margin_rate?: string | null;
-
-  /**
-   * @deprecated Deprecated. Always null. When a null/undefined value is observed, it
-   * indicates it does not apply.
-   */
-  strike_price?: string | null;
 }
 
 export interface InstrumentCore {
@@ -307,12 +295,6 @@ export interface InstrumentCore {
    */
   adv?: string | null;
 
-  /**
-   * @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) When a null/undefined value is
    * observed, it indicates that there is no available data.
@@ -348,12 +330,6 @@ export interface InstrumentCore {
    * null/undefined value is observed, it indicates that there is no available data.
    */
   short_margin_rate?: string | null;
-
-  /**
-   * @deprecated Deprecated. Always null. When a null/undefined value is observed, it
-   * indicates it does not apply.
-   */
-  strike_price?: string | null;
 }
 
 export type InstrumentCoreList = Array<InstrumentCore>;
@@ -488,7 +464,7 @@ export interface InstrumentGetInstrumentsParams {
   /**
    * Filter by instrument type (e.g. COMMON_STOCK, OPTION)
    */
-  instrument_type?: 'COMMON_STOCK' | 'OPTION' | 'CASH';
+  instrument_type?: 'COMMON_STOCK' | 'INDEX' | 'OPTION' | 'CASH';
 
   /**
    * Filter by liquidation only status

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

@@ -41,6 +41,8 @@ export {
   type OpenEntitlementConsentAction,
   type OpenScreenerAction,
   type PrefillCancelOrderAction,
+  type PrefillModifyOrderAction,
+  type PrefillModifyOrderRequest,
   type PrefillNewOrderAction,
   type PrefillOrderAction,
   type PromptButtonAction,

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

@@ -297,6 +297,48 @@ export interface PrefillCancelOrderAction {
   orders: Array<OrdersAPI.CancelOrderRequest>;
 }
 
+/**
+ * Modify-order prefill action.
+ */
+export interface PrefillModifyOrderAction {
+  /**
+   * Modification targets and deltas needed to construct replace-order API requests.
+   */
+  orders: Array<PrefillModifyOrderRequest>;
+}
+
+/**
+ * Request to replace (modify) an existing order
+ *
+ * At least one field must be provided.
+ */
+export interface PrefillModifyOrderRequest {
+  /**
+   * Account ID that owns the order.
+   */
+  account_id?: number;
+
+  /**
+   * New limit price for the order
+   */
+  limit_price?: string | null;
+
+  /**
+   * Order ID to modify.
+   */
+  order_id?: string;
+
+  /**
+   * New quantity for the order
+   */
+  quantity?: string | null;
+
+  /**
+   * New stop price for the order
+   */
+  stop_price?: string | null;
+}
+
 /**
  * New-order prefill action.
  */
@@ -316,7 +358,8 @@ export interface PrefillNewOrderAction {
  */
 export type PrefillOrderAction =
   | PrefillOrderAction.PrefillNewOrderAction
-  | PrefillOrderAction.PrefillCancelOrderAction;
+  | PrefillOrderAction.PrefillCancelOrderAction
+  | PrefillOrderAction.PrefillModifyOrderAction;
 
 export namespace PrefillOrderAction {
   /**
@@ -332,6 +375,13 @@ export namespace PrefillOrderAction {
   export interface PrefillCancelOrderAction extends OmniAIAPI.PrefillCancelOrderAction {
     action_type: 'CANCEL';
   }
+
+  /**
+   * Modify one or more existing orders.
+   */
+  export interface PrefillModifyOrderAction extends OmniAIAPI.PrefillModifyOrderAction {
+    action_type: 'MODIFY';
+  }
 }
 
 /**
@@ -443,6 +493,8 @@ export declare namespace OmniAI {
     type OpenEntitlementConsentAction as OpenEntitlementConsentAction,
     type OpenScreenerAction as OpenScreenerAction,
     type PrefillCancelOrderAction as PrefillCancelOrderAction,
+    type PrefillModifyOrderAction as PrefillModifyOrderAction,
+    type PrefillModifyOrderRequest as PrefillModifyOrderRequest,
     type PrefillNewOrderAction as PrefillNewOrderAction,
     type PrefillOrderAction as PrefillOrderAction,
     type PromptButtonAction as PromptButtonAction,

package/src/resources/v1/orders.ts

@@ -180,11 +180,6 @@ export interface Execution {
    */
   id: string;
 
-  /**
-   * Unique instrument identifier.
-   */
-  instrument_id: string;
-
   /**
    * Identifier of the order this execution belongs to.
    */
@@ -206,14 +201,22 @@ export interface Execution {
   side: Side;
 
   /**
-   * Trading symbol.
+   * Transaction timestamp in nanosecond precision (UTC).
    */
-  symbol: string;
+  transaction_time: string;
 
   /**
-   * Transaction timestamp in nanosecond precision (UTC).
+   * Unique instrument identifier. `null` when this fill has no single resolvable
+   * instrument. When a null/undefined value is observed, it indicates it does not
+   * apply.
    */
-  transaction_time: string;
+  instrument_id?: string | null;
+
+  /**
+   * Trading symbol. `null` when this fill has no single resolvable instrument. When
+   * a null/undefined value is observed, it indicates it does not apply.
+   */
+  symbol?: string | null;
 }
 
 export type ExecutionList = Array<Execution>;
@@ -337,16 +340,6 @@ export interface Order {
    */
   filled_quantity: string;
 
-  /**
-   * Instrument identifier for the traded instrument.
-   */
-  instrument_id: string;
-
-  /**
-   * Type of security
-   */
-  instrument_type: V1API.SecurityType;
-
   /**
    * Remaining unfilled quantity
    */
@@ -372,11 +365,6 @@ export interface Order {
    */
   status: OrderStatus;
 
-  /**
-   * Trading symbol
-   */
-  symbol: string;
-
   /**
    * Time in force instruction
    */
@@ -415,6 +403,19 @@ export interface Order {
    */
   extended_hours?: boolean | null;
 
+  /**
+   * Instrument identifier for the traded instrument. `null` when the order has no
+   * single resolvable instrument. When a null/undefined value is observed, it
+   * indicates it does not apply.
+   */
+  instrument_id?: string | null;
+
+  /**
+   * Type of security. `null` when the order has no single resolvable instrument.
+   * When a null/undefined value is observed, it indicates it does not apply.
+   */
+  instrument_type?: V1API.SecurityType | null;
+
   /**
    * Limit offset for trailing stop-limit orders (signed) When a null/undefined value
    * is observed, it indicates it does not apply.
@@ -446,6 +447,12 @@ export interface Order {
    */
   stop_price?: string | null;
 
+  /**
+   * Trading symbol. `null` when the order has no single resolvable instrument. When
+   * a null/undefined value is observed, it indicates it does not apply.
+   */
+  symbol?: string | null;
+
   /**
    * Current trailing limit price computed by the trailing strategy When a
    * null/undefined value is observed, it indicates it does not apply.
@@ -531,6 +538,28 @@ export type OrderType =
  */
 export type QueueState = 'AWAITING_RELEASE' | 'RELEASED';
 
+/**
+ * Request to replace (modify) an existing order
+ *
+ * At least one field must be provided.
+ */
+export interface ReplaceOrderRequest {
+  /**
+   * New limit price for the order
+   */
+  limit_price?: string | null;
+
+  /**
+   * New quantity for the order
+   */
+  quantity?: string | null;
+
+  /**
+   * New stop price for the order
+   */
+  stop_price?: string | null;
+}
+
 /**
  * Strict order-type enum for order submission/replacement requests.
  */
@@ -543,7 +572,7 @@ export type RequestOrderType =
   | 'TRAILING_STOP_LIMIT';
 
 /**
- * Strict time-in-force enum for order submission/replacement requests.
+ * Strict time-in-force enum for order submission requests.
  */
 export type RequestTimeInForce =
   | 'DAY'
@@ -634,14 +663,15 @@ export interface OrderSubmitOrdersResponse extends Shared.BaseResponse {
 
 export interface OrderCancelAllOpenOrdersParams {
   /**
-   * Comma-separated instrument identifiers
+   * Comma-separated instrument IDs (UUID) or symbols (equity tickers or OSI option
+   * symbols).
    */
-  instrument_ids?: Array<string>;
+  instrument_ids?: Array<InstrumentIDOrSymbol>;
 
   /**
    * Filter by instrument type (e.g., COMMON_STOCK, OPTION)
    */
-  instrument_type?: 'COMMON_STOCK' | 'OPTION' | 'CASH';
+  instrument_type?: 'COMMON_STOCK' | 'INDEX' | 'OPTION' | 'CASH';
 
   /**
    * Filter by order side (BUY or SELL)
@@ -714,7 +744,7 @@ export interface OrderGetOrdersParams {
   /**
    * Instrument type filter (e.g., COMMON_STOCK, OPTION)
    */
-  instrument_type?: 'COMMON_STOCK' | 'OPTION' | 'CASH';
+  instrument_type?: 'COMMON_STOCK' | 'INDEX' | 'OPTION' | 'CASH';
 
   /**
    * Comma-separated order IDs to filter by. When provided, only orders whose order
@@ -793,11 +823,6 @@ export interface OrderReplaceOrderParams {
    * Body param: New stop price for the order
    */
   stop_price?: string | null;
-
-  /**
-   * Body param: New time in force for the order
-   */
-  time_in_force?: RequestTimeInForce;
 }
 
 export interface OrderSubmitOrdersParams {
@@ -816,6 +841,7 @@ export declare namespace Orders {
     type OrderStatus as OrderStatus,
     type OrderType as OrderType,
     type QueueState as QueueState,
+    type ReplaceOrderRequest as ReplaceOrderRequest,
     type RequestOrderType as RequestOrderType,
     type RequestTimeInForce as RequestTimeInForce,
     type Side as Side,

package/src/resources/v1/v1.ts

@@ -20,7 +20,9 @@ import {
   AccountStatus,
   AccountSubtype,
   AccountType,
+  AccountWithPersonalDetails,
   Accounts,
+  Address,
   MarginDetails,
   MarginDetailsUsage,
   MarginSessionDetails,
@@ -95,6 +97,7 @@ import {
   OrderType,
   Orders,
   QueueState,
+  ReplaceOrderRequest,
   RequestOrderType,
   RequestTimeInForce,
   Side,
@@ -233,6 +236,8 @@ import {
   OpenEntitlementConsentAction,
   OpenScreenerAction,
   PrefillCancelOrderAction,
+  PrefillModifyOrderAction,
+  PrefillModifyOrderRequest,
   PrefillNewOrderAction,
   PrefillOrderAction,
   PromptButtonAction,
@@ -257,7 +262,7 @@ export class V1 extends APIResource {
 /**
  * Security type
  */
-export type SecurityType = 'COMMON_STOCK' | 'OPTION' | 'CASH';
+export type SecurityType = 'COMMON_STOCK' | 'INDEX' | 'OPTION' | 'CASH';
 
 /**
  * Sort direction sorted results
@@ -288,6 +293,8 @@ export declare namespace V1 {
     type AccountStatus as AccountStatus,
     type AccountSubtype as AccountSubtype,
     type AccountType as AccountType,
+    type AccountWithPersonalDetails as AccountWithPersonalDetails,
+    type Address as Address,
     type MarginDetails as MarginDetails,
     type MarginDetailsUsage as MarginDetailsUsage,
     type MarginSessionDetails as MarginSessionDetails,
@@ -407,6 +414,8 @@ export declare namespace V1 {
     type OpenEntitlementConsentAction as OpenEntitlementConsentAction,
     type OpenScreenerAction as OpenScreenerAction,
     type PrefillCancelOrderAction as PrefillCancelOrderAction,
+    type PrefillModifyOrderAction as PrefillModifyOrderAction,
+    type PrefillModifyOrderRequest as PrefillModifyOrderRequest,
     type PrefillNewOrderAction as PrefillNewOrderAction,
     type PrefillOrderAction as PrefillOrderAction,
     type PromptButtonAction as PromptButtonAction,
@@ -427,6 +436,7 @@ export declare namespace V1 {
     type OrderStatus as OrderStatus,
     type OrderType as OrderType,
     type QueueState as QueueState,
+    type ReplaceOrderRequest as ReplaceOrderRequest,
     type RequestOrderType as RequestOrderType,
     type RequestTimeInForce as RequestTimeInForce,
     type Side as Side,

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.89.0'; // x-release-please-version
+export const VERSION = '0.91.0'; // x-release-please-version

package/version.d.mts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.89.0";
+export declare const VERSION = "0.91.0";
 //# sourceMappingURL=version.d.mts.map

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.89.0";
+export declare const VERSION = "0.91.0";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '0.89.0'; // x-release-please-version
+exports.VERSION = '0.91.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '0.89.0'; // x-release-please-version
+export const VERSION = '0.91.0'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map