Parameters

owner

string

REQUIRED

The address of the account that owns the objects

page_size

integer

Maximum number of objects to return (default: 50, max: 1000)

page_token

string

A page token, received from a previous ListOwnedObjects call. Provide this to retrieve the subsequent page

read_mask

object

Mask specifying which fields to read (defaults to object_id,version,object_type)

object_type

string

Optional type filter to limit the types of objects listed

Returns

objects

array

List of objects owned by the specified address

objectId

string

The unique identifier of the object on-chain

version

string

The version number of the object

digest

string

Cryptographic hash representing the object's current state

objectType

string

Fully qualified Move type of the object

owner

object

Ownership information of the object

hasPublicTransfer

boolean

Indicates whether the object supports public transfers

contents

object

Deserialized contents of the object

bcs

object

BCS representation of the object

nextPageToken

string

Token for retrieving the next page (omitted if no more pages)

Request

1
grpcurl -proto ./sui/rpc/v2/state_service.proto -H "x-token: abcde123456789" -d '{
2
  "owner": "0x27c4fdb3b846aa3ae4a65ef5127a309aa3c1f466671471a806d8912a18b253e8"
3
}' docs-demo.sui-mainnet.quiknode.pro:9000 sui.rpc.v2.StateService/ListOwnedObjects
4

1
grpcurl -proto ./sui/rpc/v2/state_service.proto -H "x-token: abcde123456789" -d '{
2
  "owner": "0x27c4fdb3b846aa3ae4a65ef5127a309aa3c1f466671471a806d8912a18b253e8"
3
}' docs-demo.sui-mainnet.quiknode.pro:9000 sui.rpc.v2.StateService/ListOwnedObjects
4

1
package main
2

3
import (
4
	"context"
5
	"crypto/tls"
6
	"encoding/json"
7
	"fmt"
8
	"log"
9
	"time"
10

11
	"google.golang.org/grpc"
12
	"google.golang.org/grpc/credentials"
13
	"google.golang.org/protobuf/encoding/protojson"
14
	"google.golang.org/protobuf/types/known/fieldmaskpb"
15

16
	pb "sui-grpc/sui/rpc/v2" // Your Generated .pb.go files path
17
)
18

19
// Quicknode endpoints consist of two crucial components: the endpoint name and the corresponding token
20
// For eg: QN Endpoint: https://docs-demo.sui-mainnet.quiknode.pro/abcde123456789
21
// endpoint will be: docs-demo.sui-mainnet.quiknode.pro:9000  {9000 is the port number for Sui gRPC}
22
// token will be : abcde123456789
23

24
var (
25
	token    = "YOUR_TOKEN_NUMBER"
26
	endpoint = "YOUR_QN_ENDPOINT:9000"
27
)
28

29
// Auth structure for x-token
30
type auth struct {
31
	token string
32
}
33

34
func (a *auth) GetRequestMetadata(ctx context.Context, uri ...string) (map[string]string, error) {
35
	return map[string]string{"x-token": a.token}, nil
36
}
37
func (a *auth) RequireTransportSecurity() bool {
38
	return true
39
}
40

41
func main() {
42
	creds := credentials.NewTLS(&tls.Config{})
43
	opts := []grpc.DialOption{
44
		grpc.WithTransportCredentials(creds),
45
		grpc.WithPerRPCCredentials(&auth{token}),
46
	}
47

48
	conn, err := grpc.Dial(endpoint, opts...)
49
	if err != nil {
50
		log.Fatalf("Failed to connect: %v", err)
51
	}
52
	defer conn.Close()
53

54
	client := pb.NewStateServiceClient(conn)
55

56
	owner := "0x27c4fdb3b846aa3ae4a65ef5127a309aa3c1f466671471a806d8912a18b253e8"
57

58
	// Build request with field mask
59
	req := &pb.ListOwnedObjectsRequest{
60
		Owner: &owner,
61
		ReadMask: &fieldmaskpb.FieldMask{
62
			Paths: []string{
63
				"object_id",
64
				"version",
65
				"digest",
66
				"object_type",
67
				"owner",
68
			},
69
		},
70
	}
71

72
	ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
73
	defer cancel()
74

75
	resp, err := client.ListOwnedObjects(ctx, req)
76
	if err != nil {
77
		log.Fatalf("ListOwnedObjects failed: %v", err)
78
	}
79

80
	// Pretty print the response
81
	marshaler := protojson.MarshalOptions{
82
		UseProtoNames:   true,
83
		EmitUnpopulated: true,
84
		Indent:          "  ",
85
	}
86

87
	jsonBytes, err := marshaler.Marshal(resp)
88
	if err != nil {
89
		log.Fatalf("Failed to marshal: %v", err)
90
	}
91

92
	var pretty map[string]interface{}
93
	if err := json.Unmarshal(jsonBytes, &pretty); err != nil {
94
		log.Fatalf("Failed to parse JSON: %v", err)
95
	}
96

97
	out, _ := json.MarshalIndent(pretty, "", "  ")
98
	fmt.Println(string(out))
99
}
100

1
package main
2

3
import (
4
	"context"
5
	"crypto/tls"
6
	"encoding/json"
7
	"fmt"
8
	"log"
9
	"time"
10

11
	"google.golang.org/grpc"
12
	"google.golang.org/grpc/credentials"
13
	"google.golang.org/protobuf/encoding/protojson"
14
	"google.golang.org/protobuf/types/known/fieldmaskpb"
15

16
	pb "sui-grpc/sui/rpc/v2" // Your Generated .pb.go files path
17
)
18

19
// Quicknode endpoints consist of two crucial components: the endpoint name and the corresponding token
20
// For eg: QN Endpoint: https://docs-demo.sui-mainnet.quiknode.pro/abcde123456789
21
// endpoint will be: docs-demo.sui-mainnet.quiknode.pro:9000  {9000 is the port number for Sui gRPC}
22
// token will be : abcde123456789
23

24
var (
25
	token    = "YOUR_TOKEN_NUMBER"
26
	endpoint = "YOUR_QN_ENDPOINT:9000"
27
)
28

29
// Auth structure for x-token
30
type auth struct {
31
	token string
32
}
33

34
func (a *auth) GetRequestMetadata(ctx context.Context, uri ...string) (map[string]string, error) {
35
	return map[string]string{"x-token": a.token}, nil
36
}
37
func (a *auth) RequireTransportSecurity() bool {
38
	return true
39
}
40

41
func main() {
42
	creds := credentials.NewTLS(&tls.Config{})
43
	opts := []grpc.DialOption{
44
		grpc.WithTransportCredentials(creds),
45
		grpc.WithPerRPCCredentials(&auth{token}),
46
	}
47

48
	conn, err := grpc.Dial(endpoint, opts...)
49
	if err != nil {
50
		log.Fatalf("Failed to connect: %v", err)
51
	}
52
	defer conn.Close()
53

54
	client := pb.NewStateServiceClient(conn)
55

56
	owner := "0x27c4fdb3b846aa3ae4a65ef5127a309aa3c1f466671471a806d8912a18b253e8"
57

58
	// Build request with field mask
59
	req := &pb.ListOwnedObjectsRequest{
60
		Owner: &owner,
61
		ReadMask: &fieldmaskpb.FieldMask{
62
			Paths: []string{
63
				"object_id",
64
				"version",
65
				"digest",
66
				"object_type",
67
				"owner",
68
			},
69
		},
70
	}
71

72
	ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
73
	defer cancel()
74

75
	resp, err := client.ListOwnedObjects(ctx, req)
76
	if err != nil {
77
		log.Fatalf("ListOwnedObjects failed: %v", err)
78
	}
79

80
	// Pretty print the response
81
	marshaler := protojson.MarshalOptions{
82
		UseProtoNames:   true,
83
		EmitUnpopulated: true,
84
		Indent:          "  ",
85
	}
86

87
	jsonBytes, err := marshaler.Marshal(resp)
88
	if err != nil {
89
		log.Fatalf("Failed to marshal: %v", err)
90
	}
91

92
	var pretty map[string]interface{}
93
	if err := json.Unmarshal(jsonBytes, &pretty); err != nil {
94
		log.Fatalf("Failed to parse JSON: %v", err)
95
	}
96

97
	out, _ := json.MarshalIndent(pretty, "", "  ")
98
	fmt.Println(string(out))
99
}
100

1
import * as grpc from '@grpc/grpc-js';
2
import * as protoLoader from '@grpc/proto-loader';
3
import * as path from 'path';
4

5
// Configuration
6
const PROTO_PATH = path.join(__dirname, 'protos/proto/sui/rpc/v2/state_service.proto');
7

8
// Quicknode endpoints consist of two crucial components: the endpoint name and the corresponding token
9
// For eg: QN Endpoint: https://docs-demo.sui-mainnet.quiknode.pro/abcde123456789
10
// endpoint will be: docs-demo.sui-mainnet.quiknode.pro:9000  {9000 is the port number for Sui gRPC}
11
// token will be : abcde123456789
12

13
const endpoint = 'docs-demo.sui-mainnet.quiknode.pro:9000';
14
const token = 'abcde123456789';
15

16
// Load protobuf definitions
17
const packageDefinition = protoLoader.loadSync(PROTO_PATH, {
18
  keepCase: true,
19
  longs: String,
20
  enums: String,
21
  defaults: true,
22
  oneofs: true,
23
  includeDirs: [path.join(__dirname, 'protos/proto')],
24
});
25

26
const proto = grpc.loadPackageDefinition(packageDefinition) as any;
27
const StateService = proto.sui.rpc.v2.StateService;
28

29
// Create secure client
30
const client = new StateService(endpoint, grpc.credentials.createSsl());
31

32
// Add token metadata
33
const metadata = new grpc.Metadata();
34
metadata.add('x-token', token);
35

36
// Request payload
37
const request = {
38
  owner: '0x27c4fdb3b846aa3ae4a65ef5127a309aa3c1f466671471a806d8912a18b253e8',
39
};
40

41
// Perform gRPC call
42
client.ListOwnedObjects(request, metadata, (err: grpc.ServiceError | null, response: any) => {
43
  if (err) {
44
    console.error('gRPC Error:', {
45
      code: err.code,
46
      message: err.message,
47
      details: err.details,
48
    });
49
  } else {
50
    console.log('ListOwnedObjects Response:');
51
    console.log(JSON.stringify(response, null, 2));
52
  }
53
});
54

1
import * as grpc from '@grpc/grpc-js';
2
import * as protoLoader from '@grpc/proto-loader';
3
import * as path from 'path';
4

5
// Configuration
6
const PROTO_PATH = path.join(__dirname, 'protos/proto/sui/rpc/v2/state_service.proto');
7

8
// Quicknode endpoints consist of two crucial components: the endpoint name and the corresponding token
9
// For eg: QN Endpoint: https://docs-demo.sui-mainnet.quiknode.pro/abcde123456789
10
// endpoint will be: docs-demo.sui-mainnet.quiknode.pro:9000  {9000 is the port number for Sui gRPC}
11
// token will be : abcde123456789
12

13
const endpoint = 'docs-demo.sui-mainnet.quiknode.pro:9000';
14
const token = 'abcde123456789';
15

16
// Load protobuf definitions
17
const packageDefinition = protoLoader.loadSync(PROTO_PATH, {
18
  keepCase: true,
19
  longs: String,
20
  enums: String,
21
  defaults: true,
22
  oneofs: true,
23
  includeDirs: [path.join(__dirname, 'protos/proto')],
24
});
25

26
const proto = grpc.loadPackageDefinition(packageDefinition) as any;
27
const StateService = proto.sui.rpc.v2.StateService;
28

29
// Create secure client
30
const client = new StateService(endpoint, grpc.credentials.createSsl());
31

32
// Add token metadata
33
const metadata = new grpc.Metadata();
34
metadata.add('x-token', token);
35

36
// Request payload
37
const request = {
38
  owner: '0x27c4fdb3b846aa3ae4a65ef5127a309aa3c1f466671471a806d8912a18b253e8',
39
};
40

41
// Perform gRPC call
42
client.ListOwnedObjects(request, metadata, (err: grpc.ServiceError | null, response: any) => {
43
  if (err) {
44
    console.error('gRPC Error:', {
45
      code: err.code,
46
      message: err.message,
47
      details: err.details,
48
    });
49
  } else {
50
    console.log('ListOwnedObjects Response:');
51
    console.log(JSON.stringify(response, null, 2));
52
  }
53
});
54

1
import grpc
2
import json
3
from google.protobuf.json_format import MessageToDict
4
from sui.rpc.v2 import state_service_pb2, state_service_pb2_grpc
5

6

7
def list_owned_objects():
8

9
    # Quicknode endpoints consist of two crucial components: the endpoint name and the corresponding token
10
    # For eg: QN Endpoint: https://docs-demo.sui-mainnet.quiknode.pro/abcde123456789
11
    # endpoint will be: docs-demo.sui-mainnet.quiknode.pro:9000  {9000 is the port number for Sui gRPC}
12
    # token will be : abcde123456789
13

14
    endpoint = 'docs-demo.sui-mainnet.quiknode.pro:9000';
15
    token = 'abcde123456789';
16

17
    channel = grpc.secure_channel(endpoint, grpc.ssl_channel_credentials())
18
    stub = state_service_pb2_grpc.StateServiceStub(channel)
19

20
    owner = "0x27c4fdb3b846aa3ae4a65ef5127a309aa3c1f466671471a806d8912a18b253e8"
21

22
    request = state_service_pb2.ListOwnedObjectsRequest(
23
        owner=owner
24
    )
25

26
    metadata = [("x-token", token)]
27

28
    return stub.ListOwnedObjects(request, metadata=metadata)
29

30

31
def parse_response_to_json(response):
32
    return json.dumps(
33
        MessageToDict(response, preserving_proto_field_name=True),
34
        indent=2
35
    )
36

37

38
def main():
39
    try:
40
        response = list_owned_objects()
41
        print(parse_response_to_json(response))
42
    except grpc.RpcError as e:
43
        print(f"{e.code().name}: {e.details()}")
44

45

46
if __name__ == "__main__":
47
    main()
48

1
import grpc
2
import json
3
from google.protobuf.json_format import MessageToDict
4
from sui.rpc.v2 import state_service_pb2, state_service_pb2_grpc
5

6

7
def list_owned_objects():
8

9
    # Quicknode endpoints consist of two crucial components: the endpoint name and the corresponding token
10
    # For eg: QN Endpoint: https://docs-demo.sui-mainnet.quiknode.pro/abcde123456789
11
    # endpoint will be: docs-demo.sui-mainnet.quiknode.pro:9000  {9000 is the port number for Sui gRPC}
12
    # token will be : abcde123456789
13

14
    endpoint = 'docs-demo.sui-mainnet.quiknode.pro:9000';
15
    token = 'abcde123456789';
16

17
    channel = grpc.secure_channel(endpoint, grpc.ssl_channel_credentials())
18
    stub = state_service_pb2_grpc.StateServiceStub(channel)
19

20
    owner = "0x27c4fdb3b846aa3ae4a65ef5127a309aa3c1f466671471a806d8912a18b253e8"
21

22
    request = state_service_pb2.ListOwnedObjectsRequest(
23
        owner=owner
24
    )
25

26
    metadata = [("x-token", token)]
27

28
    return stub.ListOwnedObjects(request, metadata=metadata)
29

30

31
def parse_response_to_json(response):
32
    return json.dumps(
33
        MessageToDict(response, preserving_proto_field_name=True),
34
        indent=2
35
    )
36

37

38
def main():
39
    try:
40
        response = list_owned_objects()
41
        print(parse_response_to_json(response))
42
    except grpc.RpcError as e:
43
        print(f"{e.code().name}: {e.details()}")
44

45

46
if __name__ == "__main__":
47
    main()
48

Don't have an account yet?

Create your Quicknode endpoint in seconds and start building

Get started for free