Skip to main content

The Asset Object

When Horizon returns information about an asset, it uses the following format:

  • ATTRIBUTEDATA TYPE

    DESCRIPTION

  • asset_typestring

    This asset's type. Either credit_alphanum4 or credit_alphanum12.

  • asset_codestring

    This asset's code

  • asset_issuerstring

    The Stellar address of this asset’s issuer.

  • accountsobject

    The number of accounts grouped by each trustline flag state.

  • num_claimable_balancesnumber

    The current number of claimable_balances for this asset.

  • num_contractsnumber

    The current number of Soroban contracts holding this asset.

  • num_liquidity_poolsnumber

    The current number of liquidity pools holding this asset.

  • balancesobject

    The number of units issued for this asset grouped by each trustline flag state.

  • claimable_balances_amountstring

    The number of units for this asset held by all claimable balances.

  • contracts_amountstring

    The number of units for this asset held by all Soroban contracts.

  • liquidity_pools_amountstring

    The number of units for this asset held by all liquidity pools.

  • amountstring

    The number of authorized units issued for this asset. This will be deprecated in Horizon v3.

  • num_accountsnumber

    The number of accounts that have issued a trustline to this asset. If the auth_required flag for this asset's issuer is set to true, this number only includes the accounts who have both set up a trustline to the asset and have been authorized to hold the asset. This will be deprecated in Horizon v3.

  • flagsobject

    Flags denote the enabling/disabling of certain asset issuer privileges.

    Show child attributes
    • auth_immutableboolean

      If set to true, none of the following flags can be changed.

    • auth_requiredboolean

      If set to true, anyone who wants to hold an asset issued by this account must first be approved by this account.

    • auth_revocableboolean

      If set to true, this account can freeze the balance of a holder of an asset issued by this account.

  • paging_tokennumber

    A cursor value for use in pagination.