Skip to content

StateService.ListDynamicFields ​

List dynamic fields through sui.rpc.v2.StateService/ListDynamicFields on Inodra's Sui gRPC endpoint.

Endpoint ​

NetworkHostAuthentication
Mainnetmainnet-grpc.inodra.com:443x-api-key metadata
Testnettestnet-grpc.inodra.com:443x-api-key metadata

Full method name: sui.rpc.v2.StateService/ListDynamicFields. Unary: one request, one response. Get a key from the dashboard; the same key works on every protocol.

Request: ListDynamicFieldsRequest ​

Request message for NodeService.ListDynamicFields

FieldTypeDescription
parentstringRequired. The UID of the parent, which owns the collections of dynamic fields.
page_sizeuint32The maximum number of dynamic fields to return. The service may return fewer than this value. If unspecified, at most 50 entries will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
page_tokenbytesA page token, received from a previous ListDynamicFields call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListDynamicFields must match the call that provided the page token.
read_maskgoogle.protobuf.FieldMaskMask specifying which fields to read. If no mask is specified, defaults to parent,field_id.

Response: ListDynamicFieldsResponse ​

Response message for NodeService.ListDynamicFields

FieldTypeDescription
dynamic_fieldsrepeated DynamicFieldPage of dynamic fields owned by the specified parent.
next_page_tokenbytesA token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

DynamicField ​

FieldTypeDescription
kindDynamicField.DynamicFieldKind
parentstringObjectId of this dynamic field's parent.
field_idstringObjectId of this dynamic field.
field_objectObjectThe field object itself
nameBcsThe dynamic field's "name"
valueBcsThe dynamic field's "value"
value_typestringThe type of the dynamic field "value". If this is a dynamic object field then this is the type of the object itself (which is a child of this field), otherwise this is the type of the value of this field.
child_idstringThe ObjectId of the child object when a child is a dynamic object field. The presence or absence of this field can be used to determine if a child is a dynamic field or a dynamic child object
child_objectObjectThe object itself when a child is a dynamic object field.

grpcurl ​

bash
grpcurl -H "x-api-key: YOUR_API_KEY" \
  -d '{
  "parent": "string",
  "page_size": 20,
  "read_mask": {
    "paths": [
      "parent",
      "field_id"
    ]
  }
}' \
  mainnet-grpc.inodra.com:443 \
  sui.rpc.v2.StateService/ListDynamicFields

Server reflection is enabled, so no proto files are needed for grpcurl. Field masks are written as {"paths": [...]}.

The body is a template: replace the literal string values with your own values before the call succeeds.

TypeScript ​

typescript
import { GrpcWebFetchTransport, SuiGrpcClient } from '@mysten/sui/grpc'

const transport = new GrpcWebFetchTransport({
  baseUrl: 'https://mainnet-grpc.inodra.com',
  meta: { 'x-api-key': process.env.INODRA_API_KEY! }
})
const client = new SuiGrpcClient({ network: 'mainnet', transport })

const { dynamicFields, cursor } = await client.listDynamicFields({
  parentId: '0x5',
  limit: 20
})
console.log(dynamicFields, cursor)

Uses the typed SuiGrpcClient method from @mysten/sui v2 that calls this RPC. Install with npm install @mysten/sui and set INODRA_API_KEY. The gRPC gateway guide covers native gRPC transport for backends.

Credits ​

1 credit per item actually returned; an empty page bills the 1-credit minimum. See credits and billing for the full table.

JSON-RPC equivalent ​

Replaces suix_getDynamicFields. The JSON-RPC to gRPC migration guide has before and after code for the common calls.

The full-stack Sui data layer.