POST /v2/updates/update-by-offset

Lookup an update by its offset. If there is no update with this offset, or all the events are filtered, an UPDATE_NOT_FOUND error will be raised.

POST /v2/updates/update-by-offset

POST /v2/updates/update-by-offset

cURL

curl --request POST \
  --url https://api.example.com/v2/updates/update-by-offset \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "offset": 123,
  "updateFormat": {
    "includeReassignments": {
      "filtersByParty": {},
      "filtersForAnyParty": {
        "cumulative": [
          {
            "identifierFilter": {
              "Empty": {}
            }
          }
        ]
      },
      "verbose": true
    },
    "includeTopologyEvents": {
      "includeParticipantAuthorizationEvents": {
        "parties": [
          "<string>"
        ]
      }
    }
  }
}
'

200

{
  "update": {
    "OffsetCheckpoint": {
      "value": {
        "offset": 123,
        "synchronizerTimes": [
          {
            "synchronizerId": "<string>",
            "recordTime": "<string>"
          }
        ]
      }
    }
  }
}

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

Body

application/json

offset · integer<int64> · required

The offset of the update being looked up. Must be a valid absolute offset (positive integer).

Required

updateFormat · UpdateFormat · object · required

The format for the update.

Required

Show child attributes

Response

200

application/json

update · Update · object

Update

Update

Update

Update

Show child attributes