Read API: objects and coins

Overview

Authentication, rate limits, error handling, and sending to specific regions

See our JSON-RPC API overview doc for information on how to send to Tokyo - apac1 Mainnet and US-East - us1 Mainnet or Testnet. The examples below use the US-East region URL.

Reading Object Data

sui_getObject

Description
Return the object data for a specified object. Params

id : the ID of the queried object
options : SuiObjectDataOptions - Optional. Sui options for specifying the object content to be returned. All options default to false if not provided.

Example Request Template This example uses our US East - us1 region URL since it is currently the only region where we offer Testnet. To send to another region, see our our Node Service API Overview. The TypeScript example uses the Shinami Clients SDK, which you can install with:

Shell

npm install @shinami/clients

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

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_getObject",
        "params":[
            "{{objectId}}",
            {
                "showType": true,
                "showOwner": true,
                "showPreviousTransaction": true,
                "showDisplay": true,
                "showContent": false,
                "showBcs": false,
                "showStorageRebate": true
            }

        ],
        "id":1
    }'

Example Response

{
    "jsonrpc": "2.0",
    "result": {
        "data": {
            "objectId": "0xee496a0cc04d06a345982ba6697c90c619020de9e274408c7819f787ff66e1a1",
            "version": "1",
            "digest": "A8XvoZVx3d3b4w47cAjSoAUKHd1DLRPh4JBwRKCmFeDw",
            "type": "package",
            "owner": "Immutable",
            "previousTransaction": "9eAtptEvo2Nugre64dnjD8m87YZWppwTctUfktPXQCUi",
            "storageRebate": "75924000",
            "display": {
                "data": null,
                "error": null
            }
        }
    },
    "id": 1
}

Response Data

SuiObjectResponse , which can be either of:
- data: SuiObjectData
- error : ObjectResponseError

sui_multiGetObjects

Description
Return the object data for a list of objects. Params

ids : A list of object ids to be queried
options : SuiObjectDataOptions - Optional. Sui options for specifying the object content to be returned for each id. All options default to false if not provided.

Shell

npm install @shinami/clients

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

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_multiGetObjects",
        "params":[
            [
                "{{objectId}}",
                "{{objectId2}}"
            ],
            {
                "showType": true,
                "showOwner": true,
                "showPreviousTransaction": true,
                "showDisplay": true,
                "showContent": false,
                "showBcs": false,
                "showStorageRebate": true
            }

        ],
        "id":1
    }'

Example Response

{
    "jsonrpc": "2.0",
    "result": [
        {
            "data": {
                "objectId": "0xee496a0cc04d06a345982ba6697c90c619020de9e274408c7819f787ff66e1a1",
                "version": "1",
                "digest": "A8XvoZVx3d3b4w47cAjSoAUKHd1DLRPh4JBwRKCmFeDw",
                "type": "package",
                "owner": "Immutable",
                "previousTransaction": "9eAtptEvo2Nugre64dnjD8m87YZWppwTctUfktPXQCUi",
                "storageRebate": "75924000",
                "display": {
                    "data": null,
                    "error": null
                }
            }
        },
        {
            "error": {
                "code": "notExists",
                "object_id": "0xee496a0cc04d06a345982ba6697c90c619020de9e274408c7819f787ff66e1a2"
            }
        }
    ],
    "id": 1
}

Response Data A list of type SuiObjectResponse, whose elements can be either of:

data: SuiObjectData
error : ObjectResponseError

sui_tryGetPastObject

Caution:This will not return data on deleted objects or old object versions unless you are using a Shinami dedicated node with extra history storage enabled. For more info see here.

Description
Return the object information for a specified version.

Note there is no software-level guarantee/SLA that objects with past versions can be retrieved by this API, even if the object and version exists/existed. We store full object history on Mainnet but no object history on Testnet, as explained here.

Request Parameters

Name	Type	Description
object_id	string	The ID of the object you want historical information about.
version	number	The version of the object you wish to retrieve.
options		(Optional) `SuiObjectDataOptions` for specifying the object content to be returned

Shell

npm install @shinami/clients

ReplaceNODE_SERVICE_API_KEY with your actual API key value

curl https://api.us1.shinami.com/sui/node/v1 \
-X POST \
-H 'X-API-Key: NODE_SERVICE_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
      "jsonrpc":"2.0",
      "method":"sui_tryGetPastObject",
      "params":[
                  "0x0638aeb661190695126f978fa8b8ef54096d3dc73334e92ccc8b5ca9d69088be",
                  1,
                  {
                      "showType": false,
                      "showOwner": true,
                      "showPreviousTransaction": true,
                      "showDisplay": false,
                      "showContent": false,
                      "showBcs": false,
                      "showStorageRebate": false
                  }
            ],
      "id":1
    }'

Example Response

// Version found example
{
   "id" : 1,
   "jsonrpc" : "2.0",
   "result" : {
      "details" : {
         "digest" : "6RWWWsPnPuozKWKyKPAYTATX846theRymgRo5tbFb27E",
         "objectId" : "0x0638aeb661190695126f978fa8b8ef54096d3dc73334e92ccc8b5ca9d69088bd",
         "owner" : {
            "AddressOwner" : "0xeb583665fb5a35f488234bd8715be86bab0f8ba5311d95ee5a8f67b6088ca2b0"
         },
         "previousTransaction" : "7Aje5hgRyGvJJxsqUKxBtFf34z3Mveq9LsjvwcUF58Mh",
         "version" : "25907363"
      },
      "status" : "VersionFound"
   }
}

// Version not found example: the version is invalid or the FullNode is not storing it
{
   "id" : 1,
   "jsonrpc" : "2.0",
   "result" : {
      "details" : [
         "0x0638aeb661190695126f978fa8b8ef54096d3dc73334e92ccc8b5ca9d69088bd",
         1
      ],
      "status" : "VersionNotFound"
   }
}

// Object not found example: check that you are requesting for the correct network and object id
{
   "id" : 1,
   "jsonrpc" : "2.0",
   "result" : {
      "details" : "0x0638aeb661190695126f978fa8b8ef54096d3dc73334e92ccc8b5ca9d69088be",
      "status" : "ObjectNotExists"
   }
}

Response Data

Type	Description
`ObjectRead`	Contents vary based on the status. Statuses include “VersionFound”, “ObjectNotExists”, “ObjectDeleted”, “VersionNotFound”, and “VersionTooHigh”. Some examples are shown in the example responses. Click the link on the type to learn more about the possible data shapes.

sui_tryMultiGetPastObjects

Caution:This will not return data on deleted objects or old object versions unless you are using a Shinami dedicated node with extra history storage enabled. For more info see here.

Description
Return object information for a vector of objects and versions.

Params

past_objects : [GetPastObjectRequest] - a vector of objects and versions to be queried
options : ObjectDataOptions - Optional. Sui options for specifying the object content to be returned

curl https://api.us1.shinami.com/sui/node/v1/API_KEY \
-X POST \
-H 'Content-Type: application/json' \
-d '{ "jsonrpc":"2.0",
      "method":"sui_tryMultiGetPastObjects",
      "params":["{{past_objects}}",
          "showType": true,
          "showOwner": true,
          "showPreviousTransaction": true,
          "showDisplay": false,
          "showContent": true,
          "showBcs": false,
          "showStorageRebate": true],
      "id":1}'

Result SuiPastObjectResponse[] : [ObjectRead]

suix_getDynamicFieldObject

Description
Return the dynamic field object information for a specified object. Params

parent_object_id : String - the ID of the queried parent object
name : type DynamicFieldName with elements:
- type: String- the type of the object
- value: additional identifying information (see example below)

Shell

npm install @shinami/clients

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

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":"suix_getDynamicFieldObject",
        "params":[
            "{{parentObjectId}}",
            "type" : "objectType",
            "value" : {{theValue}}
        ],
        "id":1
    }'

##
## Real-world mainnet example:
##
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":"suix_getDynamicFieldObject",
        "params":[
             "0x0c687e442db438be185fad2e86a27abfa1f509c4932d6e8a339ae3e7c8609afd",
             {
                 "type" : "0x2::kiosk::Listing",
                 "value" : {
                     "id" : "0xe40675ff1cc967c53f6253cb9534bd8b3d9ac43539709ac1a249c5563f323889",
                     "is_exclusive" : true
                 }
             }
         ],
        "id":1
    }'

Example Response

{
     "id" : 1,
     "jsonrpc" : "2.0",
     "result" : {
         "data" : {
             "content" : {
                 "dataType" : "moveObject",
                 "fields" : {
                      "id" : {
                          "id" : "0x006d57813508869778f3e64c58408cbfbd8191b07d5a26be59b46e8e88a648be"
                      },
                      "name" : {
                          "fields" : {
                              "id" : "0xe40675ff1cc967c53f6253cb9534bd8b3d9ac43539709ac1a249c5563f323889",
                              "is_exclusive" : true
                          },
                      "type" : "0x2::kiosk::Listing"
                      },
                      "value" : "650000000"
                 },
                 "hasPublicTransfer" : false,
                 "type" : "0x2::dynamic_field::Field<0x2::kiosk::Listing, u64>"
            },
            "digest" : "DJUR6seb8ovP3WiqTywD9NSWVk17ir1MHW4HNSJhG96X",
            "objectId" : "0x006d57813508869778f3e64c58408cbfbd8191b07d5a26be59b46e8e88a648be",
            "owner" : {
                "ObjectOwner" : "0x0c687e442db438be185fad2e86a27abfa1f509c4932d6e8a339ae3e7c8609afd"
            },
            "previousTransaction" : "4fPHcSzMb5W1xK3zN79hKDrzYxR35ksQF1HZb1QGpDc9",
            "storageRebate" : "2014000",
            "type" : "0x2::dynamic_field::Field<0x2::kiosk::Listing, u64>",
            "version" : "46057077"
        }
    }
}

Result

SuiObjectResponse : type SuiObjectResponse with optional elements
- data?: type SuiObjectData | null
- error?: type ObjectResponseError | null

suix_getDynamicFields

Description
Return the list of dynamic field objects owned by an object. Params

parent_object_id : String - the ID of the queried parent object
cursor : String - optional paging cursor
limit : uint - maximum number of items per page; defaults to maximum possible if not specified, which is 50.

Shell

npm install @shinami/clients

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

curl https://api.us1.shinami.com/sui/node/v1 \
-X POST \
-H 'X-API-Key: {{nodeServiceAccessKey}}' \
-H 'Content-Type: application/json' \
-d '{
        "jsonrpc":"2.0",
        "method":"suix_getDynamicFields",
        "params":[
            "{{parentObjectId}}",
            "{{cursor}}",
            {{limit}}
            ],
        "id":1
    }'

Example Response

{
    "id" : 1,
    "jsonrpc" : "2.0",
    "result" : {
        "data" : [
            {
                "bcsName" : "49k8ctZtQ8wZoXT8BRc8JBEYZNRDbGJqRCQ9xpycG2rr",
                "digest" : "ZypNDZSBfSB9wNqgqGtjxfBDXM3ARr7x7GxxWhWMGpu",
                "name" : {
                    "type" : "0x2::kiosk::Lock",
                    "value" : {
                        "id" : "0x2ed079dd5b52f5d96238972907db0108de0f9af62e2786935bc2b5706a06f637"
                    }
                },
                "objectId" : "0x0055d940a0c04e0d9a620915c00d62f7059d4cf191e9e9b59177e0288c926485",
                "objectType" : "bool",
                "type" : "DynamicField",
                "version" : 29685770
            },
            {
                "bcsName" : "2AjnSJjsS2VtXpqshETPsk3dUMmfHzyzUZ3c7QmJPmFADN",
                "digest" : "DJUR6seb8ovP3WiqTywD9NSWVk17ir1MHW4HNSJhG96X",
                "name" : {
                    "type" : "0x2::kiosk::Listing",
                    "value" : {
                        "id" : "0xe40675ff1cc967c53f6253cb9534bd8b3d9ac43539709ac1a249c5563f323889",
                        "is_exclusive" : true
                    }
                },
                "objectId" : "0x006d57813508869778f3e64c58408cbfbd8191b07d5a26be59b46e8e88a648be",
                "objectType" : "u64",
                "type" : "DynamicField",
                "version" : 46057077
            }
        ],
        "hasNextPage" : true,
        "nextCursor" : "0x006d57813508869778f3e64c58408cbfbd8191b07d5a26be59b46e8e88a648be"
    }
}

Result DynamicFieldPage : type DynamicFieldPage with elements:

data : Array of type DynamicFieldInfo
nextCursor: String | null
hasNextPage: Boolean

suix_getOwnedObjects

Description
Return the list of objects owned by an address. Params

owner : the owner’s Sui address
SuiObjectResponseQuery
- filter : SuiObjectDataFilter - Optional. Object query criteria.
- options: SuiObjectDataOptions - Optional. Sui options for specifying the object content to be returned. All options default to false if not provided.
cursor : CheckpointedObjectID - optional paging cursor. If provided, the query will start from the next item after the specified cursor. Default to start from the first item if not specified.
limit : uint> - optional limit of items per page; default to maximum limit of 50 if not specified.

Shell

npm install @shinami/clients

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

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":"suix_getOwnedObjects",
        "params":[
            "{{ownersSuiAddress}}",
            {
            {{SuiObjectDataFilter}}, # e.g. "Package": "0xc8ada8b9d295379f5c8128fa796b76ddfd8ab78be669463520a6df57d20e5719"
            "options": {
                "showType": true,
                "showOwner": true,
                "showPreviousTransaction": true,
                "showDisplay": true,
                "showContent": true,
                "showBcs": true,
                "showStorageRebate": true
            }
        }
        ],
        "id":1
    }'

Example Response

{
    "jsonrpc": "2.0",
    "result": {
        "data": [{
            "data": {
                "objectId": "0x5b79956343aa6d3c09e362dd20f97b65027e0c64e75e88a88aa596e45d3a2371",
                "version": "36175593",
                "digest": "Gn4n9ZvoUuTmMhUSyb6JfuLjvEvX6xnpmnCydtaLG35n",
                "type": "0x8bdc95e99e393fea9b0e010353ef27109ca6b93d96c57090d7ab61fc9ca4d78d::loyalty::Box",
                "owner": {
                    "AddressOwner": "0x4da016bcfd074d7419afa7b9168dd3bc4b6dcfdbe76465bbb34aac299857562a"
                },
                "previousTransaction": "Hpx6kbrtGD4RXa4to7zwJrrbnXs3ovmHZCEfPEnjr7uH",
                "storageRebate": "1816400",
                "display": {
                    "data": {
                        "creator": "Worlds Beyond Creator",
                        "description": "The Infinity Passport is a loyalty program that rewards players for playing games in our ecosystem. Players earn Infinity Credits on their Infinity Passports for playing Worlds Beyond games, winning competitions, completing challenges and more. These Infinity Credits can be redeemed for a variety of rewards, including WBITS mining keys, in-game items, exclusive content, and real-world prizes. Be sure to follow news in our Discord and Twitter for the most updated information.",
                        "image_url": "https://cdn.worldsbeyondnft.com/nft/loyalty-boxes/0.png",
                        "infinity_credits": "27630",
                        "link": "https://worldsbeyondnft.com/loyalty-boxes/0x5b79956343aa6d3c09e362dd20f97b65027e0c64e75e88a88aa596e45d3a2371",
                        "name": "Infinity Passport #81430",
                        "project_url": "https://worldsbeyondnft.com"
                    },
                    "error": null
                },
                "content": {
                    "dataType": "moveObject",
                    "type": "0x8bdc95e99e393fea9b0e010353ef27109ca6b93d96c57090d7ab61fc9ca4d78d::loyalty::Box",
                    "hasPublicTransfer": false,
                    "fields": {
                        "attributes": {
                            "type": "0xbc3df36be17f27ac98e3c839b2589db8475fa07b20657b08e8891e3aaf5ee5f9::attributes::Attributes",
                            "fields": {
                                "map": {
                                    "type": "0x2::vec_map::VecMap<0x1::ascii::String, 0x1::ascii::String>",
                                    "fields": {
                                        "contents": [{
                                            "type": "0x2::vec_map::Entry<0x1::ascii::String, 0x1::ascii::String>",
                                            "fields": {
                                                "key": "ID",
                                                "value": "81430"
                                            }
                                        }, {
                                            "type": "0x2::vec_map::Entry<0x1::ascii::String, 0x1::ascii::String>",
                                            "fields": {
                                                "key": "Infinity Credits",
                                                "value": "900"
                                            }
                                        }]
                                    }
                                }
                            }
                        },
                        "id": {
                            "id": "0x5b79956343aa6d3c09e362dd20f97b65027e0c64e75e88a88aa596e45d3a2371"
                        },
                        "infinity_credits": "27630",
                        "name": "Infinity Passport #81430",
                        "type": "0"
                    }
                },
                "bcs": {
                    "dataType": "moveObject",
                    "type": "0x8bdc95e99e393fea9b0e010353ef27109ca6b93d96c57090d7ab61fc9ca4d78d::loyalty::Box",
                    "hasPublicTransfer": false,
                    "version": 36175593,
                    "bcsBytes": "W3mVY0OqbTwJ42LdIPl7ZQJ+DGTnXoioiqWW5F06I3EAAAAAAAAAABhJbmZpbml0eSBQYXNzcG9ydCAjODE0MzDuawAAAAAAAAICSUQFODE0MzAQSW5maW5pdHkgQ3JlZGl0cwM5MDA="
                }
            }
        }],
        "nextCursor": "0x5b79956343aa6d3c09e362dd20f97b65027e0c64e75e88a88aa596e45d3a2371",
        "hasNextPage": false ## since this is false, you should not follow the cursor
    },
    "id": 1
}

Response Data PaginatedObjectsResponse containing:

data: list of type SuiObjectResponse
hasNextPage: boolean - if false, there are no more results to fetch
nextCursor?: String - if hasNextPage is true use this cursor in the subsequent request to fetch additional objects.

Reading Coin Data

suix_getBalance

Description
Return the total Coin balance owned by an address for one coin type. Params

owner : SuiAddress - the owner’s Sui address
coin_type : string - (optional) fully qualified type names for the coin. Defaults to 0x2::sui::SUI if not specified.

npm install @shinami/clients

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

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":"suix_getBalance",
        "params":[
            "{{ownerAddress}}",
            "{{coinType}}"
        ],
        "id":1
    }'

Example Response

{
    "jsonrpc":"2.0",
    "result":{
        "coinType":"0x2::sui::SUI",
        "coinObjectCount":11,
        "totalBalance":"15822947868",
        "lockedBalance":{}
    },
    "id":1
}

Response Data A CoinBalance object containing:

coinType : string
coinObjectCount : uint
totalBalance : BigInt_for_uint128
lockedBalance : object

suix_getAllBalances

Description
Return the balance for all Coin types owned by an address. Params

owner : SuiAddress - the owner’s Sui address

Shell

npm install @shinami/clients

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

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":"suix_getAllBalances",
        "params":[
            "{{ownerAddress}}"
        ],
        "id":1
    }'

Example Response

{
    "jsonrpc" : "2.0",
    "result" : [
        {
            "coinObjectCount" : 11,
            "coinType" : "0x2::sui::SUI",
            "lockedBalance" : {},
            "totalBalance" : "15822947868"
        }
    ],
    "id" : 1
}

Response Data An array of type CoinBalance , where a CoinBalance is an object containing:

coinType : string
coinObjectCount : uint
totalBalance : BigInt_for_uint128
lockedBalance : object

suix_getCoins

Description
Return all Coin objects owned by an address of a given Coin type. Params

owner : SuiAddress - the owner’s Sui address
coin_type : string - (optional) fully qualified type names for the coin. Defaults to 0x2::sui::SUI if not specified.
cursor : string - (optional) paging cursor of the coin Object to start after when returning results for the next request
limit : uint - (optional) maximum number of items per page

Shell

npm install @shinami/clients

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

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":"suix_getCoins",
        "params":[
            "{{ownerAddress}}",
            "{{coinType}}",
            "{{cursor}}",
            {{limit}}
        ],
        "id":1
    }'

Example Response

{
    "jsonrpc" : "2.0",
    "result" : {
        "data" : [
            {
                "balance" : "1000000000",
                "coinObjectId" : "0x34a947649e7d1837dc864bfa5bbbc873fef7f003ee8b502005f521aca9ba6e07",
                "coinType" : "0x2::sui::SUI",
                "digest" : "62xUAyKWPf8yMkCUxkNNj5js8FMWnbsv6QC75QhKRYct",
                "previousTransaction" : "32sp5CeigGxKqEhMqDUJDaSb48eMPgLj1fD7UXxvjekz",
                "version" : "1191782"
            },
            {
                "balance" : "1000000000",
                "coinObjectId" : "0x3eb0bace095a1703998be4c8cf243a709ae3ef86bc5a6ebcd165c7d72279eea0",
                "coinType" : "0x2::sui::SUI",
                "digest" : "BQdrF9DYTU4tjfiqxW21DfFkcMENDSuWmA2cuELzeT8j",
                "previousTransaction" : "74xn4rX8hbN1dYEbhHz7jCctatVbdLXcgBXbtZ7WQbxj",
                "version" : "1074085"
            },
            {
                "balance" : "1000000000",
                "coinObjectId" : "0x75beecf910f5e585cf1a1ccee0a1176130dfd0e0a34ce4bf027032e6a7797727",
                "coinType" : "0x2::sui::SUI",
                "digest" : "6eB7ssJnR8wR45LqvpMcSqUnYvja4ZhqZh8H2fAeWjKG",
                "previousTransaction" : "8FhkCTwj7toJ4E9mYq6gsvG6Gbi547Sxtf1ew9t9czxk",
                "version" : "1046394"
            }
        ],
        "hasNextPage" : true,
        "nextCursor" : "0x75beecf910f5e585cf1a1ccee0a1176130dfd0e0a34ce4bf027032e6a7797727"
    },
    "id" : 1
}

Response Data PaginatedCoins object with fields:

data: Array of type CoinStruct with fields:
- balance: String
- coinObjectId: String
- coinType: String
- digest: String
- previousTransaction: String
- version: String
hasNextPage: Boolean
nextCursor?: string | null

suix_getAllCoins

Description
Return all Coin objects owned by an address. Params

owner : SuiAddress - the owner’s Sui address
cursor : string - (optional) paging cursor
limit : uint - (optional) maximum number of items per page

Shell

npm install @shinami/clients

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

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":"suix_getAllCoins",
        "params":[
            "{{ownerAddress}}",
            "{{cursor}}",
            {{limit}}
        ],
        "id":1
    }'

Example Response

{
    "jsonrpc" : "2.0",
    "result" : {
       "data" : [
           {
               "balance" : "1000000000",
               "coinObjectId" : "0x34a947649e7d1837dc864bfa5bbbc873fef7f003ee8b502005f521aca9ba6e07",
               "coinType" : "0x2::sui::SUI",
               "digest" : "62xUAyKWPf8yMkCUxkNNj5js8FMWnbsv6QC75QhKRYct",
               "previousTransaction" : "32sp5CeigGxKqEhMqDUJDaSb48eMPgLj1fD7UXxvjekz",
               "version" : "1191782"
           },
           {
               "balance" : "1000000000",
               "coinObjectId" : "0x3eb0bace095a1703998be4c8cf243a709ae3ef86bc5a6ebcd165c7d72279eea0",
               "coinType" : "0x2::sui::SUI",
               "digest" : "BQdrF9DYTU4tjfiqxW21DfFkcMENDSuWmA2cuELzeT8j",
               "previousTransaction" : "74xn4rX8hbN1dYEbhHz7jCctatVbdLXcgBXbtZ7WQbxj",
               "version" : "1074085"
           },
           {
               "balance" : "1000000000",
               "coinObjectId" : "0x75beecf910f5e585cf1a1ccee0a1176130dfd0e0a34ce4bf027032e6a7797727",
               "coinType" : "0x2::sui::SUI",
               "digest" : "6eB7ssJnR8wR45LqvpMcSqUnYvja4ZhqZh8H2fAeWjKG",
               "previousTransaction" : "8FhkCTwj7toJ4E9mYq6gsvG6Gbi547Sxtf1ew9t9czxk",
               "version" : "1046394"
           }
       ],
       "hasNextPage" : true,
       "nextCursor" : "0x75beecf910f5e585cf1a1ccee0a1176130dfd0e0a34ce4bf027032e6a7797727"
    },
    "id" : 1
}

Response Data PaginatedCoins object with fields:

data: Array of type CoinStruct with fields:
- balance: String
- coinObjectId: String
- coinType: String
- digest: String
- previousTransaction: String
- version: String
hasNextPage: Boolean
nextCursor?: string | null

suix_getCoinMetadata

Description
Return metadata(e.g., symbol, decimals) for a coin. Request parameters

Name	Type	Description
coinType	string	fully qualified type names for the coin (e.g., `"0x2::sui::SUI"`). Remember that your API key determines which network you’re querying.

Example Request This example uses our US East - us1 region URL since it is currently the only region where we offer Testnet. To send to another region, see our our Node Service API Overview. The TypeScript example uses the Shinami Clients SDK, which you can install with:

npm install @shinami/clients

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

curl https://api.us1.shinami.com/sui/node/v1 \
-X POST \
-H 'X-API-Key: NODE_SERVICE_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
        "jsonrpc":"2.0",
        "method":"suix_getCoinMetadata",
        "params":[
            "0x2::sui::SUI"
        ],
        "id":1
    }' | json_pp

Example response

{
   "id" : 1,
   "jsonrpc" : "2.0",
   "result" : {
      "decimals" : 9,
      "description" : "",
      "iconUrl" : null,
      "id" : "0x9258181f5ceac8dbffb7030890243caed69a9599d2886d957a9cb7656af3bdb3",
      "name" : "Sui",
      "symbol" : "SUI"
   }
}

Response fields The response is of type CoinMetadata with fields:

Name	Type	Description
decimals	number	Number of decimal places the coin uses.
description	string	Description of the token.
iconUrl	string \| null	URL for the token logo if it exists.
id	string \| null	Object id for the CoinMetadata object if it exists.
name	string	Name for the token.
symbol	string	Symbol for the token.

suix_getTotalSupply

Description
Return total supply for a coin. Request parameters

Name	Type	Description
coinType	string	fully qualified type names for the coin (e.g., `"0x2::sui::SUI"`). Remember that your API key determines which network you’re querying.

Shell

npm install @shinami/clients

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

curl https://api.us1.shinami.com/sui/node/v1 \
-X POST \
-H 'X-API-Key: NODE_SERVICE_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
        "jsonrpc":"2.0",
        "method":"suix_getTotalSupply",
        "params":[
            "0x2::sui::SUI"
        ],
        "id":1
    }' | json_pp

Example Response

{
   "id" : 1,
   "jsonrpc" : "2.0",
   "result" : {
      "value" : "10000000000000000000"
   }
}

Response Fields Response is of type CoinSupply with fields:

Name	Type	Description
value	string	The total supply of the coin.

Aptos

SUI

Movement

Overview

Authentication, rate limits, error handling, and sending to specific regions

Reading Object Data

sui_getObject

sui_multiGetObjects

sui_tryGetPastObject

sui_tryMultiGetPastObjects

suix_getDynamicFieldObject

suix_getDynamicFields

suix_getOwnedObjects

Reading Coin Data

suix_getBalance

suix_getAllBalances

suix_getCoins

suix_getAllCoins

suix_getCoinMetadata

suix_getTotalSupply

Aptos

SUI

Movement

​Overview

​Authentication, rate limits, error handling, and sending to specific regions

​Reading Object Data

​sui_getObject

​sui_multiGetObjects

​sui_tryGetPastObject

​sui_tryMultiGetPastObjects

​suix_getDynamicFieldObject

​suix_getDynamicFields

​suix_getOwnedObjects

​Reading Coin Data

​suix_getBalance

​suix_getAllBalances

​suix_getCoins

​suix_getAllCoins

​suix_getCoinMetadata

​suix_getTotalSupply

Overview

Authentication, rate limits, error handling, and sending to specific regions

Reading Object Data

sui_getObject

sui_multiGetObjects

sui_tryGetPastObject

sui_tryMultiGetPastObjects

suix_getDynamicFieldObject

suix_getDynamicFields

suix_getOwnedObjects

Reading Coin Data

suix_getBalance

suix_getAllBalances

suix_getCoins

suix_getAllCoins

suix_getCoinMetadata

suix_getTotalSupply