API Reference

V1

Watchlist

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Delete Watchlist Item

JsonValue v1().watchlist().deleteWatchlistItem(WatchlistDeleteWatchlistItemParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

DELETE/v1/watchlists/{watchlist_id}/items/{item_id}

Delete an instrument from a watchlist

ParametersExpand Collapse

WatchlistDeleteWatchlistItemParams params

String watchlistId

Optional<String> itemId

ReturnsExpand Collapse

class WatchlistDeleteWatchlistItemResponse:

Delete Watchlist Item

Java

HTTP

TypeScript

Python

Java

Go

CLI Tool

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.WatchlistDeleteWatchlistItemParams;
import com.clear_street.api.models.v1.watchlist.WatchlistDeleteWatchlistItemResponse;

public final class Main {
    private Main() {}

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

        WatchlistDeleteWatchlistItemParams params = WatchlistDeleteWatchlistItemParams.builder()
            .watchlistId("550e8400-e29b-41d4-a716-446655440000")
            .itemId("660e8400-e29b-41d4-a716-446655440001")
            .build();
        WatchlistDeleteWatchlistItemResponse response = client.v1().watchlist().deleteWatchlistItem(params);
    }
}

200 example

404 example

{
  "data": null,
  "metadata": {
    "request_id": "5b0709e3-5868-4116-9a84-26f1b8c30503"
  }
}

{
  "error": {
    "code": 404,
    "message": "Some requested entity was not found"
  },
  "metadata": {
    "request_id": "8462e079-739c-421b-b2d2-35cf007b4fc7"
  }
}

Returns Examples

200 example

404 example

{
  "data": null,
  "metadata": {
    "request_id": "5b0709e3-5868-4116-9a84-26f1b8c30503"
  }
}

{
  "error": {
    "code": 404,
    "message": "Some requested entity was not found"
  },
  "metadata": {
    "request_id": "8462e079-739c-421b-b2d2-35cf007b4fc7"
  }
}