Method Name
private/get_margin
private/get_marginCalculates margin for a given subaccount and (optionally) a simulated state change. Does not take into account
open orders margin requirements.
Required minimum session key permission level is read_only
Parameters
| subaccount_idintegerrequired Subaccount_id |
| simulated_collateral_changesarray of objects Optional, add collaterals to simulate deposits / withdrawals / spot trades |
| simulated_collateral_changes[].amountstringrequired Collateral amount to simulate |
| simulated_collateral_changes[].asset_namestringrequired Collateral ERC20 asset name (e.g. ETH, USDC, WSTETH) |
| simulated_position_changesarray of objects Optional, add positions to simulate perp / option trades |
| simulated_position_changes[].amountstringrequired Position amount to simulate |
| simulated_position_changes[].instrument_namestringrequired Instrument name |
| simulated_position_changes[].entry_pricestring Only for perps. Entry price to use in the simulation. Mark price is used if not provided. |
Response
| idstring or integerrequired |
| resultobjectrequired |
| result.is_valid_tradebooleanrequired True if trade passes margin requirement |
| result.post_initial_marginstringrequired Initial margin requirement post trade |
| result.post_maintenance_marginstringrequired Maintenance margin requirement post trade |
| result.pre_initial_marginstringrequired Initial margin requirement before trade |
| result.pre_maintenance_marginstringrequired Maintenance margin requirement before trade |
| result.subaccount_idintegerrequired Subaccount_id |
Example
{request_example_shell}{request_example_javascript}{request_example_python}The above command returns JSON structured like this:
{response_example_json}