Skip to main content
GET
/
balances
/
{balance_id}
/
at
Historical balances
curl --request GET \
  --url http://localhost:5001/balances/{balance_id}/at \
  --header 'X-blnk-key: <api-key>'
Use blnk.LedgerBalances.getAt to retrieve a balance at a specific point in time.
blnk.LedgerBalances.getAt
const response = await blnk.LedgerBalances.getAt(
  'bln_5ce86029-3c2e-4e2a-aae2-7fb931ca4c4f',
  { timestamp: '2025-02-24T08:55:26Z' },
);
FieldDescription
balanceIdBalance ID to query.
timestampSpecifies the exact date and time for which a historical balance is requested. Use ISO 8601 format (for example 2025-02-24T08:55:26Z).
from_sourceWhen true, reconstruct from transactions instead of snapshots.

​
Response shape

200 OK
{
  "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"
  }
}
FieldDescription
timestampPoint in time you queried (ISO 8601).
from_sourceWhether the balance was reconstructed from transactions.
balance.balance_idBalance you queried.
balance.balanceNet amount at that timestamp.
balance.credit_balanceTotal credits at that timestamp.
balance.debit_balanceTotal debits at that timestamp.
balance.currencyCurrency of the balance.

Retrieving historical balances

How point-in-time balance queries work.

Historical balances

HTTP request and response schema.

​
Need help?

We are very happy to help you make the most of Blnk, regardless of whether it is your first time or you are switching from another tool. To ask questions or discuss issues, please contact us or join our Discord community.