Skip to main content
POST
/
balances-snapshots
Balance snapshots
curl --request POST \
  --url http://localhost:5001/balances-snapshots \
  --header 'X-blnk-key: <api-key>'
Use blnk.LedgerBalances.createSnapshot to trigger balance snapshot processing on demand.
blnk.LedgerBalances.createSnapshot
const response = await blnk.LedgerBalances.createSnapshot({ batch_size: 500 });
FieldDescription
batch_sizeOptional. Server default is 1000.

​
Response shape

200 OK
{
  "message": "Snapshotting in progress. should be completed shortly"
}
FieldDescription
messageStatus message when the snapshot job starts.

How balance snapshots work

When Core runs snapshots and why they matter.

Balance snapshots

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.