@clear-street/clearstreet 0.76.0 → 0.77.0

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

@@ -264,17 +264,20 @@ export interface InstrumentAnalystConsensus {
   date: string;
 
   /**
-   * Count of individual analyst recommendations by category
+   * Count of individual analyst recommendations by category When a null/undefined
+   * value is observed, it indicates that there is no available data.
    */
   distribution?: AnalystDistribution | null;
 
   /**
-   * Aggregated analyst price target statistics
+   * Aggregated analyst price target statistics When a null/undefined value is
+   * observed, it indicates that there is no available data.
    */
   price_target?: PriceTarget | null;
 
   /**
-   * Consensus analyst rating
+   * Consensus analyst rating When a null/undefined value is observed, it indicates
+   * that there is no available data.
    */
   rating?: AnalystRating | null;
 }
@@ -823,35 +826,41 @@ export interface InstrumentDividendEvent {
   ex_date: string;
 
   /**
-   * The declaration date of the dividend
+   * The declaration date of the dividend When a null/undefined value is observed, it
+   * indicates that there is no available data.
    */
   declaration_date?: string | null;
 
   /**
-   * The dividend amount per share.
+   * The dividend amount per share. When a null/undefined value is observed, it
+   * indicates that there is no available data.
    */
   dividend_amount?: string | null;
 
   /**
-   * The dividend yield as a percentage of the stock price.
+   * The dividend yield as a percentage of the stock price. When a null/undefined
+   * value is observed, it indicates that there is no available data.
    */
   dividend_yield?: string | null;
 
   /**
-   * The frequency of the dividend payments (e.g., "Quarterly", "Annual").
+   * The frequency of the dividend payments (e.g., "Quarterly", "Annual"). When a
+   * null/undefined value is observed, it indicates that there is no available data.
    */
   frequency?: string | null;
 
   /**
    * The payment date is the date on which a declared stock dividend is scheduled to
-   * be paid.
+   * be paid. When a null/undefined value is observed, it indicates that there is no
+   * available data.
    */
   payment_date?: string | null;
 
   /**
    * The record date, set by a company's board of directors, is when a company
    * compiles a list of shareholders of the stock for which it has declared a
-   * dividend.
+   * dividend. When a null/undefined value is observed, it indicates that there is no
+   * available data.
    */
   record_date?: string | null;
 }
@@ -866,32 +875,38 @@ export interface InstrumentEarnings {
   date: string;
 
   /**
-   * The actual earnings per share (EPS) for the period
+   * The actual earnings per share (EPS) for the period When a null/undefined value
+   * is observed, it indicates that there is no available data.
    */
   eps_actual?: string | null;
 
   /**
-   * The estimated earnings per share (EPS) for the period
+   * The estimated earnings per share (EPS) for the period When a null/undefined
+   * value is observed, it indicates that there is no available data.
    */
   eps_estimate?: string | null;
 
   /**
-   * The percentage difference between actual and estimated EPS
+   * The percentage difference between actual and estimated EPS When a null/undefined
+   * value is observed, it indicates that there is no available data.
    */
   eps_surprise_percent?: string | null;
 
   /**
-   * The actual total revenue for the period
+   * The actual total revenue for the period When a null/undefined value is observed,
+   * it indicates that there is no available data.
    */
   revenue_actual?: string | null;
 
   /**
-   * The estimated total revenue for the period
+   * The estimated total revenue for the period When a null/undefined value is
+   * observed, it indicates that there is no available data.
    */
   revenue_estimate?: string | null;
 
   /**
-   * The percentage difference between actual and estimated revenue
+   * The percentage difference between actual and estimated revenue When a
+   * null/undefined value is observed, it indicates that there is no available data.
    */
   revenue_surprise_percent?: string | null;
 }
@@ -911,37 +926,44 @@ export interface InstrumentEventEnvelope {
   type: AllEventsEventType;
 
   /**
-   * Dividend payload when type is DIVIDEND.
+   * Dividend payload when type is DIVIDEND. When a null/undefined value is observed,
+   * it indicates it does not apply.
    */
   dividend_event_data?: InstrumentDividendEvent | null;
 
   /**
-   * Earnings payload when type is EARNINGS.
+   * Earnings payload when type is EARNINGS. When a null/undefined value is observed,
+   * it indicates it does not apply.
    */
   earnings_event_data?: InstrumentEarnings | null;
 
   /**
-   * Instrument identifier, when available.
+   * Instrument identifier, when available. When a null/undefined value is observed,
+   * it indicates that there is no available data.
    */
   instrument_id?: string | null;
 
   /**
-   * IPO payload when type is IPO.
+   * IPO payload when type is IPO. When a null/undefined value is observed, it
+   * indicates it does not apply.
    */
   ipo_event_data?: InstrumentEventIpoItem | null;
 
   /**
-   * Instrument name associated with the event, when available.
+   * Instrument name associated with the event, when available. When a null/undefined
+   * value is observed, it indicates that there is no available data.
    */
   name?: string | null;
 
   /**
-   * The currency used for reporting financial data.
+   * The currency used for reporting financial data. When a null/undefined value is
+   * observed, it indicates that there is no available data.
    */
   reporting_currency?: string | null;
 
   /**
-   * Stock split payload when type is STOCK_SPLIT.
+   * Stock split payload when type is STOCK_SPLIT. When a null/undefined value is
+   * observed, it indicates it does not apply.
    */
   stock_split_event_data?: InstrumentSplitEvent | null;
 }
@@ -951,37 +973,44 @@ export interface InstrumentEventEnvelope {
  */
 export interface InstrumentEventIpoItem {
   /**
-   * IPO action.
+   * IPO action. When a null/undefined value is observed, it indicates that there is
+   * no available data.
    */
   actions?: string | null;
 
   /**
-   * IPO announced timestamp.
+   * IPO announced timestamp. When a null/undefined value is observed, it indicates
+   * that there is no available data.
    */
   announced_at?: string | null;
 
   /**
-   * IPO company name.
+   * IPO company name. When a null/undefined value is observed, it indicates that
+   * there is no available data.
    */
   company?: string | null;
 
   /**
-   * IPO exchange.
+   * IPO exchange. When a null/undefined value is observed, it indicates that there
+   * is no available data.
    */
   exchange?: string | null;
 
   /**
-   * IPO market cap.
+   * IPO market cap. When a null/undefined value is observed, it indicates that there
+   * is no available data.
    */
   market_cap?: string | null;
 
   /**
-   * IPO price range.
+   * IPO price range. When a null/undefined value is observed, it indicates that
+   * there is no available data.
    */
   price_range?: string | null;
 
   /**
-   * IPO shares offered.
+   * IPO shares offered. When a null/undefined value is observed, it indicates that
+   * there is no available data.
    */
   shares?: string | null;
 }
@@ -1026,7 +1055,8 @@ export interface InstrumentEventsData {
   splits: Array<InstrumentSplitEvent>;
 
   /**
-   * The currency used for reporting financial data
+   * The currency used for reporting financial data When a null/undefined value is
+   * observed, it indicates that there is no available data.
    */
   reporting_currency?: string | null;
 }
@@ -1036,78 +1066,93 @@ export interface InstrumentEventsData {
  */
 export interface InstrumentFundamentals {
   /**
-   * The average daily trading volume over the past 30 days
+   * The average daily trading volume over the past 30 days When a null/undefined
+   * value is observed, it indicates that there is no available data.
    */
   average_volume?: number | null;
 
   /**
    * The beta value, measuring the instrument's volatility relative to the overall
-   * market
+   * market When a null/undefined value is observed, it indicates that there is no
+   * available data.
    */
   beta?: string | null;
 
   /**
-   * A detailed description of the instrument or company
+   * A detailed description of the instrument or company When a null/undefined value
+   * is observed, it indicates that there is no available data.
    */
   description?: string | null;
 
   /**
-   * The trailing twelve months (TTM) dividend yield
+   * The trailing twelve months (TTM) dividend yield When a null/undefined value is
+   * observed, it indicates that there is no available data.
    */
   dividend_yield?: string | null;
 
   /**
-   * The trailing twelve months (TTM) earnings per share
+   * The trailing twelve months (TTM) earnings per share When a null/undefined value
+   * is observed, it indicates that there is no available data.
    */
   earnings_per_share?: string | null;
 
   /**
-   * The highest price over the last 52 weeks
+   * The highest price over the last 52 weeks When a null/undefined value is
+   * observed, it indicates that there is no available data.
    */
   fifty_two_week_high?: string | null;
 
   /**
-   * The lowest price over the last 52 weeks
+   * The lowest price over the last 52 weeks When a null/undefined value is observed,
+   * it indicates that there is no available data.
    */
   fifty_two_week_low?: string | null;
 
   /**
-   * The specific industry of the instrument's issuer
+   * The specific industry of the instrument's issuer When a null/undefined value is
+   * observed, it indicates that there is no available data.
    */
   industry?: string | null;
 
   /**
-   * The date the instrument was first listed
+   * The date the instrument was first listed When a null/undefined value is
+   * observed, it indicates that there is no available data.
    */
   list_date?: string | null;
 
   /**
-   * URL to a representative logo image for the instrument or issuer
+   * URL to a representative logo image for the instrument or issuer When a
+   * null/undefined value is observed, it indicates that there is no available data.
    */
   logo_url?: string | null;
 
   /**
-   * The total market capitalization
+   * The total market capitalization When a null/undefined value is observed, it
+   * indicates that there is no available data.
    */
   market_cap?: string | null;
 
   /**
-   * The closing price from the previous trading day
+   * The closing price from the previous trading day When a null/undefined value is
+   * observed, it indicates that there is no available data.
    */
   previous_close?: string | null;
 
   /**
-   * The price-to-earnings (P/E) ratio for the trailing twelve months (TTM)
+   * The price-to-earnings (P/E) ratio for the trailing twelve months (TTM) When a
+   * null/undefined value is observed, it indicates that there is no available data.
    */
   price_to_earnings?: string | null;
 
   /**
-   * The currency used for reporting financial data
+   * The currency used for reporting financial data When a null/undefined value is
+   * observed, it indicates that there is no available data.
    */
   reporting_currency?: string | null;
 
   /**
-   * The business sector of the instrument's issuer
+   * The business sector of the instrument's issuer When a null/undefined value is
+   * observed, it indicates that there is no available data.
    */
   sector?: string | null;
 }

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

@@ -69,32 +69,38 @@ export interface DailySummary {
   instrument_id: string;
 
   /**
-   * Session high.
+   * Session high. When a null/undefined value is observed, it indicates that there
+   * is no available data.
    */
   high?: string | null;
 
   /**
-   * Session low.
+   * Session low. When a null/undefined value is observed, it indicates that there is
+   * no available data.
    */
   low?: string | null;
 
   /**
-   * Opening price for the session.
+   * Opening price for the session. When a null/undefined value is observed, it
+   * indicates that there is no available data.
    */
   open?: string | null;
 
   /**
-   * Display symbol for the security. `None` for unresolvable IDs.
+   * Display symbol for the security. `None` for unresolvable IDs. When a
+   * null/undefined value is observed, it indicates that there is no available data.
    */
   symbol?: string | null;
 
   /**
-   * Session date the OHLV represents, US/Eastern.
+   * Session date the OHLV represents, US/Eastern. When a null/undefined value is
+   * observed, it indicates that there is no available data.
    */
   trade_date?: string | null;
 
   /**
-   * Session cumulative trading volume.
+   * Session cumulative trading volume. When a null/undefined value is observed, it
+   * indicates that there is no available data.
    */
   volume?: number | null;
 }
@@ -117,33 +123,40 @@ export interface MarketDataSnapshot {
 
   /**
    * Cumulative traded volume reported on the most recent trade, in shares for
-   * equities or contracts for options. Absent when no trade is available.
+   * equities or contracts for options. Absent when no trade is available. When a
+   * null/undefined value is observed, it indicates that there is no available data.
    */
   cumulative_volume?: number | null;
 
   /**
    * Theoretical price and Greeks for option instruments. `None` for equities, and
-   * for options whose Greeks have not yet been observed
+   * for options whose Greeks have not yet been observed When a null/undefined value
+   * is observed, it indicates that there is no available data.
    */
   greeks?: SnapshotGreeks | null;
 
   /**
-   * Most recent quote if available.
+   * Most recent quote if available. When a null/undefined value is observed, it
+   * indicates that there is no available data.
    */
   last_quote?: SnapshotQuote | null;
 
   /**
-   * Most recent last-sale trade if available.
+   * Most recent last-sale trade if available. When a null/undefined value is
+   * observed, it indicates that there is no available data.
    */
   last_trade?: SnapshotLastTrade | null;
 
   /**
-   * Security name if available.
+   * Security name if available. When a null/undefined value is observed, it
+   * indicates that there is no available data.
    */
   name?: string | null;
 
   /**
-   * Session metrics computed from previous close and last trade, if available.
+   * Session metrics computed from previous close and last trade, if available. When
+   * a null/undefined value is observed, it indicates that there is no available
+   * data.
    */
   session?: SnapshotSession | null;
 }
@@ -231,12 +244,14 @@ export interface SnapshotQuote {
   midpoint: string;
 
   /**
-   * Size at the best ask, in shares.
+   * Size at the best ask, in shares. When a null/undefined value is observed, it
+   * indicates that there is no available data.
    */
   ask_size?: number | null;
 
   /**
-   * Size at the best bid, in shares.
+   * Size at the best bid, in shares. When a null/undefined value is observed, it
+   * indicates that there is no available data.
    */
   bid_size?: number | null;
 }

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

@@ -37,12 +37,14 @@ export interface NewsInstrument {
   instrument_id: string;
 
   /**
-   * Instrument name/description, if available.
+   * Instrument name/description, if available. When a null/undefined value is
+   * observed, it indicates that there is no available data.
    */
   name?: string | null;
 
   /**
-   * Trading symbol, if available.
+   * Trading symbol, if available. When a null/undefined value is observed, it
+   * indicates that there is no available data.
    */
   symbol?: string | null;
 }
@@ -82,17 +84,20 @@ export interface NewsItem {
   url: string;
 
   /**
-   * URL of an associated image if provided by the source.
+   * URL of an associated image if provided by the source. When a null/undefined
+   * value is observed, it indicates that there is no available data.
    */
   image_url?: string | null;
 
   /**
-   * The primary domain/site of the publisher.
+   * The primary domain/site of the publisher. When a null/undefined value is
+   * observed, it indicates that there is no available data.
    */
   site?: string | null;
 
   /**
-   * The full or excerpted article body.
+   * The full or excerpted article body. When a null/undefined value is observed, it
+   * indicates that there is no available data.
    */
   text?: string | null;
 }

package/src/resources/v1/instruments.ts

@@ -173,53 +173,63 @@ export interface Instrument {
   venue: string;
 
   /**
-   * Average daily share volume from the security definition.
+   * Average daily share volume from the security definition. When a null/undefined
+   * value is observed, it indicates that there is no available data.
    */
   adv?: string | null;
 
   /**
-   * The expiration date for options instruments
+   * The expiration date for options instruments When a null/undefined value is
+   * observed, it indicates it does not apply.
    */
   expiry?: string | null;
 
   /**
-   * The type of security (e.g., Common Stock, ETF)
+   * The type of security (e.g., Common Stock, ETF) When a null/undefined value is
+   * observed, it indicates that there is no available data.
    */
   instrument_type?: V1API.SecurityType | null;
 
   /**
-   * The percent of a long position's value you must post as margin
+   * The percent of a long position's value you must post as margin When a
+   * null/undefined value is observed, it indicates that there is no available data.
    */
   long_margin_rate?: string | null;
 
   /**
-   * The full name of the instrument or its issuer
+   * The full name of the instrument or its issuer When a null/undefined value is
+   * observed, it indicates that there is no available data.
    */
   name?: string | null;
 
   /**
-   * Notional average daily volume (ADV multiplied by previous close price).
+   * Notional average daily volume (ADV multiplied by previous close price). When a
+   * null/undefined value is observed, it indicates that there is no available data.
    */
   notional_adv?: string | null;
 
   /**
    * Available options expiration dates for this instrument. Present only when
-   * `include_options_expiry_dates=true` in the request.
+   * `include_options_expiry_dates=true` in the request. When a null/undefined value
+   * is observed, it indicates it does not apply.
    */
   options_expiry_dates?: Array<string> | null;
 
   /**
-   * Last close price from the security definition.
+   * Last close price from the security definition. When a null/undefined value is
+   * observed, it indicates that there is no available data.
    */
   previous_close?: string | null;
 
   /**
-   * The percent of a short position's value you must post as margin
+   * The percent of a short position's value you must post as margin When a
+   * null/undefined value is observed, it indicates that there is no available data.
    */
   short_margin_rate?: string | null;
 
   /**
-   * The strike price for options instruments
+   * The strike price for options instruments When a null/undefined value is
+   * observed, it indicates it does not apply.
    */
   strike_price?: string | null;
 }
@@ -292,47 +302,56 @@ export interface InstrumentCore {
   venue: string;
 
   /**
-   * Average daily share volume from the security definition.
+   * Average daily share volume from the security definition. When a null/undefined
+   * value is observed, it indicates that there is no available data.
    */
   adv?: string | null;
 
   /**
-   * The expiration date for options instruments
+   * The expiration date for options instruments When a null/undefined value is
+   * observed, it indicates it does not apply.
    */
   expiry?: string | null;
 
   /**
-   * The type of security (e.g., Common Stock, ETF)
+   * The type of security (e.g., Common Stock, ETF) When a null/undefined value is
+   * observed, it indicates that there is no available data.
    */
   instrument_type?: V1API.SecurityType | null;
 
   /**
-   * The percent of a long position's value you must post as margin
+   * The percent of a long position's value you must post as margin When a
+   * null/undefined value is observed, it indicates that there is no available data.
    */
   long_margin_rate?: string | null;
 
   /**
-   * The full name of the instrument or its issuer
+   * The full name of the instrument or its issuer When a null/undefined value is
+   * observed, it indicates that there is no available data.
    */
   name?: string | null;
 
   /**
-   * Notional average daily volume (ADV multiplied by previous close price).
+   * Notional average daily volume (ADV multiplied by previous close price). When a
+   * null/undefined value is observed, it indicates that there is no available data.
    */
   notional_adv?: string | null;
 
   /**
-   * Last close price from the security definition.
+   * Last close price from the security definition. When a null/undefined value is
+   * observed, it indicates that there is no available data.
    */
   previous_close?: string | null;
 
   /**
-   * The percent of a short position's value you must post as margin
+   * The percent of a short position's value you must post as margin When a
+   * null/undefined value is observed, it indicates that there is no available data.
    */
   short_margin_rate?: string | null;
 
   /**
-   * The strike price for options instruments
+   * The strike price for options instruments When a null/undefined value is
+   * observed, it indicates it does not apply.
    */
   strike_price?: string | null;
 }
@@ -409,12 +428,14 @@ export interface OptionsContract {
   symbol: string;
 
   /**
-   * Open interest (number of outstanding contracts), if available
+   * Open interest (number of outstanding contracts), if available When a
+   * null/undefined value is observed, it indicates that there is no available data.
    */
   open_interest?: number | null;
 
   /**
-   * Instrument ID of the underlying instrument, when available
+   * Instrument ID of the underlying instrument, when available When a null/undefined
+   * value is observed, it indicates that there is no available data.
    */
   underlying_instrument_id?: string | null;
 }

package/src/resources/v1/omni-ai/messages.ts

@@ -63,6 +63,10 @@ export class Messages extends APIResource {
 export interface CreateFeedbackResponse {
   created_at: string;
 
+  /**
+   * When a null/undefined value is observed, it indicates that there is no available
+   * data.
+   */
   feedback_id?: string | null;
 }