Ledger balances

Balance snapshots

Capture a balance snapshot with the TypeScript SDK.

POST/balances-snapshots

Use blnk.LedgerBalances.createSnapshot to trigger balance snapshot processing on demand.

Call the method

const response = await blnk.LedgerBalances.createSnapshot({
  batch_size: 500,
});

Field	Type	Description
`batch_size`	`number`	Optional. Server default is 1000.

Wait for completion

Snapshot jobs run asynchronously. Core returns immediately with a status message while processing continues in the background.

Response

{
  "message": "Snapshotting in progress. should be completed shortly"
}

Field	Type	Description
`message`	`string`	Status message when the snapshot job starts.