@clear-street/clearstreet 0.0.0 → 0.72.0

package/resources/v1/instruments.d.ts

@@ -0,0 +1,471 @@
+import { APIResource } from "../../core/resource.js";
+import * as Shared from "../shared.js";
+import * as OrdersAPI from "./orders.js";
+import * as V1API from "./v1.js";
+import { APIPromise } from "../../core/api-promise.js";
+import { RequestOptions } from "../../internal/request-options.js";
+/**
+ * Retrieve core details and discovery endpoints for tradable instruments.
+ */
+export declare class Instruments extends APIResource {
+    /**
+     * Retrieves detailed information for a specific instrument.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.v1.instruments.getInstrumentByID(
+     *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     *   );
+     * ```
+     */
+    getInstrumentByID(instrumentID: OrdersAPI.InstrumentIDOrSymbol, query?: InstrumentGetInstrumentByIDParams | null | undefined, options?: RequestOptions): APIPromise<InstrumentGetInstrumentByIDResponse>;
+    /**
+     * Retrieves a list of tradeable instruments.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.v1.instruments.getInstruments();
+     * ```
+     */
+    getInstruments(query?: InstrumentGetInstrumentsParams | null | undefined, options?: RequestOptions): APIPromise<InstrumentGetInstrumentsResponse>;
+    /**
+     * List options contracts.
+     *
+     * Returns options contracts for a given underlier with options-specific metadata.
+     * Exactly one underlier identifier must be provided.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.v1.instruments.getOptionContracts();
+     * ```
+     */
+    getOptionContracts(query?: InstrumentGetOptionContractsParams | null | undefined, options?: RequestOptions): APIPromise<InstrumentGetOptionContractsResponse>;
+    /**
+     * 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
+     * shares, ADRs, ETFs, and exchange-traded mutual funds). Pass `asset_class=OPTION`
+     * to search option contracts by symbol or alternate identifier.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.v1.instruments.searchInstruments({ q: 'q' });
+     * ```
+     */
+    searchInstruments(query: InstrumentSearchInstrumentsParams, options?: RequestOptions): APIPromise<InstrumentSearchInstrumentsResponse>;
+}
+/**
+ * The type of options contract
+ */
+export type ContractType = 'CALL' | 'PUT';
+/**
+ * The exercise style of an options contract
+ */
+export type ExerciseStyle = 'AMERICAN' | 'EUROPEAN';
+/**
+ * Represents a tradable financial instrument.
+ */
+export interface Instrument {
+    /**
+     * Unique OEMS instrument identifier (UUID)
+     */
+    id: string;
+    /**
+     * The ISO country code of the instrument's issue
+     */
+    country_of_issue: string;
+    /**
+     * The ISO currency code in which the instrument is traded
+     */
+    currency: string;
+    /**
+     * Indicates if the instrument is classified as Easy-To-Borrow
+     */
+    easy_to_borrow: boolean;
+    /**
+     * Indicates if the instrument supports fractional-quantity orders
+     */
+    is_fractionable: boolean;
+    /**
+     * Indicates if the instrument is liquidation only and cannot be bought
+     */
+    is_liquidation_only: boolean;
+    /**
+     * Indicates if the instrument is marginable
+     */
+    is_marginable: boolean;
+    /**
+     * Indicates if the instrument is a publicly traded partnership (PTP). PTP sales
+     * are subject to a 10% withholding tax for non-US tax residents.
+     */
+    is_ptp: boolean;
+    /**
+     * Indicates if short selling is prohibited for the instrument
+     */
+    is_short_prohibited: boolean;
+    /**
+     * Indicates if the instrument is on the Regulation SHO Threshold Security List
+     */
+    is_threshold_security: boolean;
+    /**
+     * Indicates if the instrument is tradable
+     */
+    is_tradable: boolean;
+    /**
+     * The trading symbol for the instrument
+     */
+    symbol: string;
+    /**
+     * The MIC code of the primary listing venue
+     */
+    venue: string;
+    /**
+     * Average daily share volume from the security definition.
+     */
+    adv?: string | null;
+    /**
+     * The expiration date for options instruments
+     */
+    expiry?: string | null;
+    /**
+     * The type of security (e.g., Common Stock, ETF)
+     */
+    instrument_type?: V1API.SecurityType | null;
+    /**
+     * The percent of a long position's value you must post as margin
+     */
+    long_margin_rate?: string | null;
+    /**
+     * The full name of the instrument or its issuer
+     */
+    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_adv?: string | null;
+    /**
+     * Available options expiration dates for this instrument. Present only when
+     * `include_options_expiry_dates=true` in the request.
+     */
+    options_expiry_dates?: Array<string> | null;
+    /**
+     * Last close price from the security definition.
+     */
+    previous_close?: string | null;
+    /**
+     * The percent of a short position's value you must post as margin
+     */
+    short_margin_rate?: string | null;
+    /**
+     * The strike price for options instruments
+     */
+    strike_price?: string | null;
+}
+export interface InstrumentCore {
+    /**
+     * Unique OEMS instrument identifier (UUID)
+     */
+    id: string;
+    /**
+     * The ISO country code of the instrument's issue
+     */
+    country_of_issue: string;
+    /**
+     * The ISO currency code in which the instrument is traded
+     */
+    currency: string;
+    /**
+     * Indicates if the instrument is classified as Easy-To-Borrow
+     */
+    easy_to_borrow: boolean;
+    /**
+     * Indicates if the instrument supports fractional-quantity orders
+     */
+    is_fractionable: boolean;
+    /**
+     * Indicates if the instrument is liquidation only and cannot be bought
+     */
+    is_liquidation_only: boolean;
+    /**
+     * Indicates if the instrument is marginable
+     */
+    is_marginable: boolean;
+    /**
+     * Indicates if the instrument is a publicly traded partnership (PTP). PTP sales
+     * are subject to a 10% withholding tax for non-US tax residents.
+     */
+    is_ptp: boolean;
+    /**
+     * Indicates if short selling is prohibited for the instrument
+     */
+    is_short_prohibited: boolean;
+    /**
+     * Indicates if the instrument is on the Regulation SHO Threshold Security List
+     */
+    is_threshold_security: boolean;
+    /**
+     * Indicates if the instrument is tradable
+     */
+    is_tradable: boolean;
+    /**
+     * The trading symbol for the instrument
+     */
+    symbol: string;
+    /**
+     * The MIC code of the primary listing venue
+     */
+    venue: string;
+    /**
+     * Average daily share volume from the security definition.
+     */
+    adv?: string | null;
+    /**
+     * The expiration date for options instruments
+     */
+    expiry?: string | null;
+    /**
+     * The type of security (e.g., Common Stock, ETF)
+     */
+    instrument_type?: V1API.SecurityType | null;
+    /**
+     * The percent of a long position's value you must post as margin
+     */
+    long_margin_rate?: string | null;
+    /**
+     * The full name of the instrument or its issuer
+     */
+    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_adv?: string | null;
+    /**
+     * Last close price from the security definition.
+     */
+    previous_close?: string | null;
+    /**
+     * The percent of a short position's value you must post as margin
+     */
+    short_margin_rate?: string | null;
+    /**
+     * The strike price for options instruments
+     */
+    strike_price?: string | null;
+}
+export type InstrumentCoreList = Array<InstrumentCore>;
+/**
+ * The listing type of an options contract
+ */
+export type ListingType = 'STANDARD' | 'FLEX' | 'OTC';
+/**
+ * An options contract with options-specific metadata
+ */
+export interface OptionsContract {
+    /**
+     * OEMS instrument identifier
+     */
+    id: string;
+    /**
+     * Whether this is a CALL or PUT
+     */
+    contract_type: ContractType;
+    /**
+     * ISO currency code
+     */
+    currency: string;
+    /**
+     * MIC code of the primary listing venue
+     */
+    exchange: string;
+    /**
+     * Exercise style
+     */
+    exercise_style: ExerciseStyle;
+    /**
+     * Expiration date
+     */
+    expiry: string;
+    /**
+     * Whether the contract is liquidation-only
+     */
+    is_liquidation_only: boolean;
+    /**
+     * Whether the contract is marginable
+     */
+    is_marginable: boolean;
+    /**
+     * Listing type
+     */
+    listing_type: ListingType;
+    /**
+     * Contract multiplier (100 for standard options)
+     */
+    multiplier: string;
+    /**
+     * Strike price
+     */
+    strike_price: string;
+    /**
+     * OSI symbol (e.g. "AAPL 251219C00150000")
+     */
+    symbol: string;
+    /**
+     * Open interest (number of outstanding contracts), if available
+     */
+    open_interest?: number | null;
+    /**
+     * OEMS instrument ID of the underlying instrument, if resolvable
+     */
+    underlying_instrument_id?: string | null;
+}
+export type OptionsContractList = Array<OptionsContract>;
+export interface InstrumentGetInstrumentByIDResponse extends Shared.BaseResponse {
+    /**
+     * Represents a tradable financial instrument.
+     */
+    data: Instrument;
+}
+export interface InstrumentGetInstrumentsResponse extends Shared.BaseResponse {
+    data: InstrumentCoreList;
+}
+export interface InstrumentGetOptionContractsResponse extends Shared.BaseResponse {
+    data: OptionsContractList;
+}
+export interface InstrumentSearchInstrumentsResponse extends Shared.BaseResponse {
+    data: InstrumentCoreList;
+}
+export interface InstrumentGetInstrumentByIDParams {
+    /**
+     * When true, include unique options expiry dates for this instrument
+     */
+    include_options_expiry_dates?: boolean | null;
+}
+export interface InstrumentGetInstrumentsParams {
+    /**
+     * Filter by easy to borrow status
+     */
+    easy_to_borrow?: boolean;
+    /**
+     * Comma-separated OEMS instrument UUIDs
+     */
+    instrument_ids?: Array<string>;
+    /**
+     * Filter by instrument type (e.g. COMMON_STOCK, OPTION)
+     */
+    instrument_type?: 'COMMON_STOCK' | 'OPTION' | 'CASH';
+    /**
+     * Filter by liquidation only status
+     */
+    is_liquidation_only?: boolean;
+    /**
+     * Filter by marginable status
+     */
+    is_marginable?: boolean;
+    /**
+     * Filter by publicly traded partnership (PTP) status
+     */
+    is_ptp?: boolean;
+    /**
+     * Filter by short prohibited status
+     */
+    is_short_prohibited?: boolean;
+    /**
+     * Filter by threshold security status
+     */
+    is_threshold_security?: boolean;
+    /**
+     * 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;
+}
+export interface InstrumentGetOptionContractsParams {
+    /**
+     * Filter by contract type: CALL or PUT
+     */
+    contract_type?: ContractType;
+    /**
+     * Filter to contracts expiring on this date (YYYY-MM-DD)
+     */
+    expiry?: 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;
+    /**
+     * Underlier symbol (e.g., AAPL, SPX)
+     */
+    underlier?: string;
+    /**
+     * OEMS instrument UUID or symbol of the underlying equity/index
+     */
+    underlying_instrument_id?: OrdersAPI.InstrumentIDOrSymbol;
+}
+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.
+     */
+    q: string;
+    /**
+     * Comma-separated asset classes (EQUITY|OPTION|WARRANT|BOND|FX|OTHER). Defaults to
+     * EQUITY.
+     */
+    asset_class?: string;
+    /**
+     * Optional listing-country filter (e.g., US).
+     */
+    country?: string;
+    /**
+     * Optional ISO currency filter (e.g., USD).
+     */
+    currency?: string;
+    /**
+     * Include inactive instruments. Default false.
+     */
+    include_inactive?: boolean;
+    /**
+     * Include publicly traded partnership (PTP) instruments. Default true (penalized
+     * in ranking).
+     */
+    include_ptp?: boolean;
+    /**
+     * 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;
+}
+export declare namespace Instruments {
+    export { type ContractType as ContractType, type ExerciseStyle as ExerciseStyle, type Instrument as Instrument, type InstrumentCore as InstrumentCore, type InstrumentCoreList as InstrumentCoreList, type ListingType as ListingType, type OptionsContract as OptionsContract, type OptionsContractList as OptionsContractList, type InstrumentGetInstrumentByIDResponse as InstrumentGetInstrumentByIDResponse, type InstrumentGetInstrumentsResponse as InstrumentGetInstrumentsResponse, type InstrumentGetOptionContractsResponse as InstrumentGetOptionContractsResponse, type InstrumentSearchInstrumentsResponse as InstrumentSearchInstrumentsResponse, type InstrumentGetInstrumentByIDParams as InstrumentGetInstrumentByIDParams, type InstrumentGetInstrumentsParams as InstrumentGetInstrumentsParams, type InstrumentGetOptionContractsParams as InstrumentGetOptionContractsParams, type InstrumentSearchInstrumentsParams as InstrumentSearchInstrumentsParams, };
+}
+//# sourceMappingURL=instruments.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"instruments.d.ts","sourceRoot":"","sources":["../../src/resources/v1/instruments.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,KAAK,MAAM,qBAAkB;AACpC,OAAO,KAAK,SAAS,oBAAiB;AACtC,OAAO,KAAK,KAAK,gBAAa;AAC9B,OAAO,EAAE,UAAU,EAAE,kCAA+B;AACpD,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAGhE;;GAEG;AACH,qBAAa,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;OAUG;IACH,iBAAiB,CACf,YAAY,EAAE,SAAS,CAAC,oBAAoB,EAC5C,KAAK,GAAE,iCAAiC,GAAG,IAAI,GAAG,SAAc,EAChE,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,mCAAmC,CAAC;IAIlD;;;;;;;;OAQG;IACH,cAAc,CACZ,KAAK,GAAE,8BAA8B,GAAG,IAAI,GAAG,SAAc,EAC7D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,gCAAgC,CAAC;IAI/C;;;;;;;;;;;OAWG;IACH,kBAAkB,CAChB,KAAK,GAAE,kCAAkC,GAAG,IAAI,GAAG,SAAc,EACjE,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,oCAAoC,CAAC;IAInD;;;;;;;;;;;;;;;;;OAiBG;IACH,iBAAiB,CACf,KAAK,EAAE,iCAAiC,EACxC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,mCAAmC,CAAC;CAGnD;AAED;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,MAAM,GAAG,KAAK,CAAC;AAE1C;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,UAAU,GAAG,UAAU,CAAC;AAEpD;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,cAAc,EAAE,OAAO,CAAC;IAExB;;OAEG;IACH,eAAe,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,mBAAmB,EAAE,OAAO,CAAC;IAE7B;;OAEG;IACH,aAAa,EAAE,OAAO,CAAC;IAEvB;;;OAGG;IACH,MAAM,EAAE,OAAO,CAAC;IAEhB;;OAEG;IACH,mBAAmB,EAAE,OAAO,CAAC;IAE7B;;OAEG;IACH,qBAAqB,EAAE,OAAO,CAAC;IAE/B;;OAEG;IACH,WAAW,EAAE,OAAO,CAAC;IAErB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,eAAe,CAAC,EAAE,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC;IAE5C;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;;OAGG;IACH,oBAAoB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAE5C;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAElC;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC9B;AAED,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,cAAc,EAAE,OAAO,CAAC;IAExB;;OAEG;IACH,eAAe,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,mBAAmB,EAAE,OAAO,CAAC;IAE7B;;OAEG;IACH,aAAa,EAAE,OAAO,CAAC;IAEvB;;;OAGG;IACH,MAAM,EAAE,OAAO,CAAC;IAEhB;;OAEG;IACH,mBAAmB,EAAE,OAAO,CAAC;IAE7B;;OAEG;IACH,qBAAqB,EAAE,OAAO,CAAC;IAE/B;;OAEG;IACH,WAAW,EAAE,OAAO,CAAC;IAErB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,eAAe,CAAC,EAAE,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC;IAE5C;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAElC;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC9B;AAED,MAAM,MAAM,kBAAkB,GAAG,KAAK,CAAC,cAAc,CAAC,CAAC;AAEvD;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG,UAAU,GAAG,MAAM,GAAG,KAAK,CAAC;AAEtD;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,aAAa,EAAE,YAAY,CAAC;IAE5B;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,cAAc,EAAE,aAAa,CAAC;IAE9B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,mBAAmB,EAAE,OAAO,CAAC;IAE7B;;OAEG;IACH,aAAa,EAAE,OAAO,CAAC;IAEvB;;OAEG;IACH,YAAY,EAAE,WAAW,CAAC;IAE1B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,wBAAwB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1C;AAED,MAAM,MAAM,mBAAmB,GAAG,KAAK,CAAC,eAAe,CAAC,CAAC;AAEzD,MAAM,WAAW,mCAAoC,SAAQ,MAAM,CAAC,YAAY;IAC9E;;OAEG;IACH,IAAI,EAAE,UAAU,CAAC;CAClB;AAED,MAAM,WAAW,gCAAiC,SAAQ,MAAM,CAAC,YAAY;IAC3E,IAAI,EAAE,kBAAkB,CAAC;CAC1B;AAED,MAAM,WAAW,oCAAqC,SAAQ,MAAM,CAAC,YAAY;IAC/E,IAAI,EAAE,mBAAmB,CAAC;CAC3B;AAED,MAAM,WAAW,mCAAoC,SAAQ,MAAM,CAAC,YAAY;IAC9E,IAAI,EAAE,kBAAkB,CAAC;CAC1B;AAED,MAAM,WAAW,iCAAiC;IAChD;;OAEG;IACH,4BAA4B,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;CAC/C;AAED,MAAM,WAAW,8BAA8B;IAC7C;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE/B;;OAEG;IACH,eAAe,CAAC,EAAE,cAAc,GAAG,QAAQ,GAAG,MAAM,CAAC;IAErD;;OAEG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAE9B;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IAExB;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAE9B;;OAEG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAEhC;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,kCAAkC;IACjD;;OAEG;IACH,aAAa,CAAC,EAAE,YAAY,CAAC;IAE7B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,wBAAwB,CAAC,EAAE,SAAS,CAAC,oBAAoB,CAAC;CAC3D;AAED,MAAM,WAAW,iCAAiC;IAChD;;;;OAIG;IACH,CAAC,EAAE,MAAM,CAAC;IAEV;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAE3B;;;OAGG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,CAAC,OAAO,WAAW,WAAW,CAAC;IACnC,OAAO,EACL,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mCAAmC,IAAI,mCAAmC,EAC/E,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,oCAAoC,IAAI,oCAAoC,EACjF,KAAK,mCAAmC,IAAI,mCAAmC,EAC/E,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,kCAAkC,IAAI,kCAAkC,EAC7E,KAAK,iCAAiC,IAAI,iCAAiC,GAC5E,CAAC;CACH"}

package/resources/v1/instruments.js

@@ -0,0 +1,75 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Instruments = void 0;
+const resource_1 = require("../../core/resource.js");
+const path_1 = require("../../internal/utils/path.js");
+/**
+ * Retrieve core details and discovery endpoints for tradable instruments.
+ */
+class Instruments extends resource_1.APIResource {
+    /**
+     * Retrieves detailed information for a specific instrument.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.v1.instruments.getInstrumentByID(
+     *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     *   );
+     * ```
+     */
+    getInstrumentByID(instrumentID, query = {}, options) {
+        return this._client.get((0, path_1.path) `/v1/instruments/${instrumentID}`, { query, ...options });
+    }
+    /**
+     * Retrieves a list of tradeable instruments.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.v1.instruments.getInstruments();
+     * ```
+     */
+    getInstruments(query = {}, options) {
+        return this._client.get('/v1/instruments', { query, ...options });
+    }
+    /**
+     * List options contracts.
+     *
+     * Returns options contracts for a given underlier with options-specific metadata.
+     * Exactly one underlier identifier must be provided.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.v1.instruments.getOptionContracts();
+     * ```
+     */
+    getOptionContracts(query = {}, options) {
+        return this._client.get('/v1/instruments/options/contracts', { query, ...options });
+    }
+    /**
+     * 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
+     * shares, ADRs, ETFs, and exchange-traded mutual funds). Pass `asset_class=OPTION`
+     * to search option contracts by symbol or alternate identifier.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.v1.instruments.searchInstruments({ q: 'q' });
+     * ```
+     */
+    searchInstruments(query, options) {
+        return this._client.get('/v1/instruments/search', { query, ...options });
+    }
+}
+exports.Instruments = Instruments;
+//# sourceMappingURL=instruments.js.map

package/resources/v1/instruments.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"instruments.js","sourceRoot":"","sources":["../../src/resources/v1/instruments.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAMlD,uDAAiD;AAEjD;;GAEG;AACH,MAAa,WAAY,SAAQ,sBAAW;IAC1C;;;;;;;;;;OAUG;IACH,iBAAiB,CACf,YAA4C,EAC5C,QAA8D,EAAE,EAChE,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,mBAAmB,YAAY,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxF,CAAC;IAED;;;;;;;;OAQG;IACH,cAAc,CACZ,QAA2D,EAAE,EAC7D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,iBAAiB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpE,CAAC;IAED;;;;;;;;;;;OAWG;IACH,kBAAkB,CAChB,QAA+D,EAAE,EACjE,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,mCAAmC,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtF,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,iBAAiB,CACf,KAAwC,EACxC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,wBAAwB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3E,CAAC;CACF;AA/ED,kCA+EC"}

package/resources/v1/instruments.mjs

@@ -0,0 +1,71 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../../core/resource.mjs";
+import { path } from "../../internal/utils/path.mjs";
+/**
+ * Retrieve core details and discovery endpoints for tradable instruments.
+ */
+export class Instruments extends APIResource {
+    /**
+     * Retrieves detailed information for a specific instrument.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.v1.instruments.getInstrumentByID(
+     *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     *   );
+     * ```
+     */
+    getInstrumentByID(instrumentID, query = {}, options) {
+        return this._client.get(path `/v1/instruments/${instrumentID}`, { query, ...options });
+    }
+    /**
+     * Retrieves a list of tradeable instruments.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.v1.instruments.getInstruments();
+     * ```
+     */
+    getInstruments(query = {}, options) {
+        return this._client.get('/v1/instruments', { query, ...options });
+    }
+    /**
+     * List options contracts.
+     *
+     * Returns options contracts for a given underlier with options-specific metadata.
+     * Exactly one underlier identifier must be provided.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.v1.instruments.getOptionContracts();
+     * ```
+     */
+    getOptionContracts(query = {}, options) {
+        return this._client.get('/v1/instruments/options/contracts', { query, ...options });
+    }
+    /**
+     * 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
+     * shares, ADRs, ETFs, and exchange-traded mutual funds). Pass `asset_class=OPTION`
+     * to search option contracts by symbol or alternate identifier.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.v1.instruments.searchInstruments({ q: 'q' });
+     * ```
+     */
+    searchInstruments(query, options) {
+        return this._client.get('/v1/instruments/search', { query, ...options });
+    }
+}
+//# sourceMappingURL=instruments.mjs.map

package/resources/v1/instruments.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"instruments.mjs","sourceRoot":"","sources":["../../src/resources/v1/instruments.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAMlD,OAAO,EAAE,IAAI,EAAE,sCAAkC;AAEjD;;GAEG;AACH,MAAM,OAAO,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;OAUG;IACH,iBAAiB,CACf,YAA4C,EAC5C,QAA8D,EAAE,EAChE,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,mBAAmB,YAAY,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxF,CAAC;IAED;;;;;;;;OAQG;IACH,cAAc,CACZ,QAA2D,EAAE,EAC7D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,iBAAiB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpE,CAAC;IAED;;;;;;;;;;;OAWG;IACH,kBAAkB,CAChB,QAA+D,EAAE,EACjE,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,mCAAmC,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtF,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,iBAAiB,CACf,KAAwC,EACxC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,wBAAwB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3E,CAAC;CACF"}