API Reference

Libraries

TypeScript

0.0.1

npm install @clear-street/clearstreet

Read Docs

Python

0.0.1

pip install clearstreet

Read Docs

Java

0.0.1

implementation("com.clearstreet.api:clear-street-java:0.0.1")

Read Docs

Go

0.0.1

go get -u 'github.com/clear-street/clear-street-go@v0.0.1'

Read Docs

CLI tool

0.0.1

Read Docs

API Overview

V1

V1Accounts

Manage trading accounts, balances, and portfolio history.

Get Accounts

GET/v1/accounts

Get Account By ID

GET/v1/accounts/{account_id}

Patch Account By ID

PATCH/v1/accounts/{account_id}

Get Account Balances

GET/v1/accounts/{account_id}/balances

Get Portfolio History

GET/v1/accounts/{account_id}/portfolio-history

List non-trade activities

GET/v1/accounts/{account_id}/non-trade-activities

V1API Version

Endpoints for API service metadata.

Get the API version.

GET/v1/version

V1Calendar

Access clocks and financial calendars for market sessions and events.

Get Clock

GET/v1/clock

Get Market Hours Calendar.

GET/v1/calendars/market-hours

Get Economic Calendar Events

GET/v1/calendars/economic-events

V1Instrument Data

Retrieve instrument analytics, market data, news, and related reference data.

Get All Instrument Events

GET/v1/instruments/events

Get Instrument Events

GET/v1/instruments/{instrument_id}/events

Get Instrument Fundamentals

GET/v1/instruments/{instrument_id}/fundamentals

Get Instrument Balance Sheet Statements

GET/v1/instruments/{instrument_id}/balance-sheets

Get Instrument Income Statements

GET/v1/instruments/{instrument_id}/income-statements

Get Instrument Analyst Consensus

GET/v1/instruments/{instrument_id}/analyst-reporting

Get Instrument Earnings Transcripts

GET/v1/instruments/{instrument_id}/earnings-transcripts

Get Instrument Cash Flow Statements

GET/v1/instruments/{instrument_id}/cash-flow-statements

V1Instrument DataMarket Data

Retrieve instrument analytics, market data, news, and related reference data.

Get Snapshots

GET/v1/market-data/snapshot

Get Daily Aggregate Summaries

Deprecated

GET/v1/market-data/daily-summary

V1Instrument DataNews

Retrieve instrument analytics, market data, news, and related reference data.

Get News

GET/v1/news

V1Instruments

Retrieve core details and discovery endpoints for tradable instruments.

Get Instruments

GET/v1/instruments

Get Instrument By ID

GET/v1/instruments/{instrument_id}

Search Instruments

GET/v1/instruments/search

Get Option Contracts

GET/v1/instruments/options/contracts

V1Locates

Query locate requests, granted locates, and cached locate borrow rates.

List Locate Rates

GET/v1/locates/rates

Get Locate Rate

GET/v1/locates/rates/{instrument_id}

List Locates

GET/v1/accounts/{account_id}/locates

Get Locate

GET/v1/accounts/{account_id}/locates/{id}

V1Omni AI

V1Omni AIEntitlements

Thread-centric AI assistant for conversational trading. Create threads to start conversations, poll response objects for in-progress output, and read finalized messages from thread history. Thread/message/response endpoints require an explicit account_id. Entitlement endpoints are caller-scoped and use account_ids.

Get Entitlements

Deprecated

GET/v1/omni-ai/entitlements

Create Entitlements

POST/v1/omni-ai/entitlements

Delete Entitlement

Deprecated

DELETE/v1/omni-ai/entitlements/{entitlement_id}

Get Entitlement Status

GET/v1/omni-ai/entitlement-status

Opt Out Of Entitlements

POST/v1/omni-ai/entitlements/opt-out

Get Entitlement Agreements

GET/v1/omni-ai/entitlement-agreements

V1Omni AIMessages

Thread-centric AI assistant for conversational trading. Create threads to start conversations, poll response objects for in-progress output, and read finalized messages from thread history. Thread/message/response endpoints require an explicit account_id. Entitlement endpoints are caller-scoped and use account_ids.

Get Message

GET/v1/omni-ai/messages/{message_id}

Submit Feedback

POST/v1/omni-ai/messages/{message_id}/feedback

V1Omni AIResponses

Thread-centric AI assistant for conversational trading. Create threads to start conversations, poll response objects for in-progress output, and read finalized messages from thread history. Thread/message/response endpoints require an explicit account_id. Entitlement endpoints are caller-scoped and use account_ids.

Get Response By ID

GET/v1/omni-ai/responses/{response_id}

Cancel Response

DELETE/v1/omni-ai/responses/{response_id}

V1Omni AIThreads

Thread-centric AI assistant for conversational trading. Create threads to start conversations, poll response objects for in-progress output, and read finalized messages from thread history. Thread/message/response endpoints require an explicit account_id. Entitlement endpoints are caller-scoped and use account_ids.

Get Threads

GET/v1/omni-ai/threads

Get Thread

GET/v1/omni-ai/threads/{thread_id}

Create Thread

POST/v1/omni-ai/threads

Get Thread Response

GET/v1/omni-ai/threads/{thread_id}/response

Get Messages

GET/v1/omni-ai/threads/{thread_id}/messages

Create Message

POST/v1/omni-ai/threads/{thread_id}/messages

V1Orders

Place, monitor, and manage trading orders.

Get Orders

GET/v1/accounts/{account_id}/orders

Get Order By ID

GET/v1/accounts/{account_id}/orders/{order_id}

Submit Orders

POST/v1/accounts/{account_id}/orders

Replace Order

PATCH/v1/accounts/{account_id}/orders/{order_id}

Cancel Open Order

DELETE/v1/accounts/{account_id}/orders/{order_id}

Cancel All Open Orders

DELETE/v1/accounts/{account_id}/orders

Get Executions

GET/v1/accounts/{account_id}/executions

Preview Orders

POST/v1/accounts/{account_id}/orders/preview

V1Positions

View positions and manage position instructions.

Get Positions

GET/v1/accounts/{account_id}/positions

Close Positions

DELETE/v1/accounts/{account_id}/positions

Close Position

DELETE/v1/accounts/{account_id}/positions/{instrument_id}

Get Position Instructions

GET/v1/accounts/{account_id}/positions/instructions

Submit Position Instructions

POST/v1/accounts/{account_id}/positions/instructions

Cancel Position Instruction

DELETE/v1/accounts/{account_id}/positions/instructions/{instruction_id}

V1Private Markets

Browse private-market offerings and their indicative terms. Access requires the account holder to hold an accreditation attestation.

Get SPV

GET/v1/private-markets/spvs/{spv_id}

Get Company

GET/v1/private-markets/companies/{company_id}

V1Private MarketsIois

Browse private-market offerings and their indicative terms. Access requires the account holder to hold an accreditation attestation.

List every live IOI for the caller's account-holder entity.

GET/v1/private-markets/iois

Create an IOI for a visible upcoming offering.

POST/v1/private-markets/iois

Update an IOI's notional, accepting the current NDA revision when required.

PATCH/v1/private-markets/iois/{ioi_id}

Withdraw a live IOI. Repeating a withdrawal returns 404.

DELETE/v1/private-markets/iois/{ioi_id}

V1Private MarketsOfferings

Browse private-market offerings and their indicative terms. Access requires the account holder to hold an accreditation attestation.

List Offerings

GET/v1/private-markets/offerings

Get Offering

GET/v1/private-markets/offerings/{offering_id}

V1Screener

Search instruments and manage saved screeners.

Search Screener

POST/v1/screener

Get Screeners

GET/v1/saved-screeners

Get Screener By ID

GET/v1/saved-screeners/{screener_id}

Create Screener

POST/v1/saved-screeners

Replace Screener

Deprecated

PUT/v1/saved-screeners/{screener_id}

Patch Screener

PATCH/v1/saved-screeners/{screener_id}

Delete Screener

DELETE/v1/saved-screeners/{screener_id}

Get Screener Catalog

GET/v1/screener/catalog

V1Watchlist

Create and manage watchlists.

Get Watchlists

GET/v1/watchlists

Get Watchlist By ID

GET/v1/watchlists/{watchlist_id}

Create Watchlist

POST/v1/watchlists

Delete Watchlist

DELETE/v1/watchlists/{watchlist_id}

Add Watchlist Item

POST/v1/watchlists/{watchlist_id}/items

Delete Watchlist Item

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