API Reference

V1

Watchlist

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Create Watchlist

WatchlistCreateWatchlistResponse v1().watchlist().createWatchlist(WatchlistCreateWatchlistParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

POST/v1/watchlists

Create Watchlist

ParametersExpand Collapse

WatchlistCreateWatchlistParams params

String name

The desired watchlist name.

ReturnsExpand Collapse

class WatchlistCreateWatchlistResponse:

WatchlistEntry data

Represents a user watchlist.

String id

The unique identifier for the watchlist.

formatuuid

LocalDateTime createdAt

The timestamp when the watchlist was created.

formatdate-time

String name

The user-provided watchlist name.

Create Watchlist

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

public final class Main {
    private Main() {}

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

        WatchlistCreateWatchlistParams params = WatchlistCreateWatchlistParams.builder()
            .name("name")
            .build();
        WatchlistCreateWatchlistResponse response = client.v1().watchlist().createWatchlist(params);
    }
}

200 example

400 example

409 example

{
  "data": {
    "created_at": "2025-01-23T12:00:00.000000000Z",
    "id": "770e8400-e29b-41d4-a716-446655440002",
    "name": "Growth Stocks"
  },
  "error": null,
  "metadata": {
    "request_id": "b2c3d4e5-f6a7-8901-2345-678901bcdefg"
  }
}

{
  "error": {
    "code": 400,
    "message": "Failed to parse the request body as JSON: trailing comma at line 3 column 1"
  },
  "metadata": {
    "request_id": "72348112-c92d-4610-829a-f769c82a9a0f"
  }
}

{
  "error": {
    "code": 409,
    "message": "Resource already exists"
  },
  "metadata": {
    "request_id": "0efec74c-7d58-4fef-b73b-df50731e4f6b"
  }
}

Returns Examples

200 example

400 example

409 example

{
  "data": {
    "created_at": "2025-01-23T12:00:00.000000000Z",
    "id": "770e8400-e29b-41d4-a716-446655440002",
    "name": "Growth Stocks"
  },
  "error": null,
  "metadata": {
    "request_id": "b2c3d4e5-f6a7-8901-2345-678901bcdefg"
  }
}

{
  "error": {
    "code": 400,
    "message": "Failed to parse the request body as JSON: trailing comma at line 3 column 1"
  },
  "metadata": {
    "request_id": "72348112-c92d-4610-829a-f769c82a9a0f"
  }
}

{
  "error": {
    "code": 409,
    "message": "Resource already exists"
  },
  "metadata": {
    "request_id": "0efec74c-7d58-4fef-b73b-df50731e4f6b"
  }
}