API Reference

Balance

Read your settled and pending Bitcoin balance.

The Balance object

Your settled and pending Bitcoin balance.

objectstring: Always `"balance"`.
assetstring: Balance asset. Currently always `BTC`.
confirmed_satsinteger: Withdrawable, fully-confirmed balance in satoshis.
total_satsinteger: Confirmed balance plus unconfirmed incoming credits, in satoshis.
confirmed_usdnumber | null: USD value of the confirmed balance. `null` if the live price is unavailable.

Example balance

application/json

{
  "object": "balance",
  "asset": "BTC",
  "confirmed_sats": 1532099,
  "total_sats": 1664198,
  "confirmed_usd": 1159.42
}

read

GET/api/v1/balance

Returns your withdrawable (`confirmed_sats`) and total (`total_sats`) balance for the settlement asset, with a best-effort USD valuation.

curl "https://markgroup.app/api/v1/balance" \
  -H "Authorization: Bearer $MG_API_KEY"

application/json

{
  "object": "balance",
  "asset": "BTC",
  "confirmed_sats": 1532099,
  "total_sats": 1664198,
  "confirmed_usd": 1159.42
}