Introduction

Shinami is building the foundational developer platform for Sui. Our products are designed to help teams build apps faster, with better UX, and less overhead:

Node Service: enterprise-grade infrastructure to read and write to the Sui blockchain
Gas Station: abstract gas fees from your user's experience by sponsoring their transactions
In-App Wallet: fully abstract web3 from your user's experience (third-party wallet connections, gas fees, signing popups, seed phrases)

We can’t wait to see what you build!

Getting Started

You’ll need to have a Shinami account to follow this 1-minute quickstart guide.

1. 🔑 Create a Shinami access key

To use Shinami's products, you’ll need an access key to authenticate your requests. You can create access keys from your account dashboard.

2. 🤚 Make a request with Shinami

You can interact with the Sui network using Shinami’s Sui JSON-RPC API and your command line.

For manual requests, we recommend interacting with the JSON-RPC via POST requests. Simply pass in the Content-Type: application/json header and your query as the POST body with the following fields:

jsonrpc: The JSON-RPC version—currently, only 2.0 is supported.

method: The Sui API method you want to execute. Shinami supports all Sui JSON-RPC methods.

params: A list of parameters to pass to the method.

id: The ID of your request. Will be returned by the response so you can keep track of which request a response belongs to.

Here is an example method you can run from your command line to return the total number of transactions known to the node.

sui_getTotalTransactionNumber

curl https://api.shinami.com/node/v1/<<apiKey>> \
-X POST \
-H 'Content-Type: application/json' \
-d '{ "jsonrpc":"2.0", "method":"sui_getTotalTransactionBlocks", "params":[], "id":1}' | json_pp

The response should resemble the following:

{
  "id" : 1,
  "jsonrpc" : "2.0",
  "result" : "71237"
}

3. 🏗 Build on Sui!

If there’s anything else you need, you can reach us at [email protected]

For a full list of methods and descriptions for Shinami's APIs, continue to the API Reference section.
If you're running into errors, take a look at our Error Reference page.

We also have guides for the following: