@clear-street/clearstreet 0.102.0 → 0.104.0

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

@@ -27,6 +27,11 @@ export declare 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 =
@@ -189,7 +194,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;
     /**
@@ -386,12 +392,24 @@ export interface MarketDataGetDailySummariesParams {
     instrument_ids: string;
 }
 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 {
     export { type DailySummary as DailySummary, type DailySummaryList as DailySummaryList, type MarketDataSnapshot as MarketDataSnapshot, type MarketDataSnapshotList as MarketDataSnapshotList, type SnapshotGreeks as SnapshotGreeks, type SnapshotLastTrade as SnapshotLastTrade, type SnapshotQuote as SnapshotQuote, type SnapshotSession as SnapshotSession, type MarketDataGetDailySummariesResponse as MarketDataGetDailySummariesResponse, type MarketDataGetSnapshotsResponse as MarketDataGetSnapshotsResponse, type MarketDataGetDailySummariesParams as MarketDataGetDailySummariesParams, type MarketDataGetSnapshotsParams as MarketDataGetSnapshotsParams, };

package/resources/v1/instrument-data/market-data.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"market-data.d.ts","sourceRoot":"","sources":["../../../src/resources/v1/instrument-data/market-data.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,kCAA+B;AACrD,OAAO,KAAK,MAAM,wBAAqB;AACvC,OAAO,KAAK,SAAS,qBAAkB;AACvC,OAAO,EAAE,UAAU,EAAE,qCAAkC;AACvD,OAAO,EAAE,cAAc,EAAE,6CAA0C;AAEnE;;GAEG;AACH,qBAAa,UAAW,SAAQ,WAAW;IACzC;;;;;;;;;;;;;;;OAeG;IACH,iBAAiB,CACf,KAAK,EAAE,iCAAiC,EACxC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,mCAAmC,CAAC;IAIlD;;;;;;;;OAQG;IACH,YAAY,CACV,KAAK,GAAE,4BAA4B,GAAG,IAAI,GAAG,SAAc,EAC3D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,8BAA8B,CAAC;CAG9C;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;;OAGG;IACH,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpB;;;;OAIG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;;;OAIG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;AAED,MAAM,MAAM,gBAAgB,GAAG,KAAK,CAAC,YAAY,CAAC,CAAC;AAEnD;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;;OAGG;IACH,OAAO,EAAE,eAAe,CAAC;IAEzB;;;;;;;;;;;;;;;OAeG;IACH,qBAAqB,EAAE,OAAO,GAAG,IAAI,CAAC;IAEtC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;;;;;OAOG;IACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAElC;;;;OAIG;IACH,MAAM,CAAC,EAAE,cAAc,GAAG,IAAI,CAAC;IAE/B;;;OAGG;IACH,UAAU,CAAC,EAAE,aAAa,GAAG,IAAI,CAAC;IAElC;;;;;OAKG;IACH,UAAU,CAAC,EAAE,iBAAiB,GAAG,IAAI,CAAC;IAEtC;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;;;OAIG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC/B;AAED,MAAM,MAAM,sBAAsB,GAAG,KAAK,CAAC,kBAAkB,CAAC,CAAC;AAE/D;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;;;;;GAMG;AACH,MAAM,WAAW,iBAAiB;IAChC;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;;;OAKG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;;;;OAKG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;;OAGG;IACH,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;;;OAIG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;;OAGG;IACH,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;;;OAIG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAED;;;;GAIG;AACH,MAAM,WAAW,eAAe;IAC9B;;;;;;OAMG;IACH,eAAe,EAAE,OAAO,CAAC;IAEzB;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;;;;;OAMG;IACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAElC;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;;OAGG;IACH,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpB;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;;;;;;OAOG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;;;;OAKG;IACH,yBAAyB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3C;AAED,MAAM,WAAW,mCAAoC,SAAQ,MAAM,CAAC,YAAY;IAC9E,IAAI,EAAE,gBAAgB,CAAC;CACxB;AAED,MAAM,WAAW,8BAA+B,SAAQ,MAAM,CAAC,YAAY;IACzE,IAAI,EAAE,sBAAsB,CAAC;CAC9B;AAED,MAAM,WAAW,iCAAiC;IAChD;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,4BAA4B;IAC3C;;;;OAIG;IACH,cAAc,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC,oBAAoB,CAAC,CAAC;CACxD;AAED,MAAM,CAAC,OAAO,WAAW,UAAU,CAAC;IAClC,OAAO,EACL,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,mCAAmC,IAAI,mCAAmC,EAC/E,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,4BAA4B,IAAI,4BAA4B,GAClE,CAAC;CACH"}
+{"version":3,"file":"market-data.d.ts","sourceRoot":"","sources":["../../../src/resources/v1/instrument-data/market-data.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,kCAA+B;AACrD,OAAO,KAAK,MAAM,wBAAqB;AACvC,OAAO,KAAK,SAAS,qBAAkB;AACvC,OAAO,EAAE,UAAU,EAAE,qCAAkC;AACvD,OAAO,EAAE,cAAc,EAAE,6CAA0C;AAEnE;;GAEG;AACH,qBAAa,UAAW,SAAQ,WAAW;IACzC;;;;;;;;;;;;;;;OAeG;IACH,iBAAiB,CACf,KAAK,EAAE,iCAAiC,EACxC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,mCAAmC,CAAC;IAIlD;;;;;;;;;;;;;OAaG;IACH,YAAY,CACV,KAAK,GAAE,4BAA4B,GAAG,IAAI,GAAG,SAAc,EAC3D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,8BAA8B,CAAC;CAG9C;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;;OAGG;IACH,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpB;;;;OAIG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;;;OAIG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;AAED,MAAM,MAAM,gBAAgB,GAAG,KAAK,CAAC,YAAY,CAAC,CAAC;AAEnD;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;;OAGG;IACH,OAAO,EAAE,eAAe,CAAC;IAEzB;;;;;;;;;;;;;;;OAeG;IACH,qBAAqB,EAAE,OAAO,GAAG,IAAI,CAAC;IAEtC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;;;;;OAOG;IACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAElC;;;;OAIG;IACH,MAAM,CAAC,EAAE,cAAc,GAAG,IAAI,CAAC;IAE/B;;;OAGG;IACH,UAAU,CAAC,EAAE,aAAa,GAAG,IAAI,CAAC;IAElC;;;;;OAKG;IACH,UAAU,CAAC,EAAE,iBAAiB,GAAG,IAAI,CAAC;IAEtC;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;;;OAIG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC/B;AAED,MAAM,MAAM,sBAAsB,GAAG,KAAK,CAAC,kBAAkB,CAAC,CAAC;AAE/D;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;;;;;GAMG;AACH,MAAM,WAAW,iBAAiB;IAChC;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;;;OAKG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;;;;OAKG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;;OAGG;IACH,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;;;OAIG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;;OAGG;IACH,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;;;OAIG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAED;;;;GAIG;AACH,MAAM,WAAW,eAAe;IAC9B;;;;;;OAMG;IACH,eAAe,EAAE,OAAO,CAAC;IAEzB;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;;;;;OAMG;IACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAElC;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;;OAGG;IACH,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpB;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;;;;;;OAOG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;;;;OAKG;IACH,yBAAyB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3C;AAED,MAAM,WAAW,mCAAoC,SAAQ,MAAM,CAAC,YAAY;IAC9E,IAAI,EAAE,gBAAgB,CAAC;CACxB;AAED,MAAM,WAAW,8BAA+B,SAAQ,MAAM,CAAC,YAAY;IACzE,IAAI,EAAE,sBAAsB,CAAC;CAC9B;AAED,MAAM,WAAW,iCAAiC;IAChD;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,4BAA4B;IAC3C;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;;;OAKG;IACH,cAAc,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC,oBAAoB,CAAC,CAAC;IAEvD;;;;OAIG;IACH,wBAAwB,CAAC,EAAE,MAAM,CAAC;CACnC;AAED,MAAM,CAAC,OAAO,WAAW,UAAU,CAAC;IAClC,OAAO,EACL,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,mCAAmC,IAAI,mCAAmC,EAC/E,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,4BAA4B,IAAI,4BAA4B,GAClE,CAAC;CACH"}

package/resources/v1/instrument-data/market-data.js

@@ -29,6 +29,11 @@ class MarketData extends resource_1.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 =

package/resources/v1/instrument-data/market-data.js.map

@@ -1 +1 @@
-{"version":3,"file":"market-data.js","sourceRoot":"","sources":["../../../src/resources/v1/instrument-data/market-data.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,wDAAqD;AAMrD;;GAEG;AACH,MAAa,UAAW,SAAQ,sBAAW;IACzC;;;;;;;;;;;;;;;OAeG;IACH,iBAAiB,CACf,KAAwC,EACxC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,+BAA+B,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClF,CAAC;IAED;;;;;;;;OAQG;IACH,YAAY,CACV,QAAyD,EAAE,EAC3D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,0BAA0B,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7E,CAAC;CACF;AAvCD,gCAuCC"}
+{"version":3,"file":"market-data.js","sourceRoot":"","sources":["../../../src/resources/v1/instrument-data/market-data.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,wDAAqD;AAMrD;;GAEG;AACH,MAAa,UAAW,SAAQ,sBAAW;IACzC;;;;;;;;;;;;;;;OAeG;IACH,iBAAiB,CACf,KAAwC,EACxC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,+BAA+B,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClF,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,YAAY,CACV,QAAyD,EAAE,EAC3D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,0BAA0B,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7E,CAAC;CACF;AA5CD,gCA4CC"}

package/resources/v1/instrument-data/market-data.mjs

@@ -26,6 +26,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 =

package/resources/v1/instrument-data/market-data.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"market-data.mjs","sourceRoot":"","sources":["../../../src/resources/v1/instrument-data/market-data.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,mCAA+B;AAMrD;;GAEG;AACH,MAAM,OAAO,UAAW,SAAQ,WAAW;IACzC;;;;;;;;;;;;;;;OAeG;IACH,iBAAiB,CACf,KAAwC,EACxC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,+BAA+B,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClF,CAAC;IAED;;;;;;;;OAQG;IACH,YAAY,CACV,QAAyD,EAAE,EAC3D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,0BAA0B,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7E,CAAC;CACF"}
+{"version":3,"file":"market-data.mjs","sourceRoot":"","sources":["../../../src/resources/v1/instrument-data/market-data.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,mCAA+B;AAMrD;;GAEG;AACH,MAAM,OAAO,UAAW,SAAQ,WAAW;IACzC;;;;;;;;;;;;;;;OAeG;IACH,iBAAiB,CACf,KAAwC,EACxC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,+BAA+B,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClF,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,YAAY,CACV,QAAyD,EAAE,EAC3D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,0BAA0B,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7E,CAAC;CACF"}

package/resources/v1/locates.d.mts

@@ -0,0 +1,220 @@
+import { APIResource } from "../../core/resource.mjs";
+import * as Shared from "../shared.mjs";
+import * as OrdersAPI from "./orders.mjs";
+import { APIPromise } from "../../core/api-promise.mjs";
+import { RequestOptions } from "../../internal/request-options.mjs";
+/**
+ * Query locate requests, granted locates, and cached locate borrow rates.
+ */
+export declare 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>;
+    /**
+     * > **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>;
+    /**
+     * > **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>;
+    /**
+     * > **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>;
+}
+/**
+ * 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, };
+}
+//# sourceMappingURL=locates.d.mts.map

package/resources/v1/locates.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"locates.d.mts","sourceRoot":"","sources":["../../src/resources/v1/locates.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,KAAK,MAAM,sBAAkB;AACpC,OAAO,KAAK,SAAS,qBAAiB;AACtC,OAAO,EAAE,UAAU,EAAE,mCAA+B;AACpD,OAAO,EAAE,cAAc,EAAE,2CAAuC;AAGhE;;GAEG;AACH,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;;;OAaG;IACH,aAAa,CACX,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,yBAAyB,EACjC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,2BAA2B,CAAC;IAK1C;;;;;;;;;;;;OAYG;IACH,iBAAiB,CACf,YAAY,EAAE,SAAS,CAAC,oBAAoB,EAC5C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,+BAA+B,CAAC;IAI9C;;;;;;;;;;;;;;;OAeG;IACH,cAAc,CACZ,KAAK,EAAE,0BAA0B,EACjC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,4BAA4B,CAAC;IAI3C;;;;;;;;;;;OAWG;IACH,UAAU,CACR,SAAS,EAAE,MAAM,EACjB,KAAK,GAAE,sBAAsB,GAAG,IAAI,GAAG,SAAc,EACrD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,wBAAwB,CAAC;CAGxC;AAED;;GAEG;AACH,MAAM,WAAW,MAAM;IACrB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,MAAM,EAAE,YAAY,CAAC;IAErB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;;OAGG;IACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAElC;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC/B;AAED,MAAM,MAAM,UAAU,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC;AAEvC;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;;OAGG;IACH,UAAU,EAAE,SAAS,CAAC,oBAAoB,CAAC;IAE3C;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC,QAAQ,GAAG,IAAI,CAAC;IAE/B;;;OAGG;IACH,IAAI,CAAC,EAAE,UAAU,GAAG,IAAI,CAAC;CAC1B;AAED,MAAM,MAAM,oBAAoB,GAAG,KAAK,CAAC,gBAAgB,CAAC,CAAC;AAE3D;;;GAGG;AACH,MAAM,MAAM,YAAY,GAAG,WAAW,GAAG,UAAU,GAAG,UAAU,GAAG,SAAS,CAAC;AAE7E,MAAM,WAAW,2BAA4B,SAAQ,MAAM,CAAC,YAAY;IACtE;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,+BAAgC,SAAQ,MAAM,CAAC,YAAY;IAC1E;;OAEG;IACH,IAAI,EAAE,UAAU,CAAC;CAClB;AAED,MAAM,WAAW,4BAA6B,SAAQ,MAAM,CAAC,YAAY;IACvE,IAAI,EAAE,oBAAoB,CAAC;CAC5B;AAED,MAAM,WAAW,wBAAyB,SAAQ,MAAM,CAAC,YAAY;IACnE,IAAI,EAAE,UAAU,CAAC;CAClB;AAED,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,cAAc,EAAE,KAAK,CAAC,SAAS,CAAC,oBAAoB,CAAC,CAAC;CACvD;AAED,MAAM,WAAW,sBAAsB;IACrC;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,cAAc,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC,oBAAoB,CAAC,CAAC;IAEvD;;OAEG;IACH,MAAM,CAAC,EAAE,KAAK,CAAC,WAAW,GAAG,UAAU,GAAG,UAAU,GAAG,SAAS,CAAC,CAAC;CACnE;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,MAAM,IAAI,MAAM,EACrB,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,sBAAsB,IAAI,sBAAsB,GACtD,CAAC;CACH"}

package/resources/v1/locates.d.ts

@@ -0,0 +1,220 @@
+import { APIResource } from "../../core/resource.js";
+import * as Shared from "../shared.js";
+import * as OrdersAPI from "./orders.js";
+import { APIPromise } from "../../core/api-promise.js";
+import { RequestOptions } from "../../internal/request-options.js";
+/**
+ * Query locate requests, granted locates, and cached locate borrow rates.
+ */
+export declare 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>;
+    /**
+     * > **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>;
+    /**
+     * > **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>;
+    /**
+     * > **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>;
+}
+/**
+ * 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, };
+}
+//# sourceMappingURL=locates.d.ts.map

package/resources/v1/locates.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"locates.d.ts","sourceRoot":"","sources":["../../src/resources/v1/locates.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,KAAK,MAAM,qBAAkB;AACpC,OAAO,KAAK,SAAS,oBAAiB;AACtC,OAAO,EAAE,UAAU,EAAE,kCAA+B;AACpD,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAGhE;;GAEG;AACH,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;;;OAaG;IACH,aAAa,CACX,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,yBAAyB,EACjC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,2BAA2B,CAAC;IAK1C;;;;;;;;;;;;OAYG;IACH,iBAAiB,CACf,YAAY,EAAE,SAAS,CAAC,oBAAoB,EAC5C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,+BAA+B,CAAC;IAI9C;;;;;;;;;;;;;;;OAeG;IACH,cAAc,CACZ,KAAK,EAAE,0BAA0B,EACjC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,4BAA4B,CAAC;IAI3C;;;;;;;;;;;OAWG;IACH,UAAU,CACR,SAAS,EAAE,MAAM,EACjB,KAAK,GAAE,sBAAsB,GAAG,IAAI,GAAG,SAAc,EACrD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,wBAAwB,CAAC;CAGxC;AAED;;GAEG;AACH,MAAM,WAAW,MAAM;IACrB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,MAAM,EAAE,YAAY,CAAC;IAErB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;;OAGG;IACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAElC;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC/B;AAED,MAAM,MAAM,UAAU,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC;AAEvC;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;;OAGG;IACH,UAAU,EAAE,SAAS,CAAC,oBAAoB,CAAC;IAE3C;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC,QAAQ,GAAG,IAAI,CAAC;IAE/B;;;OAGG;IACH,IAAI,CAAC,EAAE,UAAU,GAAG,IAAI,CAAC;CAC1B;AAED,MAAM,MAAM,oBAAoB,GAAG,KAAK,CAAC,gBAAgB,CAAC,CAAC;AAE3D;;;GAGG;AACH,MAAM,MAAM,YAAY,GAAG,WAAW,GAAG,UAAU,GAAG,UAAU,GAAG,SAAS,CAAC;AAE7E,MAAM,WAAW,2BAA4B,SAAQ,MAAM,CAAC,YAAY;IACtE;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,+BAAgC,SAAQ,MAAM,CAAC,YAAY;IAC1E;;OAEG;IACH,IAAI,EAAE,UAAU,CAAC;CAClB;AAED,MAAM,WAAW,4BAA6B,SAAQ,MAAM,CAAC,YAAY;IACvE,IAAI,EAAE,oBAAoB,CAAC;CAC5B;AAED,MAAM,WAAW,wBAAyB,SAAQ,MAAM,CAAC,YAAY;IACnE,IAAI,EAAE,UAAU,CAAC;CAClB;AAED,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,cAAc,EAAE,KAAK,CAAC,SAAS,CAAC,oBAAoB,CAAC,CAAC;CACvD;AAED,MAAM,WAAW,sBAAsB;IACrC;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,cAAc,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC,oBAAoB,CAAC,CAAC;IAEvD;;OAEG;IACH,MAAM,CAAC,EAAE,KAAK,CAAC,WAAW,GAAG,UAAU,GAAG,UAAU,GAAG,SAAS,CAAC,CAAC;CACnE;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,MAAM,IAAI,MAAM,EACrB,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,sBAAsB,IAAI,sBAAsB,GACtD,CAAC;CACH"}

package/resources/v1/locates.js

@@ -0,0 +1,81 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Locates = void 0;
+const resource_1 = require("../../core/resource.js");
+const path_1 = require("../../internal/utils/path.js");
+/**
+ * Query locate requests, granted locates, and cached locate borrow rates.
+ */
+class Locates extends resource_1.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, params, options) {
+        const { account_id } = params;
+        return this._client.get((0, path_1.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, options) {
+        return this._client.get((0, path_1.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, options) {
+        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, query = {}, options) {
+        return this._client.get((0, path_1.path) `/v1/accounts/${accountID}/locates`, { query, ...options });
+    }
+}
+exports.Locates = Locates;
+//# sourceMappingURL=locates.js.map

package/resources/v1/locates.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"locates.js","sourceRoot":"","sources":["../../src/resources/v1/locates.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAKlD,uDAAiD;AAEjD;;GAEG;AACH,MAAa,OAAQ,SAAQ,sBAAW;IACtC;;;;;;;;;;;;;OAaG;IACH,aAAa,CACX,EAAU,EACV,MAAiC,EACjC,OAAwB;QAExB,MAAM,EAAE,UAAU,EAAE,GAAG,MAAM,CAAC;QAC9B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,gBAAgB,UAAU,YAAY,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACnF,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,iBAAiB,CACf,YAA4C,EAC5C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,qBAAqB,YAAY,EAAE,EAAE,OAAO,CAAC,CAAC;IAC5E,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,cAAc,CACZ,KAAiC,EACjC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,mBAAmB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;IAED;;;;;;;;;;;OAWG;IACH,UAAU,CACR,SAAiB,EACjB,QAAmD,EAAE,EACrD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,gBAAgB,SAAS,UAAU,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1F,CAAC;CACF;AAtFD,0BAsFC"}