---
title: "Paper balance"
method: GET
path: "/api/bot/v1/balance"
tags: ["Paper trading"]
---

# Paper balance

`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`

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.

## Response `200`

ok

- Balance
  - `starting_balance_usd` number
  - `balance_usd` number
  - `equity_usd` number
  - `margin_in_use_usd` number
  - `free_margin_usd` number
  - `unrealized_pnl_usd` number: 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_enforced` boolean: Whether this book is a real budget. Set it on GET|POST /api/bot/v2/sim.

---

[API](https://skmtc.dev/marginpad/apis/marginpad-free-crypto-api.md) · [All operations](https://skmtc.dev/marginpad/apis/marginpad-free-crypto-api/llms.txt) · [OpenAPI document](https://skmtc.dev/marginpad/apis/marginpad-free-crypto-api/revisions/27d21fcd0bf0?raw)
