API Reference

V1

Websocket

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Websocket Handler

v1().websocket().websocketHandler(WebsocketWebsocketHandlerParamsparams = WebsocketWebsocketHandlerParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

GET/v1/ws

Upgrade the HTTP connection to a WebSocket and echo incoming messages.

ParametersExpand Collapse

WebsocketWebsocketHandlerParams params

Websocket Handler

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.websocket.WebsocketWebsocketHandlerParams;

public final class Main {
    private Main() {}

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

        client.v1().websocket().websocketHandler();
    }
}

Returns Examples