Documentation | Accounts › List Accounts

API Reference

Accounts

accounts

Methods

List Accounts -> { data }

get/accounts

List all available accounts.

Response fields

data: Array<

Account

Optional

Request example

curl https://api.clearstreet.io/studio/v2/accounts \
    -H "Authorization: Bearer $STUDIO_SDK_BEARER_TOKEN"

200Example

{
  "data": [
    {
      "account_id": "x",
      "account_number": "ACC0001",
      "entity_id": "x",
      "name": "Clear Street"
    }
  ]
}

Get Account ->

Account

get/accounts/{account_id}

Get an account by its ID or number.

Domain types

Account = { account_id, account_number, entity_id, 1 more... }

Accounts

Bulk Orders

accounts.bulk_orders

Methods

Create Bulk Orders -> { data, rejected, submitted }

post/accounts/{account_id}/bulk-orders

Creates multiple orders in a single request, up to 1000. Note that a successful call to this endpoint does not necessarily mean your orders have been accepted, e.g. a downstream venue might reject your order. You should therefore utilize our WebSocket APIs to listen for changes in order lifecycle events.

The response will contain an array of objects, indicating whether your order was submitted. If the order was submitted, the order_id field will be populated with the order ID assigned to this order. If the order was rejected, the reason field will be populated with the reason for rejection. The data array returned in the response object is guaranteed to be ordered in the same order as the orders you provided in the request. Again, note that even if your order was submitted, that doesn't mean it was accepted, and may still be rejected by downstream venues.

Accounts

Easy Borrows

accounts.easy_borrows

Methods

List Easy Borrows -> { data }

get/accounts/{account_id}/easy-borrows

List all current easy-to-borrow stock symbols. This list changes dynamically daily.

Accounts

Holdings

accounts.holdings

Methods

List Holdings -> { account_id, account_number, data, 4 more... }

get/accounts/{account_id}/holdings

List holdings for a given account, filtered on the given query parameters. This endpoint will return either historical or real-time holdings directly from our custodial systems. Positions returned here are can be different than positions returned from the Execution API. While the Execution API returns positions based on trading activity within Studio, our custodial system returns all positions regardless of where trades occur.

Accounts

Inventories

accounts.inventories

Methods

Get Inventory -> { account_id, account_number, available, 3 more... }

get/accounts/{account_id}/inventories/{symbol}

Get located inventory for a symbol.

Accounts

Locate Orders

accounts.locate_orders

Methods

Create Locate Order ->

LocateOrder

post/accounts/{account_id}/locate-orders

Create locate order to borrow inventory for short-selling.

List Locate Orders -> { data }

get/accounts/{account_id}/locate-orders

List all locate orders

Get Locate Order ->

LocateOrder

get/accounts/{account_id}/locate-orders/{locate_order_id}

Get locate order by its unique locate order ID.

Update Locate Order ->

patch/accounts/{account_id}/locate-orders/{locate_order_id}

Accept or decline locate order that has been offered.

Accounts

Orders

accounts.orders

Methods

Delete Order ->

delete/accounts/{account_id}/orders/{order_id}

Attempts to cancel an existing order. Cancelling an order cannot be guaranteed as there might be in-flight executions.

Create Order -> { order_id }

post/accounts/{account_id}/orders

Creates a new order and sends to our internal systems for execution. Note that a successful call to this endpoint does not necessarily mean your order has been accepted, e.g. a downstream venue might reject your order. You should therefore utilize our WebSocket APIs to listen for changes in order lifecycle events.

Delete All Orders -> { data }

delete/accounts/{account_id}/orders

Attempts to cancel all open orders for a given account. Cancelling an order cannot be guaranteed as there might be in-flight executions.

List Orders -> { data, next_page_token }

get/accounts/{account_id}/orders

List orders for a given account for the current trading day, filtered on the given query parameters.

Update Order ->

patch/accounts/{account_id}/orders/{order_id}

Attempts to update an existing order. This can be used to update a subset of an order's attributes, for example price and quantity.

Get Order -> { order }

get/accounts/{account_id}/orders/{order_id}

Get an order that was previously created.

Accounts

Pnl Details

accounts.pnl_details

Methods

List Account Pnl Details -> { data }

get/accounts/{account_id}/pnl-details

List PNL details for a given account.

Accounts

Pnl Summary

accounts.pnl_summary

Methods

Get Account Pnl Summary ->

PnlSummary

get/accounts/{account_id}/pnl-summary

Get PNL summary for a given account.

Accounts

Pnl Sums

accounts.pnl_sums

Methods

List Pnl Sums -> { account_id, account_number, data, 10 more... }

get/accounts/{account_id}/pnl-sums

List historical PNL summations for a given account over a given date range, filtered on the given query parameters.

Accounts

Positions

accounts.positions

Methods

List Positions -> { data, next_page_token }

get/accounts/{account_id}/positions

List current positions for a given account.

Get Position ->

Position

get/accounts/{account_id}/positions/{symbol}

Get current position for a given account for a given symbol.

Accounts

Trades

accounts.trades

Methods

List Trades -> { data, next_page_token }

get/accounts/{account_id}/trades

List trades for a given account for the current trading day.

Get Trade ->

Trade

get/accounts/{account_id}/trades/{trade_id}

Get trade a trade by its unique trade ID.