State

Get Entity Metadata Page

Returns all the metadata properties associated with a given global entity. The returned response is in a paginated format, ordered by first appearance on the ledger.

post/state/entity/page/metadata

Request body

cursorstring nullable

This cursor allows forward pagination, by providing the cursor from the previous request.

limit_per_pageinteger nullable

The page size requested.

addressstring required

Bech32m-encoded human readable version of the address.

Example request

{
  "address": "<entity-address>"
}

Response

Entity Metadata (paginated)

total_countinteger nullable

Total number of items in underlying collection, fragment of which is available in items collection.

next_cursorstring nullable

If specified, contains a cursor to query next page of the items collection.

addressstring required

Bech32m-encoded human readable version of the address.

Example response

{
  "ledger_state": {
    "network": "<network-name>"
  }
}

Changes

Changed in 3 of the 50 revisions of this API.53

Dec 10, 202400c5f3bf5c2132See the full diff
- ▲
  the response property //////// became nullable for the status
  response-property-became-nullable
- ▲
  the response property ///////////// became nullable for the status
  response-property-became-nullable
- ▲
  the response property ///////////// became nullable for the status
  response-property-became-nullable
- ○
  the request property //// became nullable
  request-property-became-nullable
- ○
  the request property //// became nullable
  request-property-became-nullable
Dec 9, 20246ccf7b2ba0b02See the full diff
- ▲
  the request property //// became not nullable
  request-property-became-not-nullable
- ▲
  the request property //// became not nullable
  request-property-became-not-nullable
May 14, 20247601c23b1af11See the full diff
- ○
  added AccountLockerNotFoundError discriminator mapping keys to the response property for the response status
  response-property-discriminator-mapping-added

Full history