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 client.LedgerBalance.CreateSnapshot to trigger balance snapshot processing on demand.
1

Call the method

client.LedgerBalance.CreateSnapshot
result, resp, err := client.LedgerBalance.CreateSnapshot(blnkgo.CreateBalanceSnapshotRequest{
	BatchSize: 500,
})
FieldTypeDescription
BatchSizeintOptional. Server default is 1000. Omit or set to 0 to use the default.
2

Wait for completion

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

Response

200 OK
{
  "message": "Snapshotting in progress. should be completed shortly"
}
FieldTypeDescription
messagestringStatus 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.