@clear-street/clearstreet 0.102.0 → 0.103.0

package/resources/v1/v1.js

@@ -12,6 +12,8 @@ const CalendarAPI = tslib_1.__importStar(require("./calendar.js"));
 const calendar_1 = require("./calendar.js");
 const InstrumentsAPI = tslib_1.__importStar(require("./instruments.js"));
 const instruments_1 = require("./instruments.js");
+const LocatesAPI = tslib_1.__importStar(require("./locates.js"));
+const locates_1 = require("./locates.js");
 const OmniFeedAPI = tslib_1.__importStar(require("./omni-feed.js"));
 const omni_feed_1 = require("./omni-feed.js");
 const OrdersAPI = tslib_1.__importStar(require("./orders.js"));
@@ -36,6 +38,7 @@ class V1 extends resource_1.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);
@@ -51,6 +54,7 @@ V1.APIVersion = api_version_1.APIVersion;
 V1.Calendar = calendar_1.Calendar;
 V1.InstrumentData = instrument_data_1.InstrumentData;
 V1.Instruments = instruments_1.Instruments;
+V1.Locates = locates_1.Locates;
 V1.OmniAI = omni_ai_1.OmniAI;
 V1.OmniFeed = omni_feed_1.OmniFeed;
 V1.Orders = orders_1.Orders;

package/resources/v1/v1.js.map

@@ -1 +1 @@
-{"version":3,"file":"v1.js","sourceRoot":"","sources":["../../src/resources/v1/v1.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,qDAAkD;AAClD,mEAA0C;AAC1C,4CA8BoB;AACpB,wEAA+C;AAC/C,kDAAkF;AAClF,mEAA0C;AAC1C,4CAoBoB;AACpB,yEAAgD;AAChD,kDAoBuB;AACvB,oEAA2C;AAC3C,8CAUqB;AACrB,+DAAsC;AACtC,wCAiCkB;AAClB,qEAA4C;AAC5C,8CAsBqB;AACrB,mEAA0C;AAC1C,4CAyCoB;AACpB,qEAA4C;AAC5C,8CAiBqB;AACrB,gGAAuE;AACvE,0EAsC2C;AAC3C,wEAA+C;AAC/C,kDA6B2B;AAC3B,gGAAuE;AACvE,0EAa2C;AAE3C,MAAa,EAAG,SAAQ,sBAAW;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;AAbD,gBAaC;AAYD,EAAE,CAAC,QAAQ,GAAG,mBAAQ,CAAC;AACvB,EAAE,CAAC,UAAU,GAAG,wBAAU,CAAC;AAC3B,EAAE,CAAC,QAAQ,GAAG,mBAAQ,CAAC;AACvB,EAAE,CAAC,cAAc,GAAG,gCAAc,CAAC;AACnC,EAAE,CAAC,WAAW,GAAG,yBAAW,CAAC;AAC7B,EAAE,CAAC,MAAM,GAAG,gBAAM,CAAC;AACnB,EAAE,CAAC,QAAQ,GAAG,oBAAQ,CAAC;AACvB,EAAE,CAAC,MAAM,GAAG,eAAM,CAAC;AACnB,EAAE,CAAC,SAAS,GAAG,qBAAS,CAAC;AACzB,EAAE,CAAC,cAAc,GAAG,gCAAc,CAAC;AACnC,EAAE,CAAC,QAAQ,GAAG,mBAAQ,CAAC;AACvB,EAAE,CAAC,SAAS,GAAG,qBAAS,CAAC"}
+{"version":3,"file":"v1.js","sourceRoot":"","sources":["../../src/resources/v1/v1.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,qDAAkD;AAClD,mEAA0C;AAC1C,4CA8BoB;AACpB,wEAA+C;AAC/C,kDAAkF;AAClF,mEAA0C;AAC1C,4CAoBoB;AACpB,yEAAgD;AAChD,kDAoBuB;AACvB,iEAAwC;AACxC,0CAQmB;AACnB,oEAA2C;AAC3C,8CAUqB;AACrB,+DAAsC;AACtC,wCAiCkB;AAClB,qEAA4C;AAC5C,8CAsBqB;AACrB,mEAA0C;AAC1C,4CAyCoB;AACpB,qEAA4C;AAC5C,8CAiBqB;AACrB,gGAAuE;AACvE,0EAsC2C;AAC3C,wEAA+C;AAC/C,kDA6B2B;AAC3B,gGAAuE;AACvE,0EAa2C;AAE3C,MAAa,EAAG,SAAQ,sBAAW;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;AAdD,gBAcC;AAYD,EAAE,CAAC,QAAQ,GAAG,mBAAQ,CAAC;AACvB,EAAE,CAAC,UAAU,GAAG,wBAAU,CAAC;AAC3B,EAAE,CAAC,QAAQ,GAAG,mBAAQ,CAAC;AACvB,EAAE,CAAC,cAAc,GAAG,gCAAc,CAAC;AACnC,EAAE,CAAC,WAAW,GAAG,yBAAW,CAAC;AAC7B,EAAE,CAAC,OAAO,GAAG,iBAAO,CAAC;AACrB,EAAE,CAAC,MAAM,GAAG,gBAAM,CAAC;AACnB,EAAE,CAAC,QAAQ,GAAG,oBAAQ,CAAC;AACvB,EAAE,CAAC,MAAM,GAAG,eAAM,CAAC;AACnB,EAAE,CAAC,SAAS,GAAG,qBAAS,CAAC;AACzB,EAAE,CAAC,cAAc,GAAG,gCAAc,CAAC;AACnC,EAAE,CAAC,QAAQ,GAAG,mBAAQ,CAAC;AACvB,EAAE,CAAC,SAAS,GAAG,qBAAS,CAAC"}

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,EAOL,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,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,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/client.ts

@@ -773,5 +773,6 @@ export declare namespace ClearStreet {
 
   export type APIError = API.APIError;
   export type BaseResponse = API.BaseResponse;
+  export type ErrorDetails = API.ErrorDetails;
   export type ResponseMetadata = API.ResponseMetadata;
 }

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?: Array<{ [key: string]: unknown }>;
+  details?: ErrorDetails;
 }
 
 export interface BaseResponse {
@@ -34,6 +34,8 @@ 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/index.ts

@@ -113,6 +113,15 @@ export {
   type InstrumentGetOptionContractsParams,
   type InstrumentSearchInstrumentsParams,
 } from './instruments';
+export {
+  Locates,
+  type LocateRate,
+  type LocateRateResult,
+  type LocateRateResultList,
+  type LocateGetLocateRateByIDResponse,
+  type LocateGetLocateRatesResponse,
+  type LocateGetLocateRatesParams,
+} from './locates';
 export {
   OmniAI,
   type ActionButton,

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. One of `SOR`, `VWAP`, or `TWAP`. Defaults to `SOR`.
-   * `VWAP` and `TWAP` are supported only on `MARKET` and `LIMIT` orders with `DAY`
-   * time-in-force, and are 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

@@ -309,9 +309,10 @@ export interface NewOrderRequest {
   stop_price?: string | null;
 
   /**
-   * Optional execution strategy. One of `SOR`, `VWAP`, or `TWAP`. Defaults to `SOR`.
-   * `VWAP` and `TWAP` are supported only on `MARKET` and `LIMIT` orders with `DAY`
-   * time-in-force, and are 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;
 
@@ -553,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.
@@ -595,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 {
   /**
@@ -655,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';
+  }
 }
 
 /**

package/src/resources/v1/v1.ts

@@ -79,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,
@@ -305,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);
@@ -329,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;
@@ -462,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.102.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.102.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.102.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.102.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.102.0'; // x-release-please-version
+export const VERSION = '0.103.0'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map