StudioOlympus
API Reference

Create Reg-T simulation

post
https://api.clearstreet.io/studio/v2/entities//regt-margin-simulations

Simulate Reg-T margin calculation for a given hypothetical set of prices and/or trades. This is useful for understanding the impact of price fluctuations or trades on margin requirements. Once a simulation is created, it remains available for 48-hours, after which it will automatically be deleted.

Simulations created through the API are visible in the Studio UI under the Risk & Margin section, after enabling the "Risk Simulations" toggle.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
length between 1 and 256

Entity ID

Body Params
string
required
1 to 256

A name for this simulation for reference.

prices
array of objects

List of prices to use in the simulation, i.e. fair-market-values you specify for each symbol. If this is not provided, current market prices will be used, if they are available.

prices
trades
array of objects

List of hypothetical trades to include in the simulation, if any.

trades
boolean
Defaults to false

If true, the simulation will ignore any existing positions and balances in the account. Set to true if you want to simulate from a clean slate, i.e. an empty account.

Responses

Updated 3 months ago

Did this page help you?
Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Choose an example:
application/json

Updated 3 months ago

Did this page help you?