You'll learn how to

• Send a request to Sui Node Service.
• View your requests and error codes in your Shinami dashboard
• Get guidance on a specific error code in our Error guide.

Steps

1. Create a Shinami account

You’ll need a Shinami account to follow this quick-start guide.

2. Create an API Access Key in your preferred geographic region

To use Shinami's products, you need an API access key to authenticate your requests. API keys are tied to a geographic region and a network in that region. As shown below, we currently only run Sui Testnet in the US, so the example code below uses an API key from the US East - us1 region and the associated URL. To send to Tokyo - apac1 Mainnet insrtead, use an API key from that region and use the associated URL shown in the table:

See how to make a Sui Node access key in our Authentication and API Keys guide

3. Make a request!

Here is an example sui_getTransactionBlock request that returns data about a given transaction digest. It uses our US East - us1 shared Sui node, which has a URL of https://api.us1.shinami.com/sui/node/v1. If you made an API key in Tokyo - apac1 you'd use the associated URL from the table above.

Sending toTokyo - apac1 with our SDK

When using our TypeScript SDK, just construct it with an API key from Tokyo - apac1 and we'll set the Tokyo - apac1 URL automatically! Since the region is encoded in the api key name (e.g. apac1_sui_mainnet_59...) we know what URL to set. Same goes for keys from US East - us1.

Example Request with an error

Replace all instances of {{name}} with the actual value for that name. The TypeScript example uses our Shinami Clients SDK.

curl https://api.us1.shinami.com/sui/node/v1 \
-X POST \
-H 'X-API-Key: {{USEastTestnetNodeAccessKey}}' \
-H 'Content-Type: application/json' \
-d '{ 
        "jsonrpc":"2.0", 
        "method":"sui_getTransactionBlock",
        "params":[
            "22222222222222222222222222222222222222222222", 
            {
                "showInput": true,
                "showRawInput": true,
                "showEffects": true,
                "showEvents": true,
                "showObjectChanges": true,
                "showBalanceChanges": true
             }
        ],
        "id":1
    }' | json_pp

import { createSuiClient } from "@shinami/clients/sui";

const nodeClient = createSuiClient({{nodeAccessKey}});

const resp = await nodeClient.getTransactionBlock({
    digest: "22222222222222222222222222222222222222222222",
    options: {
        showEvents: true,
        showBalanceChanges: true,
        showInput: true,
        showRawInput: true,
        showObjectChanges: true,
        showEffects: true
    }
});
console.log(resp);

Error Response

{
   "error" : {
      "code" : -32602,
      "message" : "Could not find the referenced transaction [TransactionDigest(22222222222222222222222222222222222222222222)]."
   },
   "id" : 1,
   "jsonrpc" : "2.0"
}

JsonRpcError: Could not find the referenced transaction [TransactionDigest(22222222222222222222222222222222222222222222)].
    at ... {
  code: -32602,
  type: 'InvalidParams'
}

4. View the request and error in your dashboard

On the Sui Node Service page of your dashboard, you can view a rich set of API insights. It can take a few minutes for a request to show up. If your request hasn't shown up yet, just keep reading this doc to learn about the in-dashboard metrics and error guide, then refresh the your dashboard page.

1. Services exist within geographic regions. Select the region you sent a request to. Since we're using Sui Testnet, it's US-East - us1 as that's the only region we host Testnet in currently. API Access Keys are tied to a region, so we had to use an API key from this region to send the request (along with the region specific URL for this service https://api.us1.shinami.com/sui/node/v1).
2. Within a region, each service has its own page with its own API insights.
3. Sui Node Service has only one tab, but others have more.
4. Filters: I've chosen "Sui Testnet" and "Last 60 minutes" to narrow down to this one request. It's often good to look at errors across all methods and then drill down into individual methods (another filter). You can also filter by API key.
5. Summary metrics: a great place to get a quick overview of your integration health. If there's an issue - like a lot of rate-limit or other errors, you can scroll down to the graphs below to see when they occurred and what the error codes were. When you filter by an individual method or API key or network, these update to reflect that. Here, we see that our one request had a non-rate-limit error.
6. Graphs: this is the first one, showing requests by method name. Your graph will show as many requests as you sent.

Scroll down to view more graphs, including a breakdown of errors by JSON-RPC error code. Right now this graph is showing all requests. Since I just sent one, I know this error came on a sui_getTransactionBlock request. If you sent requests of different types, it's helpful to use the top-level methods filter to make sure you're only looking at errors on sui_getTransactionBlock requests.

5. See what the error means in our Error guide

Our Error guide has an overall section for all Shinami Services, as well as a specific section for each service, including our Sui Node Service. In this case, we'll find JSON-RPC error -32602: Invalid Params. The notes tell us, among other things, that on a sui_getTransactionBlock request it can be because a digest doesn't exist. That's our issue here. We're also told to check the general section above. That's good advice: always check the service-specific section and the general JSON-RPC and HTTP error code sections at the top.

6. Send a successful request

Let's input a valid Testnet digest and try again.

Updated request

Replace all instances of {{name}} with the actual value for that name. The TypeScript example uses our Shinami Clients SDK. Note that for a smaller example response we only set showBalanceChanges to true. In your app you'll ask for whatever you need.

curl https://api.us1.shinami.com/sui/node/v1 \
-X POST \
-H 'X-API-Key: {{nodeAccessKey}}' \
-H 'Content-Type: application/json' \
-d '{ 
        "jsonrpc":"2.0", 
        "method":"sui_getTransactionBlock",
        "params":[
            "2zDvVpTkkQJYaW95HNdvBQm8CiSr8ateuoFK57xbRyQ9", 
            {
                "showInput": false,
                "showRawInput": false,
                "showEffects": false,
                "showEvents": false,
                "showObjectChanges": false,
                "showBalanceChanges": true
             }
        ],
        "id":1
    }' | json_pp

import { createSuiClient } from "@shinami/clients/sui";

const nodeClient = createSuiClient({{nodeAccessKey}});

const resp = await shinamiTestnetNodeClient.getTransactionBlock({
    digest: "2zDvVpTkkQJYaW95HNdvBQm8CiSr8ateuoFK57xbRyQ9",
    options: {
        showEvents: false,
        showBalanceChanges: true,
        showInput: false,
        showRawInput: false,
        showObjectChanges: false,
        showEffects: false
    }
});
console.log(resp);

Successful response

{
   "id" : 1,
   "jsonrpc" : "2.0",
   "result" : {
      "balanceChanges" : [
         {
            "amount" : "-1028196",
            "coinType" : "0x2::sui::SUI",
            "owner" : {
               "AddressOwner" : "0xfc837a36850adfd5ea076de8c1638ad7c2d228c91d9fe3e2771ff305cb52c07c"
            }
         }
      ],
      "checkpoint" : "125146246",
      "digest" : "2zDvVpTkkQJYaW95HNdvBQm8CiSr8ateuoFK57xbRyQ9",
      "timestampMs" : "1730149869581"
   }
}

{
  digest: '2zDvVpTkkQJYaW95HNdvBQm8CiSr8ateuoFK57xbRyQ9',
  balanceChanges: [
    { owner: [Object], coinType: '0x2::sui::SUI', amount: '-1028196' }
  ],
  timestampMs: '1730149869581',
  checkpoint: '125146246'
}

Next step: build on Sui! 🏗

• For an overview of our API docs and tutorials for each of our services, see our API References Overview.
• For tips on learning how to code in Sui Move, see Sui Move Resources
• Check out the Sui Node Service product usage FAQ and billing FAQ in our Help Center for answers to common questions
• If you ever have questions, reach out to us.