Clear Street Trading API
A unified, secure, and high-performance RESTful API for all client interactions with the Active trading platform. This specification provides a single source…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
A unified, secure, and high-performance RESTful API for all client interactions with the Active trading platform.
This specification provides a single source of truth for the API surface, covering order management, trade execution, market data, and account services.
Authentication
All endpoints require authentication via a JWT Bearer token provided in the Authorization header.
Response Structure
All responses, both for success and error, adhere to a standard envelope structure:
data: Contains the response payload on success, ornullon error.error: Contains a structured error object on failure, ornullon success.metadata: Contains therequest_idand pagination information.
Endpoints 81
API version
- GETGet the API version.
/v1/versionReturns the current version string for this API endpoint.
Accounts
- GETGet Accounts
/v1/accountsList accounts the authenticated user has permission to access. Results can be narrowed with the optional account_id and account_name filters. account_id is a… - GETGet Account By ID
/v1/accounts/:account_idFetch account details by ID, including the mailing address, date of birth, phone number, and country of tax residency of the account-holder entity when on file. - PATCHPatch Account By ID
/v1/accounts/:account_idUpdate account risk settings - GETGet Account Balances
/v1/accounts/:account_id/balancesFetch account balance information - GETList non-trade activities
/v1/accounts/:account_id/non-trade-activitiesResults are paginated. - GETGet Portfolio History
/v1/accounts/:account_id/portfolio-history?start_date=2024-01-01Retrieves daily portfolio history for the specified account.
Orders
- GETGet Executions
/v1/accounts/:account_id/executionsRetrieves filled and partially-filled execution reports for the specified trading account, ordered by transaction time (nanosecond precision) descending. - GETGet Orders
/v1/accounts/:account_id/ordersList orders for an account with optional filtering - POSTSubmit Orders
/v1/accounts/:account_id/ordersSubmit new orders - DELETECancel All Open Orders
/v1/accounts/:account_id/ordersCancel all orders for an account - POSTPreview Orders
/v1/accounts/:account_id/orders/previewPreview the impact of orders without submitting them. For each order the engine evaluates every pre-trade risk check and projects the account's balances and… - GETGet Order By ID
/v1/accounts/:account_id/orders/:order_idFetch a single order. The {order_id} path parameter accepts either the order's id or its client_order_id. A client_order_id can only be used while the order… - DELETECancel Open Order
/v1/accounts/:account_id/orders/:order_idCancel a specific order - PATCHReplace Order
/v1/accounts/:account_id/orders/:order_idReplace an order with new parameters
Positions
- GETGet Positions
/v1/accounts/:account_id/positionsRetrieves all positions for the specified trading account. - DELETEClose Positions
/v1/accounts/:account_id/positionsDelete all positions within an account. Closes all positions for the specified trading account. - GETGet Position Instructions
/v1/accounts/:account_id/positions/instructionsReturns the current lifecycle state of the account's position instructions. Optionally filter by a specific contract. Note: instructions that fail… - POSTSubmit Position Instructions
/v1/accounts/:account_id/positions/instructionsSubmit one or more position instructions (Exercise, Do-Not-Exercise, Contrary Exercise Advice) against the account. Batch semantics: All rows accepted → 200… - DELETECancel Position Instruction
/v1/accounts/:account_id/positions/instructions/:instruction_idCancel an outstanding position instruction by its server-assigned id. Returns the updated instruction with status CANCEL_REQUESTED. The terminal CANCELLED or… - DELETEClose Position
/v1/accounts/:account_id/positions/:instrument_idDelete a position within an account for an instrument. Retrieves orders generated to close the position.
Watchlist
- GETGet Watchlists
/v1/watchlistsList watchlists for the authenticated user - POSTCreate Watchlist
/v1/watchlists - GETGet Watchlist By ID
/v1/watchlists/:watchlist_idGet a watchlist by ID with all its items - DELETEDelete Watchlist
/v1/watchlists/:watchlist_idDelete a watchlist and all its items - POSTAdd Watchlist Item
/v1/watchlists/:watchlist_id/itemsAdd an instrument to a watchlist - DELETEDelete Watchlist Item
/v1/watchlists/:watchlist_id/items/:item_idDelete an instrument from a watchlist
Instruments
- GETGet Instruments
/v1/instrumentsRetrieves a list of tradeable instruments. - GETGet Option Contracts
/v1/instruments/options/contractsList options contracts. Returns options contracts with options-specific metadata. Exactly one identifier must be provided: root/underlying_instrument_id (list… - GETSearch Instruments
/v1/instruments/search?q=stringSearch instruments by symbol, alternate identifier, or company name. The q parameter is case-insensitive and supports ticker symbols, alternate identifiers… - GETGet Instrument By ID
/v1/instruments/:instrument_idRetrieves detailed information for a specific instrument.
Instrument Data
- GETGet All Instrument Events
/v1/instruments/eventsList instrument events across all securities, grouped by date. Results are paginated via page_size / page_token; a date's events may span two pages. Date… - GETGet Instrument Analyst Consensus
/v1/instruments/:instrument_id/analyst-reportingRetrieves analyst ratings and price targets for an instrument. - GETGet Instrument Balance Sheet Statements
/v1/instruments/:instrument_id/balance-sheetsGet balance sheet statements for an instrument. Retrieves quarterly balance sheet statements for a specific instrument, sorted by fiscal period (most recent… - GETGet Instrument Cash Flow Statements
/v1/instruments/:instrument_id/cash-flow-statementsGet cash flow statements for an instrument. Retrieves historical cash flow statements for the specified instrument. Cash flow statements show cash inflows and… - GETGet Instrument Earnings Transcripts
/v1/instruments/:instrument_id/earnings-transcriptsRetrieves earnings call transcripts for a specific instrument, newest fiscal period first. Defaults: page_size is 1 and is capped at 5, because each… - GETGet Instrument Events
/v1/instruments/:instrument_id/eventsRetrieves corporate events (earnings, dividends, splits, IPO) for an instrument, grouped by event type. Filter to specific types via event_types. Date range… - GETGet Instrument Fundamentals
/v1/instruments/:instrument_id/fundamentalsRetrieves supplemental fundamentals and company profile data for an instrument. - GETGet Instrument Income Statements
/v1/instruments/:instrument_id/income-statementsRetrieves quarterly income statements for a specific instrument, sorted by fiscal period (most recent first). Date range defaults: from_date: None (no lower… - GETGet Daily Aggregate Summaries
/v1/market-data/daily-summary?instrument_ids=stringDeprecated. Deprecated: use GET /market-data/snapshot instead, which now reports the same open/high/low/volume/open-interest fields under session and… - GETGet Snapshots
/v1/market-data/snapshotGet market data snapshots for one or more securities. Targeting modes are mutually exclusive: instrument_ids (1-100 ids), or underlying_instrument_id + expiry… - GETGet News
/v1/newsRetrieves news items with optional filtering by security IDs, time range, publisher, type, and text query. Pagination metadata does not include total_items or…
Calendar
- GETGet Economic Calendar Events
/v1/calendars/economic-eventsRetrieves macroeconomic calendar events (e.g. CPI, jobs reports, central bank rate decisions), optionally filtered by country, impact, and event time range.… - GETGet Market Hours Calendar.
/v1/calendars/market-hoursRetrieves comprehensive trading hours including pre-market, regular, and after-hours sessions. Returns market status, session times, and next session schedules. - GETGet Clock
/v1/clockReturns the current server time in UTC.
Screener
- GETGet Screeners
/v1/saved-screenersList saved screener configurations. Returns all screener configurations for the authenticated user. - POSTCreate Screener
/v1/saved-screenersCreate a saved screener configuration. Persists a screener configuration for the authenticated user. - GETGet Screener By ID
/v1/saved-screeners/:screener_idGet a saved screener configuration by ID. Returns a single screener configuration for the authenticated user. - PUTReplace Screener
/v1/saved-screeners/:screener_idDeprecated. Update a saved screener configuration. Replaces the screener configuration for the authenticated user. If name is null, the existing name is… - DELETEDelete Screener
/v1/saved-screeners/:screener_idDelete a saved screener configuration. Deletes the screener configuration for the authenticated user. - PATCHPatch Screener
/v1/saved-screeners/:screener_idPartially update a saved screener configuration. Every field is optional. Omitting a field, or sending it as null, leaves the stored value unchanged. Sending… - POSTSearch Screener
/v1/screenerSearch instruments using structured filters. Compose a request with filters, plus optional sorts, columns, and page_size/page_token for pagination. Each… - GETGet Screener Catalog
/v1/screener/catalogReturns the complete screener field catalog: the field kinds, the per-field data, the enum universes, the request-side rules, the built-in variables and…
Omni AI
- GETGet Entitlement Agreements
/v1/omni-ai/entitlement-agreementsList current signable entitlement agreements for consent UX. - GETGet Entitlement Status
/v1/omni-ai/entitlement-statusWhether each entitlement is enabled, per account. Accounts with no recorded choice are enabled by default. Without account_id, covers every account the caller… - GETGet Entitlements
/v1/omni-ai/entitlementsDeprecated. List caller's active entitlement grants. Deprecated -- use GET /omni-ai/entitlement-status; this lists explicit grants only and omits accounts… - POSTCreate Entitlements
/v1/omni-ai/entitlementsRecord consent and upsert one-or-more active grants. - POSTOpt Out Of Entitlements
/v1/omni-ai/entitlements/opt-outTurn off one-or-more entitlements for the given accounts. Idempotent: accounts that are already opted out are left as they are. To turn an entitlement back… - DELETEDelete Entitlement
/v1/omni-ai/entitlements/:entitlement_idDeprecated. Revoke one entitlement grant by id. Deprecated -- use POST /omni-ai/entitlements/opt-out. - GETGet Message
/v1/omni-ai/messages/:message_idRead a finalized message using its parent thread for ownership and linked-account authorization. In-progress assistant messages are not available here; use… - POSTSubmit Feedback
/v1/omni-ai/messages/:message_id/feedbackAttach a score and optional comment to a finalized assistant message. Feedback is only valid for messages with role ASSISTANT that have reached a terminal… - GETGet Response By ID
/v1/omni-ai/responses/:response_idPoll the current snapshot of an in-progress or completed assistant response. While its status is queued or running, content may be partial and include… - DELETECancel Response
/v1/omni-ai/responses/:response_idCancel a queued or running response. Canceling a running response (Stop) also cancels every queued response in the thread that answers a user message.… - GETGet Threads
/v1/omni-ai/threadsList authorized conversation metadata, most recently active first (by updated_at, which a new message moves). Use page_size and page_token for pagination, and… - POSTCreate Thread
/v1/omni-ai/threadsAtomically create a conversation and submit its first user turn. Use instant with text for a prompt, or deep_insights with a ticker target and optional thesis… - GETGet Thread
/v1/omni-ai/threads/:thread_idRead an owned thread's metadata. Use GET /omni-ai/threads/{thread_id}/messages for conversation history. Omission or another account selection does not change… - GETGet Messages
/v1/omni-ai/threads/:thread_id/messagesList finalized messages, including messages created before the account link. Return the latest page by default, in chronological order within each page. Use… - POSTCreate Message
/v1/omni-ai/threads/:thread_id/messagesAppend a user message to an existing thread and start an assistant response. Poll the returned response_id via GET /omni-ai/responses/{response_id} for… - GETGet Thread Response
/v1/omni-ai/threads/:thread_id/responseReturns the running response, or else the next queued response. Poll it while a thread is open to follow every response in order, including answers that start…
Locates
- GETList Locates
/v1/accounts/:account_id/locatesList locates for the account on one effective date, which defaults to today's New York calendar date. Filter by comma-separated statuses and instrument ids or… - GETGet Locate
/v1/accounts/:account_id/locates/:idFetch one locate by id, matched against the locate request id, locate id, and client request id, across all days in force. - GETList Locate Rates
/v1/locates/rates?instrument_ids=stringFetch the cached locate borrow rates for up to 1,000 instruments. The response returns one row per requested instrument, in request order. Each row carries… - GETGet Locate Rate
/v1/locates/rates/:instrument_idFetch the cached locate borrow rate for one instrument. Rates refresh periodically; 404 means no rate is currently cached for the instrument.
Private Markets
- GETGet Company
/v1/private-markets/companies/:company_id?account_id=0Fetch one published private-market company with its complete versioned profile. Requires the account holder to have attested. Returns 404 when the company… - GETList every live IOI for the caller's account-holder entity.
/v1/private-markets/iois?account_id=0 - POSTCreate an IOI for a visible upcoming offering.
/v1/private-markets/iois?account_id=0 - DELETEWithdraw a live IOI. Repeating a withdrawal returns 404.
/v1/private-markets/iois/:ioi_id?account_id=0 - PATCHUpdate an IOI's notional, accepting the current NDA revision when required.
/v1/private-markets/iois/:ioi_id?account_id=0 - GETList Offerings
/v1/private-markets/offerings?account_id=0List every visible private-market offering as a card, with its derived class, company and SPV identity, and indicative terms. Requires the account holder to… - GETGet Offering
/v1/private-markets/offerings/:offering_id?account_id=0Fetch one visible private-market offering with its documents, participants, and any attached SPV. Requires the account holder to have attested. Returns 404… - GETGet SPV
/v1/private-markets/spvs/:spv_id?account_id=0Fetch one private-market SPV's complete economics and fee schedule. Requires the account holder to have attested. Returns 404 unless the SPV is OPEN and…
API details
- Base URL
https://api.clearstreet.comhttps://api-dev.clearstreet.comhttp://localhost:5001- Authentication
- A bearer token in the Authorization header
- Operations
- 81 operations on 62 pathsGET 52POST 13DELETE 11PATCH 4PUT 1
4 marked deprecated - Main resources
- Omni AI 16Instrument Data 11Orders 8Private Markets 8Screener 8Accounts 6Positions 6Watchlist 6Instruments 4Locates 4
- Response formats
application/json- Description format
- OpenAPI 3.1.0, API version
2025-10-31 - Links
- OpenAPI document · Support
- Listed from
- Clearstreet's published OpenAPI description
How to test the Clear Street Trading API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Clear Street Trading API collection, without the publisher's secrets.
- Add your credentialsThis API uses A bearer token in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Get the API version.” (GET /v1/version), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Clear Street Trading API?
A unified, secure, and high-performance RESTful API for all client interactions with the Active trading platform. This specification provides a single source… It is listed under Finance & banking and has 81 endpoints.
Who publishes the Clear Street Trading API?
It is listed from Clearstreet's public API description (an OpenAPI document), not published by Clearstreet on Swastik Codes. Anyone who controls clearstreet.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Clear Street Trading API?
Its description lists 3 base URLs: https://api.clearstreet.com, https://api-dev.clearstreet.com, http://localhost:5001. The first is the usual one; the others are typically sandbox or regional servers.
How do I authenticate with the Clear Street Trading API?
With A bearer token in the Authorization header.
How many endpoints does the Clear Street Trading API have?
81 operations on 62 paths (52 GET, 13 POST, 11 DELETE, 4 PATCH, 1 PUT). The largest groups are Omni AI, Instrument Data, Orders, Private Markets.
Is forking the Clear Street Trading API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.