@clear-street/clearstreet 0.90.0 → 0.92.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/calendar.ts

@@ -203,7 +203,7 @@ export interface CalendarGetMarketHoursCalendarParams {
   /**
    * Market type to query (us_equities, us_options). If omitted, returns all markets.
    */
-  market?: MarketType;
+  market?: 'us_equities' | 'us_options';
 }
 
 export declare namespace Calendar {

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/instrument-data/instrument-data.ts

@@ -41,9 +41,15 @@ export class InstrumentData extends APIResource {
   news: NewsAPI.News = new NewsAPI.News(this._client);
 
   /**
-   * List instrument events across all securities.
+   * List instrument events across all securities, grouped by date.
    *
-   * Retrieves all instrument events grouped by date.
+   * 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.
+   * - Filtered (with `instrument_ids`): a 30-day lookback ending on the anchor
+   *   (`from_date` = anchor − 30 days, `to_date` = anchor).
    *
    * @example
    * ```ts
@@ -65,12 +71,12 @@ export class InstrumentData extends APIResource {
    * ```ts
    * const response =
    *   await client.v1.instrumentData.getInstrumentAnalystConsensus(
-   *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *     'x',
    *   );
    * ```
    */
   getInstrumentAnalystConsensus(
-    instrumentID: OrdersAPI.InstrumentIDOrSymbol,
+    instrumentID: string,
     query: InstrumentDataGetInstrumentAnalystConsensusParams | null | undefined = {},
     options?: RequestOptions,
   ): APIPromise<InstrumentDataGetInstrumentAnalystConsensusResponse> {
@@ -92,12 +98,12 @@ export class InstrumentData extends APIResource {
    * ```ts
    * const response =
    *   await client.v1.instrumentData.getInstrumentBalanceSheetStatements(
-   *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *     'x',
    *   );
    * ```
    */
   getInstrumentBalanceSheetStatements(
-    instrumentID: OrdersAPI.InstrumentIDOrSymbol,
+    instrumentID: string,
     query: InstrumentDataGetInstrumentBalanceSheetStatementsParams | null | undefined = {},
     options?: RequestOptions,
   ): APIPromise<InstrumentDataGetInstrumentBalanceSheetStatementsResponse> {
@@ -115,12 +121,12 @@ export class InstrumentData extends APIResource {
    * ```ts
    * const response =
    *   await client.v1.instrumentData.getInstrumentCashFlowStatements(
-   *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *     'x',
    *   );
    * ```
    */
   getInstrumentCashFlowStatements(
-    instrumentID: OrdersAPI.InstrumentIDOrSymbol,
+    instrumentID: string,
     query: InstrumentDataGetInstrumentCashFlowStatementsParams | null | undefined = {},
     options?: RequestOptions,
   ): APIPromise<InstrumentDataGetInstrumentCashFlowStatementsResponse> {
@@ -142,13 +148,11 @@ export class InstrumentData extends APIResource {
    * @example
    * ```ts
    * const response =
-   *   await client.v1.instrumentData.getInstrumentEvents(
-   *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
-   *   );
+   *   await client.v1.instrumentData.getInstrumentEvents('x');
    * ```
    */
   getInstrumentEvents(
-    instrumentID: OrdersAPI.InstrumentIDOrSymbol,
+    instrumentID: string,
     query: InstrumentDataGetInstrumentEventsParams | null | undefined = {},
     options?: RequestOptions,
   ): APIPromise<InstrumentDataGetInstrumentEventsResponse> {
@@ -162,12 +166,12 @@ export class InstrumentData extends APIResource {
    * ```ts
    * const response =
    *   await client.v1.instrumentData.getInstrumentFundamentals(
-   *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *     'x',
    *   );
    * ```
    */
   getInstrumentFundamentals(
-    instrumentID: OrdersAPI.InstrumentIDOrSymbol,
+    instrumentID: string,
     options?: RequestOptions,
   ): APIPromise<InstrumentDataGetInstrumentFundamentalsResponse> {
     return this._client.get(path`/v1/instruments/${instrumentID}/fundamentals`, options);
@@ -186,12 +190,12 @@ export class InstrumentData extends APIResource {
    * ```ts
    * const response =
    *   await client.v1.instrumentData.getInstrumentIncomeStatements(
-   *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *     'x',
    *   );
    * ```
    */
   getInstrumentIncomeStatements(
-    instrumentID: OrdersAPI.InstrumentIDOrSymbol,
+    instrumentID: string,
     query: InstrumentDataGetInstrumentIncomeStatementsParams | null | undefined = {},
     options?: RequestOptions,
   ): APIPromise<InstrumentDataGetInstrumentIncomeStatementsResponse> {

package/src/resources/v1/instruments.ts

@@ -2,7 +2,6 @@
 
 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';
@@ -18,13 +17,11 @@ export class Instruments extends APIResource {
    * @example
    * ```ts
    * const response =
-   *   await client.v1.instruments.getInstrumentByID(
-   *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
-   *   );
+   *   await client.v1.instruments.getInstrumentByID('x');
    * ```
    */
   getInstrumentByID(
-    instrumentID: OrdersAPI.InstrumentIDOrSymbol,
+    instrumentID: string,
     query: InstrumentGetInstrumentByIDParams | null | undefined = {},
     options?: RequestOptions,
   ): APIPromise<InstrumentGetInstrumentByIDResponse> {
@@ -178,12 +175,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 +217,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 +292,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 +327,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>;
@@ -532,7 +505,7 @@ export interface InstrumentGetOptionContractsParams {
   /**
    * Filter by contract type: CALL or PUT
    */
-  contract_type?: ContractType;
+  contract_type?: 'CALL' | 'PUT';
 
   /**
    * Filter to contracts expiring on this date (YYYY-MM-DD)
@@ -559,7 +532,7 @@ export interface InstrumentGetOptionContractsParams {
   /**
    * Instrument identifier or symbol of the underlying equity/index
    */
-  underlying_instrument_id?: OrdersAPI.InstrumentIDOrSymbol;
+  underlying_instrument_id?: string;
 }
 
 export interface InstrumentSearchInstrumentsParams {

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

@@ -222,7 +222,8 @@ export interface Execution {
 export type ExecutionList = Array<Execution>;
 
 /**
- * Instrument identifier
+ * Instrument identifier: either an instrument UUID or a symbol (symbol for
+ * equities, OSI for options). Non-UUID inputs are resolved server-side.
  */
 export type InstrumentIDOrSymbol = string;
 
@@ -270,7 +271,8 @@ export interface NewOrderRequest {
   extended_hours?: boolean | null;
 
   /**
-   * Instrument identifier
+   * Instrument ID (UUID) or symbol (equity ticker or OSI option symbol). Either
+   * `symbol` or `instrument_id` must be provided.
    */
   instrument_id?: InstrumentIDOrSymbol | null;
 
@@ -538,6 +540,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.
  */
@@ -550,7 +574,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'
@@ -801,11 +825,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 {
@@ -824,6 +843,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/positions.ts

@@ -48,7 +48,7 @@ export class Positions extends APIResource {
    * @example
    * ```ts
    * const response = await client.v1.positions.closePosition(
-   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *   'x',
    *   { account_id: 0 },
    * );
    * ```

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,
@@ -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/resources/v1/watchlist.ts

@@ -19,7 +19,7 @@ export class Watchlist extends APIResource {
    * ```ts
    * const response = await client.v1.watchlist.addWatchlistItem(
    *   '550e8400-e29b-41d4-a716-446655440000',
-   *   { instrument_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' },
+   *   { instrument_id: 'x' },
    * );
    * ```
    */
@@ -240,7 +240,7 @@ export interface WatchlistGetWatchlistsResponse extends Shared.BaseResponse {
 
 export interface WatchlistAddWatchlistItemParams {
   /**
-   * Instrument identifier
+   * Instrument ID (UUID) or symbol (equity ticker or OSI option symbol).
    */
   instrument_id: OrdersAPI.InstrumentIDOrSymbol;
 }

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.90.0'; // x-release-please-version
+export const VERSION = '0.92.0'; // x-release-please-version

package/version.d.mts

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

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.90.0";
+export declare const VERSION = "0.92.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.90.0'; // x-release-please-version
+exports.VERSION = '0.92.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

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