Jump to Content

Guides API Reference

Studio Olympus Log In

API Reference

Guides API Reference

OAuth2 Authentication

Access Tokenpost

Reference API

Entities
- List entitiesget
- Get entityget
Accounts
- List accountsget
- Get accountget
Instruments
- Get instrumentget

Execution API

Orders
Trades
- Get tradeget
- List tradesget
Positions
- Get positionget
- List positionsget
WebSockets
- Activity Channel

Lending API

Locates
Rates
- List easy borrowsget
Inventories
- Get inventoryget

Risk & Margin API

PNL
Margin
- Get Reg-T marginget
- Get portfolio marginget
Margin Simulations
- Create Reg-T simulationpost
- Get Reg-T simulationget

Custodial API

Performance
- List PNL Sumsget
Holdings
- List holdingsget

Get entity PNL summary

get https://api.clearstreet.io/studio/v2/entities/{entity_id}/pnl-summary

Get PNL summary for all accounts in an entity.

Language

Credentials

Bearer

JWT

URL