@clear-street/clearstreet 0.101.0 → 0.103.0

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

@@ -1021,11 +1021,21 @@ export interface InstrumentEventIpoItem {
   exchange?: string | null;
 
   /**
-   * IPO market cap. When a null/undefined value is observed, it indicates that there
-   * is no available data.
+   * @deprecated Deprecated: use `offering_amount`, which carries the same value.
+   * This is not a market capitalization. When a null/undefined value is observed, it
+   * indicates that there is no available data.
    */
   market_cap?: string | null;
 
+  /**
+   * IPO maximum aggregate offering value: all offered shares, including
+   * over-allotment (greenshoe) shares, at the top of the price range. This is an
+   * upper bound. It assumes full exercise of the over-allotment option and pricing
+   * at the top of the range. When a null/undefined value is observed, it indicates
+   * that there is no available data.
+   */
+  offering_amount?: string | null;
+
   /**
    * IPO price range. When a null/undefined value is observed, it indicates that
    * there is no available data.
@@ -1412,11 +1422,21 @@ export interface InstrumentIpoEvent {
   exchange?: string | null;
 
   /**
-   * IPO market cap. When a null/undefined value is observed, it indicates that there
-   * is no available data.
+   * @deprecated Deprecated: use `offering_amount`, which carries the same value.
+   * This is not a market capitalization. When a null/undefined value is observed, it
+   * indicates that there is no available data.
    */
   market_cap?: string | null;
 
+  /**
+   * IPO maximum aggregate offering value: all offered shares, including
+   * over-allotment (greenshoe) shares, at the top of the price range. This is an
+   * upper bound. It assumes full exercise of the over-allotment option and pricing
+   * at the top of the range. When a null/undefined value is observed, it indicates
+   * that there is no available data.
+   */
+  offering_amount?: string | null;
+
   /**
    * IPO price range. When a null/undefined value is observed, it indicates that
    * there is no available data.

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

@@ -36,6 +36,11 @@ export class MarketData extends APIResource {
   /**
    * Get market data snapshots for one or more securities.
    *
+   * Two targeting modes, mutually exclusive: `instrument_ids` (1-100 ids), or
+   * `underlying_instrument_id` + `expiry` together, which resolves the underlier's
+   * option chain for that expiry and returns a snapshot for every contract in it
+   * (uncapped).
+   *
    * @example
    * ```ts
    * const response =
@@ -456,12 +461,26 @@ export interface MarketDataGetDailySummariesParams {
 }
 
 export interface MarketDataGetSnapshotsParams {
+  /**
+   * Filter the option chain to contracts expiring on this date (YYYY-MM-DD). Must be
+   * provided together with `underlying_instrument_id`.
+   */
+  expiry?: string;
+
   /**
    * Comma-separated instrument IDs (UUID) or symbols (equity tickers or OSI option
-   * symbols). Required; accepts 1 to 100 IDs. Duplicate resolved ids collapse to a
-   * single row.
+   * symbols). Accepts 1 to 100 IDs; duplicate resolved ids collapse to a single row.
+   * Required unless `underlying_instrument_id` and `expiry` are provided; mutually
+   * exclusive with that pair.
    */
   instrument_ids?: Array<OrdersAPI.InstrumentIDOrSymbol>;
+
+  /**
+   * Instrument identifier or symbol of the underlying equity/index for an option
+   * chain. Must be provided together with `expiry`; mutually exclusive with
+   * `instrument_ids`.
+   */
+  underlying_instrument_id?: string;
 }
 
 export declare namespace MarketData {

package/src/resources/v1/locates.ts

@@ -0,0 +1,130 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as Shared from '../shared';
+import * as OrdersAPI from './orders';
+import { APIPromise } from '../../core/api-promise';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+/**
+ * Query locate requests, granted locates, and cached locate borrow rates.
+ */
+export class Locates extends APIResource {
+  /**
+   * > **Beta** — this endpoint may change before general availability.
+   *
+   * Fetch the cached locate borrow rate for one instrument. Rates refresh
+   * periodically; `404` means no rate is currently cached for the instrument.
+   *
+   * @example
+   * ```ts
+   * const response = await client.v1.locates.getLocateRateByID(
+   *   'x',
+   * );
+   * ```
+   */
+  getLocateRateByID(
+    instrumentID: OrdersAPI.InstrumentIDOrSymbol,
+    options?: RequestOptions,
+  ): APIPromise<LocateGetLocateRateByIDResponse> {
+    return this._client.get(path`/v1/locates/rates/${instrumentID}`, options);
+  }
+
+  /**
+   * > **Beta** — this endpoint may change before general availability.
+   *
+   * Fetch the cached locate borrow rates for up to 1,000 instruments. The response
+   * returns one row per requested instrument, in request order. Each row carries
+   * either the `rate` or an `error` — a `404` when the instrument is unknown or has
+   * no cached rate. The status is `207` when any row has an error, `200` when every
+   * instrument resolved to a rate.
+   *
+   * @example
+   * ```ts
+   * const response = await client.v1.locates.getLocateRates({
+   *   instrument_ids: ['x'],
+   * });
+   * ```
+   */
+  getLocateRates(
+    query: LocateGetLocateRatesParams,
+    options?: RequestOptions,
+  ): APIPromise<LocateGetLocateRatesResponse> {
+    return this._client.get('/v1/locates/rates', { query, ...options });
+  }
+}
+
+/**
+ * A locate borrow rate for an instrument.
+ */
+export interface LocateRate {
+  /**
+   * Instrument id the rate applies to.
+   */
+  instrument_id: string;
+
+  /**
+   * Borrow rate, expressed as a decimal (e.g. 0.037012 for 3.7012%).
+   */
+  rate: string;
+
+  /**
+   * When the rate was requested from the locates venue.
+   */
+  as_of?: string | null;
+}
+
+/**
+ * A requested instrument with either its cached borrow rate or an error.
+ */
+export interface LocateRateResult {
+  /**
+   * The instrument id (UUID) or symbol, echoed exactly as requested, so each result
+   * maps back to its request.
+   */
+  instrument: OrdersAPI.InstrumentIDOrSymbol;
+
+  /**
+   * Why no rate is present — a `404` when the instrument is unknown or has no cached
+   * rate. Omitted when `rate` is present.
+   */
+  error?: Shared.APIError | null;
+
+  /**
+   * The cached borrow rate. Present when a rate was found; omitted when `error` is
+   * present.
+   */
+  rate?: LocateRate | null;
+}
+
+export type LocateRateResultList = Array<LocateRateResult>;
+
+export interface LocateGetLocateRateByIDResponse extends Shared.BaseResponse {
+  /**
+   * A locate borrow rate for an instrument.
+   */
+  data: LocateRate;
+}
+
+export interface LocateGetLocateRatesResponse extends Shared.BaseResponse {
+  data: LocateRateResultList;
+}
+
+export interface LocateGetLocateRatesParams {
+  /**
+   * Comma-separated instrument IDs (UUID) or symbols; at least one, at most 1,000.
+   */
+  instrument_ids: Array<OrdersAPI.InstrumentIDOrSymbol>;
+}
+
+export declare namespace Locates {
+  export {
+    type LocateRate as LocateRate,
+    type LocateRateResult as LocateRateResult,
+    type LocateRateResultList as LocateRateResultList,
+    type LocateGetLocateRateByIDResponse as LocateGetLocateRateByIDResponse,
+    type LocateGetLocateRatesResponse as LocateGetLocateRatesResponse,
+    type LocateGetLocateRatesParams as LocateGetLocateRatesParams,
+  };
+}

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

@@ -533,9 +533,10 @@ 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.
+   * Optional execution strategy. One of `SOR`, `VWAP`, `TWAP`, or `DMA`. Defaults to
+   * `SOR`, the only strategy OTC common-stock orders support. `VWAP` and `TWAP` are
+   * supported only on `MARKET` and `LIMIT` orders, and `DMA` only on `LIMIT` orders;
+   * all three require `DAY` time-in-force.
    */
   strategy?: OrdersAPI.OrderStrategy | null;
 

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

@@ -138,8 +138,10 @@ export class Threads extends APIResource {
   }
 
   /**
-   * List authorized conversation metadata, newest first. Use `page_size` and
-   * `page_token` for pagination, and the messages endpoint for conversation history.
+   * List authorized conversation metadata, most recently active first (by
+   * `updated_at`, which a new message moves). Use `page_size` and `page_token` for
+   * pagination, and the messages endpoint for conversation history. A thread that
+   * gets a message while you page moves to the first page.
    *
    * With `account_id`, list only conversations linked to that account and require
    * current account access. Without it, list only conversations with no linked
@@ -323,6 +325,10 @@ export interface Thread {
 
   title: string;
 
+  /**
+   * Time of the last activity: a new message in the thread or a change to the
+   * thread.
+   */
   updated_at: string;
 }
 

package/src/resources/v1/orders.ts

@@ -172,7 +172,8 @@ export interface Execution {
   order_id: string;
 
   /**
-   * Filled quantity.
+   * Filled quantity. For a strategy-level multileg fill this is the net strategy
+   * quantity, not a per-leg quantity.
    */
   quantity: string;
 
@@ -187,9 +188,9 @@ export interface Execution {
   transaction_time: string;
 
   /**
-   * 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.
+   * Unique instrument identifier. `null` when this is a strategy-level multileg fill
+   * whose legs are reported individually in `legs[]`. When a null/undefined value is
+   * observed, it indicates it does not apply.
    */
   instrument_id?: string | null;
 
@@ -200,8 +201,9 @@ export interface Execution {
   price?: 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.
+   * Trading symbol. `null` when this is a strategy-level multileg fill whose legs
+   * are reported individually in `legs[]`. When a null/undefined value is observed,
+   * it indicates it does not apply.
    */
   symbol?: string | null;
 
@@ -307,9 +309,10 @@ export interface NewOrderRequest {
   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.
+   * Optional execution strategy. One of `SOR`, `VWAP`, `TWAP`, or `DMA`. Defaults to
+   * `SOR`, the only strategy OTC common-stock orders support. `VWAP` and `TWAP` are
+   * supported only on `MARKET` and `LIMIT` orders, and `DMA` only on `LIMIT` orders;
+   * all three require `DAY` time-in-force.
    */
   strategy?: OrderStrategy | null;
 
@@ -431,15 +434,16 @@ 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 identifier for the traded instrument. `null` when the order is a
+   * multileg strategy whose legs are reported individually in `legs[]`. 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.
+   * Type of security. `null` when the order is a multileg strategy whose legs are
+   * reported individually in `legs[]`. When a null/undefined value is observed, it
+   * indicates it does not apply.
    */
   instrument_type?: V1API.SecurityType | null;
 
@@ -480,8 +484,9 @@ export interface Order {
   strategy?: Order.Strategy;
 
   /**
-   * Trading symbol. `null` when the order has no single resolvable instrument. When
-   * a null/undefined value is observed, it indicates it does not apply.
+   * Trading symbol. `null` when the order is a multileg strategy whose legs are
+   * reported individually in `legs[]`. When a null/undefined value is observed, it
+   * indicates it does not apply.
    */
   symbol?: string | null;
 
@@ -549,7 +554,12 @@ export namespace Order {
     /**
      * Execution strategy type.
      */
-    type: string;
+    type: 'SOR' | 'VWAP' | 'TWAP' | 'DMA';
+
+    /**
+     * Venue code the order is routed to. DMA only.
+     */
+    destination?: string;
 
     /**
      * UTC timestamp (RFC 3339) at which execution ends.
@@ -591,9 +601,13 @@ export type OrderStatus =
 
 /**
  * Optional execution strategy controlling how the order is worked in the market.
- * Omit to use standard routing. One of `SOR`, `VWAP`, or `TWAP`.
+ * Omit to use standard routing. One of `SOR`, `VWAP`, `TWAP`, or `DMA`.
  */
-export type OrderStrategy = OrderStrategy.Type | OrderStrategy.UnionMember1 | OrderStrategy.UnionMember2;
+export type OrderStrategy =
+  | OrderStrategy.Type
+  | OrderStrategy.UnionMember1
+  | OrderStrategy.UnionMember2
+  | OrderStrategy.UnionMember3;
 
 export namespace OrderStrategy {
   /**
@@ -651,6 +665,21 @@ export namespace OrderStrategy {
      */
     start_at?: string;
   }
+
+  /**
+   * Direct Market Access. Routes the order straight to the named venue.
+   */
+  export interface UnionMember3 {
+    /**
+     * Venue code the order is routed to.
+     */
+    destination: string;
+
+    /**
+     * Execution strategy type.
+     */
+    type: 'DMA';
+  }
 }
 
 /**
@@ -970,26 +999,40 @@ export interface OrderGetOrdersParams {
 export namespace OrderGetOrdersParams {
   export interface UpdatedAt {
     /**
-     * > **Alpha** — this parameter is experimental and may change or be removed at any
-     * > time.
+     * Return only rows where `updated_at` is strictly after the given value. A bare
+     * `YYYY-MM-DD` date expands to the end of that day (UTC), so this matches from the
+     * start of the following day. See
+     * [Range filters](https://docs.clearstreet.com/guides/api-fundamentals#range-filters)
+     * for accepted formats, bare-date expansion, and combining bounds. Returns 400 if
+     * the resulting range is inverted.
      */
     gt?: string;
 
     /**
-     * > **Alpha** — this parameter is experimental and may change or be removed at any
-     * > time.
+     * Return only rows where `updated_at` is on or after the given value. A bare
+     * `YYYY-MM-DD` date expands to the start of that day (UTC). See
+     * [Range filters](https://docs.clearstreet.com/guides/api-fundamentals#range-filters)
+     * for accepted formats, bare-date expansion, and combining bounds. Returns 400 if
+     * the resulting range is inverted.
      */
     gte?: string;
 
     /**
-     * > **Alpha** — this parameter is experimental and may change or be removed at any
-     * > time.
+     * Return only rows where `updated_at` is strictly before the given value. A bare
+     * `YYYY-MM-DD` date expands to the start of that day (UTC). See
+     * [Range filters](https://docs.clearstreet.com/guides/api-fundamentals#range-filters)
+     * for accepted formats, bare-date expansion, and combining bounds. Returns 400 if
+     * the resulting range is inverted.
      */
     lt?: string;
 
     /**
-     * > **Alpha** — this parameter is experimental and may change or be removed at any
-     * > time.
+     * Return only rows where `updated_at` is on or before the given value. A bare
+     * `YYYY-MM-DD` date expands to the end of that day (UTC), so this matches through
+     * the end of that day. See
+     * [Range filters](https://docs.clearstreet.com/guides/api-fundamentals#range-filters)
+     * for accepted formats, bare-date expansion, and combining bounds. Returns 400 if
+     * the resulting range is inverted.
      */
     lte?: string;
   }

package/src/resources/v1/positions.ts

@@ -350,12 +350,11 @@ export interface PositionInstruction {
   created_at?: string | null;
 
   /**
-   * Machine-readable counterpart to `rejection_reason`: a stable reason code plus
-   * params, present on every rejected row that has a `rejection_reason` — on submit,
-   * cancel, get, and list alike. Branch on `rejection.reason` instead of parsing
-   * `rejection_reason`. Forward-only: instructions rejected before this field
-   * shipped may carry only `rejection_reason`. When a null/undefined value is
-   * observed, it indicates it does not apply.
+   * Machine-readable counterpart to `rejection_reason`: a stable reason code,
+   * human-readable `description`, and params, present on every rejected row — on
+   * submit, cancel, get, and list alike. Branch on `rejection.reason` and read
+   * `rejection.description` instead of the top-level `rejection_reason`. When a
+   * null/undefined value is observed, it indicates it does not apply.
    */
   rejection?: PositionInstructionRejection | null;
 
@@ -385,13 +384,17 @@ export type PositionInstructionList = Array<PositionInstruction>;
 /**
  * Machine-readable detail for a rejected position instruction.
  *
- * Present on every rejected row that carries a `rejection_reason`, across the full
- * lifecycle — submit, cancel, get, and list. Branch on `reason` for programmatic
- * handling and template your own copy from `metadata`; `rejection_reason` remains
- * the human-readable fallback. Forward-only: instructions rejected before this
- * field shipped may carry only `rejection_reason`.
+ * Present on every rejected row, across the full lifecycle — submit, cancel, get,
+ * and list. Branch on `reason` for programmatic handling and template your own
+ * copy from `metadata`, or show `description` directly.
  */
 export interface PositionInstructionRejection {
+  /**
+   * Human-readable explanation of the rejection. Duplicates the top-level
+   * `rejection_reason`; prefer this field.
+   */
+  description: string;
+
   /**
    * Namespacing domain of the `reason` code — `com.clearstreet.oems.exercise` for
    * reasons OEMS validates, `com.clearstreet.oems.clearing` for clearing-owned

package/src/resources/v1/v1.ts

@@ -39,10 +39,16 @@ import * as CalendarAPI from './calendar';
 import {
   Calendar,
   CalendarGetClockResponse,
+  CalendarGetEconomicEventsCalendarParams,
+  CalendarGetEconomicEventsCalendarResponse,
   CalendarGetMarketHoursCalendarParams,
   CalendarGetMarketHoursCalendarResponse,
   ClockDetail,
   DayType,
+  EconomicEvent,
+  EconomicEventImpact,
+  EconomicEventList,
+  EconomicEventUnit,
   MarketHoursDetail,
   MarketHoursDetailList,
   MarketSessionType,
@@ -73,6 +79,16 @@ import {
   OptionsContractList,
   TickRule,
 } from './instruments';
+import * as LocatesAPI from './locates';
+import {
+  LocateGetLocateRateByIDResponse,
+  LocateGetLocateRatesParams,
+  LocateGetLocateRatesResponse,
+  LocateRate,
+  LocateRateResult,
+  LocateRateResultList,
+  Locates,
+} from './locates';
 import * as OmniFeedAPI from './omni-feed';
 import {
   FeedItem,
@@ -299,6 +315,7 @@ export class V1 extends APIResource {
   calendar: CalendarAPI.Calendar = new CalendarAPI.Calendar(this._client);
   instrumentData: InstrumentDataAPI.InstrumentData = new InstrumentDataAPI.InstrumentData(this._client);
   instruments: InstrumentsAPI.Instruments = new InstrumentsAPI.Instruments(this._client);
+  locates: LocatesAPI.Locates = new LocatesAPI.Locates(this._client);
   omniAI: OmniAIAPI.OmniAI = new OmniAIAPI.OmniAI(this._client);
   omniFeed: OmniFeedAPI.OmniFeed = new OmniFeedAPI.OmniFeed(this._client);
   orders: OrdersAPI.Orders = new OrdersAPI.Orders(this._client);
@@ -323,6 +340,7 @@ V1.APIVersion = APIVersion;
 V1.Calendar = Calendar;
 V1.InstrumentData = InstrumentData;
 V1.Instruments = Instruments;
+V1.Locates = Locates;
 V1.OmniAI = OmniAI;
 V1.OmniFeed = OmniFeed;
 V1.Orders = Orders;
@@ -376,6 +394,10 @@ export declare namespace V1 {
     Calendar as Calendar,
     type ClockDetail as ClockDetail,
     type DayType as DayType,
+    type EconomicEvent as EconomicEvent,
+    type EconomicEventImpact as EconomicEventImpact,
+    type EconomicEventList as EconomicEventList,
+    type EconomicEventUnit as EconomicEventUnit,
     type MarketHoursDetail as MarketHoursDetail,
     type MarketHoursDetailList as MarketHoursDetailList,
     type MarketSessionType as MarketSessionType,
@@ -384,7 +406,9 @@ export declare namespace V1 {
     type SessionSchedule as SessionSchedule,
     type TradingSessions as TradingSessions,
     type CalendarGetClockResponse as CalendarGetClockResponse,
+    type CalendarGetEconomicEventsCalendarResponse as CalendarGetEconomicEventsCalendarResponse,
     type CalendarGetMarketHoursCalendarResponse as CalendarGetMarketHoursCalendarResponse,
+    type CalendarGetEconomicEventsCalendarParams as CalendarGetEconomicEventsCalendarParams,
     type CalendarGetMarketHoursCalendarParams as CalendarGetMarketHoursCalendarParams,
   };
 
@@ -450,6 +474,16 @@ export declare namespace V1 {
     type InstrumentSearchInstrumentsParams as InstrumentSearchInstrumentsParams,
   };
 
+  export {
+    Locates as Locates,
+    type LocateRate as LocateRate,
+    type LocateRateResult as LocateRateResult,
+    type LocateRateResultList as LocateRateResultList,
+    type LocateGetLocateRateByIDResponse as LocateGetLocateRateByIDResponse,
+    type LocateGetLocateRatesResponse as LocateGetLocateRatesResponse,
+    type LocateGetLocateRatesParams as LocateGetLocateRatesParams,
+  };
+
   export {
     OmniAI as OmniAI,
     type ActionButton as ActionButton,

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.101.0'; // x-release-please-version
+export const VERSION = '0.103.0'; // x-release-please-version

package/version.d.mts

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

package/version.d.ts

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

package/version.mjs

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