## Get Instrument By ID `$ clear-street v1:instruments get-instrument-by-id` **get** `/v1/instruments/{instrument_id}` Retrieves detailed information for a specific instrument. ### Parameters - `--instrument-id: string` OEMS instrument UUID - `--include-options-expiry-dates: optional boolean` When true, include unique options expiry dates for this instrument ### Returns - `V1InstrumentGetInstrumentByIDResponse: BaseResponse` - `data: object { id, country_of_issue, currency, 19 more }` Represents a tradable financial instrument. - `id: string` Unique OEMS instrument identifier (UUID) - `country_of_issue: string` The ISO country code of the instrument's issue - `currency: string` The ISO currency code in which the instrument is traded - `easy_to_borrow: boolean` Indicates if the instrument is classified as Easy-To-Borrow - `is_liquidation_only: boolean` Indicates if the instrument is liquidation only and cannot be bought - `is_marginable: boolean` Indicates if the instrument is marginable - `is_restricted: boolean` Indicates if the instrument is restricted from trading - `is_short_prohibited: boolean` Indicates if short selling is prohibited for the instrument - `is_threshold_security: boolean` Indicates if the instrument is on the Regulation SHO Threshold Security List - `is_tradable: boolean` Indicates if the instrument is tradable - `symbol: string` The trading symbol for the instrument - `venue: string` The MIC code of the primary listing venue - `adv: optional string` Average daily share volume from the security definition. - `expiry: optional string` The expiration date for options instruments - `instrument_type: optional "COMMON_STOCK" or "PREFERRED_STOCK" or "OPTION" or 2 more` The type of security (e.g., Common Stock, ETF) - `"COMMON_STOCK"` - `"PREFERRED_STOCK"` - `"OPTION"` - `"CASH"` - `"OTHER"` - `long_margin_rate: optional string` The percent of a long position's value you must post as margin - `name: optional string` The full name of the instrument or its issuer - `notional_adv: optional string` 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. - `options_expiry_dates: optional array of string` Available options expiration dates for this instrument. Present only when `include_options_expiry_dates=true` in the request. - `previous_close: optional string` Last close price from the security definition. - `short_margin_rate: optional string` The percent of a short position's value you must post as margin - `strike_price: optional string` The strike price for options instruments ### Example ```cli clear-street v1:instruments get-instrument-by-id \ --api-key 'My API Key' \ --instrument-id 182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e ``` #### Response ```json { "data": { "country_of_issue": "US", "currency": "USD", "easy_to_borrow": true, "id": "0f5a1a4e-5b3e-4d8f-9b7a-2b1d0e3f4a5b", "instrument_type": "COMMON_STOCK", "is_liquidation_only": false, "is_marginable": true, "is_restricted": false, "is_short_prohibited": false, "is_threshold_security": false, "is_tradable": true, "long_margin_rate": "0.25", "name": "Apple Inc.", "short_margin_rate": "0.25", "symbol": "AAPL", "venue": "XNMS" }, "error": null, "metadata": { "request_id": "5b6c7d8e-9f0a-1b2c-3d4e-5f6a7b8c9d0e" } } ```