Skip to main content
POST

JSON Ledger API

Lookup an update by its offset

OpenAPISince 3.4Changed 3.5
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.

Protocol Details

Operation IDpostV2UpdatesUpdate-by-offset
AuthenticationBearer token
Published3.5

Inputs

Request body

application/json
number
required
OpenAPI type: integer (int64).The offset of the update being looked up. Must be a valid absolute offset (positive integer). Required
object
required
OpenAPI type: UpdateFormat.A format specifying what updates to include and how to render them.

Outputs

200

application/json
Update

400

text/plain
string
required

default

application/json
string
required
string
required
string
string
Map_String
required
Tuple2_String_String[]
integer (int32)
required
integer (int32)
string
boolean

History

Changed3.5

The POST /v2/updates/update-by-offset operation changed in this snapshot.

Introduced3.4