GET /v2/state/ledger-end

Get the current ledger end. Subscriptions started with the returned offset will serve events after this RPC was called.

GET /v2/state/ledger-end

GET /v2/state/ledger-end

cURL

curl --request GET \
  --url https://api.example.com/v2/state/ledger-end \
  --header 'Authorization: Bearer <token>'

200

{
  "offset": 123
}

Endpoint history: Added in 3.4. Modified in 3.5: description updated; response 400 description updated.

Authorizations

httpAuthapiKeyAuth

Authorization · string · header · required

Ledger API standard JWT token

Response

200

application/json

offset · integer<int64>

It will always be a non-negative integer. If zero, the participant view of the ledger is empty. If positive, the absolute offset of the ledger as viewed by the participant.

Optional