@clear-street/clearstreet 0.74.1 → 0.75.0

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

@@ -32,17 +32,17 @@ export class News extends APIResource {
  */
 export interface NewsInstrument {
   /**
-   * OEMS instrument UUID.
+   * Instrument identifier.
    */
   instrument_id: string;
 
   /**
-   * Instrument name/description, if available from instrument cache enrichment.
+   * Instrument name/description, if available.
    */
   name?: string | null;
 
   /**
-   * Trading symbol, if available from instrument cache enrichment.
+   * Trading symbol, if available.
    */
   symbol?: string | null;
 }
@@ -127,7 +127,7 @@ export interface NewsGetNewsParams {
   include_publishers?: string;
 
   /**
-   * Comma-delimited OEMS instrument UUIDs to filter by.
+   * Comma-delimited instrument identifiers to filter by.
    */
   instrument_ids?: Array<string>;
 

package/src/resources/v1/instruments.ts

@@ -70,11 +70,9 @@ export class Instruments extends APIResource {
    * Search instruments by symbol, alternate identifier, or company name.
    *
    * The `q` parameter is case-insensitive and supports ticker symbols, alternate
-   * identifiers such as CUSIP, ISIN, OPRA root, and CMS identifiers, and company
-   * names for non-option instruments. Results are ranked by match quality plus
-   * instrument quality signals including log-scaled ADV, listing status,
-   * marginability, easy-to-borrow status, and OTC, restricted, and liquidation-only
-   * penalties. Defaults to the `EQUITY` asset class (common stocks, preferred
+   * identifiers such as CUSIP, ISIN, and OPRA root, and company names for non-option
+   * instruments. Results are ranked by match quality plus instrument quality signals
+   * and relevance. Defaults to the `EQUITY` asset class (common stocks, preferred
    * shares, ADRs, ETFs, and exchange-traded mutual funds). Pass `asset_class=OPTION`
    * to search option contracts: by full OSI symbol, by an OSI prefix (root +
    * `YYMMDD` expiry, e.g. `AAPL 261217`), or by a root-scoped phrase such as
@@ -109,7 +107,7 @@ export type ExerciseStyle = 'AMERICAN' | 'EUROPEAN';
  */
 export interface Instrument {
   /**
-   * Unique OEMS instrument identifier (UUID)
+   * Unique instrument identifier (UUID)
    */
   id: string;
 
@@ -200,9 +198,7 @@ export interface Instrument {
   name?: string | null;
 
   /**
-   * Notional ADV (`adv × previous_close`). The primary liquidity signal used by
-   * `/instruments/search` ranking. Computed at response time so it stays consistent
-   * with whatever `adv` and `previous_close` show.
+   * Notional average daily volume (ADV multiplied by previous close price).
    */
   notional_adv?: string | null;
 
@@ -230,7 +226,7 @@ export interface Instrument {
 
 export interface InstrumentCore {
   /**
-   * Unique OEMS instrument identifier (UUID)
+   * Unique instrument identifier (UUID)
    */
   id: string;
 
@@ -321,9 +317,7 @@ export interface InstrumentCore {
   name?: string | null;
 
   /**
-   * Notional ADV (`adv × previous_close`). The primary liquidity signal used by
-   * `/instruments/search` ranking. Computed at response time so it stays consistent
-   * with whatever `adv` and `previous_close` show.
+   * Notional average daily volume (ADV multiplied by previous close price).
    */
   notional_adv?: string | null;
 
@@ -355,7 +349,7 @@ export type ListingType = 'STANDARD' | 'FLEX' | 'OTC';
  */
 export interface OptionsContract {
   /**
-   * OEMS instrument identifier
+   * Instrument identifier
    */
   id: string;
 
@@ -420,7 +414,7 @@ export interface OptionsContract {
   open_interest?: number | null;
 
   /**
-   * OEMS instrument ID of the underlying instrument, if resolvable
+   * Instrument ID of the underlying instrument, when available
    */
   underlying_instrument_id?: string | null;
 }
@@ -460,7 +454,7 @@ export interface InstrumentGetInstrumentsParams {
   easy_to_borrow?: boolean;
 
   /**
-   * Comma-separated OEMS instrument UUIDs
+   * Comma-separated instrument identifiers
    */
   instrument_ids?: Array<string>;
 
@@ -536,7 +530,7 @@ export interface InstrumentGetOptionContractsParams {
   underlier?: string;
 
   /**
-   * OEMS instrument UUID or symbol of the underlying equity/index
+   * Instrument identifier or symbol of the underlying equity/index
    */
   underlying_instrument_id?: OrdersAPI.InstrumentIDOrSymbol;
 }
@@ -544,8 +538,8 @@ export interface InstrumentGetOptionContractsParams {
 export interface InstrumentSearchInstrumentsParams {
   /**
    * Search term applied case-insensitively to ticker symbols, alternate identifiers
-   * (CUSIP, ISIN, OPRA root, CMS), and company names for non-option instruments.
-   * Option searches match symbols and alternate identifiers.
+   * (CUSIP, ISIN, OPRA root), and company names for non-option instruments. Option
+   * searches match symbols and alternate identifiers.
    */
   q: string;
 

package/src/resources/v1/orders.ts

@@ -197,7 +197,7 @@ export interface Execution {
   id: string;
 
   /**
-   * OEMS instrument identifier.
+   * Unique instrument identifier.
    */
   instrument_id: string;
 
@@ -235,7 +235,7 @@ export interface Execution {
 export type ExecutionList = Array<Execution>;
 
 /**
- * OEMS instrument UUID
+ * Instrument identifier
  */
 export type InstrumentIDOrSymbol = string;
 
@@ -283,7 +283,7 @@ export interface NewOrderRequest {
   extended_hours?: boolean | null;
 
   /**
-   * OEMS instrument UUID
+   * Instrument identifier
    */
   instrument_id?: InstrumentIDOrSymbol | null;
 
@@ -344,7 +344,7 @@ export interface Order {
   account_id: number;
 
   /**
-   * Client-provided identifier echoed back (FIX tag 11).
+   * Client-provided identifier echoed back.
    */
   client_order_id: string;
 
@@ -359,7 +359,7 @@ export interface Order {
   filled_quantity: string;
 
   /**
-   * OEMS instrument UUID for the traded instrument.
+   * Instrument identifier for the traded instrument.
    */
   instrument_id: string;
 
@@ -491,9 +491,9 @@ export interface Order {
   trailing_watermark_ts?: string | null;
 
   /**
-   * OEMS instrument ID of the option's underlying instrument. Populated only for
-   * OPTIONS orders; `null` for non-options and for options whose underlier cannot be
-   * resolved from the instrument cache.
+   * Instrument ID of the option's underlying instrument. Populated only for options
+   * orders; `null` for non-options and for options whose underlier cannot be
+   * resolved.
    */
   underlying_instrument_id?: string | null;
 }
@@ -645,7 +645,7 @@ export interface OrderSubmitOrdersResponse extends Shared.BaseResponse {
 
 export interface OrderCancelAllOpenOrdersParams {
   /**
-   * Comma-separated OEMS instrument UUIDs
+   * Comma-separated instrument identifiers
    */
   instrument_ids?: Array<string>;
 
@@ -680,7 +680,7 @@ export interface OrderGetExecutionsParams {
 
   /**
    * Optional instrument to filter by. Accepts either a symbol (e.g. `AAPL`) or an
-   * OEMS instrument UUID.
+   * instrument identifier.
    */
   instrument_id?: InstrumentIDOrSymbol;
 
@@ -716,7 +716,7 @@ export interface OrderGetOrdersParams {
   from?: string;
 
   /**
-   * Comma-separated OEMS instrument UUIDs
+   * Comma-separated instrument identifiers
    */
   instrument_ids?: Array<string>;
 
@@ -769,7 +769,7 @@ export interface OrderGetOrdersParams {
   to?: string;
 
   /**
-   * Comma-separated OEMS instrument UUIDs. Matches options orders whose resolved
+   * Comma-separated instrument identifiers. Matches options orders whose resolved
    * underlier is any of the given IDs.
    */
   underlying_instrument_ids?: Array<string>;

package/src/resources/v1/positions.ts

@@ -179,7 +179,7 @@ export interface Position {
   available_quantity: string;
 
   /**
-   * OEMS instrument UUID
+   * Unique instrument identifier
    */
   instrument_id: string;
 
@@ -245,7 +245,7 @@ export interface Position {
   instrument_price?: string | null;
 
   /**
-   * OEMS instrument identifier of the underlying instrument, if resolvable
+   * Identifier of the underlying instrument, when available
    */
   underlying_instrument_id?: string | null;
 
@@ -337,21 +337,19 @@ export type PositionInstructionList = Array<PositionInstruction>;
 /**
  * Lifecycle status of a position instruction.
  *
- * - `SENT`: accepted and forwarded to the clearing venue.
+ * - `SENT`: accepted and submitted to the clearing venue.
  * - `ACCEPTED`: terminal — accepted by the clearing venue.
  * - `REJECTED`: terminal rejection from the clearing venue; `rejection_reason`
  *   carries the venue-reported detail.
- * - `ENGINE_REJECTED`: terminal rejection raised before the instruction reached
- *   the clearing venue; `rejection_reason` carries the detail. Typical causes:
- *   duplicate `instruction_id`, `DO_NOT_EXERCISE` / `CONTRARY_EXERCISE` submitted
- *   on a non-expiry day, insufficient position, or an instrument that does not
- *   resolve.
+ * - `ENGINE_REJECTED`: terminal rejection from validation; `rejection_reason`
+ *   carries the detail. Typical causes: duplicate `instruction_id`,
+ *   `DO_NOT_EXERCISE` / `CONTRARY_EXERCISE` submitted on a non-expiry day,
+ *   insufficient position, or an invalid instrument.
  * - `CANCEL_REQUESTED`: cancel accepted; final cancel state pending.
  * - `CANCELLED`: terminal — cancel completed.
  * - `CANCEL_FAILED`: cancel could not be completed; operator attention required.
  *   `rejection_reason` carries the detail.
- * - `UNKNOWN`: status could not be mapped from the upstream service. Not expected
- *   in practice; surfaces a service version skew.
+ * - `UNKNOWN`: status could not be determined.
  */
 export type PositionInstructionStatus =
   | 'SENT'
@@ -439,7 +437,7 @@ export interface PositionGetPositionInstructionsParams {
 
 export interface PositionGetPositionsParams {
   /**
-   * Comma-separated OEMS instrument UUIDs
+   * Comma-separated instrument identifiers
    */
   instrument_ids?: Array<string>;
 

package/src/resources/v1/v1.ts

@@ -23,6 +23,7 @@ import {
   Accounts,
   MarginDetails,
   MarginDetailsUsage,
+  MarginSessionDetails,
   MarginTopContributor,
   MarginType,
   PortfolioHistoryResponse,
@@ -256,6 +257,7 @@ export declare namespace V1 {
     type AccountType as AccountType,
     type MarginDetails as MarginDetails,
     type MarginDetailsUsage as MarginDetailsUsage,
+    type MarginSessionDetails as MarginSessionDetails,
     type MarginTopContributor as MarginTopContributor,
     type MarginType as MarginType,
     type PortfolioHistoryResponse as PortfolioHistoryResponse,

package/src/resources/v1/watchlist.ts

@@ -238,7 +238,7 @@ export interface WatchlistGetWatchlistsResponse extends Shared.BaseResponse {
 
 export interface WatchlistAddWatchlistItemParams {
   /**
-   * OEMS instrument UUID
+   * Instrument identifier
    */
   instrument_id: OrdersAPI.InstrumentIDOrSymbol;
 }

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.74.1'; // x-release-please-version
+export const VERSION = '0.75.0'; // x-release-please-version

package/version.d.mts

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

package/version.d.ts

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

package/version.mjs

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