Skip to content
clear-street
Search
Ctrl
K
Auto
Light
Dark
Get started
Guides
API Reference
Get started
TypeScript
HTTP
TypeScript
Guides
API Reference
API Reference
Overview
Active
Overview
V1
Overview
Accounts
Overview
Get Account By ID
Get Accounts
Patch Account By ID
Balances
Overview
Get Account Balances
Locates
Overview
Create Locate Request
Get Locate Requests
Update Locate Request
Inventory
Overview
Get Locate Inventory
Orders
Overview
Cancel All Orders
Cancel Order
Get Order By ID
Get Orders
Replace Order
Submit Orders
Portfolio History
Overview
Get Portfolio History
Positions
Overview
Close Position
Close Positions
Get Positions
API Keys
Overview
Create
List
Revoke
Revoke All
Calendars
Overview
Dividends
Overview
Get Dividends Calendar
Earnings
Overview
Get Earnings Calendar
Economic
Overview
Get Economic Calendar
Market Hours
Overview
Get Market Hours Calendar
Mergers Acquisitions
Overview
Get Mergers And Acquisitions Calendar
Splits
Overview
Get Splits Calendar
Summary
Overview
Get Calendar Summary
Instruments
Overview
Get Instrument By ID
Get Instruments
Analyst Reporting
Overview
Get Instrument Analyst Consensus
Events
Overview
Get All Instrument Events
Get Instrument Events
Reporting
Overview
Get Instrument Reporting
Venues
Overview
Get Venues
Iris
Overview
Feedback
Overview
Create Feedback Deprecated
Runs
Overview
Cancel Run Deprecated
Get Run Deprecated
Start Run Deprecated
Threads
Overview
Get Thread Deprecated
List Threads Deprecated
Messages
Overview
List Messages Deprecated
Market Data
Overview
Snapshot
Overview
Get Snapshots
News
Overview
Get News
Omni AI
Overview
Feedback
Overview
Create Feedback
Runs
Overview
Cancel Run
Get Run
Start Run
Threads
Overview
Get Thread
List Threads
Messages
Overview
List Messages
Saved Screeners
Overview
Create Screener
Delete Screener
Get Screener By ID
List Screeners
Update Screener
Screener
Overview
Get Screener
Version
Overview
Get Version
Update Version
Watchlists
Overview
Create Watchlist
Delete Watchlist
Get Watchlist By ID
Get Watchlists
Items
Overview
Add Watchlist Item
Delete Watchlist Item
Ws
Overview
Websocket Handler
Auto
Light
Dark
API Reference
Active
V1
View as Markdown
View as Markdown
Copy Markdown
Open in
Claude
Open in
ChatGPT
Ws
Upgrade the HTTP connection to a WebSocket and echo incoming messages.
client.active.v1.ws.
websocketHandler
(
RequestOptions
options
?
)
:
void
get
/active/v1/ws