stellar-sdk/com.soneso.stellar.sdk.horizon.responses/AssetResponse

AssetResponse

@Serializable

data class AssetResponse(val assetType: String, val assetCode: String, val assetIssuer: String, val pagingToken: String, val contractId: String? = null, val numClaimableBalances: Int? = null, val numLiquidityPools: Int? = null, val numContracts: Int? = null, val accounts: AssetResponse.Accounts, val claimableBalancesAmount: String? = null, val liquidityPoolsAmount: String? = null, val contractsAmount: String? = null, val balances: AssetResponse.Balances, val flags: AssetResponse.Flags, val links: AssetResponse.Links) : Response, Pageable

Represents an asset response from the Horizon API.

Assets are representations of value issued on the Stellar network. This response provides detailed information about an asset including its supply, number of accounts holding it, and various flags set by the issuer.

See also

Asset documentation

Constructors

constructor(assetType: String, assetCode: String, assetIssuer: String, pagingToken: String, contractId: String? = null, numClaimableBalances: Int? = null, numLiquidityPools: Int? = null, numContracts: Int? = null, accounts: AssetResponse.Accounts, claimableBalancesAmount: String? = null, liquidityPoolsAmount: String? = null, contractsAmount: String? = null, balances: AssetResponse.Balances, flags: AssetResponse.Flags, links: AssetResponse.Links)

Types

@Serializable

data class Accounts(val authorized: Int, val authorizedToMaintainLiabilities: Int, val unauthorized: Int)

Statistics about accounts holding this asset.

@Serializable

data class Balances(val authorized: String, val authorizedToMaintainLiabilities: String, val unauthorized: String)

Statistics about balances of this asset.

@Serializable

data class Flags(val authRequired: Boolean, val authRevocable: Boolean, val authImmutable: Boolean, val authClawbackEnabled: Boolean)

Flags set on the asset issuer account.

@Serializable

data class Links(val toml: Link)

HAL links connected to this asset.

Properties

@SerialName(value = "accounts")

val accounts: AssetResponse.Accounts

Statistics about the number of accounts holding this asset

@SerialName(value = "asset_code")

val assetCode: String

The asset code

@SerialName(value = "asset_issuer")

val assetIssuer: String

The account ID of the asset issuer

@SerialName(value = "asset_type")

val assetType: String

The type of asset (credit_alphanum4, credit_alphanum12)

@SerialName(value = "balances")

val balances: AssetResponse.Balances

Statistics about the balances of this asset

claimableBalancesAmount

@SerialName(value = "claimable_balances_amount")

val claimableBalancesAmount: String?

The total amount held in claimable balances

@SerialName(value = "contract_id")

val contractId: String?

The Stellar Asset Contract ID for this asset in hex format (Soroban)

contractsAmount

@SerialName(value = "contracts_amount")

val contractsAmount: String?

The total amount held in contracts

@SerialName(value = "flags")

val flags: AssetResponse.Flags

Flags set on the asset issuer account

@SerialName(value = "_links")

val links: AssetResponse.Links

HAL links related to this asset

liquidityPoolsAmount

@SerialName(value = "liquidity_pools_amount")

val liquidityPoolsAmount: String?

The total amount held in liquidity pools

numClaimableBalances

@SerialName(value = "num_claimable_balances")

val numClaimableBalances: Int?

The number of claimable balances holding this asset

@SerialName(value = "num_contracts")

val numContracts: Int?

The number of contracts holding this asset

numLiquidityPools

@SerialName(value = "num_liquidity_pools")

val numLiquidityPools: Int?

The number of liquidity pools that include this asset

@SerialName(value = "paging_token")

open override val pagingToken: String

A cursor value for use in pagination