@clear-street/clearstreet 0.103.0 → 0.105.0

package/src/resources/shared.ts

@@ -19,7 +19,7 @@ export interface APIError {
    * Additional error details, if any. This can include structured information such
    * as field violations or error metadata.
    */
-  details?: ErrorDetails;
+  details?: Array<{ [key: string]: unknown }>;
 }
 
 export interface BaseResponse {
@@ -34,8 +34,6 @@ export interface BaseResponse {
   error?: APIError | null;
 }
 
-export type ErrorDetails = Array<{ [key: string]: unknown }>;
-
 /**
  * Metadata for the response. This will always contain a request ID which can be
  * used to identify the request to Clear Street for tracing, and optionally may

package/src/resources/v1/accounts.ts

@@ -172,7 +172,7 @@ export interface AccountBalances {
   /**
    * The total buying power available in the account: base buying power plus the open
    * order adjustment, where base buying power is maintenance margin excess times the
-   * multiplier for intraday and initial margin excess times the multiplier for
+   * multiplier for intraday and overnight margin excess times the multiplier for
    * overnight.
    */
   buying_power: string;
@@ -515,6 +515,16 @@ export interface MarginDetails {
    */
   overnight_details: MarginSessionDetails;
 
+  /**
+   * The difference between equity and the overnight margin requirement.
+   */
+  overnight_margin_excess: string;
+
+  /**
+   * The amount of equity required to hold current positions overnight.
+   */
+  overnight_margin_requirement: string;
+
   /**
    * Optional top margin contributors, returned only when explicitly requested.
    */
@@ -543,8 +553,8 @@ export interface MarginSessionDetails {
   /**
    * Maximum buying power available in the account during the session: base buying
    * power plus the open order adjustment, where base buying power is maintenance
-   * margin excess times the multiplier for intraday and initial margin excess times
-   * the multiplier for overnight.
+   * margin excess times the multiplier for intraday and overnight margin excess
+   * times the multiplier for overnight.
    */
   buying_power: string;
 
@@ -571,6 +581,11 @@ export interface MarginTopContributor {
    */
   market_value: string;
 
+  /**
+   * Overnight margin requirement attributable to this underlying.
+   */
+  overnight_margin_requirement: string;
+
   /**
    * UUID of the underlying security contributing to margin requirement.
    */

package/src/resources/v1/index.ts

@@ -115,12 +115,19 @@ export {
 } from './instruments';
 export {
   Locates,
+  type Locate,
+  type LocateList,
   type LocateRate,
   type LocateRateResult,
   type LocateRateResultList,
+  type LocateStatus,
+  type LocateGetLocateByIDResponse,
   type LocateGetLocateRateByIDResponse,
   type LocateGetLocateRatesResponse,
+  type LocateGetLocatesResponse,
+  type LocateGetLocateByIDParams,
   type LocateGetLocateRatesParams,
+  type LocateGetLocatesParams,
 } from './locates';
 export {
   OmniAI,
@@ -222,17 +229,35 @@ export {
 } from './positions';
 export {
   PrivateMarkets,
-  type PrivateMarketCreateIoiResponse,
+  type ChargedBy,
+  type CompanyCategory,
+  type CompanyCitation,
+  type CompanyCustomer,
+  type CompanyDetail,
+  type CompanyDocumentPreview,
+  type CompanyDocumentRelation,
+  type CompanyDocumentResource,
+  type CompanyDocumentType,
+  type CompanyHeadquarters,
+  type CompanyLegalEntity,
+  type CompanyMetricPoint,
+  type CompanyMetricSeries,
+  type CompanyNarrativeSection,
+  type CompanyPerson,
+  type CompanyPersonRole,
+  type CompanyProfileResource,
+  type CompanySocialLink,
+  type CompanySocialType,
+  type FeeFrequency,
+  type FeeType,
+  type MetricFrequency,
+  type MetricKey,
+  type SpvDetail,
+  type SpvFeeTermResource,
   type PrivateMarketGetCompanyByIDResponse,
-  type PrivateMarketGetIoisResponse,
   type PrivateMarketGetSpvByIDResponse,
-  type PrivateMarketUpdateIoiResponse,
-  type PrivateMarketCreateIoiParams,
-  type PrivateMarketDeleteIoiParams,
   type PrivateMarketGetCompanyByIDParams,
-  type PrivateMarketGetIoisParams,
   type PrivateMarketGetSpvByIDParams,
-  type PrivateMarketUpdateIoiParams,
 } from './private-markets/index';
 export {
   Screener,

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

@@ -232,7 +232,8 @@ export interface SnapshotGreeks {
   gamma: string;
 
   /**
-   * Implied volatility, annualized (`0.20` == 20%).
+   * Implied volatility. Temporarily withheld: always `0`. Do not use this value; it
+   * is not a market implied volatility.
    */
   iv: string;
 

package/src/resources/v1/instruments.ts

@@ -49,8 +49,8 @@ export class Instruments extends APIResource {
    * List options contracts.
    *
    * 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).
+   * must be provided: `root`/`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
@@ -621,7 +621,7 @@ 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.
+   * root/underlying_instrument_id; up to 100 values.
    */
   contract_ids?: Array<OrdersAPI.InstrumentIDOrSymbol>;
 
@@ -654,7 +654,13 @@ export interface InstrumentGetOptionContractsParams {
   page_token?: string;
 
   /**
-   * Underlier symbol (e.g., AAPL, SPX)
+   * OSI option root symbol (e.g., AAPL, SPXW). Index roots also include their weekly
+   * series (e.g., SPX includes SPXW).
+   */
+  root?: string;
+
+  /**
+   * Deprecated: use `root`. If both are sent, the values must match.
    */
   underlier?: string;
 

package/src/resources/v1/locates.ts

@@ -11,6 +11,29 @@ 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 one locate by id, matched against the locate request id, locate id, and
+   * client request id, across all days in force.
+   *
+   * @example
+   * ```ts
+   * const response = await client.v1.locates.getLocateByID(
+   *   'id',
+   *   { account_id: 0 },
+   * );
+   * ```
+   */
+  getLocateByID(
+    id: string,
+    params: LocateGetLocateByIDParams,
+    options?: RequestOptions,
+  ): APIPromise<LocateGetLocateByIDResponse> {
+    const { account_id } = params;
+    return this._client.get(path`/v1/accounts/${account_id}/locates/${id}`, options);
+  }
+
   /**
    * > **Beta** — this endpoint may change before general availability.
    *
@@ -53,8 +76,100 @@ export class Locates extends APIResource {
   ): APIPromise<LocateGetLocateRatesResponse> {
     return this._client.get('/v1/locates/rates', { query, ...options });
   }
+
+  /**
+   * > **Beta** — this endpoint may change before general availability.
+   *
+   * List locates for the account on one effective date, which defaults to today's
+   * New York calendar date. Filter by comma-separated statuses and instrument ids or
+   * symbols.
+   *
+   * @example
+   * ```ts
+   * const response = await client.v1.locates.getLocates(0);
+   * ```
+   */
+  getLocates(
+    accountID: number,
+    query: LocateGetLocatesParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<LocateGetLocatesResponse> {
+    return this._client.get(path`/v1/accounts/${accountID}/locates`, { query, ...options });
+  }
 }
 
+/**
+ * A locate request joined with the locate granted for it, if any.
+ */
+export interface Locate {
+  /**
+   * Account the locate is booked to.
+   */
+  account_id: number;
+
+  /**
+   * Caller-assigned id of the locate request.
+   */
+  client_request_id: string;
+
+  /**
+   * New York calendar date the locate is in force for.
+   */
+  effective_date: string;
+
+  /**
+   * Instrument id.
+   */
+  instrument_id: string;
+
+  /**
+   * Engine-assigned locate request id.
+   */
+  locate_request_id: string;
+
+  /**
+   * Number of shares requested.
+   */
+  requested_quantity: number;
+
+  /**
+   * Presented status of the locate.
+   */
+  status: LocateStatus;
+
+  /**
+   * Engine-assigned locate id; set once the locate is granted. When a null/undefined
+   * value is observed, it indicates it does not apply.
+   */
+  locate_id?: string | null;
+
+  /**
+   * Number of shares granted; set once the locate is granted. When a null/undefined
+   * value is observed, it indicates it does not apply.
+   */
+  quantity?: number | null;
+
+  /**
+   * Client order id the request relates to, if any. When a null/undefined value is
+   * observed, it indicates it does not apply.
+   */
+  related_order_id?: string | null;
+
+  /**
+   * Number of granted shares reserved. When a null/undefined value is observed, it
+   * indicates it does not apply.
+   */
+  reserved_quantity?: number | null;
+
+  /**
+   * Number of granted shares already used. When a null/undefined value is observed,
+   * it indicates it does not apply.
+   */
+  used_quantity?: number | null;
+}
+
+export type LocateList = Array<Locate>;
+
 /**
  * A locate borrow rate for an instrument.
  */
@@ -100,6 +215,19 @@ export interface LocateRateResult {
 
 export type LocateRateResultList = Array<LocateRateResult>;
 
+/**
+ * The presented status of a locate: the locate-request lifecycle plus `EXPIRED`
+ * for accepted locates whose effective date has passed.
+ */
+export type LocateStatus = 'REQUESTED' | 'ACCEPTED' | 'REJECTED' | 'EXPIRED';
+
+export interface LocateGetLocateByIDResponse extends Shared.BaseResponse {
+  /**
+   * A locate request joined with the locate granted for it, if any.
+   */
+  data: Locate;
+}
+
 export interface LocateGetLocateRateByIDResponse extends Shared.BaseResponse {
   /**
    * A locate borrow rate for an instrument.
@@ -111,6 +239,17 @@ export interface LocateGetLocateRatesResponse extends Shared.BaseResponse {
   data: LocateRateResultList;
 }
 
+export interface LocateGetLocatesResponse extends Shared.BaseResponse {
+  data: LocateList;
+}
+
+export interface LocateGetLocateByIDParams {
+  /**
+   * Account identifier
+   */
+  account_id: number;
+}
+
 export interface LocateGetLocateRatesParams {
   /**
    * Comma-separated instrument IDs (UUID) or symbols; at least one, at most 1,000.
@@ -118,13 +257,38 @@ export interface LocateGetLocateRatesParams {
   instrument_ids: Array<OrdersAPI.InstrumentIDOrSymbol>;
 }
 
+export interface LocateGetLocatesParams {
+  /**
+   * Effective date to list; defaults to today's New York calendar date. Explicit
+   * dates are used unchanged, including weekends and holidays.
+   */
+  effective_date?: string;
+
+  /**
+   * Comma-separated instrument IDs (UUID) or symbols.
+   */
+  instrument_ids?: Array<OrdersAPI.InstrumentIDOrSymbol>;
+
+  /**
+   * Comma-separated locate statuses to filter by
+   */
+  status?: Array<'REQUESTED' | 'ACCEPTED' | 'REJECTED' | 'EXPIRED'>;
+}
+
 export declare namespace Locates {
   export {
+    type Locate as Locate,
+    type LocateList as LocateList,
     type LocateRate as LocateRate,
     type LocateRateResult as LocateRateResult,
     type LocateRateResultList as LocateRateResultList,
+    type LocateStatus as LocateStatus,
+    type LocateGetLocateByIDResponse as LocateGetLocateByIDResponse,
     type LocateGetLocateRateByIDResponse as LocateGetLocateRateByIDResponse,
     type LocateGetLocateRatesResponse as LocateGetLocateRatesResponse,
+    type LocateGetLocatesResponse as LocateGetLocatesResponse,
+    type LocateGetLocateByIDParams as LocateGetLocateByIDParams,
     type LocateGetLocateRatesParams as LocateGetLocateRatesParams,
+    type LocateGetLocatesParams as LocateGetLocatesParams,
   };
 }

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

@@ -34,13 +34,9 @@ export class Entitlements extends APIResource {
   /**
    * Revoke one entitlement grant by id.
    *
-   * @example
-   * ```ts
-   * const response =
-   *   await client.v1.omniAI.entitlements.deleteEntitlement(
-   *     'entitlement_id',
-   *   );
-   * ```
+   * Deprecated -- use `POST /omni-ai/entitlements/opt-out`.
+   *
+   * @deprecated
    */
   deleteEntitlement(
     entitlementID: string,
@@ -65,20 +61,58 @@ export class Entitlements extends APIResource {
   }
 
   /**
-   * List caller's active entitlement grants.
+   * Whether each entitlement is enabled, per account. Accounts with no recorded
+   * choice are enabled by default. Without `account_id`, covers every account the
+   * caller can access.
    *
    * @example
    * ```ts
    * const response =
-   *   await client.v1.omniAI.entitlements.getEntitlements();
+   *   await client.v1.omniAI.entitlements.getEntitlementStatus();
    * ```
    */
+  getEntitlementStatus(
+    query: EntitlementGetEntitlementStatusParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<EntitlementGetEntitlementStatusResponse> {
+    return this._client.get('/v1/omni-ai/entitlement-status', { query, ...options });
+  }
+
+  /**
+   * List caller's active entitlement grants.
+   *
+   * Deprecated -- use `GET /omni-ai/entitlement-status`; this lists explicit grants
+   * only and omits accounts that are enabled by default.
+   *
+   * @deprecated
+   */
   getEntitlements(
     query: EntitlementGetEntitlementsParams | null | undefined = {},
     options?: RequestOptions,
   ): APIPromise<EntitlementGetEntitlementsResponse> {
     return this._client.get('/v1/omni-ai/entitlements', { query, ...options });
   }
+
+  /**
+   * Turn off one-or-more entitlements for the given accounts. Idempotent: accounts
+   * that are already opted out are left as they are. To turn an entitlement back on,
+   * sign the agreement with `POST /omni-ai/entitlements`.
+   *
+   * @example
+   * ```ts
+   * const response =
+   *   await client.v1.omniAI.entitlements.optOutEntitlements({
+   *     account_ids: [100019, 100021],
+   *     entitlement_codes: ['omni.account_data'],
+   *   });
+   * ```
+   */
+  optOutEntitlements(
+    body: EntitlementOptOutEntitlementsParams,
+    options?: RequestOptions,
+  ): APIPromise<EntitlementOptOutEntitlementsResponse> {
+    return this._client.post('/v1/omni-ai/entitlements/opt-out', { body, ...options });
+  }
 }
 
 export interface DeleteEntitlementResponse {
@@ -125,6 +159,23 @@ export interface EntitlementResource {
 
 export type EntitlementResourceList = Array<EntitlementResource>;
 
+/**
+ * Whether an entitlement is enabled for one account. Accounts the user never chose
+ * for are enabled by default.
+ */
+export interface EntitlementStatusResource {
+  account_id: number;
+
+  enabled: boolean;
+
+  /**
+   * Stable entitlement code granted by an agreement.
+   */
+  entitlement_code: OmniAIAPI.EntitlementCode;
+}
+
+export type EntitlementStatusResourceList = Array<EntitlementStatusResource>;
+
 export interface EntitlementCreateEntitlementsResponse extends Shared.BaseResponse {
   data: EntitlementResourceList;
 }
@@ -137,10 +188,18 @@ export interface EntitlementGetEntitlementAgreementsResponse extends Shared.Base
   data: EntitlementAgreementResourceList;
 }
 
+export interface EntitlementGetEntitlementStatusResponse extends Shared.BaseResponse {
+  data: EntitlementStatusResourceList;
+}
+
 export interface EntitlementGetEntitlementsResponse extends Shared.BaseResponse {
   data: EntitlementResourceList;
 }
 
+export interface EntitlementOptOutEntitlementsResponse extends Shared.BaseResponse {
+  data: EntitlementStatusResourceList;
+}
+
 export interface EntitlementCreateEntitlementsParams {
   account_ids: Array<number>;
 
@@ -149,10 +208,20 @@ export interface EntitlementCreateEntitlementsParams {
   entitlement_codes: Array<OmniAIAPI.EntitlementCode>;
 }
 
+export interface EntitlementGetEntitlementStatusParams {
+  account_id?: number;
+}
+
 export interface EntitlementGetEntitlementsParams {
   account_id?: number;
 }
 
+export interface EntitlementOptOutEntitlementsParams {
+  account_ids: Array<number>;
+
+  entitlement_codes: Array<OmniAIAPI.EntitlementCode>;
+}
+
 export declare namespace Entitlements {
   export {
     type DeleteEntitlementResponse as DeleteEntitlementResponse,
@@ -160,11 +229,17 @@ export declare namespace Entitlements {
     type EntitlementAgreementResourceList as EntitlementAgreementResourceList,
     type EntitlementResource as EntitlementResource,
     type EntitlementResourceList as EntitlementResourceList,
+    type EntitlementStatusResource as EntitlementStatusResource,
+    type EntitlementStatusResourceList as EntitlementStatusResourceList,
     type EntitlementCreateEntitlementsResponse as EntitlementCreateEntitlementsResponse,
     type EntitlementDeleteEntitlementResponse as EntitlementDeleteEntitlementResponse,
     type EntitlementGetEntitlementAgreementsResponse as EntitlementGetEntitlementAgreementsResponse,
+    type EntitlementGetEntitlementStatusResponse as EntitlementGetEntitlementStatusResponse,
     type EntitlementGetEntitlementsResponse as EntitlementGetEntitlementsResponse,
+    type EntitlementOptOutEntitlementsResponse as EntitlementOptOutEntitlementsResponse,
     type EntitlementCreateEntitlementsParams as EntitlementCreateEntitlementsParams,
+    type EntitlementGetEntitlementStatusParams as EntitlementGetEntitlementStatusParams,
     type EntitlementGetEntitlementsParams as EntitlementGetEntitlementsParams,
+    type EntitlementOptOutEntitlementsParams as EntitlementOptOutEntitlementsParams,
   };
 }

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

@@ -7,12 +7,18 @@ export {
   type EntitlementAgreementResourceList,
   type EntitlementResource,
   type EntitlementResourceList,
+  type EntitlementStatusResource,
+  type EntitlementStatusResourceList,
   type EntitlementCreateEntitlementsResponse,
   type EntitlementDeleteEntitlementResponse,
   type EntitlementGetEntitlementAgreementsResponse,
+  type EntitlementGetEntitlementStatusResponse,
   type EntitlementGetEntitlementsResponse,
+  type EntitlementOptOutEntitlementsResponse,
   type EntitlementCreateEntitlementsParams,
+  type EntitlementGetEntitlementStatusParams,
   type EntitlementGetEntitlementsParams,
+  type EntitlementOptOutEntitlementsParams,
 } from './entitlements';
 export {
   Messages,

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

@@ -13,10 +13,16 @@ import {
   EntitlementCreateEntitlementsResponse,
   EntitlementDeleteEntitlementResponse,
   EntitlementGetEntitlementAgreementsResponse,
+  EntitlementGetEntitlementStatusParams,
+  EntitlementGetEntitlementStatusResponse,
   EntitlementGetEntitlementsParams,
   EntitlementGetEntitlementsResponse,
+  EntitlementOptOutEntitlementsParams,
+  EntitlementOptOutEntitlementsResponse,
   EntitlementResource,
   EntitlementResourceList,
+  EntitlementStatusResource,
+  EntitlementStatusResourceList,
   Entitlements,
 } from './entitlements';
 import * as MessagesAPI from './messages';
@@ -536,7 +542,8 @@ export interface PrefillNewOrderRequest {
    * 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.
+   * all three require `DAY` time-in-force. `VWAP`, `TWAP`, and `DMA` do not support
+   * `extended_hours`.
    */
   strategy?: OrdersAPI.OrderStrategy | null;
 
@@ -726,12 +733,18 @@ export declare namespace OmniAI {
     type EntitlementAgreementResourceList as EntitlementAgreementResourceList,
     type EntitlementResource as EntitlementResource,
     type EntitlementResourceList as EntitlementResourceList,
+    type EntitlementStatusResource as EntitlementStatusResource,
+    type EntitlementStatusResourceList as EntitlementStatusResourceList,
     type EntitlementCreateEntitlementsResponse as EntitlementCreateEntitlementsResponse,
     type EntitlementDeleteEntitlementResponse as EntitlementDeleteEntitlementResponse,
     type EntitlementGetEntitlementAgreementsResponse as EntitlementGetEntitlementAgreementsResponse,
+    type EntitlementGetEntitlementStatusResponse as EntitlementGetEntitlementStatusResponse,
     type EntitlementGetEntitlementsResponse as EntitlementGetEntitlementsResponse,
+    type EntitlementOptOutEntitlementsResponse as EntitlementOptOutEntitlementsResponse,
     type EntitlementCreateEntitlementsParams as EntitlementCreateEntitlementsParams,
+    type EntitlementGetEntitlementStatusParams as EntitlementGetEntitlementStatusParams,
     type EntitlementGetEntitlementsParams as EntitlementGetEntitlementsParams,
+    type EntitlementOptOutEntitlementsParams as EntitlementOptOutEntitlementsParams,
   };
 
   export {

package/src/resources/v1/orders.ts

@@ -312,7 +312,8 @@ export interface NewOrderRequest {
    * 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.
+   * all three require `DAY` time-in-force. `VWAP`, `TWAP`, and `DMA` do not support
+   * `extended_hours`.
    */
   strategy?: OrderStrategy | null;