@clear-street/clearstreet 0.105.0 → 0.107.0

package/src/resources/v1/index.ts

@@ -59,6 +59,7 @@ export {
   type AnalystDistribution,
   type AnalystRating,
   type FiscalPeriodType,
+  type FiscalQuarter,
   type InstrumentAllEventsData,
   type InstrumentAnalystConsensus,
   type InstrumentBalanceSheetStatement,
@@ -67,6 +68,8 @@ export {
   type InstrumentCashFlowStatementList,
   type InstrumentDividendEvent,
   type InstrumentEarnings,
+  type InstrumentEarningsTranscript,
+  type InstrumentEarningsTranscriptList,
   type InstrumentEventEnvelope,
   type InstrumentEventIpoItem,
   type InstrumentEventsByDate,
@@ -82,6 +85,7 @@ export {
   type InstrumentDataGetInstrumentAnalystConsensusResponse,
   type InstrumentDataGetInstrumentBalanceSheetStatementsResponse,
   type InstrumentDataGetInstrumentCashFlowStatementsResponse,
+  type InstrumentDataGetInstrumentEarningsTranscriptsResponse,
   type InstrumentDataGetInstrumentEventsResponse,
   type InstrumentDataGetInstrumentFundamentalsResponse,
   type InstrumentDataGetInstrumentIncomeStatementsResponse,
@@ -89,6 +93,7 @@ export {
   type InstrumentDataGetInstrumentAnalystConsensusParams,
   type InstrumentDataGetInstrumentBalanceSheetStatementsParams,
   type InstrumentDataGetInstrumentCashFlowStatementsParams,
+  type InstrumentDataGetInstrumentEarningsTranscriptsParams,
   type InstrumentDataGetInstrumentEventsParams,
   type InstrumentDataGetInstrumentIncomeStatementsParams,
 } from './instrument-data/index';
@@ -100,9 +105,11 @@ export {
   type InstrumentCore,
   type InstrumentCoreList,
   type ListingType,
+  type NotShortableReason,
   type OptionExpiryDate,
   type OptionsContract,
   type OptionsContractList,
+  type ShortableAttribute,
   type TickRule,
   type InstrumentGetInstrumentByIDResponse,
   type InstrumentGetInstrumentsResponse,
@@ -178,6 +185,15 @@ export {
   type NewOrderRequest,
   type Order,
   type OrderList,
+  type OrderPreview,
+  type OrderPreviewAmount,
+  type OrderPreviewDelta,
+  type OrderPreviewEntry,
+  type OrderPreviewEntryList,
+  type OrderPreviewError,
+  type OrderPreviewMarginDetails,
+  type OrderPreviewOutcome,
+  type OrderPreviewPosition,
   type OrderStatus,
   type OrderStrategy,
   type OrderType,
@@ -194,6 +210,7 @@ export {
   type OrderGetExecutionsResponse,
   type OrderGetOrderByIDResponse,
   type OrderGetOrdersResponse,
+  type OrderPreviewOrdersResponse,
   type OrderReplaceOrderResponse,
   type OrderSubmitOrdersResponse,
   type OrderCancelAllOpenOrdersParams,
@@ -201,6 +218,7 @@ export {
   type OrderGetExecutionsParams,
   type OrderGetOrderByIDParams,
   type OrderGetOrdersParams,
+  type OrderPreviewOrdersParams,
   type OrderReplaceOrderParams,
   type OrderSubmitOrdersParams,
 } from './orders';

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

@@ -6,6 +6,7 @@ export {
   type AnalystDistribution,
   type AnalystRating,
   type FiscalPeriodType,
+  type FiscalQuarter,
   type InstrumentAllEventsData,
   type InstrumentAnalystConsensus,
   type InstrumentBalanceSheetStatement,
@@ -14,6 +15,8 @@ export {
   type InstrumentCashFlowStatementList,
   type InstrumentDividendEvent,
   type InstrumentEarnings,
+  type InstrumentEarningsTranscript,
+  type InstrumentEarningsTranscriptList,
   type InstrumentEventEnvelope,
   type InstrumentEventIpoItem,
   type InstrumentEventsByDate,
@@ -29,6 +32,7 @@ export {
   type InstrumentDataGetInstrumentAnalystConsensusResponse,
   type InstrumentDataGetInstrumentBalanceSheetStatementsResponse,
   type InstrumentDataGetInstrumentCashFlowStatementsResponse,
+  type InstrumentDataGetInstrumentEarningsTranscriptsResponse,
   type InstrumentDataGetInstrumentEventsResponse,
   type InstrumentDataGetInstrumentFundamentalsResponse,
   type InstrumentDataGetInstrumentIncomeStatementsResponse,
@@ -36,6 +40,7 @@ export {
   type InstrumentDataGetInstrumentAnalystConsensusParams,
   type InstrumentDataGetInstrumentBalanceSheetStatementsParams,
   type InstrumentDataGetInstrumentCashFlowStatementsParams,
+  type InstrumentDataGetInstrumentEarningsTranscriptsParams,
   type InstrumentDataGetInstrumentEventsParams,
   type InstrumentDataGetInstrumentIncomeStatementsParams,
 } from './instrument-data';

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

@@ -147,6 +147,39 @@ export class InstrumentData extends APIResource {
     });
   }
 
+  /**
+   * Retrieves earnings call transcripts for a specific instrument, newest fiscal
+   * period first.
+   *
+   * Defaults: `page_size` is 1 and is capped at 5, because each transcript is large.
+   * Send `event_date` with the `date` of an earnings event from the events endpoints
+   * to fetch that event's transcript. The `date.gt`, `date.gte`, `date.lt`, and
+   * `date.lte` filters compare the call date itself. An instrument without
+   * transcripts returns an empty list.
+   *
+   * Pagination metadata does not include `total_items` or `total_pages` for this
+   * endpoint. Use `next_page_token` to detect whether more results exist. The token
+   * does not carry filters: send the same filters with every page request.
+   *
+   * @example
+   * ```ts
+   * const response =
+   *   await client.v1.instrumentData.getInstrumentEarningsTranscripts(
+   *     'x',
+   *   );
+   * ```
+   */
+  getInstrumentEarningsTranscripts(
+    instrumentID: string,
+    query: InstrumentDataGetInstrumentEarningsTranscriptsParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<InstrumentDataGetInstrumentEarningsTranscriptsResponse> {
+    return this._client.get(path`/v1/instruments/${instrumentID}/earnings-transcripts`, {
+      query,
+      ...options,
+    });
+  }
+
   /**
    * Retrieves corporate events (earnings, dividends, splits, IPO) for an instrument,
    * grouped by event type. Filter to specific types via `event_types`.
@@ -262,6 +295,11 @@ export type AnalystRating = 'STRONG_BUY' | 'BUY' | 'HOLD' | 'SELL' | 'STRONG_SEL
  */
 export type FiscalPeriodType = 'QUARTERLY' | 'ANNUAL' | 'TTM' | 'BIANNUAL';
 
+/**
+ * Fiscal quarter of a reporting period
+ */
+export type FiscalQuarter = 'Q1' | 'Q2' | 'Q3' | 'Q4';
+
 /**
  * All-events payload grouped by date.
  */
@@ -892,6 +930,13 @@ export interface InstrumentEarnings {
    */
   date: string;
 
+  /**
+   * True when an earnings call transcript exists for this event. Fetch it with
+   * `GET /v1/instruments/{instrument_id}/earnings-transcripts?event_date=<date>`,
+   * where `<date>` is this event's `date`.
+   */
+  transcript_available: boolean;
+
   /**
    * The actual earnings per share (EPS) for the period When a null/undefined value
    * is observed, it indicates that there is no available data.
@@ -935,6 +980,38 @@ export interface InstrumentEarnings {
   revenue_surprise_percent?: string | null;
 }
 
+/**
+ * An earnings call transcript for one fiscal quarter.
+ */
+export interface InstrumentEarningsTranscript {
+  /**
+   * The full text of the transcript
+   */
+  content: string;
+
+  /**
+   * The date of the earnings call
+   */
+  date: string;
+
+  /**
+   * The fiscal quarter of the call
+   */
+  period: FiscalQuarter;
+
+  /**
+   * The type of fiscal period. Always `QUARTERLY`.
+   */
+  period_type: FiscalPeriodType;
+
+  /**
+   * The fiscal year of the call
+   */
+  year: number;
+}
+
+export type InstrumentEarningsTranscriptList = Array<InstrumentEarningsTranscript>;
+
 /**
  * Unified envelope for the all-events response.
  */
@@ -1527,6 +1604,10 @@ export interface InstrumentDataGetInstrumentCashFlowStatementsResponse extends S
   data: InstrumentCashFlowStatementList;
 }
 
+export interface InstrumentDataGetInstrumentEarningsTranscriptsResponse extends Shared.BaseResponse {
+  data: InstrumentEarningsTranscriptList;
+}
+
 export interface InstrumentDataGetInstrumentEventsResponse extends Shared.BaseResponse {
   /**
    * Grouped instrument events by type
@@ -1642,6 +1723,80 @@ export interface InstrumentDataGetInstrumentCashFlowStatementsParams {
   to_date?: string;
 }
 
+export interface InstrumentDataGetInstrumentEarningsTranscriptsParams {
+  date?: InstrumentDataGetInstrumentEarningsTranscriptsParams.Date;
+
+  /**
+   * Return only transcripts whose call date is within one day of this earnings event
+   * date (`YYYY-MM-DD`). Use an event's `date` to fetch that event's transcript.
+   */
+  event_date?: string;
+
+  /**
+   * The number of items to return per page. Only used when page_token is not
+   * provided.
+   */
+  page_size?: number;
+
+  /**
+   * Token for retrieving the next or previous page of results. Contains encoded
+   * pagination state; when provided, page_size is ignored.
+   */
+  page_token?: string;
+
+  /**
+   * Only return the transcript for this fiscal quarter.
+   */
+  period?: 'Q1' | 'Q2' | 'Q3' | 'Q4';
+
+  /**
+   * Only return the transcript for this fiscal year.
+   */
+  year?: number;
+}
+
+export namespace InstrumentDataGetInstrumentEarningsTranscriptsParams {
+  export interface Date {
+    /**
+     * Return only rows where `date` is strictly after the given value. A bare
+     * `YYYY-MM-DD` date expands to the end of that day (UTC), so this matches from the
+     * start of the following day. See
+     * [Range filters](https://docs.clearstreet.com/guides/api-fundamentals#range-filters)
+     * for accepted formats, bare-date expansion, and combining bounds. Returns 400 if
+     * the resulting range is inverted.
+     */
+    gt?: string;
+
+    /**
+     * Return only rows where `date` is on or after the given value. A bare
+     * `YYYY-MM-DD` date expands to the start of that day (UTC). See
+     * [Range filters](https://docs.clearstreet.com/guides/api-fundamentals#range-filters)
+     * for accepted formats, bare-date expansion, and combining bounds. Returns 400 if
+     * the resulting range is inverted.
+     */
+    gte?: string;
+
+    /**
+     * Return only rows where `date` is strictly before the given value. A bare
+     * `YYYY-MM-DD` date expands to the start of that day (UTC). See
+     * [Range filters](https://docs.clearstreet.com/guides/api-fundamentals#range-filters)
+     * for accepted formats, bare-date expansion, and combining bounds. Returns 400 if
+     * the resulting range is inverted.
+     */
+    lt?: string;
+
+    /**
+     * Return only rows where `date` is on or before the given value. A bare
+     * `YYYY-MM-DD` date expands to the end of that day (UTC), so this matches through
+     * the end of that day. See
+     * [Range filters](https://docs.clearstreet.com/guides/api-fundamentals#range-filters)
+     * for accepted formats, bare-date expansion, and combining bounds. Returns 400 if
+     * the resulting range is inverted.
+     */
+    lte?: string;
+  }
+}
+
 export interface InstrumentDataGetInstrumentEventsParams {
   /**
    * Filter by event type(s). Comma-delimited list. Example:
@@ -1693,6 +1848,7 @@ export declare namespace InstrumentData {
     type AnalystDistribution as AnalystDistribution,
     type AnalystRating as AnalystRating,
     type FiscalPeriodType as FiscalPeriodType,
+    type FiscalQuarter as FiscalQuarter,
     type InstrumentAllEventsData as InstrumentAllEventsData,
     type InstrumentAnalystConsensus as InstrumentAnalystConsensus,
     type InstrumentBalanceSheetStatement as InstrumentBalanceSheetStatement,
@@ -1701,6 +1857,8 @@ export declare namespace InstrumentData {
     type InstrumentCashFlowStatementList as InstrumentCashFlowStatementList,
     type InstrumentDividendEvent as InstrumentDividendEvent,
     type InstrumentEarnings as InstrumentEarnings,
+    type InstrumentEarningsTranscript as InstrumentEarningsTranscript,
+    type InstrumentEarningsTranscriptList as InstrumentEarningsTranscriptList,
     type InstrumentEventEnvelope as InstrumentEventEnvelope,
     type InstrumentEventIpoItem as InstrumentEventIpoItem,
     type InstrumentEventsByDate as InstrumentEventsByDate,
@@ -1716,6 +1874,7 @@ export declare namespace InstrumentData {
     type InstrumentDataGetInstrumentAnalystConsensusResponse as InstrumentDataGetInstrumentAnalystConsensusResponse,
     type InstrumentDataGetInstrumentBalanceSheetStatementsResponse as InstrumentDataGetInstrumentBalanceSheetStatementsResponse,
     type InstrumentDataGetInstrumentCashFlowStatementsResponse as InstrumentDataGetInstrumentCashFlowStatementsResponse,
+    type InstrumentDataGetInstrumentEarningsTranscriptsResponse as InstrumentDataGetInstrumentEarningsTranscriptsResponse,
     type InstrumentDataGetInstrumentEventsResponse as InstrumentDataGetInstrumentEventsResponse,
     type InstrumentDataGetInstrumentFundamentalsResponse as InstrumentDataGetInstrumentFundamentalsResponse,
     type InstrumentDataGetInstrumentIncomeStatementsResponse as InstrumentDataGetInstrumentIncomeStatementsResponse,
@@ -1723,6 +1882,7 @@ export declare namespace InstrumentData {
     type InstrumentDataGetInstrumentAnalystConsensusParams as InstrumentDataGetInstrumentAnalystConsensusParams,
     type InstrumentDataGetInstrumentBalanceSheetStatementsParams as InstrumentDataGetInstrumentBalanceSheetStatementsParams,
     type InstrumentDataGetInstrumentCashFlowStatementsParams as InstrumentDataGetInstrumentCashFlowStatementsParams,
+    type InstrumentDataGetInstrumentEarningsTranscriptsParams as InstrumentDataGetInstrumentEarningsTranscriptsParams,
     type InstrumentDataGetInstrumentEventsParams as InstrumentDataGetInstrumentEventsParams,
     type InstrumentDataGetInstrumentIncomeStatementsParams as InstrumentDataGetInstrumentIncomeStatementsParams,
   };

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

@@ -36,10 +36,12 @@ 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
+   * Three targeting modes, mutually exclusive: `instrument_ids` (1-100 ids),
    * `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).
+   * (uncapped), or `event_codes` (1-100 event tickers), which returns a snapshot for
+   * every market in those events in any status (uncapped). Unknown event codes are
+   * ignored.
    *
    * @example
    * ```ts

package/src/resources/v1/instruments.ts

@@ -205,6 +205,14 @@ export interface Instrument {
    */
   name?: string | null;
 
+  /**
+   * Why the instrument is `NOT_SHORTABLE`: every reason that applies, using the same
+   * codes as the `type` of the equivalent order-preview errors. Omitted unless
+   * `shortable_attribute` is `NOT_SHORTABLE`. When a null/undefined value is
+   * observed, it indicates it does not apply.
+   */
+  not_shortable_reasons?: Array<NotShortableReason> | null;
+
   /**
    * Notional average daily volume (ADV multiplied by the cax-adjusted close when
    * present, the raw previous close otherwise). When a null/undefined value is
@@ -242,6 +250,16 @@ export interface Instrument {
    */
   short_margin_rate?: string | null;
 
+  /**
+   * How readily the instrument can be shorted: `EASY_TO_BORROW`, `HARD_TO_BORROW`,
+   * or `NOT_SHORTABLE`. Easy-to-borrow instruments can be shorted without a locate.
+   * A hard-to-borrow instrument is not easy to borrow but has locate inventory
+   * remaining and supports short selling; anything else is not shortable. Omitted
+   * for instruments that are not tradable equities. When a null/undefined value is
+   * observed, it indicates it does not apply.
+   */
+  shortable_attribute?: ShortableAttribute | null;
+
   /**
    * Price bands this instrument quotes on, ascending. Absent when we have no
    * schedule for it, which includes an option whose penny-program status our
@@ -350,6 +368,14 @@ export interface InstrumentCore {
    */
   name?: string | null;
 
+  /**
+   * Why the instrument is `NOT_SHORTABLE`: every reason that applies, using the same
+   * codes as the `type` of the equivalent order-preview errors. Omitted unless
+   * `shortable_attribute` is `NOT_SHORTABLE`. When a null/undefined value is
+   * observed, it indicates it does not apply.
+   */
+  not_shortable_reasons?: Array<NotShortableReason> | null;
+
   /**
    * Notional average daily volume (ADV multiplied by the cax-adjusted close when
    * present, the raw previous close otherwise). When a null/undefined value is
@@ -369,6 +395,16 @@ export interface InstrumentCore {
    */
   short_margin_rate?: string | null;
 
+  /**
+   * How readily the instrument can be shorted: `EASY_TO_BORROW`, `HARD_TO_BORROW`,
+   * or `NOT_SHORTABLE`. Easy-to-borrow instruments can be shorted without a locate.
+   * A hard-to-borrow instrument is not easy to borrow but has locate inventory
+   * remaining and supports short selling; anything else is not shortable. Omitted
+   * for instruments that are not tradable equities. When a null/undefined value is
+   * observed, it indicates it does not apply.
+   */
+  shortable_attribute?: ShortableAttribute | null;
+
   /**
    * Price bands this instrument quotes on, ascending. Absent when we have no
    * schedule for it, which includes an option whose penny-program status our
@@ -384,6 +420,11 @@ export type InstrumentCoreList = Array<InstrumentCore>;
  */
 export type ListingType = 'STANDARD' | 'FLEX' | 'OTC';
 
+/**
+ * Why an instrument cannot be shorted.
+ */
+export type NotShortableReason = 'INSUFFICIENT_LOCATE_INVENTORY' | 'UNSUPPORTED_SECURITY';
+
 /**
  * An options expiry date, annotated with which settlement cycles have listed
  * contracts on it.
@@ -508,10 +549,21 @@ export interface OptionsContract {
    * value is observed, it indicates that there is no available data.
    */
   underlying_instrument_id?: string | null;
+
+  /**
+   * Type of the underlying instrument, alongside `underlying_instrument_id` When a
+   * null/undefined value is observed, it indicates that there is no available data.
+   */
+  underlying_instrument_type?: V1API.SecurityType | null;
 }
 
 export type OptionsContractList = Array<OptionsContract>;
 
+/**
+ * How readily a tradable equity can be shorted.
+ */
+export type ShortableAttribute = 'EASY_TO_BORROW' | 'HARD_TO_BORROW' | 'NOT_SHORTABLE';
+
 /**
  * One band of an instrument's tick schedule. A price in the band is valid only if
  * it is a whole multiple of `tick_size`. Bands describe the instrument itself: on
@@ -726,9 +778,11 @@ export declare namespace Instruments {
     type InstrumentCore as InstrumentCore,
     type InstrumentCoreList as InstrumentCoreList,
     type ListingType as ListingType,
+    type NotShortableReason as NotShortableReason,
     type OptionExpiryDate as OptionExpiryDate,
     type OptionsContract as OptionsContract,
     type OptionsContractList as OptionsContractList,
+    type ShortableAttribute as ShortableAttribute,
     type TickRule as TickRule,
     type InstrumentGetInstrumentByIDResponse as InstrumentGetInstrumentByIDResponse,
     type InstrumentGetInstrumentsResponse as InstrumentGetInstrumentsResponse,

package/src/resources/v1/locates.ts

@@ -12,8 +12,6 @@ import { path } from '../../internal/utils/path';
  */
 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.
    *
@@ -35,8 +33,6 @@ 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.
    *
@@ -55,8 +51,6 @@ export class Locates extends APIResource {
   }
 
   /**
-   * > **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
@@ -78,8 +72,6 @@ export class Locates extends APIResource {
   }
 
   /**
-   * > **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.