Class TokenData

Token information retrieved from a mirror node.

Inheritance

object

TokenData

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Hiero.Mirror

Assembly: Hiero.dll

Syntax

public class TokenData

Properties

| Edit this page View Source

Administrator

Administrator key for signing transactions modifying this token's properties.

Declaration

[JsonPropertyName("admin_key")]
public Endorsement? Administrator { get; set; }

Property Value

Type	Description
Endorsement

| Edit this page View Source

Ceiling

The maximum number of tokens allowed in circulation at a given time. The value of 0 is unbounded.

Declaration

[JsonPropertyName("max_supply")]
[JsonConverter(typeof(LongMirrorConverter))]
public long Ceiling { get; set; }

Property Value

Type	Description
long

| Edit this page View Source

Circulation

The total supply of the token (in tinytokens).

Declaration

[JsonPropertyName("total_supply")]
[JsonConverter(typeof(LongMirrorConverter))]
public long Circulation { get; set; }

Property Value

Type	Description
long

| Edit this page View Source

ConfiscateEndorsement

Administrator key for signing transactions that completely remove tokens from an crypto address.

Declaration

[JsonPropertyName("wipe_key")]
public Endorsement? ConfiscateEndorsement { get; set; }

Property Value

Type	Description
Endorsement

| Edit this page View Source

Created

The consensus timestamp of the token's creation.

Declaration

[JsonPropertyName("created_timestamp")]
public ConsensusTimeStamp Created { get; set; }

Property Value

Type	Description
ConsensusTimeStamp

| Edit this page View Source

Decimals

The number of token decimals (if this is a fungible token).

Declaration

[JsonPropertyName("decimals")]
[JsonConverter(typeof(IntMirrorConverter))]
public int Decimals { get; set; }

Property Value

Type	Description
int

| Edit this page View Source

Deleted

Flag indicating the token has been deleted.

Declaration

[JsonPropertyName("deleted")]
[JsonConverter(typeof(BooleanMirrorConverter))]
public bool Deleted { get; set; }

Property Value

Type	Description
bool

| Edit this page View Source

Expiration

Expiration date for the token. Will renew as determined by the renew period and balance of auto renew account.

Declaration

[JsonPropertyName("expiry_timestamp")]
[JsonConverter(typeof(ConsensusTimeStampForTokenExpirationConverter))]
public ConsensusTimeStamp Expiration { get; set; }

Property Value

Type	Description
ConsensusTimeStamp

| Edit this page View Source

GrantKycEndorsement

Administrator key for signing transactions updating the grant or revoke KYC status of an account.

Declaration

[JsonPropertyName("kyc_key")]
public Endorsement? GrantKycEndorsement { get; set; }

Property Value

Type	Description
Endorsement

| Edit this page View Source

InitialSupply

The number of tokens in circulation upon creation of this token.

Declaration

[JsonPropertyName("initial_supply")]
[JsonConverter(typeof(LongMirrorConverter))]
public long InitialSupply { get; set; }

Property Value

Type	Description
long

| Edit this page View Source

Memo

The memo associated with the token instance.

Declaration

[JsonPropertyName("memo")]
public string Memo { get; set; }

Property Value

Type	Description
string

| Edit this page View Source

Modified

The last time this token was modified.

Declaration

[JsonPropertyName("modified_timestamp")]
public ConsensusTimeStamp Modified { get; set; }

Property Value

Type	Description
ConsensusTimeStamp

| Edit this page View Source

Name

Name of this token

Declaration

[JsonPropertyName("name")]
public string Name { get; set; }

Property Value

Type	Description
string

| Edit this page View Source

PauseEndorsement

Administrator key for signing transactions that can pause or continue the exchange of all assets across all accounts on the network.

Declaration

[JsonPropertyName("pause_key")]
public Endorsement? PauseEndorsement { get; set; }

Property Value

Type	Description
Endorsement

| Edit this page View Source

PauseStatus

The current paused/frozen status of the token for all accounts.

Declaration

[JsonPropertyName("pause_status")]
[JsonConverter(typeof(PauseStatusConverter))]
public TokenTradableStatus PauseStatus { get; set; }

Property Value

Type	Description
TokenTradableStatus

| Edit this page View Source

RenewAccount

Optional address of the account supporting the auto renewal of the token at expiration time. The token lifetime will be extended by the RenewPeriod at expiration time if this account contains sufficient funds. The private key associated with this account must sign the transaction if RenewAccount is specified.

Declaration

[JsonPropertyName("auto_renew_account")]
public EntityId? RenewAccount { get; set; }

Property Value

Type	Description
EntityId

| Edit this page View Source

RenewPeriodInSeconds

Interval of the token and auto-renewal period. If the associated renewal account does not have sufficient funds to renew at the expiration time, it will be renewed for a period of time the remaining funds can support. If no funds remain, the token instance will be deleted.

Declaration

[JsonPropertyName("auto_renew_period")]
[JsonConverter(typeof(LongMirrorConverter))]
public long RenewPeriodInSeconds { get; set; }

Property Value

Type	Description
long

| Edit this page View Source

Royalties

The list of royalties assessed on transactions by the network when transferring this token.

Declaration

[JsonPropertyName("custom_fees")]
public CustomFeeData Royalties { get; set; }

Property Value

Type	Description
CustomFeeData

| Edit this page View Source

RoyaltiesEndorsement

Administrator key for signing transactions updating the royalties (custom transfer fees) associated with this token.

Declaration

[JsonPropertyName("fee_schedule_key")]
public Endorsement? RoyaltiesEndorsement { get; set; }

Property Value

Type	Description
Endorsement

| Edit this page View Source

SupplyEndorsement

Administrator key for signing transactions for minting or unminting tokens in the treasury account.

Declaration

[JsonPropertyName("supply_key")]
public Endorsement? SupplyEndorsement { get; set; }

Property Value

Type	Description
Endorsement

| Edit this page View Source

SupplyType

The supply type, finite or infinite.

Declaration

[JsonPropertyName("supply_type")]
public string SupplyType { get; set; }

Property Value

Type	Description
string

| Edit this page View Source

SuspendEndorsement

Administrator key for signing transactions for freezing or unfreezing an account's ability to transfer tokens.

Declaration

[JsonPropertyName("freeze_key")]
public Endorsement? SuspendEndorsement { get; set; }

Property Value

Type	Description
Endorsement

| Edit this page View Source

SuspendedByDefault

The current default suspended/frozen status of the token.

Declaration

[JsonPropertyName("freeze_default")]
public bool SuspendedByDefault { get; set; }

Property Value

Type	Description
bool

| Edit this page View Source

Symbol

The string symbol representing this token.

Declaration

[JsonPropertyName("symbol")]
public string Symbol { get; set; }

Property Value

Type	Description
string

| Edit this page View Source

Token

The Hedera address of this token.

Declaration

[JsonPropertyName("token_id")]
public EntityId Token { get; set; }

Property Value

Type	Description
EntityId

| Edit this page View Source

Treasury

The treasury account holding uncirculated tokens.

Declaration

[JsonPropertyName("treasury_account_id")]
public EntityId Treasury { get; set; }

Property Value

Type	Description
EntityId

| Edit this page View Source

Type

The type of token this represents, fungible token or Nft (NFT).

Declaration

[JsonPropertyName("type")]
public TokenType Type { get; set; }

Property Value

Type	Description
TokenType