Sign in

Returns the list of holders of an EVM (ERC-20, ...) token.

Changed on

This endpoint does not verify that address is actually an EVM token; if it is not, it will simply return an empty list.

get/{runtime}/evm_tokens/{address}/holders

Request

  • Base URL: https://nexus.oasis.io/v1
  • URL: https://nexus.oasis.io/v1/{runtime}/evm_tokens/{address}/holders
  • Auth: none declared

Path parameters

runtime'emerald' | 'sapphire' | 'pontusxtest' | 'pontusxdev' | 'cipher' required
Example:sapphire

The runtime which to query.

addressstring required

The staking address of the token contract for which to return the holders.

Query parameters

limitinteger

The maximum numbers of items to return.

offsetinteger

The number of items to skip before starting to collect the result set.

Response

The requested holders.

total_countinteger required

The total number of records that match the query, i.e. the number of records the query would return with limit=infinity.

is_total_count_clippedboolean required

Whether total_count is clipped for performance reasons.

Example response

{
  "total_count": 412,
  "is_total_count_clipped": true,
  "holders": [
    {
      "holder_address": "oasis1qpg2xuz46g53737343r20yxeddhlvc2ldqsjh70p",
      "balance": "1234567890123456789012"
    }
  ]
}

Changes

  • v107a2d7aea71cRevision changes
    • breaking

      the path request parameter runtime was restricted to a list of enum values

    • info

      added the new enum value cipher to the path request parameter runtime

    • info

      added the new enum value emerald to the path request parameter runtime

    • info

      added the new enum value pontusxdev to the path request parameter runtime

    • info

      added the new enum value pontusxtest to the path request parameter runtime

    • info

      added the new enum value sapphire to the path request parameter runtime

    • info

      for the path request parameter runtime, the type was generalized from no type to string

  • v1a19bd7c959b6Revision changes
    • breaking

      removed the enum value cipher from the path request parameter runtime

    • breaking

      removed the enum value emerald from the path request parameter runtime

    • breaking

      removed the enum value pontusxdev from the path request parameter runtime

    • breaking

      removed the enum value pontusxtest from the path request parameter runtime

    • breaking

      removed the enum value sapphire from the path request parameter runtime

    • info

      for the path request parameter runtime, the type was generalized from string to no type