Getting Started

Clear Street Studio's API allows you to programmatically drive many of the workflows that are available through UI portal.

Studio uses modern RESTful + WebSocket APIs. The REST API gives you a synchronous interface for reading data, in addition to supporting several write-flows like placing orders, or requesting a locate. The WebSocket API allows you to listen for asynchronous events, like order-updates, position-updates, etc. For these APIs, we also provide a Sandbox environment (detailed throughout the docs) for testing purposes.

To get started, read through our REST API docs, and then check out the REST API reference.