Retrieve Coin Holders

Returns holders of a coin by a given object type.

📘

Supported on Sui Mainnet.

🚧

For the Indexing APIs on Sui, we currently only open them for whitelisted users. If you're interested, please submit your request here or contact us via Discord or Email.

Params

  • coinType, string - the coin type for the coin to get the holders.
  • pageIndex, integer - the index of the page to retrieve. The first page is typically indexed as 1, and subsequent pages are numbered incrementally.
  • pageSize, integer - the number of records showing on each page. 20 by default and up to 50.

Returns

Array - an array of coin holder objects, or an empty array if there are no holders.

  • address, string - the address of a holder.
  • quantity, string - the number of coins the holder has.
  • percentage, float - the relative share of coins held by an individual holder.

For higher throughput, create your own API key.

Language
Authentication
Header
Click Try It! to start a request and see the response here!