Ledger balances

Historical balances

Retrieve accurate historical balance information with the Python SDK.

GET/balances/{balance_id}/at

Use blnk.ledger_balances.get_at to retrieve a balance at a specific point in time.

Call the method

response = blnk.ledger_balances.get_at(
  "bln_5ce86029-3c2e-4e2a-aae2-7fb931ca4c4f",
  {
    "timestamp": "2025-02-24T08:55:26Z",
  },
)
FieldTypeDescription
balanceIdstrBalance ID to query.
timestampstrSpecifies the exact date and time for which a historical balance is requested. Use ISO 8601 format (for example 2025-02-24T08:55:26Z).
from_sourceboolWhen True, reconstruct from transactions instead of snapshots.

Use the historical amounts

Read response.data["balance"] for net, credit, and debit totals at the requested timestamp. Compare with current balance if you are auditing or reconciling.

Response

{
  "timestamp": "2025-02-24T08:55:26Z",
  "from_source": false,
  "balance": {
    "balance_id": "bln_5ce86029-3c2e-4e2a-aae2-7fb931ca4c4f",
    "balance": 5000,
    "credit_balance": 5000,
    "debit_balance": 0,
    "currency": "USD"
  }
}
FieldTypeDescription
timestampstrPoint in time you queried (ISO 8601).
from_sourceboolWhether the balance was reconstructed from transactions.
balance.balance_idstrBalance you queried.
balance.balancenumberNet amount at that timestamp.
balance.credit_balancenumberTotal credits at that timestamp.
balance.debit_balancenumberTotal debits at that timestamp.
balance.currencystrCurrency of the balance.