Overview

Shinami APIs use the JSON-RPC 2.0 standard. JSON-RPC error codes you may receive when interacting with our services are listed below, along with service-specific errors. Additionally, our services return standard HTTP codes which are also displayed below.

General Error Codes

HTTP Errors

All of our services return standard HTTP codes including (but not limited to):

Too Many Requests: When you hit a rate limit, we return a HTTP 200 code with a JSON-RPC error code -32010 in the response body (see in the next section). The one exception is our Sui WebSocket API, which returns HTTP 429 when you try to open a new connection but have already reached your maximum number of connections.

JSON-RPC Errors

For JSON-RPC errors, Shinami returns HTTP 200 with the JSON-RPC error in the JSON response. Common errors across our services include:

Other Errors

You may see the following errors when using our Shinami Clients SDK.

Aptos: Service-Specific Error Codes

Aptos Gas Station API

In addition to the general error codes listed above, the following codes are returned by our Gas Station API. Note: you may see additional errors beyond what's listed below.

JSON-RPC errors

Other errors

Aptos Invisible Wallet API

In addition to the general error codes listed above, the following codes are returned by our Invisible Wallet API. Note: you may see additional errors beyond what's listed below.

JSON-RPC errors

Example JSON-RPC Errors

Below are two example requests and their assocaited JSON-RPC error responses, one using cURL and one using our Shinami Clients TypeScript SDK.

Replace all instances of {{name}} with the actual value for that name

curl https://api.shinami.com/aptos/gas/v1 \
-X POST \
-H 'X-API-Key: {{gasStationAccessKey}}' \
-H 'Content-Type: application/json' \
-d '{
        "jsonrpc":"2.0",
        "method":"getAMilkshakeAndFries",
        "params":[
            "0x397020433ff4fd6446d9ac73b7d3fb210840168e6bfe146d1bbea21ff5b425cf00000000000000000075a11ceb0b0600000007010002030206040802050a0707110c081d20063d0a0000000101020100000001030106090000056465627567057072696e74000000000000000000000000000000000000000000000000000000000000000103080100000000000000000000070b000700160c010e013800020001010100000000000000400d03000000000064000000000000005ee543660000000002"
        ],
        "id":1
}'


// Response:
{
   "error" : {
      "code" : -32601,
      "message" : "Method not found"
   },
   "id" : 1,
   "jsonrpc" : "2.0"
}

import { GasStationClient } from "@shinami/clients/aptos";
const gasStationClient = new GasStationClient("{{gasStationAccessKey}}");

const transaction = // build a tranasaction where 
                    // transaction.rawTransaction.expiration_timestamp_secs 
                    // is set in the past, or more than an hour in the future

await gasStationClient.sponsorTransaction(transaction);

// Response:
JSONRPCError: Invalid params
    at new JSONRPCError ... {
  code: -32602,
  data: { details: 'expirationTimestampSecs out of range' }

Sui: Service-Specific Error Codes

Sui Node Service: JSON-RPC API

Sui Node Service: WebSocket API (deprecated)

Note: Mysten is retiring this service around the middle of August, 2024. See the note at the top of the API doc.

In addition to the general error codes listed above, the following codes are returned by our WebSocket API. Note: you may see additional errors beyond what's listed below.

HTTP Codes

This is the one Shinami service that returns HTTP 429 for rate-limit errors. It connotes that you cannot create additional connections to the service because you have reached your maximum allowed.

JSON-RPC Errors

Sui Gas Station API

In addition to the general error codes listed above, the following codes are returned by our Gas Station API. Note: you may see additional errors beyond what's listed below.

JSON-RPC errors

Other errors

Sui Invisible Wallet API

In addition to the general error codes listed above, the following codes are returned by our Invisible Wallet API. Note: you may see additional errors beyond what's listed below.

JSON-RPC errors

Sui zkLogin wallet API

In addition to the general error codes listed above, the following codes are returned by our zkLogin wallet API. Note: you may see additional errors beyond what's listed below.

JSON-RPC errors

Example JSON-RPC errors

Below are two example JSON-RPC error responses - one using cURL and one using our Shinami Clients TypeScript SDK.
Replace all instances of {{name}} with the actual value for that name

// Here, we've mistyped the name of the suix_getReferenceGasPrice method
curl https://api.shinami.com/node/v1 \
-X POST \
-H 'X-API-Key: {{nodeServiceAccessKey}}' \
-H 'Content-Type: application/json' \
-d '{ 
        "jsonrpc":"2.0", 
        "method":"getAMilkshakeAndFries", 
        "params":[], 
        "id":1
    }'

// Response:
{
   "error" : {
      "code" : -32601,
      "message" : "Method not found"
   },
   "id" : 1,
   "jsonrpc" : "2.0"
}

// Here, we are making a request to Shinami Gas Station for transaction 
//  sponsorship with a value of 1 MIST. This is too low to have a chance 
//  of success, so we get a -32602 Invalid params error
import { GasStationClient } from "@shinami/clients/sui";

const gasClient = new GasStationClient({{gasStationAccessKey}});

await gasClient.sponsorTransaction(
  {{transactionToSponsor}},
  {{senderAddress}},
  1 // 1 MIST 
);

// Response:
JSONRPCError: Invalid params
    at new JSONRPCError... {
  code: -32602,
  data: { details: 'gasBudget: 1 out of range' }
}