Get object

POST

https://sui-grpc.nownodes.io/sui.rpc.v2.LedgerService/GetObject

Authorizations

ApiKeyAuthApiKeyAuth

api-key string

NOWNodes API key passed in the api-key header.

Returns an object by object ID.

gRPC method: sui.rpc.v2.LedgerService.GetObject (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/ledger_service.proto.

Example grpcurl request:

Copied!

grpcurl \
  -insecure \
  -H 'api-key: YOUR_API_KEY' \
  -emit-defaults \
  -proto './sui-apis-grpc/proto/sui/rpc/v2/ledger_service.proto' \
  -import-path './sui-apis-grpc/proto' \
  -d '{"objectId": "0xOBJECT_ID"}' \
  'sui-grpc.nownodes.io' \
  sui.rpc.v2.LedgerService.GetObject

Body

application/json

objectIdstring

Required. The ObjectId of the requested object.

versionstring<uint64>

Request a specific version of the object. If no version is specified, and the object is live, then the latest version of the object is returned.

readMaskobject

Mask specifying which fields to read. If no mask is specified, defaults to object_id,version,digest. 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.

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.

Get object

curl -X POST 'https://sui-grpc.nownodes.io/sui.rpc.v2.LedgerService/GetObject' \
  -H 'Content-Type: application/json' \
  -d '{
    "objectId": "string",
    "version": "string",
    "readMask": {
      "paths": [
        "string"
      ]
    }
  }'

const response = await fetch('https://sui-grpc.nownodes.io/sui.rpc.v2.LedgerService/GetObject', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
      "objectId": "string",
      "version": "string",
      "readMask": {
        "paths": [
          "string"
        ]
      }
    }),
});

const data = await response.json();

require 'net/http'
require 'json'

uri = URI('https://sui-grpc.nownodes.io/sui.rpc.v2.LedgerService/GetObject')
request = Net::HTTP::Post.new(uri)
request['Content-Type'] = 'application/json'
request.body = '{
    "objectId": "string",
    "version": "string",
    "readMask": {
      "paths": [
        "string"
      ]
    }
  }'

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

import requests

payload = {
  "objectId": "string",
  "version": "string",
  "readMask": {
    "paths": [
      "string"
    ]
  }
}

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

const response = await fetch('https://sui-grpc.nownodes.io/sui.rpc.v2.LedgerService/GetObject', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
      "objectId": "string",
      "version": "string",
      "readMask": {
        "paths": [
          "string"
        ]
      }
    }),
});

const data = await response.json();

const endpoint = "https://sui-grpc.nownodes.io/sui.rpc.v2.LedgerService/GetObject";
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({
    "objectId": "string",
    "version": "string",
    "readMask": {
      "paths": [
        "string"
      ]
    }
  });
console.log(result);

const response = await fetch('https://sui-grpc.nownodes.io/sui.rpc.v2.LedgerService/GetObject', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
      "objectId": "string",
      "version": "string",
      "readMask": {
        "paths": [
          "string"
        ]
      }
    }),
});

const data = await response.json();

import requests

payload = {
  "objectId": "string",
  "version": "string",
  "readMask": {
    "paths": [
      "string"
    ]
  }
}

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

require 'net/http'
require 'json'

uri = URI('https://sui-grpc.nownodes.io/sui.rpc.v2.LedgerService/GetObject')
request = Net::HTTP::Post.new(uri)
request['Content-Type'] = 'application/json'
request.body = '{
    "objectId": "string",
    "version": "string",
    "readMask": {
      "paths": [
        "string"
      ]
    }
  }'

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

Request Body

{
  "objectId": "0xOBJECT_ID"
}

{
  "objectId": "0xOBJECT_ID",
  "version": "123"
}

{
  "objectId": "0xOBJECT_ID",
  "readMask": {
    "paths": [
      "object_id",
      "version",
      "digest",
      "object_type"
    ]
  }
}