v2
latestOpenAPI 3.0.02026-07-311824171.4 MBCalculates the Extended Risk Matrix (ERM) and detailed margin information for Portfolio Margin accounts. The ERM provides a comprehensive view of portfolio risk across different scenarios and market conditions.
You can calculate the ERM for a specific currency or for the entire Cross-Collateral portfolio. The response includes margin requirements, risk metrics, and scenario analysis that helps assess portfolio risk under various market conditions.
Use this method to understand margin requirements and risk exposure before making trading decisions in a Portfolio Margin account.
📖 Related Article: Portfolio Margin
Scope: account:read
Query parameters
The currency for which the Extended Risk Matrix will be calculated. Use CROSS for Cross Collateral simulation.
The currency for which the Extended Risk Matrix will be calculated. Use CROSS for Cross Collateral simulation.
If true, adds simulated positions to current positions, otherwise uses only simulated positions. By default true
JSON string containing: object data
Object with positions in following form: {InstrumentName1: Position1, InstrumentName2: Position2...}, for example {"BTC-PERPETUAL": -1.0} (or corresponding URI-encoding for GET). Size in base currency.
Response
Success response