Skip to main content

/api/v1/tokens/{tokenId} REST API Endpoint

Returns token entity information given the id.

Updated on
Dec 18, 2024

Path Parameters

tokenId
string
REQUIRED

The network entity ID in the format of shard.realm.num

Query Parameters

timestamp
string

The Unix timestamp in seconds.nanoseconds format

Returns

admin_key
object | null

The admin_key object which contains the following fields:

_type
string

The type of the key

key
string

The key itself

auto_renew_account
string | null

The account ID for auto-renewal payments

auto_renew_period
integer

The period in seconds for auto-renewal

created_timestamp
string

The timestamp when the token was created

custom_fees
object

The custom_fees object which contains the following fields:

created_timestamp
string

The timestamp when the custom fees were created

fixed_fees
array

An array of fixed fees associated with the token.

fractional_fees
array

An array of fractional fees associated with the token

decimals
string

The number of decimal places the token uses.

deleted
boolean

A boolean indicating whether the token has been deleted.

expiry_timestamp
integer

The timestamp when the token expires

fee_schedule_key
object | null

The fee_schedule_key object which contains the following fields:

_type
string

The type of the key

key
string

The key itself

freeze_default
boolean

A boolean indicating whether new accounts are frozen by default

freeze_key
object | null

The key for freezing the token

initial_supply
string

The initial supply of the token

kyc_key
object | null

The key for KYC

max_supply
string

The maximum supply of the token

memo
string

A memo associated with the token

metadata
string

Any metadata associated with the token

metadata_key
object | null

The key for managing the token's metadata

modified_timestamp
string

The timestamp when the token was last modified

name
string

The name of the token

pause_key
object | null

The pause_key object which contains the following fields:

_type
string

The type of the key

key
string

The key itself

pause_status
string

The current pause status of the token

supply_key
object | null

The supply_key object which contains the following fields:

_type
string

The type of the key

key
string

The key itself

supply_type
string

The supply type of the token

symbol
string

The symbol of the token

token_id
string

The unique identifier of the token

total_supply
string

The total supply of the token

treasury_account_id
string

The account ID of the token's treasury

type
string

The type of the token

wipe_key
object | null

The wipe_key object which contains the following fields:

_type
string

The type of the key

key
string

The key itself

Request
Don't have an account yet?
Create your Quicknode endpoint in seconds and start building
Get started for free