API Reference

Retrieve Coin Holders

Returns holders of a coin by a given object type.

πŸ“˜

Supported on Sui Mainnet.

🚧

The Coins Holder API on Sui is currently exclusively available to Pro Members. Non-Pro members can also enjoy a trial period with an allocation of 30 free calls. If you're interested, please register directly through here. Please note that the API Key can also be used for your RPC endpoint.

Parameter

  • coinType, string - the coin type for the coin to get the holders.
  • cursor, string - next page cursor.
  • limit, integer - the maximum number of results to return per page. Defaults to 20, maximum is 50.

Response

Object - a returned object with coin holders info, next page index and total holders of a coin. Contains:

  • data, 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 a holder has.
    • percentage, float - the relative share of coins held by an individual holder.
  • nextPageCursor, string - cursor used for paginating to the next page of results.
  • total, integer - the number of holders of a coin.
Language
Credentials
Header
Click Try It! to start a request and see the response here!