## Get Watchlist By ID

`WatchlistGetWatchlistByIdResponse v1().watchlist().getWatchlistById(WatchlistGetWatchlistByIdParamsparams = WatchlistGetWatchlistByIdParams.none(), RequestOptionsrequestOptions = RequestOptions.none())`

**get** `/v1/watchlists/{watchlist_id}`

Get a watchlist by ID with all its items

### Parameters

- `WatchlistGetWatchlistByIdParams params`

  - `Optional<String> watchlistId`

### Returns

- `class WatchlistGetWatchlistByIdResponse:`

  - `WatchlistDetail data`

    Detailed watchlist with all items

    - `String id`

      Watchlist ID

    - `LocalDateTime createdAt`

      Creation timestamp

    - `List<WatchlistItemEntry> items`

      Items in the watchlist

      - `String id`

        Item ID

      - `LocalDateTime addedAt`

        When the item was added

      - `Optional<String> addedPrice`

        Price when the item was added

      - `Optional<Instrument> instrument`

        Instrument details

        - `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<String> adv`

          Average daily share volume from the security definition.

        - `Optional<LocalDate> expiry`

          The expiration date for options instruments

        - `Optional<SecurityType> 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<String> longMarginRate`

          The percent of a long position's value you must post as margin

        - `Optional<String> name`

          The full name of the instrument or its issuer

        - `Optional<String> 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<List<LocalDate>> optionsExpiryDates`

          Available options expiration dates for this instrument.
          Present only when `include_options_expiry_dates=true` in the request.

        - `Optional<String> previousClose`

          Last close price from the security definition.

        - `Optional<String> shortMarginRate`

          The percent of a short position's value you must post as margin

        - `Optional<String> strikePrice`

          The strike price for options instruments

    - `String name`

      Watchlist name

### 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.watchlist.WatchlistGetWatchlistByIdParams;
import com.clear_street.api.models.v1.watchlist.WatchlistGetWatchlistByIdResponse;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        ClearStreetClient client = ClearStreetOkHttpClient.builder()
            .fromEnv()
            .apiKey("My API Key")
            .build();

        WatchlistGetWatchlistByIdResponse response = client.v1().watchlist().getWatchlistById("550e8400-e29b-41d4-a716-446655440000");
    }
}
```

#### Response

```json
{
  "data": {
    "created_at": "2025-01-15T10:00:00.000000000Z",
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "items": [
      {
        "added_at": "2025-01-16T09:30:00.000000000Z",
        "added_price": "150.25",
        "id": "660e8400-e29b-41d4-a716-446655440001",
        "instrument": {
          "country_of_issue": "US",
          "currency": "USD",
          "easy_to_borrow": true,
          "id": "a1a2a3a4-b1b2-c1c2-d1d2-d3d4d5d6d7d8",
          "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,
          "name": "Apple Inc.",
          "symbol": "AAPL",
          "venue": "XNMS"
        }
      }
    ],
    "name": "Tech Stocks"
  },
  "error": null,
  "metadata": {
    "request_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef"
  }
}
```