List owned objects

POST

https://sui-grpc.nownodes.io/sui.rpc.v2.StateService/ListOwnedObjects

Authorizations

ApiKeyAuthApiKeyAuth

api-key string

NOWNodes API key passed in the api-key header.

Lists objects owned by an address.

gRPC method: sui.rpc.v2.StateService.ListOwnedObjects (unary).

This is a gRPC method (HTTP/2, Protocol Buffers), not a REST endpoint. The request and response bodies below are shown in the proto3 JSON form that tools such as grpcurl and Postman accept and print. Pass your NOWNodes API key as the api-key gRPC metadata header. Proto files: sui/rpc/v2/state_service.proto.

Example grpcurl request:

Copied!

grpcurl \
  -insecure \
  -H 'api-key: YOUR_API_KEY' \
  -emit-defaults \
  -proto './sui-apis-grpc/proto/sui/rpc/v2/state_service.proto' \
  -import-path './sui-apis-grpc/proto' \
  -d '{"owner": "0xOWNER_ADDRESS", "pageSize": 50}' \
  'sui-grpc.nownodes.io' \
  sui.rpc.v2.StateService.ListOwnedObjects

Body

application/json

ownerstring

Required. The address of the account that owns the objects.

pageSizeinteger<uint32>

The maximum number of entries 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.

pageTokenstring<byte>

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

When paginating, all other parameters provided to ListOwnedObjects must match the call that provided the page token. Base64-encoded bytes.

readMaskobject

Mask specifying which fields to read. If no mask is specified, defaults to object_id,version,object_type. Read mask: list of field paths to return, in snake_case (e.g. "object_id", "version", "digest"). Nested fields use dots (e.g. "effects.status").

Show child attributes

pathsArray<string>required

Field paths to return.

objectTypestring

Optional type filter to limit the types of objects listed.

Providing an object type with no type params will return objects of that type with any type parameter, e.g. 0x2::coin::Coin will return all Coin<T> objects regardless of the type parameter T. Providing a type with a type param will restrict the returned objects to only those objects that match the provided type parameters, e.g. 0x2::coin::Coin<0x2::sui::SUI> will only return Coin<SUI> objects.

Response

200OK

Successful response.

default

gRPC error. The status code (e.g. UNAUTHENTICATED, INVALID_ARGUMENT, NOT_FOUND) is returned in the grpc-status trailer, details in grpc-message.

List owned objects

curl -X POST 'https://sui-grpc.nownodes.io/sui.rpc.v2.StateService/ListOwnedObjects' \
  -H 'Content-Type: application/json' \
  -d '{
    "owner": "string",
    "pageSize": 0,
    "pageToken": "dGVzdA==",
    "readMask": {
      "paths": [
        "string"
      ]
    },
    "objectType": "string"
  }'

const response = await fetch('https://sui-grpc.nownodes.io/sui.rpc.v2.StateService/ListOwnedObjects', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
      "owner": "string",
      "pageSize": 0,
      "pageToken": "dGVzdA==",
      "readMask": {
        "paths": [
          "string"
        ]
      },
      "objectType": "string"
    }),
});

const data = await response.json();

require 'net/http'
require 'json'

uri = URI('https://sui-grpc.nownodes.io/sui.rpc.v2.StateService/ListOwnedObjects')
request = Net::HTTP::Post.new(uri)
request['Content-Type'] = 'application/json'
request.body = '{
    "owner": "string",
    "pageSize": 0,
    "pageToken": "dGVzdA==",
    "readMask": {
      "paths": [
        "string"
      ]
    },
    "objectType": "string"
  }'

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }
data = JSON.parse(response.body)

import requests

payload = {
  "owner": "string",
  "pageSize": 0,
  "pageToken": "dGVzdA==",
  "readMask": {
    "paths": [
      "string"
    ]
  },
  "objectType": "string"
}

response = requests.post('https://sui-grpc.nownodes.io/sui.rpc.v2.StateService/ListOwnedObjects', json=payload)
data = response.json()

const response = await fetch('https://sui-grpc.nownodes.io/sui.rpc.v2.StateService/ListOwnedObjects', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
      "owner": "string",
      "pageSize": 0,
      "pageToken": "dGVzdA==",
      "readMask": {
        "paths": [
          "string"
        ]
      },
      "objectType": "string"
    }),
});

const data = await response.json();

const endpoint = "https://sui-grpc.nownodes.io/sui.rpc.v2.StateService/ListOwnedObjects";
const apiKey = "YOUR_API_KEY";

async function nownodesRequest(payload) {
  const response = await fetch(endpoint, {
    method: "POST",
    headers: {
      "Content-Type": "application/json",
      "api-key": apiKey,
    },
    body: JSON.stringify(payload),
  });

  return response.json();
}

const result = await nownodesRequest({
    "owner": "string",
    "pageSize": 0,
    "pageToken": "dGVzdA==",
    "readMask": {
      "paths": [
        "string"
      ]
    },
    "objectType": "string"
  });
console.log(result);

const response = await fetch('https://sui-grpc.nownodes.io/sui.rpc.v2.StateService/ListOwnedObjects', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
      "owner": "string",
      "pageSize": 0,
      "pageToken": "dGVzdA==",
      "readMask": {
        "paths": [
          "string"
        ]
      },
      "objectType": "string"
    }),
});

const data = await response.json();

import requests

payload = {
  "owner": "string",
  "pageSize": 0,
  "pageToken": "dGVzdA==",
  "readMask": {
    "paths": [
      "string"
    ]
  },
  "objectType": "string"
}

response = requests.post('https://sui-grpc.nownodes.io/sui.rpc.v2.StateService/ListOwnedObjects', json=payload)
data = response.json()

require 'net/http'
require 'json'

uri = URI('https://sui-grpc.nownodes.io/sui.rpc.v2.StateService/ListOwnedObjects')
request = Net::HTTP::Post.new(uri)
request['Content-Type'] = 'application/json'
request.body = '{
    "owner": "string",
    "pageSize": 0,
    "pageToken": "dGVzdA==",
    "readMask": {
      "paths": [
        "string"
      ]
    },
    "objectType": "string"
  }'

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }
data = JSON.parse(response.body)

Request Body

{
  "owner": "0xOWNER_ADDRESS",
  "pageSize": 50
}

{
  "owner": "0xOWNER_ADDRESS",
  "objectType": "0x2::coin::Coin<0x2::sui::SUI>"
}