@clear-street/clearstreet 0.93.1 → 0.94.0

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

@@ -41,13 +41,15 @@ export class InstrumentData extends APIResource {
   news: NewsAPI.News = new NewsAPI.News(this._client);
 
   /**
-   * List instrument events across all securities, grouped by date.
+   * List instrument events across all securities, grouped by date. Results are
+   * paginated via `page_size` / `page_token`; a date's events may span two pages.
    *
    * 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.
+   *   `to_date` = anchor). If only one bound is given, the other defaults to 6 days
+   *   from it; there is no maximum span once both bounds are given.
    * - Filtered (with `instrument_ids`): a 30-day lookback ending on the anchor
    *   (`from_date` = anchor − 30 days, `to_date` = anchor).
    *
@@ -137,8 +139,8 @@ export class InstrumentData extends APIResource {
   }
 
   /**
-   * Retrieves corporate events (dividends, splits, etc.) for an instrument, grouped
-   * by event type.
+   * Retrieves corporate events (earnings, dividends, splits, IPO) for an instrument,
+   * grouped by event type. Filter to specific types via `event_types`.
    *
    * Date range defaults:
    *
@@ -1059,6 +1061,11 @@ export interface InstrumentEventsData {
    */
   instrument_id: string;
 
+  /**
+   * IPO events
+   */
+  ipos: Array<InstrumentIpoEvent>;
+
   /**
    * Stock split events
    */
@@ -1359,6 +1366,58 @@ export interface InstrumentIncomeStatement {
 
 export type InstrumentIncomeStatementList = Array<InstrumentIncomeStatement>;
 
+/**
+ * Represents an IPO event for an instrument
+ */
+export interface InstrumentIpoEvent {
+  /**
+   * The date of the IPO
+   */
+  date: string;
+
+  /**
+   * IPO action. When a null/undefined value is observed, it indicates that there is
+   * no available data.
+   */
+  actions?: string | null;
+
+  /**
+   * IPO announced timestamp. When a null/undefined value is observed, it indicates
+   * that there is no available data.
+   */
+  announced_at?: string | null;
+
+  /**
+   * IPO company name. When a null/undefined value is observed, it indicates that
+   * there is no available data.
+   */
+  company?: string | null;
+
+  /**
+   * IPO exchange. When a null/undefined value is observed, it indicates that there
+   * is no available data.
+   */
+  exchange?: string | null;
+
+  /**
+   * IPO market cap. When a null/undefined value is observed, it indicates that there
+   * is no available data.
+   */
+  market_cap?: string | null;
+
+  /**
+   * IPO price range. When a null/undefined value is observed, it indicates that
+   * there is no available data.
+   */
+  price_range?: string | null;
+
+  /**
+   * IPO shares offered. When a null/undefined value is observed, it indicates that
+   * there is no available data.
+   */
+  shares?: string | null;
+}
+
 /**
  * Represents a stock split event for an instrument
  */
@@ -1473,6 +1532,18 @@ export interface InstrumentDataGetAllInstrumentEventsParams {
    */
   instrument_ids?: Array<OrdersAPI.InstrumentIDOrSymbol>;
 
+  /**
+   * The number of items to return per page. Only used when page_token is not
+   * provided.
+   */
+  page_size?: number;
+
+  /**
+   * Token for retrieving the next or previous page of results. Contains encoded
+   * pagination state; when provided, page_size is ignored.
+   */
+  page_token?: string;
+
   /**
    * The end date for the query range, inclusive (YYYY-MM-DD).
    */
@@ -1540,6 +1611,12 @@ export interface InstrumentDataGetInstrumentCashFlowStatementsParams {
 }
 
 export interface InstrumentDataGetInstrumentEventsParams {
+  /**
+   * Filter by event type(s). Comma-delimited list. Example:
+   * `event_types=EARNINGS,IPO`.
+   */
+  event_types?: Array<AllEventsEventType>;
+
   /**
    * The start date for the query range, inclusive (YYYY-MM-DD).
    */
@@ -1599,6 +1676,7 @@ export declare namespace InstrumentData {
     type InstrumentFundamentals as InstrumentFundamentals,
     type InstrumentIncomeStatement as InstrumentIncomeStatement,
     type InstrumentIncomeStatementList as InstrumentIncomeStatementList,
+    type InstrumentIpoEvent as InstrumentIpoEvent,
     type InstrumentSplitEvent as InstrumentSplitEvent,
     type PriceTarget as PriceTarget,
     type ReportTime as ReportTime,

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

@@ -300,9 +300,19 @@ export interface SnapshotSession {
   change_percent: string;
 
   /**
-   * Previous session close price.
+   * 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.
    */
   previous_close: string;
+
+  /**
+   * Unadjusted (raw) previous session close. Present only when a corporate-action
+   * adjustment exists for the previous close date; when no adjustment exists,
+   * `previous_close` is the raw close and this field is omitted. When a
+   * null/undefined value is observed, it indicates that there is no available data.
+   */
+  previous_close_unadjusted?: string | null;
 }
 
 export interface MarketDataGetDailySummariesResponse extends Shared.BaseResponse {

package/src/resources/v1/instruments.ts

@@ -2,6 +2,7 @@
 
 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';
@@ -47,8 +48,10 @@ export class Instruments extends APIResource {
   /**
    * List options contracts.
    *
-   * Returns options contracts for a given underlier with options-specific metadata.
-   * Exactly one underlier identifier must be provided.
+   * Returns options contracts with options-specific metadata. Exactly one identifier
+   * must be provided: `underlier`/`underlying_instrument_id` (list all contracts for
+   * that underlier) or `contract_ids` (look up specific contracts directly).
+   * `expiry`/`contract_type` apply as filters in either case.
    *
    * @example
    * ```ts
@@ -175,6 +178,13 @@ export interface Instrument {
    */
   adv?: string | null;
 
+  /**
+   * Corporate-action-adjusted last close; present only when an adjustment exists for
+   * the previous_close date. When a null/undefined value is observed, it indicates
+   * that there is no available data.
+   */
+  cax_adjusted_previous_close?: 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.
@@ -194,16 +204,28 @@ export interface Instrument {
   name?: string | null;
 
   /**
-   * 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 average daily volume (ADV multiplied by the cax-adjusted close when
+   * present, the raw previous close otherwise). 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
+   * Available options expiration dates for this instrument, each annotated with
+   * which settlement cycles have listed contracts on it. Present only when
    * `include_options_expiry_dates=true` in the request. When a null/undefined value
    * is observed, it indicates it does not apply.
    */
+  options_contract_expiry_dates?: Array<OptionExpiryDate> | null;
+
+  /**
+   * @deprecated Available options expiration dates for this instrument. Present only
+   * when `include_options_expiry_dates=true` in the request.
+   *
+   * Deprecated: use `options_contract_expiry_dates`, which carries the same dates
+   * annotated with settlement-cycle information. When a null/undefined value is
+   * observed, it indicates it does not apply.
+   */
   options_expiry_dates?: Array<string> | null;
 
   /**
@@ -292,6 +314,13 @@ export interface InstrumentCore {
    */
   adv?: string | null;
 
+  /**
+   * Corporate-action-adjusted last close; present only when an adjustment exists for
+   * the previous_close date. When a null/undefined value is observed, it indicates
+   * that there is no available data.
+   */
+  cax_adjusted_previous_close?: 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.
@@ -311,8 +340,9 @@ export interface InstrumentCore {
   name?: string | null;
 
   /**
-   * 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 average daily volume (ADV multiplied by the cax-adjusted close when
+   * present, the raw previous close otherwise). When a null/undefined value is
+   * observed, it indicates that there is no available data.
    */
   notional_adv?: string | null;
 
@@ -336,6 +366,29 @@ export type InstrumentCoreList = Array<InstrumentCore>;
  */
 export type ListingType = 'STANDARD' | 'FLEX' | 'OTC';
 
+/**
+ * An options expiry date, annotated with which settlement cycles have listed
+ * contracts on it.
+ */
+export interface OptionExpiryDate {
+  /**
+   * The expiration date.
+   */
+  date: string;
+
+  /**
+   * Whether this date has at least one listed contract that settles at the close (PM
+   * settlement) -- the standard cycle.
+   */
+  has_settles_on_close: boolean;
+
+  /**
+   * Whether this date has at least one listed contract that settles on the opening
+   * print (AM settlement).
+   */
+  has_settles_on_open: boolean;
+}
+
 /**
  * An options contract with options-specific metadata
  */
@@ -514,6 +567,13 @@ export interface InstrumentGetInstrumentsParams {
 }
 
 export interface InstrumentGetOptionContractsParams {
+  /**
+   * Comma-separated contract instrument IDs (UUID) or OSI option symbols to look up
+   * directly, bypassing underlier expansion. Mutually exclusive with
+   * underlier/underlying_instrument_id; up to 100 values.
+   */
+  contract_ids?: Array<OrdersAPI.InstrumentIDOrSymbol>;
+
   /**
    * Filter by contract type: CALL or PUT
    */
@@ -524,6 +584,12 @@ export interface InstrumentGetOptionContractsParams {
    */
   expiry?: string;
 
+  /**
+   * Filter by settlement cycle: true for early-settling (AM, settle-on-open)
+   * contracts, false for normal (PM) contracts. Omit to return both.
+   */
+  is_settle_on_open?: boolean;
+
   /**
    * The number of items to return per page. Only used when page_token is not
    * provided.
@@ -603,6 +669,7 @@ export declare namespace Instruments {
     type InstrumentCore as InstrumentCore,
     type InstrumentCoreList as InstrumentCoreList,
     type ListingType as ListingType,
+    type OptionExpiryDate as OptionExpiryDate,
     type OptionsContract as OptionsContract,
     type OptionsContractList as OptionsContractList,
     type InstrumentGetInstrumentByIDResponse as InstrumentGetInstrumentByIDResponse,

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

@@ -318,6 +318,11 @@ export interface PrefillModifyOrderRequest {
    */
   account_id?: number;
 
+  /**
+   * New limit offset for trailing stop-limit orders (signed)
+   */
+  limit_offset?: string | null;
+
   /**
    * New limit price for the order
    */
@@ -337,6 +342,16 @@ export interface PrefillModifyOrderRequest {
    * New stop price for the order
    */
   stop_price?: string | null;
+
+  /**
+   * New trailing offset for trailing orders
+   */
+  trailing_offset?: string | null;
+
+  /**
+   * New trailing offset type (PRICE or BPS)
+   */
+  trailing_offset_type?: OrdersAPI.TrailingOffsetType | null;
 }
 
 /**

package/src/resources/v1/orders.ts

@@ -71,7 +71,11 @@ export class Orders extends APIResource {
   }
 
   /**
-   * Get Order By ID
+   * Fetch a single order. The `{order_id}` path parameter accepts either the order's
+   * `id` or its `client_order_id`. A `client_order_id` can only be used while the
+   * order is open; after that, use the `id` returned in every order response, or
+   * find the order with the list-orders endpoint's `order_ids` filter, which accepts
+   * both identifiers at any time.
    *
    * @example
    * ```ts
@@ -218,6 +222,22 @@ export interface Execution {
    * a null/undefined value is observed, it indicates it does not apply.
    */
   symbol?: string | null;
+
+  /**
+   * Underlying instrument identifier for a derivative fill. `null` for a
+   * non-derivative fill, when the underlier could not be resolved, or when a
+   * multileg fill's legs resolve to different underliers. When a null/undefined
+   * value is observed, it indicates it does not apply.
+   */
+  underlying_instrument_id?: string | null;
+
+  /**
+   * Venue where this fill occurred, as reported by that venue. Distinct from an
+   * order's `venue`, which is the routing destination. Codes are not normalized, so
+   * the format varies by venue. When a null/undefined value is observed, it
+   * indicates that there is no available data.
+   */
+  venue?: string | null;
 }
 
 export type ExecutionList = Array<Execution>;
@@ -550,6 +570,11 @@ export type QueueState = 'AWAITING_RELEASE' | 'RELEASED';
  * At least one field must be provided.
  */
 export interface ReplaceOrderRequest {
+  /**
+   * New limit offset for trailing stop-limit orders (signed)
+   */
+  limit_offset?: string | null;
+
   /**
    * New limit price for the order
    */
@@ -564,6 +589,16 @@ export interface ReplaceOrderRequest {
    * New stop price for the order
    */
   stop_price?: string | null;
+
+  /**
+   * New trailing offset for trailing orders
+   */
+  trailing_offset?: string | null;
+
+  /**
+   * New trailing offset type (PRICE or BPS)
+   */
+  trailing_offset_type?: TrailingOffsetType | null;
 }
 
 /**
@@ -587,10 +622,7 @@ export type RequestTimeInForce =
   | 'FILL_OR_KILL'
   | 'GOOD_TILL_DATE'
   | 'AT_THE_OPENING'
-  | 'AT_THE_CLOSE'
-  | 'GOOD_TILL_CROSSING'
-  | 'GOOD_THROUGH_CROSSING'
-  | 'AT_CROSSING';
+  | 'AT_THE_CLOSE';
 
 /**
  * Side of an order
@@ -608,9 +640,6 @@ export type TimeInForce =
   | 'GOOD_TILL_DATE'
   | 'AT_THE_OPENING'
   | 'AT_THE_CLOSE'
-  | 'GOOD_TILL_CROSSING'
-  | 'GOOD_THROUGH_CROSSING'
-  | 'AT_CROSSING'
   | 'OTHER';
 
 /**
@@ -710,6 +739,12 @@ export interface OrderGetExecutionsParams {
    */
   instrument_ids?: Array<string>;
 
+  /**
+   * Comma-separated order IDs to filter by. When provided, only executions belonging
+   * to an order in this set are returned.
+   */
+  order_ids?: Array<string>;
+
   /**
    * The number of items to return per page. Only used when page_token is not
    * provided.
@@ -726,6 +761,13 @@ export interface OrderGetExecutionsParams {
    * The end date and time for the query range, inclusive (ISO 8601 format)
    */
   to?: string;
+
+  /**
+   * Comma-separated instrument IDs (UUID) or symbols (equity tickers or OSI option
+   * symbols). Matches option fills whose resolved underlier is any of the given
+   * instruments.
+   */
+  underlying_instrument_ids?: Array<string>;
 }
 
 export interface OrderGetOrderByIDParams {
@@ -753,8 +795,9 @@ export interface OrderGetOrdersParams {
   instrument_type?: 'COMMON_STOCK' | 'INDEX' | 'OPTION' | 'CASH';
 
   /**
-   * Comma-separated order IDs to filter by. When provided, only orders whose order
-   * ID is in this set are returned.
+   * Comma-separated list of order identifiers. Each value may be an order's `id` or
+   * its `client_order_id`; only orders matching one of the given identifiers are
+   * returned.
    */
   order_ids?: Array<string>;
 
@@ -815,6 +858,11 @@ export interface OrderReplaceOrderParams {
    */
   account_id: number;
 
+  /**
+   * Body param: New limit offset for trailing stop-limit orders (signed)
+   */
+  limit_offset?: string | null;
+
   /**
    * Body param: New limit price for the order
    */
@@ -829,6 +877,16 @@ export interface OrderReplaceOrderParams {
    * Body param: New stop price for the order
    */
   stop_price?: string | null;
+
+  /**
+   * Body param: New trailing offset for trailing orders
+   */
+  trailing_offset?: string | null;
+
+  /**
+   * Body param: New trailing offset type (PRICE or BPS)
+   */
+  trailing_offset_type?: TrailingOffsetType | null;
 }
 
 export interface OrderSubmitOrdersParams {

package/src/resources/v1/v1.ts

@@ -67,6 +67,7 @@ import {
   InstrumentSearchInstrumentsResponse,
   Instruments,
   ListingType,
+  OptionExpiryDate,
   OptionsContract,
   OptionsContractList,
 } from './instruments';
@@ -212,6 +213,7 @@ import {
   InstrumentFundamentals,
   InstrumentIncomeStatement,
   InstrumentIncomeStatementList,
+  InstrumentIpoEvent,
   InstrumentSplitEvent,
   PriceTarget,
   ReportTime,
@@ -357,6 +359,7 @@ export declare namespace V1 {
     type InstrumentFundamentals as InstrumentFundamentals,
     type InstrumentIncomeStatement as InstrumentIncomeStatement,
     type InstrumentIncomeStatementList as InstrumentIncomeStatementList,
+    type InstrumentIpoEvent as InstrumentIpoEvent,
     type InstrumentSplitEvent as InstrumentSplitEvent,
     type PriceTarget as PriceTarget,
     type ReportTime as ReportTime,
@@ -383,6 +386,7 @@ export declare namespace V1 {
     type InstrumentCore as InstrumentCore,
     type InstrumentCoreList as InstrumentCoreList,
     type ListingType as ListingType,
+    type OptionExpiryDate as OptionExpiryDate,
     type OptionsContract as OptionsContract,
     type OptionsContractList as OptionsContractList,
     type InstrumentGetInstrumentByIDResponse as InstrumentGetInstrumentByIDResponse,

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.93.1'; // x-release-please-version
+export const VERSION = '0.94.0'; // x-release-please-version

package/version.d.mts

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

package/version.d.ts

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

package/version.mjs

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