Documentation

Entities

entities

Methods

List Entities -> { data }
get/entities

List all available entities.

Get Entity ->
Entity
get/entities/{entity_id}

Get an entity by its ID.

Domain types

Entity = { client_code, entity_id, legal_name }
PnlSummary = { day_pnl, entity_id, equity, 15 more... }
PortfolioMargin = { add_on_requirement, add_on_requirement_percent, concentration_add_on, 18 more... }
RegtMargin = { day_trade_buying_power, effective_requirement, exchange_requirement, 11 more... }
Entities

Pnl Summaries

entities.pnl_summaries

Methods

Get Entity Pnl Summary ->
PnlSummary
get/entities/{entity_id}/pnl-summary

Get PNL summary for all accounts in an entity.

Entities

Portfolio Margins

entities.portfolio_margins

Methods

Get Portfolio Margin ->
PortfolioMargin
get/entities/{entity_id}/portfolio-margin

Get latest portfolio margin calculation for the given entity

Entities

Regt Margin Simulations

entities.regt_margin_simulations

Methods

Create Reg T Simulation -> { simulation_id }
post/entities/{entity_id}/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.

Get Reg T Simulation ->
RegtMarginSimulation
get/entities/{entity_id}/regt-margin-simulations/{simulation_id}

Get a Reg-T margin simluation that was previously created. Note, simulations are automatically deleted after 48-hours.

Domain types

SimulationID = string

Unique ID for a simulation.

Entities

Regt Margins

entities.regt_margins

Methods

Get Reg T Margin ->
RegtMargin
get/entities/{entity_id}/regt-margin

Get the latest Reg-T margin calculation for the given entity