Paper trading

Paper balance

Starting balance, balance, equity, margin in use, free margin, unrealized P&L. The balance is a scorecard: margin_enforced is false, so opens are never rejected for lack of funds.

get/api/bot/v1/balance

Request

  • Base URL: https://marginpad.io
  • URL: https://marginpad.io/api/bot/v1/balance
  • Auth: API key in header X-API-Key

Response

ok

starting_balance_usdnumber
balance_usdnumber
equity_usdnumber
margin_in_use_usdnumber
free_margin_usdnumber
unrealized_pnl_usdnumber

With margin_enforced on, free_margin_usd is balance minus committed margin - unrealized profit on an open isolated position is not collateral for a new one.

margin_enforcedboolean

Whether this book is a real budget. Set it on GET|POST /api/bot/v2/sim.

Changes

No recorded changes to this operation across all 1 revision of this API.