@clear-street/clearstreet 0.102.0 → 0.104.0

package/resources/v1/v1.mjs

@@ -8,6 +8,8 @@ import * as CalendarAPI from "./calendar.mjs";
 import { Calendar, } from "./calendar.mjs";
 import * as InstrumentsAPI from "./instruments.mjs";
 import { Instruments, } from "./instruments.mjs";
+import * as LocatesAPI from "./locates.mjs";
+import { Locates, } from "./locates.mjs";
 import * as OmniFeedAPI from "./omni-feed.mjs";
 import { OmniFeed, } from "./omni-feed.mjs";
 import * as OrdersAPI from "./orders.mjs";
@@ -32,6 +34,7 @@ export class V1 extends APIResource {
         this.calendar = new CalendarAPI.Calendar(this._client);
         this.instrumentData = new InstrumentDataAPI.InstrumentData(this._client);
         this.instruments = new InstrumentsAPI.Instruments(this._client);
+        this.locates = new LocatesAPI.Locates(this._client);
         this.omniAI = new OmniAIAPI.OmniAI(this._client);
         this.omniFeed = new OmniFeedAPI.OmniFeed(this._client);
         this.orders = new OrdersAPI.Orders(this._client);
@@ -46,6 +49,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;

package/resources/v1/v1.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"v1.mjs","sourceRoot":"","sources":["../../src/resources/v1/v1.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,KAAK,WAAW,uBAAmB;AAC1C,OAAO,EAoBL,QAAQ,GAUT,uBAAmB;AACpB,OAAO,KAAK,aAAa,0BAAsB;AAC/C,OAAO,EAAE,UAAU,EAAyC,0BAAsB;AAClF,OAAO,KAAK,WAAW,uBAAmB;AAC1C,OAAO,EACL,QAAQ,GAmBT,uBAAmB;AACpB,OAAO,KAAK,cAAc,0BAAsB;AAChD,OAAO,EAcL,WAAW,GAMZ,0BAAsB;AACvB,OAAO,KAAK,WAAW,wBAAoB;AAC3C,OAAO,EAML,QAAQ,GAIT,wBAAoB;AACrB,OAAO,KAAK,SAAS,qBAAiB;AACtC,OAAO,EAwBL,MAAM,GASP,qBAAiB;AAClB,OAAO,KAAK,YAAY,wBAAoB;AAC5C,OAAO,EAqBL,SAAS,GACV,wBAAoB;AACrB,OAAO,KAAK,WAAW,uBAAmB;AAC1C,OAAO,EAmBL,QAAQ,GAsBT,uBAAmB;AACpB,OAAO,KAAK,YAAY,wBAAoB;AAC5C,OAAO,EAEL,SAAS,GAeV,wBAAoB;AACrB,OAAO,KAAK,iBAAiB,8CAA0C;AACvE,OAAO,EAWL,cAAc,GA2Bf,8CAA0C;AAC3C,OAAO,KAAK,SAAS,8BAA0B;AAC/C,OAAO,EAcL,MAAM,GAeP,8BAA0B;AAC3B,OAAO,KAAK,iBAAiB,8CAA0C;AACvE,OAAO,EAYL,cAAc,GACf,8CAA0C;AAE3C,MAAM,OAAO,EAAG,SAAQ,WAAW;IAAnC;;QACE,aAAQ,GAAyB,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACxE,eAAU,GAA6B,IAAI,aAAa,CAAC,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAClF,aAAQ,GAAyB,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACxE,mBAAc,GAAqC,IAAI,iBAAiB,CAAC,cAAc,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACtG,gBAAW,GAA+B,IAAI,cAAc,CAAC,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACvF,WAAM,GAAqB,IAAI,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC9D,aAAQ,GAAyB,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACxE,WAAM,GAAqB,IAAI,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC9D,cAAS,GAA2B,IAAI,YAAY,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC7E,mBAAc,GAAqC,IAAI,iBAAiB,CAAC,cAAc,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACtG,aAAQ,GAAyB,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACxE,cAAS,GAA2B,IAAI,YAAY,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAC/E,CAAC;CAAA;AAYD,EAAE,CAAC,QAAQ,GAAG,QAAQ,CAAC;AACvB,EAAE,CAAC,UAAU,GAAG,UAAU,CAAC;AAC3B,EAAE,CAAC,QAAQ,GAAG,QAAQ,CAAC;AACvB,EAAE,CAAC,cAAc,GAAG,cAAc,CAAC;AACnC,EAAE,CAAC,WAAW,GAAG,WAAW,CAAC;AAC7B,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC;AACnB,EAAE,CAAC,QAAQ,GAAG,QAAQ,CAAC;AACvB,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC;AACnB,EAAE,CAAC,SAAS,GAAG,SAAS,CAAC;AACzB,EAAE,CAAC,cAAc,GAAG,cAAc,CAAC;AACnC,EAAE,CAAC,QAAQ,GAAG,QAAQ,CAAC;AACvB,EAAE,CAAC,SAAS,GAAG,SAAS,CAAC"}
+{"version":3,"file":"v1.mjs","sourceRoot":"","sources":["../../src/resources/v1/v1.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,KAAK,WAAW,uBAAmB;AAC1C,OAAO,EAoBL,QAAQ,GAUT,uBAAmB;AACpB,OAAO,KAAK,aAAa,0BAAsB;AAC/C,OAAO,EAAE,UAAU,EAAyC,0BAAsB;AAClF,OAAO,KAAK,WAAW,uBAAmB;AAC1C,OAAO,EACL,QAAQ,GAmBT,uBAAmB;AACpB,OAAO,KAAK,cAAc,0BAAsB;AAChD,OAAO,EAcL,WAAW,GAMZ,0BAAsB;AACvB,OAAO,KAAK,UAAU,sBAAkB;AACxC,OAAO,EAcL,OAAO,GACR,sBAAkB;AACnB,OAAO,KAAK,WAAW,wBAAoB;AAC3C,OAAO,EAML,QAAQ,GAIT,wBAAoB;AACrB,OAAO,KAAK,SAAS,qBAAiB;AACtC,OAAO,EAwBL,MAAM,GASP,qBAAiB;AAClB,OAAO,KAAK,YAAY,wBAAoB;AAC5C,OAAO,EAqBL,SAAS,GACV,wBAAoB;AACrB,OAAO,KAAK,WAAW,uBAAmB;AAC1C,OAAO,EAmBL,QAAQ,GAsBT,uBAAmB;AACpB,OAAO,KAAK,YAAY,wBAAoB;AAC5C,OAAO,EAEL,SAAS,GAeV,wBAAoB;AACrB,OAAO,KAAK,iBAAiB,8CAA0C;AACvE,OAAO,EAWL,cAAc,GA2Bf,8CAA0C;AAC3C,OAAO,KAAK,SAAS,8BAA0B;AAC/C,OAAO,EAcL,MAAM,GAeP,8BAA0B;AAC3B,OAAO,KAAK,iBAAiB,8CAA0C;AACvE,OAAO,EA4BL,cAAc,GAGf,8CAA0C;AAE3C,MAAM,OAAO,EAAG,SAAQ,WAAW;IAAnC;;QACE,aAAQ,GAAyB,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACxE,eAAU,GAA6B,IAAI,aAAa,CAAC,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAClF,aAAQ,GAAyB,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACxE,mBAAc,GAAqC,IAAI,iBAAiB,CAAC,cAAc,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACtG,gBAAW,GAA+B,IAAI,cAAc,CAAC,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACvF,YAAO,GAAuB,IAAI,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACnE,WAAM,GAAqB,IAAI,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC9D,aAAQ,GAAyB,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACxE,WAAM,GAAqB,IAAI,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC9D,cAAS,GAA2B,IAAI,YAAY,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC7E,mBAAc,GAAqC,IAAI,iBAAiB,CAAC,cAAc,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACtG,aAAQ,GAAyB,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACxE,cAAS,GAA2B,IAAI,YAAY,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAC/E,CAAC;CAAA;AAYD,EAAE,CAAC,QAAQ,GAAG,QAAQ,CAAC;AACvB,EAAE,CAAC,UAAU,GAAG,UAAU,CAAC;AAC3B,EAAE,CAAC,QAAQ,GAAG,QAAQ,CAAC;AACvB,EAAE,CAAC,cAAc,GAAG,cAAc,CAAC;AACnC,EAAE,CAAC,WAAW,GAAG,WAAW,CAAC;AAC7B,EAAE,CAAC,OAAO,GAAG,OAAO,CAAC;AACrB,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC;AACnB,EAAE,CAAC,QAAQ,GAAG,QAAQ,CAAC;AACvB,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC;AACnB,EAAE,CAAC,SAAS,GAAG,SAAS,CAAC;AACzB,EAAE,CAAC,cAAc,GAAG,cAAc,CAAC;AACnC,EAAE,CAAC,QAAQ,GAAG,QAAQ,CAAC;AACvB,EAAE,CAAC,SAAS,GAAG,SAAS,CAAC"}

package/src/resources/v1/index.ts

@@ -113,6 +113,22 @@ export {
   type InstrumentGetOptionContractsParams,
   type InstrumentSearchInstrumentsParams,
 } 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,
   type ActionButton,
@@ -213,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/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 =
@@ -227,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;
 
@@ -456,12 +462,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,294 @@
+// 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 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.
+   *
+   * 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 });
+  }
+
+  /**
+   * > **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.
+ */
+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>;
+
+/**
+ * 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.
+   */
+  data: LocateRate;
+}
+
+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.
+   */
+  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,