Skip to main content
GET
/
v1
/
reports
/
ledger-summary
Get ledger summary
curl --request GET \
  --url https://api.scrip.dev/v1/reports/ledger-summary \
  --header 'X-API-Key: <api-key>'
{
  "data": [
    {
      "asset_id": "550e8400-e29b-41d4-a716-446655440000",
      "asset_name": "Loyalty Points",
      "asset_symbol": "POINTS",
      "closing_balance": "562500.00",
      "current_balance": "625000.00",
      "opening_balance": "500000.00",
      "other_adjustments_net": "3000.00",
      "participant_count": 15420,
      "period_expired": "2500.00",
      "period_forfeited": "2000.00",
      "period_issued": "150000.00",
      "period_redeemed": "85000.00",
      "total_expired": "5000.00",
      "total_forfeited": "20000.00",
      "total_issued": "1500000.00",
      "total_redeemed": "850000.00"
    }
  ],
  "pagination": {
    "has_more": true,
    "next_cursor": "YWJjMTIz"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.scrip.dev/llms.txt

Use this file to discover all available pages before exploring further.

Returns aggregated balances and flows for each asset in your ledger. The response includes total_issued, total_redeemed, total_expired, total_forfeited, current_balance, and participant_count per asset. Pass program_id to scope the summary to a single program. Omit it to get org-wide totals across all programs. All values are computed in real time from the ledger, so they reflect the current state without any delay.
For usage patterns and examples, see the Reporting guide.

Authorizations

​
X-API-Key
string
header
required

API key passed in the X-API-Key header.

Query Parameters

​
program_id
string<uuid>

Filter by program ID

​
from
string<date-time>

Period start (inclusive, RFC3339). Must be provided with to.

​
to
string<date-time>

Period end (inclusive, RFC3339). Must be provided with from.

Response

Ledger summaries

Ledger summary results

​
data
object[]

Per-asset ledger summaries

​
pagination
object

Pagination metadata for list responses