HomeDocumentationAPI Reference
Log In
API Reference

Get Margin

Calculates 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

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
simulated_collateral_changes
array of objects | null
Defaults to null

Optional, add collaterals to simulate deposits / withdrawals / spot trades

simulated_collateral_changes
simulated_position_changes
array of objects | null
Defaults to null

Optional, add positions to simulate perp / option trades

simulated_position_changes
integer
required

Subaccount_id

Response

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json