Skip to content

House Margin

GET
/house-margin

This endpoint returns margin-related information for the specified account. The ratio {house_margin_req / house_equity} is used by the clearing firm to issue margin warnings.

If this ratio exceeds 50%, then 75%, then 90%, you will receive a margin warning (currently this is done over email). At 100%, you will receive a margin call.

The margin requirement value is calculated based on many factors including your margin account type (PM vs Reg-T), the concentration and correlation of your portfolio, whether there are offsetting positons, value-at-risk, etc.

Parameters

Header Parameters

X-API-KEY*
Type
string
Required

Query Parameters

account_number*
Type
string
Required

Responses

Margin Information

application/json
JSON
{
  
"account": "clearing_firm_account_number",
  
"system_Dt": "2026-02-02",
  
"marginType": "CPM",
  
"equity": 10000000,
  
"sodEquity": 10000000,
  
"lmv": 3000000,
  
"smv": 0,
  
"pl": 40000,
  
"macroStress": -200000.59,
  
"vaR": -270067.3,
  
"concentrationCheck1": -250000.71,
  
"concentrationCheck2": -620231.04,
  
"finalHouse": 4500000,
  
"houseExcess": 5500000,
  
"isStale": false
}

Playground

Headers
Variables
Key
Value

Samples

Powered by VitePress OpenAPI