Reporting

Get ledger summary

Returns aggregated balances and flows per asset, optionally scoped to a program or asset and a time window. This report does not accept created_after or created_before.

get/v1/reports/ledger-summary

Request

Base URL: https://api.scrip.dev
URL: https://api.scrip.dev/v1/reports/ledger-summary
Auth: HTTP bearer

Query parameters

program_idstring uuid

Filter by program ID. May be combined with asset_id.

asset_idstring uuid

Filter to a single asset. May be combined with program_id.

period_startstring date-time

Start of the reporting period, inclusive, RFC 3339; send it together with period_end.

period_endstring date-time

End of the reporting period, inclusive, RFC 3339; send it together with period_start.

Response

Ledger summaries

Example response

{
  "data": [
    {
      "asset_id": "a3bb189e-8bf9-4c8b-9be0-6b5d2f4e7a02",
      "asset_name": "Points",
      "asset_symbol": "PTS",
      "closing_balance": "559595",
      "current_balance": "624095",
      "opening_balance": "500000",
      "other_adjustments_net": "-905",
      "participant_count": 15420,
      "period_expired": "2500",
      "period_forfeited": "2000",
      "period_issued": "150000",
      "period_redeemed": "85000",
      "total_expired": "5000",
      "total_forfeited": "20000",
      "total_issued": "1500000",
      "total_redeemed": "850000"
    }
  ],
  "pagination": {
    "has_more": true,
    "next_cursor": "YWJjMTIz"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.