Skip to content
clear-street
  • Auto
  • Light
  • Dark
Get started
API Reference
Overview

API Reference

Libraries

TypeScript
0.44.0
npm install @clear-street-internal/sdk
Read Docs

API Overview

Active

ActiveV1

ActiveV1Accounts

Fetch account details by ID
get/active/v1/accounts/{account_id}
List accounts the authenticated user has permission to access
get/active/v1/accounts
Update account risk settings
patch/active/v1/accounts/{account_id}

ActiveV1AccountsBalances

Fetch account balance information
get/active/v1/accounts/{account_id}/balances

ActiveV1AccountsLocates

Create a locate request.
post/active/v1/accounts/{account_id}/locates
Get locate requests.
get/active/v1/accounts/{account_id}/locates
Update a locate request.
patch/active/v1/accounts/{account_id}/locates

ActiveV1AccountsLocatesInventory

Get locate inventory.
get/active/v1/accounts/{account_id}/locates/inventory

ActiveV1AccountsOrders

Cancel all orders for an account
delete/active/v1/accounts/{account_id}/orders
Cancel a specific order
delete/active/v1/accounts/{account_id}/orders/{order_id}
Get order by ID
get/active/v1/accounts/{account_id}/orders/{order_id}
List orders for an account with optional filtering
get/active/v1/accounts/{account_id}/orders
Replace an order with new parameters
patch/active/v1/accounts/{account_id}/orders/{order_id}
Submit new orders
post/active/v1/accounts/{account_id}/orders

ActiveV1AccountsPortfolio History

Get account portfolio history.
get/active/v1/accounts/{account_id}/portfolio-history

ActiveV1AccountsPositions

Delete a position within an account for an instrument.
delete/active/v1/accounts/{account_id}/positions/{security_id_source}/{security_id}
Delete all positions within an account.
delete/active/v1/accounts/{account_id}/positions
Get account positions.
get/active/v1/accounts/{account_id}/positions

ActiveV1API Keys

Create a new API key
post/active/v1/api_keys
List API keys for the authenticated user
get/active/v1/api_keys
Revoke a specific API key
delete/active/v1/api_keys/{id}
Revoke all API keys for the authenticated user
delete/active/v1/api_keys

ActiveV1Calendars

ActiveV1CalendarsDividends

Get dividends calendar.
get/active/v1/calendars/dividends

ActiveV1CalendarsEarnings

Get earnings calendar.
get/active/v1/calendars/earnings

ActiveV1CalendarsEconomic

Get economic calendar.
get/active/v1/calendars/economic

ActiveV1CalendarsMarket Hours

Get market hours calendar.
get/active/v1/calendars/market-hours

ActiveV1CalendarsMergers Acquisitions

Get mergers and acquisitions calendar.
get/active/v1/calendars/mergers-acquisitions

ActiveV1CalendarsSplits

Get stock splits calendar.
get/active/v1/calendars/splits

ActiveV1CalendarsSummary

Get calendar summary.
get/active/v1/calendars/summary

ActiveV1Instruments

Get instrument by ID.
get/active/v1/instruments/{security_id_source}/{security_id}
List instruments.
get/active/v1/instruments

ActiveV1InstrumentsAnalyst Reporting

Get analyst consensus.
get/active/v1/instruments/{security_id_source}/{security_id}/analyst-reporting

ActiveV1InstrumentsEvents

List instrument events across all securities.
get/active/v1/instruments/events
Get instrument events.
get/active/v1/instruments/{security_id_source}/{security_id}/events

ActiveV1InstrumentsReporting

Get instrument reporting data.
get/active/v1/instruments/{security_id_source}/{security_id}/reporting

ActiveV1InstrumentsVenues

Get trading venues.
get/active/v1/instruments/venues

ActiveV1Iris

ActiveV1IrisFeedback

Create feedback on a message (deprecated).
Deprecated
post/active/v1/iris/feedback

ActiveV1IrisRuns

Cancel a running assistant run (deprecated).
Deprecated
delete/active/v1/iris/runs/{run_id}
Get run status and events (deprecated).
Deprecated
get/active/v1/iris/runs/{run_id}
Start a new assistant run (deprecated).
Deprecated
post/active/v1/iris/runs

ActiveV1IrisThreads

Get a specific thread (deprecated).
Deprecated
get/active/v1/iris/threads/{thread_id}
List conversation threads (deprecated).
Deprecated
get/active/v1/iris/threads

ActiveV1IrisThreadsMessages

List messages in a thread (deprecated).
Deprecated
get/active/v1/iris/threads/{thread_id}/messages

ActiveV1Market Data

ActiveV1Market DataSnapshot

Get market data snapshots for one or more securities.
get/active/v1/market-data/snapshot

ActiveV1News

Get news.
get/active/v1/news

ActiveV1Omni AI

ActiveV1Omni AIFeedback

Create feedback on a message.
post/active/v1/omni-ai/feedback

ActiveV1Omni AIRuns

Cancel a running assistant run.
delete/active/v1/omni-ai/runs/{run_id}
Get run status and events.
get/active/v1/omni-ai/runs/{run_id}
Start a new assistant run.
post/active/v1/omni-ai/runs

ActiveV1Omni AIThreads

Get a specific thread.
get/active/v1/omni-ai/threads/{thread_id}
List conversation threads.
get/active/v1/omni-ai/threads

ActiveV1Omni AIThreadsMessages

List messages in a thread.
get/active/v1/omni-ai/threads/{thread_id}/messages

ActiveV1Saved Screeners

Create a saved screener configuration.
post/active/v1/saved-screeners
Delete a saved screener configuration.
delete/active/v1/saved-screeners/{screener_id}
Get a saved screener configuration by ID.
get/active/v1/saved-screeners/{screener_id}
List saved screener configurations.
get/active/v1/saved-screeners
Update a saved screener configuration.
put/active/v1/saved-screeners/{screener_id}

ActiveV1Screener

Screen instruments.
get/active/v1/screener

ActiveV1Version

Get the API version.
get/active/v1/version
Update API version preferences.
patch/active/v1/version

ActiveV1Watchlists

Create a new watchlist
post/active/v1/watchlists
Delete a watchlist and all its items
delete/active/v1/watchlists/{watchlist_id}
Get a watchlist by ID with all its items
get/active/v1/watchlists/{watchlist_id}
List watchlists for the authenticated user
get/active/v1/watchlists

ActiveV1WatchlistsItems

Add an instrument to a watchlist
post/active/v1/watchlists/{watchlist_id}/items
Delete an instrument from a watchlist
delete/active/v1/watchlists/{watchlist_id}/items/{item_id}

ActiveV1Ws

Upgrade the HTTP connection to a WebSocket and echo incoming messages.
get/active/v1/ws