suix_getCoins

POST

/{apiKey}

Returns all Coin objects of the specified coin type owned by the given address. If the coin type is not provided, defaults to 0x2::sui::SUI.

Path Parameters

stringrequireddefaults to docs-demo

For higher throughput, create your own API key

Request

stringrequired

The owner's Sui address.

stringoptional

Fully qualified type name of the coin (e.g., 0x2::sui::SUI). Defaults to 0x2::sui::SUI if omitted.

stringoptional

Optional paging cursor to paginate results.

integeroptional

Maximum number of items to return in a single page.

Responses

200

A page of Coin objects and pagination metadata.

POST/v2/{apiKey}

curl --request POST \  --url https://sui-mainnet.g.alchemy.com/v2/docs-demo \  --header 'Content-Type: application/json' \  --data '{  "jsonrpc": "2.0",  "id": 1,  "method": "suix_getCoins",  "params": [    "0xe883a1df96561884e46d8e29cfb4e127bb6fd2719c33af1c16239a25a469e0a6",    "0x2::sui::SUI",    "0x1c574d9f2db5f293a799cc82795486aa8ce2962f831c7c6a433cbdcd84639acb",    3  ]}'

200Success

{  "jsonrpc": "2.0",  "id": 1,  "result": {    "data": [      {        "coinType": "0x2::sui::SUI",        "coinObjectId": "0xb770280feece9abe5f4683ee9a1b5baa76e3426d3dd46e9e17ae45a294d8a486",        "version": "2960614",        "digest": "CwcAqcZsw9toDkJjg2WjUvdY5U8o914CwzbTSUeEgPRR",        "balance": "1000000000",        "lockedUntilEpoch": null,        "previousTransaction": "DsYAh2efV1nD4UuEQXMeicPBgeYD4UbQSDpLg9mKTMzc"      }    ],    "nextCursor": "0xb770280feece9abe5f4683ee9a1b5baa76e3426d3dd46e9e17ae45a294d8a486",    "hasNextPage": false  }}

Was this page helpful?