## Get Instrument By ID `InstrumentGetInstrumentByIdResponse v1().instruments().getInstrumentById(InstrumentGetInstrumentByIdParamsparams = InstrumentGetInstrumentByIdParams.none(), RequestOptionsrequestOptions = RequestOptions.none())` **get** `/v1/instruments/{instrument_id}` Retrieves detailed information for a specific instrument. ### Parameters - `InstrumentGetInstrumentByIdParams params` - `Optional instrumentId` OEMS instrument UUID - `Optional includeOptionsExpiryDates` When true, include unique options expiry dates for this instrument ### Returns - `class InstrumentGetInstrumentByIdResponse:` - `Instrument data` Represents a tradable financial instrument. - `String id` Unique OEMS instrument identifier (UUID) - `String countryOfIssue` The ISO country code of the instrument's issue - `String currency` The ISO currency code in which the instrument is traded - `boolean easyToBorrow` Indicates if the instrument is classified as Easy-To-Borrow - `boolean isLiquidationOnly` Indicates if the instrument is liquidation only and cannot be bought - `boolean isMarginable` Indicates if the instrument is marginable - `boolean isRestricted` Indicates if the instrument is restricted from trading - `boolean isShortProhibited` Indicates if short selling is prohibited for the instrument - `boolean isThresholdSecurity` Indicates if the instrument is on the Regulation SHO Threshold Security List - `boolean isTradable` Indicates if the instrument is tradable - `String symbol` The trading symbol for the instrument - `String venue` The MIC code of the primary listing venue - `Optional adv` Average daily share volume from the security definition. - `Optional expiry` The expiration date for options instruments - `Optional instrumentType` The type of security (e.g., Common Stock, ETF) - `COMMON_STOCK("COMMON_STOCK")` - `PREFERRED_STOCK("PREFERRED_STOCK")` - `OPTION("OPTION")` - `CASH("CASH")` - `OTHER("OTHER")` - `Optional longMarginRate` The percent of a long position's value you must post as margin - `Optional name` The full name of the instrument or its issuer - `Optional notionalAdv` 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. - `Optional> optionsExpiryDates` Available options expiration dates for this instrument. Present only when `include_options_expiry_dates=true` in the request. - `Optional previousClose` Last close price from the security definition. - `Optional shortMarginRate` The percent of a short position's value you must post as margin - `Optional strikePrice` The strike price for options instruments ### Example ```java package com.clear_street.api.example; import com.clear_street.api.client.ClearStreetClient; import com.clear_street.api.client.okhttp.ClearStreetOkHttpClient; import com.clear_street.api.models.v1.instruments.InstrumentGetInstrumentByIdParams; import com.clear_street.api.models.v1.instruments.InstrumentGetInstrumentByIdResponse; public final class Main { private Main() {} public static void main(String[] args) { ClearStreetClient client = ClearStreetOkHttpClient.builder() .fromEnv() .apiKey("My API Key") .build(); InstrumentGetInstrumentByIdResponse response = client.v1().instruments().getInstrumentById("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" } } ```